Get Facture

Utilisez ceci lorsque vous avez besoin de l'état actuel d'un Facture, comme son solde et ses paiements, à partir de son _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} , {_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 que nous attribuons à cette facture. Omettez-le lors de la création d'une facture et envoyez-le lors de la mise à jour d'une facture.
externalId
String
Votre propre identifiant pour cette facture, provenant de votre logiciel. Envoyez à nouveau le même externalId 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.
invoiceNumber
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.
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 taxes, 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.
term
Les conditions de la facture, par leur _id Hyfin ou votre externalId. Envoyez l'un ou l'autre. Définit la date d'échéance et ajoute les escomptes de paiement anticipé et les frais de retard des conditions. Par défaut, les conditions de facturation du client, si elles existent.
lines
Une liste des articles de ligne sur le Facture. Requis si description n'est pas passé en.
invoiceDate
La date de Facture. Retourné sous forme d'horodatage à minuit UTC à cette date. Un moment précis en format ISO 8601, avec un fuseau horaire. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
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
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.
createdAt
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
attachmentRefs
Une liste de pièces jointes.
customerUrl
String
Le lien destiné au client pour consulter et payer la Facture. Il s'agit du même lien que le client reçoit lorsque la Facture lui est envoyée.
send
À qui Facture est envoyé, par canal. Un canal que vous indiquez est utilisé tel quel, et une liste vide ([]) désactive ce canal. Un canal que vous omettez conserve les destinataires que Facture a déjà, ou est rempli à partir des contacts du client, selon le contrôle des notifications du client, lorsqu'il n'en a pas encore. Lors d'une création, omettez send pour laisser les contacts du client décider de chaque canal lors de l'envoi de Facture. Lors d'une mise à jour, l'omettre conserve les destinataires déjà choisis. Une lecture renvoie send.to à null tant que les destinataires n'ont pas été choisis. billTo.emails et billTo.sms demeurent le remplacement pour déterminer qui reçoit ces canaux, mais ne réactivent jamais un canal que send a désactivé.
onHold
Boolean
Indique si le premier versement impayé est mis en attente, de sorte que sa demande de paiement n'est pas envoyée tant que la mise en attente n'est pas levée. En lecture, la valeur est true lorsque ce versement est en attente et false autrement. En écriture, définissez-la à true pour mettre ce versement en attente, ou à false lors d'une mise à jour pour la lever. Omettez-la pour laisser la mise en attente telle quelle. La mise en attente se trouve sur le versement, et non sur Facture.
false lève une mise en attente que vous ou le marchand avez placée. Il ne lève pas la mise en attente qu'obtient Facture lorsqu'il ne rejoint personne et ne sera pas facturé automatiquement : send.to désactive tous les canaux, ou toutes les adresses du client sont en mode ne pas contacter et il n'y a aucun remplacement billTo. Ce Facture reste en attente et l'écriture réussit quand même, y compris lorsque vous fournissez vous-même installments ou définissez installments[].onHold à false. Donnez-lui un destinataire pour permettre l'envoi.
Une écriture qui envoie à la fois onHold et installments[].onHold sur le premier versement impayé doit leur donner la même valeur. Sinon, elle est refusée avec une erreur 400 et le message « Invalid on_hold, it conflicts with on_hold on the first unpaid installment. Send one of them, or the same value in both ». Une valeur qui n'est pas un booléen est refusée avec « Invalid on_hold, must be a boolean ».
customer
String
L'identifiant du client
billToCustomer
String
Le _id du client qui reçoit et paie la facture.
billTo
Remplacements facultatifs pour la section Facturer à de la facture. Si billToCustomer est fourni, cet objet sera fusionné avec les renseignements du client et peut servir à remplacer des champs précis. Si billToCustomer n'est pas fourni, les champs de cet objet seront utilisés comme renseignements de facturation 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",
  "externalId": "439772921",
  "invoiceNumber": "12345",
  "totals": {
    "taxes": 285,
    "discounts": 0,
    "total": 3285
  },
  "customer": "61f32dc2f62bdc6a48951255",
  "billToCustomer": "61f32dc2f62bdc6a48951255",
  "billTo": {
    "name": "John Doe",
    "attn": "",
    "address": {},
    "emails": [],
    "sms": []
  },
  "soldTo": {
    "name": "John Doe",
    "attn": "",
    "address": {}
  },
  "term": {
    "_id": "61f32dc2f62bdc6a48940a12",
    "externalId": "E3680754-8F2B-42CE-A451-792AAD4A7840"
  },
  "lines": [
    {
      "name": "Mens Large T-shirt",
      "description": "",
      "qty": 2,
      "unitPrice": 1500,
      "total": 3000,
      "item": "62166eda3a8c0517866b9b46"
    }
  ],
  "invoiceDate": "2022-12-01T00:00:00.000Z",
  "dueDate": "2022-12-01T00:00:00.000Z",
  "expireAt": "2023-01-01",
  "poNumber": "",
  "customerMemo": "Thank you for your business!",
  "internalMemo": "",
  "payments": [
    "62166eda3a8c0517866b9c23"
  ],
  "attachmentRefs": {
    "internal": [],
    "external": [],
    "sourceDocument": null
  },
  "webhookUrl": "https://yourcompany.com/webhook",
  "customerUrl": "https://site.url/L-KA39TI45JLMN",
  "createdAt": "2025-05-30T19:19:44.143Z",
  "deleted": false
}


		

Voir aussi