Get Customer

Utilisez ceci lorsque vous avez besoin d'un client tel que Hyfin le possède, à partir de son _id.


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 que nous attribuons à ce client. Omettez-le lors de la création d'un client et envoyez-le lors de la mise à jour d'un client.
externalId
String
Votre propre identifiant pour ce client, provenant de votre logiciel. Envoyez à nouveau le même externalId pour mettre à jour ce client au lieu d'en ajouter un nouveau. Nous faisons la correspondance sur cette valeur, mais nous n'empêchons pas les doublons; gardez-la donc unique au sein du site.
displayName
String
Le nom qui sera affiché pour le client.
accountName
String
Le nom de l'entreprise ou du ménage du client, par exemple ABC Company. C'est le nom affiché pour un client ayant plus d'un contact, et pour un client ayant un seul contact uniquement lorsqu'aucun prénom ni nom de famille n'est envoyé.
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
Définissez à true pour envoyer les factures de ce client au client parent aux fins de paiement. S'applique uniquement lorsque parentCustomer est défini.
notes
String
Notes internes pour le client. Visible seulement par le commerçant.
attachmentRefs
Une liste de pièces jointes.
createdAt
La date à laquelle le client a été créé. Un moment précis en format ISO 8601, avec un fuseau horaire. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
updatedAt
La date à laquelle le client a été mis à jour pour la dernière fois. Un moment précis en format ISO 8601, avec un fuseau horaire. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
deleted
Boolean
Que le dossier du client ait été supprimé et n'est plus actif.
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"
}


		

Voir aussi