Get Facture
The following endpoint can be used to retrieve the details of a Facture within the Hyfin application.
Point de terminaison
The following endpoint can be used to retrieve a Facture. You must replace the {base_url} , {_id} and {site_id} variables with the appropriate values.
GET
{base_url}/api/v4/site/{site_id}/invoice/{_id}
Demande
Aucun corps n'est requis pour cet appel API
Réponse
Champ
Type
Description
_id
String
L'identifiant de la facture. Ce champ est généré automatiquement par le système et n'est pas requis lors de la création d'une nouvelle facture, mais il est requis lors de la mise à jour d'une facture existante.
invoiceNumber
String
Le numéro unique attribué par le système source et affiché au client sur le Facture.
totals
Les montants totaux sur le Facture. Validés par rapport à la somme des éléments de ligne trouvés dans lines.
invoiceTermName
String
Le nom du terme de facturation pour le Facture. Par défaut, il est défini sur le terme de facturation du client s'il existe, à moins que null ne soit passé en paramètre.
lines
Une liste des articles de ligne sur le Facture. Requis si description n'est pas passé en.
description
String
Une brève description des produits/services sur le Facture. Requis si les lines ne sont pas passées en paramètre.
invoiceDate
Date
La date du Facture. Si elle est définie dans le futur, la demande ne sera pas envoyée avant cette date. Par défaut, elle est définie à aujourd'hui si elle est laissée vide. Format = YYYY-MM-DD
customerMemo
String
Une note présentée au client en bas du Facture.
internalMemo
String
Un mémo ajouté au bas de la Facture. Visible uniquement par le personnel interne, jamais affiché aux clients.
webhookUrl
String
Le URL où envoyer les données lorsque des actions spécifiques sont effectuées sur le Facture. Des notifications seront envoyées en cas d'échec d'un envoi de texto/courriel, si un client clique sur un lien, ou s'il effectue un paiement.
createdAt
Date
La date à laquelle le Facture a été créé.
updatedAt
Date
La date à laquelle le Facture a été dernièrement mis à jour.
attachmentRefs
Une liste de pièces jointes.
customer
String
L'identifiant du client
billToCustomer
String
L' _id du client à facturer.
billTo
Options de remplacement facultatives pour la section Destinataire de la facture. Si billToCustomer est fourni, cet objet sera fusionné avec les informations du client et pourra être utilisé pour remplacer des champs spécifiques. Si billToCustomer n'est pas fourni, les champs de cet objet seront utilisés comme informations de Destinataire sur la facture.
soldTo
Options facultatives pour la section Expédié à / Client de la facture.
payments
String [ ]
Les _ids des paiements associés à cette facture.
deleted
Boolean
Ce drapeau représente si l'enregistrement est supprimé et n'est plus disponible pour être utilisé.
Sample Response
{
"_id": "61f32dc2f62bdc6a48945067",
"invoiceNumber": "12345",
"description": "",
"customerMemo": "",
"internalMemo": "",
"dueDate": "2021-10-01",
"totals": {
"taxes": 285,
"total": 3000
},
"customer": {
"_id": "61f32dc2f62bdc6a48951255",
"firstName": "John",
"lastName": "Doe",
"mobilePhone": "111-222-3333",
"email": "johndoe@abc.com"
},
"lines": [
{
"description": "",
"product": {
"_id": "62166eda3a8c0517866b9b46",
"name": "Mens Large T-shirt",
"unitPrice": 1500
},
"unitPrice": 1500,
"qty": 2,
"total": 3000
}
],
"payments": [
{
"_id": "62166eda3a8c0517866b9r23",
"paymentType": "payment_card",
"paymentSubType": "amex",
"displayName": "AMEX ****** 3422",
"last4": "3422",
"amount": 3000,
"paidOn": "2021-03-15T16:32:11Z",
"status": "captured",
"deleted": false
}
],
"notifications": [
{
"error": false,
"value": "test@test.com",
"description": "Email to test@test.com sent",
"at": "2021-03-15T13:32:11Z"
},
{
"error": false,
"value": "999-123-4567",
"description": "Text to 999-123-4567 sent",
"at": "2021-03-15T13:32:11Z"
}
],
"webhookUrl": "https://yourcompany.com/webhook",
"createdAt": "2025-05-30T19:19:44.143Z",
"updatedAt": "2025-05-30T19:19:44.143Z"
}