Get Credit


The following endpoint can be used to retrieve the details of a credit within the Hyfin application, including how much of it has been applied and how much can still be applied.


Point de terminaison

The following endpoint can be used to retrieve a credit. You must replace the {base_url} , {site_id} and {_id} variables with the appropriate values. The credit's external id can be used in place of its _id .

GET
{base_url}/api/v4/site/{site_id}/credit/{_id}

A credit sent through Add/Update Invoice is stored as a credit, not an invoice. Reading it with Get Invoice returns the error record_is_credit with the credit's _id in credit ; read it with this endpoint instead.

Demande
Aucun corps n'est requis pour cet appel API
Réponse
Champ
Type
Description
_id
String
L'identifiant du crédit. Ce champ est généré automatiquement par le système et n'est pas requis lors de la création d'un nouveau crédit. Soit _id, soit externalId est requis lors de la mise à jour d'un crédit existant.
externalId
String
L'identifiant unique du crédit provenant du système ou de la base de données source. Requis lors de la création d'un crédit sans _id. Si nous détectons un crédit avec le même externalId, il sera mis à jour; sinon, il sera ajouté. Il ne peut pas correspondre au externalId d'une Facture sur le même site.
code
String
Le code du crédit généré par le système.
creditNumber
String
Le numéro de crédit affiché au client (le « N° de crédit »). Par défaut, il correspond au code.
kind
String
Le type de crédit. Seul creditNote peut être créé par l'API.
Default = creditNote | One of creditNote
status
String
Le statut du crédit. Un crédit créé par l'API est émis immédiatement et peut être appliqué aux factures du client. Un crédit annulé ne peut plus être appliqué.
One of issued, voided
site
String
L'identifiant du site
customer
String
L'identifiant du client
billToCustomer
String
L' _id du client à facturer.
creditDate
La date du crédit, retournée sous forme d'horodatage. Par défaut, il s'agit du moment de la création du crédit. Un moment précis en format ISO 8601, avec un fuseau horaire. Format = YYYY-MM-DDTHH:mm:ss.SSSZ
poNumber
String
Le numéro de bon de commande du crédit.
description
String
Une brève description du crédit, comme le motif ou l'autorisation de retour.
customerMemo
String
Une note au client.
lines
Les lignes du crédit. Au moins une ligne est requise, et le total de chaque ligne doit être égal à son subtotal plus sa taxe.
amount
Number
La valeur nominale du crédit : subtotal + taxes - discounts. Calculée à partir des lignes si elle est omise. Il s'agit d'un nombre entier de cents, donc 1035 signifie $10.35.
subtotal
Number
La somme des sous-totaux des lignes. Il s'agit d'un nombre entier de cents, donc 1035 signifie $10.35.
taxes
Number
La taxe sur le crédit. Il s'agit d'un nombre entier de cents, donc 1035 signifie $10.35.
discounts
Number
Tout rabais sur le crédit, sous forme de montant positif. Il s'agit d'un nombre entier de cents, donc 1035 signifie $10.35.
applied
Number
Le montant du crédit appliqué aux factures jusqu'à présent. Il s'agit d'un nombre entier de cents, donc 1035 signifie $10.35.
reserved
Number
Le montant retenu par les paiements encore en cours. Il s'agit d'un nombre entier de cents, donc 1035 signifie $10.35.
remaining
Number
Le montant non encore appliqué : amount - applied. Il s'agit d'un nombre entier de cents, donc 1035 signifie $10.35.
spendable
Number
Le montant pouvant être appliqué maintenant : le solde restant, moins tout montant retenu par des paiements en cours. Zéro pour un crédit annulé. Il s'agit d'un nombre entier de cents, donc 1035 signifie $10.35.
isExhausted
Boolean
Indique si le crédit est entièrement appliqué.
lastAppliedAt
Le moment où le crédit a été appliqué pour la dernière fois à une Facture. 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-DDTHH:mm:ss.SSSZ
linesSynthesized
Boolean
Indique si le système a créé la ligne unique du crédit parce que le crédit a été envoyé par invoice/addUpdate sans lignes.
isReady
Boolean
Indique si le crédit peut être appliqué.
voidedAt
Date à laquelle le crédit a été annulé. 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-DDTHH:mm:ss.SSSZ
deleted
Boolean
Passez true pour annuler le crédit. Un crédit qui a été appliqué à une facture ne peut pas être annulé. Un crédit annulé ne peut pas être mis à jour ni recréé sous le même id. L'indicateur reste false dans l'enregistrement; status indique voided.
createdAt
Date à laquelle le crédit a été créé. 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-DDTHH:mm:ss.SSSZ
updatedAt
Date de la dernière mise à jour du crédit. 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-DDTHH:mm:ss.SSSZ
Sample Response
			
{
  "_id": "6717a2c4e1f0a93b2c5d8e11",
  "externalId": "CM-88123",
  "code": "P5XU4MK7QZ2X",
  "creditNumber": "CM-88123",
  "kind": "creditNote",
  "status": "issued",
  "site": "6201825a0cf5e23261a08646",
  "customer": "649dc5bb468bd5b5d863c7d1",
  "billToCustomer": null,
  "creditDate": "2026-10-01T00:00:00.000Z",
  "poNumber": "PO-552",
  "description": "Return RMA 7781",
  "customerMemo": null,
  "amount": 15000,
  "subtotal": 15000,
  "taxes": 0,
  "discounts": 0,
  "applied": 5000,
  "reserved": 0,
  "remaining": 10000,
  "spendable": 10000,
  "isExhausted": false,
  "lastAppliedAt": "2026-10-08T15:20:11.000Z",
  "linesSynthesized": false,
  "isReady": true,
  "voidedAt": null,
  "deleted": false,
  "createdAt": "2026-10-01T14:02:37.000Z",
  "updatedAt": "2026-10-08T15:20:11.000Z",
  "lines": [
    {
      "name": "Returned: Cabinet Knob K-12",
      "qty": 10,
      "unitPrice": 1250,
      "subtotal": 12500,
      "total": 12500,
      "description": null,
      "item": null,
      "glAccount": null,
      "isTaxable": false,
      "taxRates": []
    },
    {
      "name": "Returned: Drawer Pull P-40",
      "qty": 2,
      "unitPrice": 1250,
      "subtotal": 2500,
      "total": 2500,
      "description": null,
      "item": null,
      "glAccount": null,
      "isTaxable": false,
      "taxRates": []
    }
  ]
}