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
Requis
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.
display_name
String
Le nom qui sera affiché pour le client.
account_name
String
--
Si le client est un groupe, vous voudrez peut-être fournir un nom d'entreprise ou l'adresse du client ici.
contacts
A list of customer contacts. Required if `primary_contact` is not passed in.
parent_customer
String
--
L'identifiant du client parent, si applicable.
bill_to_parent_flag
Boolean
--
A flag indicating whether the parent customer should be billed for this customer. Only applicable if `parent_customer` is provided.
notes
String
--
Notes internes pour le client. Visible seulement par le commerçant.
attachment_refs
--
Une liste de pièces jointes.
deleted
Boolean
--
Que le dossier du client ait été supprimé et n'est plus actif.
Default = `false`
Default = `false`
created_at
Date
--
La date à laquelle le client a été créé.
updated_at
Date
--
La date à laquelle le client a été mis à jour pour la dernière fois.
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"
}
}
]
}
]
}