Get Customer
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 del cliente. Este campo es generado por el sistema y no es necesario al crear un nuevo cliente, pero es necesario al actualizar un cliente existente.
displayName
String
El nombre que se mostrará al cliente.
accountName
String
Si el cliente es un grupo, es posible que desees proporcionar un nombre comercial o la dirección del cliente aquí.
contacts
A list of customer contacts. Required if `primary_contact` is not passed in.
parentCustomer
String
El id del cliente padre, si corresponde.
billToParentFlag
Boolean
A flag indicating whether the parent customer should be billed for this customer. Only applicable if `parent_customer` is provided.
notes
String
Notas internas del cliente. Visible solo para el comerciante.
attachmentRefs
Una lista de adjuntos.
createdAt
Date
La fecha en que se creó el cliente.
updatedAt
Date
La fecha en que se actualizó por última vez el cliente.
deleted
Boolean
Si el registro del cliente ha sido eliminado y ya no está activo.
Default = `false`
Default = `false`
Sample Response
{
"_id": "6839e415564d3cc2160d945e",
"display_name": "ABC Plumbing",
"created_at": "2025-05-30T19:19:44.143Z",
"updated_at": "2025-05-30T19:19:44.143Z",
"contacts": [
{
"_id": "6839e415564d3cc21603236y",
"first_name": "John",
"last_name": "Doe",
"display_name": "John Doe",
"language": "en",
"emails": [
{
"label": "work",
"address": "johndoe@abc.com"
}
],
"phoneNumbers": [
{
"label": "mobile",
"number": "333-444-5555"
}
],
"addresses": [
{
"label": "billing",
"address": {
"address_line1": "123 Main Street",
"address_line2": "Suite 123",
"city": "Naples",
"state_code": "FL",
"zip_code": "34102"
}
},
{
"label": "shipping",
"address": {
"address_line1": "456 Boulevard Street",
"city": "Naples",
"state_code": "FL",
"zip_code": "34102"
}
}
]
}
]
}