Champ
Type
Description
_id
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
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
Le code du crédit généré par le système.
creditNumber
Le numéro de crédit affiché au client (le « N° de crédit »). Par défaut, il correspond au code.
kind
Le type de crédit. Seul creditNote peut être créé par l'API.
Default = creditNote | One of creditNote
status
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
L'identifiant du site
customer
L'identifiant du client
billToCustomer
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
Le numéro de bon de commande du crédit.
description
Une brève description du crédit, comme le motif ou l'autorisation de retour.
customerMemo
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
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
La somme des sous-totaux des lignes. Il s'agit d'un nombre entier de cents, donc 1035 signifie $10.35.
taxes
La taxe sur le crédit. Il s'agit d'un nombre entier de cents, donc 1035 signifie $10.35.
discounts
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
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
Le montant retenu par les paiements encore en cours. Il s'agit d'un nombre entier de cents, donc 1035 signifie $10.35.
remaining
Le montant non encore appliqué : amount - applied. Il s'agit d'un nombre entier de cents, donc 1035 signifie $10.35.
spendable
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
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
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
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
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