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} , {external_id} and {site_id} variables with the appropriate values.
GET
{base_url}/api/v3.1/site/{site_id}/invoice/{external_id}
Demande
Aucun corps n'est requis pour cet appel API
Réponse
Champ
Type
Description
external_id
String
Le numéro de facture unique du système/base de données source. Si nous détectons un enregistrement avec le même external_id, il sera mis à jour, sinon il sera ajouté.
_id
String
The id of the Facture, assigned by the system.
invoice_number
String
Le numéro unique attribué par le système source et affiché au client sur le Facture.
reference_number
String
The unique reference number assigned to the Facture by the system. It is also the code in the customer-facing link.
internal
Boolean
Whether the Facture is internal to the merchant and was never sent to a customer.
notifications
The notifications sent to the customer for this Facture, most recent last.
totals
The total amounts on the Facture. When lines are supplied, total is validated against them and must equal the sum of every lines[].total, plus tax, minus discounts. A request whose totals do not reconcile is rejected. Omit lines and no such check is made.
customer
Une référence au dossier du client. Omettez ce champ pour recevoir un lien vers le Facture.
invoice_term_name
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.
invoice_date
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
customer_memo
String
Une note présentée au client en bas du Facture.
internal_memo
String
Un mémo ajouté au bas de la Facture. Visible uniquement par le personnel interne, jamais affiché aux clients.
active
Boolean
Ce drapeau représente si l'enregistrement Facture est actif et disponible pour être utilisé ou non.
Default = true
Default = true
payments
Une liste des paiements effectués sur le Facture.
webhook_url
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.
attachments
String [ ]
Une liste d'URL de pièces jointes.
created_at
Date
La date à laquelle le Facture a été créé.
updated_at
Date
La date à laquelle le Facture a été dernièrement mis à jour.
Sample Response
{
"_id": "61f32dc2f62bdc6a48945067",
"external_id": "439772921",
"invoice_number": "12345",
"description": "",
"customer_memo": "",
"internal_memo": "",
"due_date": "2021-10-01",
"totals": {
"tax": 2.85,
"total": 32.85
},
"customer": {
"external_id": "39772634",
"first_name": "John",
"last_name": "Doe",
"mobile_phone": "111-222-3333",
"email": "johndoe@abc.com"
},
"lines": [
{
"description": "",
"product": {
"external_id": "62331255",
"name": "Mens Large T-shirt",
"unit_price": 15
},
"unit_price": 15,
"qty": 2,
"total": 30
}
],
"payments": [
{
"external_id": "72345322",
"reference_number": "N7E6NFU6WZZ5-PW3A",
"gateway_transaction_id": "53912387124235234",
"payment_type": "payment_card",
"payment_sub_type": "amex",
"display_name": "Amex",
"amount": 30,
"tip": 0,
"tax": 0,
"fee": 0,
"paid_on": "2021-03-15T16:32:11Z",
"status": "captured",
"is_refund": false,
"created_at": "2025-05-30T19:19:44.143Z",
"updated_at": "2025-05-30T19:19:44.143Z"
}
],
"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"
}
],
"webhook_url": "https://yourcompany.com/webhook",
"created_at": "2025-05-30T19:19:44.143Z",
"updated_at": "2025-05-30T19:19:44.143Z"
}