Ver un cliente

GET/api/v1/customers/get

Permiso

customers.view

Empresa

Opera sobre la empresa activa

Tipo

Lectura: no cambia nada

Respuesta

JSON

Encabezados

• Cookietextorequerido

  La cookie de sesión del usuario de la integración (__Secure-erp.session_token). Cuando esté la clave API, va en Authorization: Bearer. Ver Autenticación.

• X-Expected-Companyuuidrequerido

  La empresa sobre la que operás. Si no coincide con la de la credencial, responde 409. Ver Empresa activa.

Parámetros de la consulta

• customerIduuidrequerido

Respuesta

200 con este JSON.

• iduuidrequerido
• codeenterorequerido

  mínimo 1

• documentTypeopciónrequerido

  Valores: CUIT CUIL DNI

• documentNumbertextorequerido
• legalNametextorequerido
• tradeNamecualquierarequerido
• emailcualquierarequerido
• phonecualquierarequerido
• vatConditionopciónrequerido

  Valores: registered monotributo exempt final_consumer

• iibbConditioncualquierarequerido
• iibbNumbercualquierarequerido
• streetcualquierarequerido
• streetNumbercualquierarequerido
• citycualquierarequerido
• provinceIduuidrequeridoadmite null
• postalCodecualquierarequerido
• salesModeopciónrequerido

  Valores: cash account

• paymentTermobjetorequeridoadmite null
  Campos (3)

  • iduuidrequerido
  • nametextorequerido
  • statusopciónrequerido

    Valores: active inactive

• priceListobjetorequeridoadmite null
  Campos (3)

  • iduuidrequerido
  • nametextorequerido
  • statusopciónrequerido

    Valores: active inactive

• generalDiscountPercenttextorequerido
• creditLimitcualquierarequerido
• taxDataSourcecualquierarequerido
• taxDataCheckedAtfecha y horarequeridoadmite null
• statusopciónrequerido

  Valores: active inactive

• versionenterorequerido

  mínimo 1

• createdAtfecha y horarequerido
• recipientslista de objetorequerido
  Campos de cada elemento (15)

  • iduuidrequerido
  • customerIduuidrequerido
  • nametextorequerido
  • streettextorequerido
  • streetNumbercualquierarequerido
  • citytextorequerido
  • provinceIduuidrequerido
  • postalCodecualquierarequerido
  • receiverNamecualquierarequerido
  • receiverPhonecualquierarequerido
  • receivingHourscualquierarequerido
  • carrierTaxIdcualquierarequerido
  • isDefaultsí o norequerido
  • statusopciónrequerido

    Valores: active inactive

  • versionenterorequerido

    mínimo 1

• contactslista de objetorequerido
  Campos de cada elemento (9)

  • iduuidrequerido
  • customerIduuidrequerido
  • nametextorequerido
  • rolecualquierarequerido
  • emailcualquierarequerido
  • phonecualquierarequerido
  • isPrimarysí o norequerido
  • statusopciónrequerido

    Valores: active inactive

  • versionenterorequerido

    mínimo 1

• apocryphalobjetorequeridoadmite null
  Campos (2)

  • listedOnfecharequerido
  • checkedAtfecha y horarequerido

Errores

Un rechazo responde application/problem+json con un code estable. Los más comunes en esta operación:

401	Falta la credencial o venció.
403	La credencial no tiene el permiso customers.view.
409	La empresa activa no es la de X-Expected-Company.
422	Datos inválidos o una regla de negocio rota, con el detalle por campo.
503	Sistema ocupado: reintentá después de Retry-After segundos.

La lista completa está en Errores.

curl

curl "$ERP_URL/api/v1/customers/get?customerId=3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90" \
  -b sesion.txt \
  -H "X-Expected-Company: $ERP_EMPRESA"

TypeScript

const respuesta = await fetch(`${process.env.ERP_URL}/api/v1/customers/get?customerId=3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90`, {
  headers: {
    Cookie: process.env.ERP_SESION!,
    "X-Expected-Company": process.env.ERP_EMPRESA!,
  },
});
if (!respuesta.ok) throw new Error((await respuesta.json()).title);
const datos = await respuesta.json();

Respuesta 200

{
  "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
  "code": 1,
  "documentType": "CUIT",
  "documentNumber": "texto",
  "legalName": "texto",
  "tradeName": null,
  "email": null,
  "phone": null,
  "vatCondition": "registered",
  "iibbCondition": null,
  "iibbNumber": null,
  "street": null,
  "streetNumber": null,
  "city": null,
  "provinceId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
  "postalCode": null,
  "salesMode": "cash",
  "paymentTerm": {
    "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
    "name": "texto",
    "status": "active"
  },
  "priceList": {
    "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
    "name": "texto",
    "status": "active"
  },
  "generalDiscountPercent": "texto",
  "creditLimit": null,
  "taxDataSource": null,
  "taxDataCheckedAt": "2026-10-23T14:30:00.000Z",
  "status": "active",
  "version": 1,
  "createdAt": "2026-10-23T14:30:00.000Z",
  "recipients": [
    {
      "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "customerId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "name": "texto",
      "street": "texto",
      "streetNumber": null,
      "city": "texto",
      "provinceId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "postalCode": null,
      "receiverName": null,
      "receiverPhone": null,
      "receivingHours": null,
      "carrierTaxId": null,
      "isDefault": false,
      "status": "active",
      "version": 1
    }
  ],
  "contacts": [
    {
      "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "customerId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "name": "texto",
      "role": null,
      "email": null,
      "phone": null,
      "isPrimary": false,
      "status": "active",
      "version": 1
    }
  ],
  "apocryphal": {
    "listedOn": "2026-10-23",
    "checkedAt": "2026-10-23T14:30:00.000Z"
  }
}