Get Customer
The following endpoint can be used to retrieve the details of a customer within the Hyfin application.
Point de terminaison
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}
Demande
Aucun corps n'est requis pour cet appel API
Réponse
Champ
Type
Description
_id
String
L'identifiant du client. Ce champ est généré par le système et n'est pas requis lors de la création d'un nouveau client, mais il est requis lors de la mise à jour d'un client existant.
displayName
String
Le nom qui sera affiché pour le client.
accountName
String
Si le client est un groupe, vous voudrez peut-être fournir un nom d'entreprise ou l'adresse du client ici.
contacts
Une liste de contacts clients. Requis si primaryContact n'est pas passé en paramètre.
parentCustomer
String
L'identifiant du client parent, si applicable.
billToParentFlag
Boolean
Un drapeau indiquant si le client parent doit être facturé pour ce client. Applicable uniquement si parentCustomer est fourni.
notes
String
Notes internes pour le client. Visible seulement par le commerçant.
attachmentRefs
Une liste de pièces jointes.
createdAt
Date
La date à laquelle le client a été créé.
updatedAt
Date
La date à laquelle le client a été mis à jour pour la dernière fois.
deleted
Boolean
Que le dossier du client ait été supprimé et n'est plus actif.
Default = false
Default = false
Sample Response
{
"_id": "6839e415564d3cc2160d945e",
"displayName": "ABC Plumbing",
"createdAt": "2025-05-30T19:19:44.143Z",
"updatedAt": "2025-05-30T19:19:44.143Z",
"contacts": [
{
"_id": "6839e415564d3cc21603236y",
"firstName": "John",
"lastName": "Doe",
"displayName": "John Doe",
"language": "en",
"emails": [
{
"label": "work",
"address": "johndoe@abc.com"
}
],
"phoneNumbers": [
{
"label": "mobile",
"number": "333-444-5555"
}
],
"addresses": [
{
"label": "billing",
"address": {
"addressLine1": "123 Main Street",
"addressLine2": "Suite 123",
"city": "Naples",
"stateCode": "FL",
"zipCode": "34102"
}
},
{
"label": "shipping",
"address": {
"addressLine1": "456 Boulevard Street",
"city": "Naples",
"stateCode": "FL",
"zipCode": "34102"
}
}
]
}
]
}