Get Facture

Utilisez ceci lorsque vous avez besoin de l'état actuel d'un Facture, comme son solde et ses paiements, à partir de son external_id.


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
Votre propre identifiant pour cette facture, provenant de votre logiciel. Envoyez à nouveau le même external_id pour mettre à jour cette facture au lieu d'en ajouter une nouvelle. Nous faisons la correspondance sur cette valeur, mais nous n'empêchons pas les doublons; gardez-la donc unique au sein du site.
_id
String
L'identifiant de Facture, attribué par le système.
invoice_number
String
Le numéro attribué par le système source et affiché au client sur la Facture. Deux Factures d'un même site peuvent partager un numéro, et un paiement appliqué par numéro est attribué à la première correspondance trouvée; gardez-le donc unique au sein du site.
reference_number
String
Le numéro de référence unique attribué à Facture par le système. C'est aussi le code figurant dans le lien destiné au client.
internal
Boolean
Indique si Facture est interne au marchand et n'a jamais été envoyé à un client.
notifications
Les notifications envoyées au client pour ce Facture, la plus récente en dernier.
totals
Les montants totaux de Facture. Lorsque lines est fourni, total est validé par rapport à celles-ci et doit être égal à la somme de chaque lines[].total, plus tax, moins discounts. Une requête dont les totaux ne concordent pas est rejetée. Omettez lines et aucune vérification de ce type n'est effectuée.
customer
Une référence au dossier du client.
invoice_term_name
String
Le nom d'une condition de facture configurée pour le site, par exemple Net 30. Lorsqu'il est envoyé, la date d'échéance est calculée à partir de la condition et de la date de la Facture, remplaçant tout due_date que vous envoyez. Un nom ne correspondant à aucune condition est rejeté avec Invoice term "" not found. Lorsqu'il est omis pour une nouvelle Facture, la condition de facture du client est utilisée s'il en a une.
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 de Facture. Si elle est fixée dans le futur, Facture n'est envoyé par texto ou par courriel au client qu'à cette date. Par défaut, la date du jour si elle est laissée vide. Une date sans heure. Une heure ou un fuseau horaire envoyé avec elle est ignoré, et non converti, de sorte que la date reste telle qu'écrite. 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
payments
Une liste des paiements effectués sur le Facture.
webhook_url
String
L'URL à laquelle envoyer une requête POST lorsque certaines actions sont effectuées sur Facture. Un webhook est envoyé lorsqu'un paiement atteint un nouvel état, et lorsqu'un message texte, un courriel ou un message WhatsApp est envoyé, livré, lu, retardé ou échoue, ou lorsque le client clique sur le lien de paiement.
attachments
String [ ]
Une liste d'URL de pièces jointes.
created_at
Timestamp
La date à laquelle le Facture a été créé. Un moment précis en format ISO 8601, avec un fuseau horaire. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
updated_at
Timestamp
La date à laquelle le Facture a été dernièrement mis à jour. Un moment précis en format ISO 8601, avec un fuseau horaire. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
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"
}


		

Voir aussi