Get Customer

Usa esto cuando necesites un cliente tal como lo tiene Hyfin, mediante su _id.


The following endpoint can be used to retrieve the details of a customer within the Hyfin application.


Punto Final

The following endpoint can be used to retrieve a customer. You must replace the {base_url} , {site_id} and {_id} variables with the appropriate values.

GET
{base_url}/api/v4/site/{site_id}/customer/{_id}
Solicitud
Ningún cuerpo es necesario para esta llamada de API
Respuesta
Campo
Tipo
Descripción
_id
String
El id que asignamos a este cliente. Omítelo al crear un cliente y envíalo al actualizar uno.
externalId
String
Tu propio id para este cliente, desde tu software. Envía de nuevo el mismo externalId para actualizar este cliente en lugar de agregar uno nuevo. Usamos este valor para hacer la coincidencia, pero no evitamos duplicados, así que manténgalo único dentro del sitio.
displayName
String
El nombre que se mostrará al cliente.
accountName
String
El nombre de la empresa o del hogar del cliente, como ABC Company. Es el nombre que se muestra para un cliente con más de un contacto, y para un cliente con un solo contacto solo cuando no se envía nombre ni apellido.
contacts
Una lista de contactos de clientes. Requerido si no se pasa primaryContact.
parentCustomer
String
El id del cliente padre, si corresponde.
billToParentFlag
Boolean
Establécelo en true para enviar las órdenes de compra de este cliente al cliente principal para que las pague. Solo aplica cuando parentCustomer está establecido.
notes
String
Notas internas del cliente. Visible solo para el comerciante.
attachmentRefs
Una lista de adjuntos.
createdAt
La fecha en que se creó el cliente. Un momento en el tiempo en formato ISO 8601, con zona horaria. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
updatedAt
La fecha en que se actualizó por última vez el cliente. Un momento en el tiempo en formato ISO 8601, con zona horaria. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
deleted
Boolean
Si el registro del cliente ha sido eliminado y ya no está activo.
Default = false
Sample Response
			
{
  "_id": "6839e415564d3cc2160d945e",
  "externalId": "39772634",
  "displayName": "ABC Plumbing",
  "accountName": null,
  "contacts": [
    {
      "_id": "6839e415564d3cc216032361",
      "isPrimary": true,
      "roles": []
    }
  ],
  "billToParentFlag": false,
  "notes": null,
  "attachmentRefs": {
    "internal": [],
    "external": []
  },
  "deleted": false,
  "createdAt": "2025-05-30T19:19:44.143Z",
  "updatedAt": "2025-05-30T19:19:44.143Z"
}


		

Ver también