Passer au contenu principal
POST
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Paramètres de chemin

invoice
string
requis

L'ID de la facture, un UUID.

Corps

application/json

Un paiement effectué en dehors de StockShift, consigné pour une facture émise.

amount
string
requis

Le montant payé, supérieur à zéro, au cent près et ne dépassant pas le solde dû.

Pattern: ^(?!0+(\.0+)?$)\d{1,18}(\.\d{1,2})?$
paid_on
string<date> | null

La date du paiement, sous forme YYYY-MM-DD. Aujourd'hui si elle est omise.

method
string | null

Comment elle a été payée, par exemple Virement bancaire, jusqu'à 64 caractères.

Maximum string length: 64
reference
string | null

Une référence du paiement, comme un numéro de chèque ou de transaction, jusqu'à 128 caractères.

Maximum string length: 128

Réponse

SalesInvoiceResource

data
SalesInvoiceResource · object
requis

Une facture à un client pour une commande client, avec ses lignes, ses paiements et ses notes de crédit. Il y a une note de crédit pour chaque retour de marchandises qu'elle a facturé, et une de plus une fois annulée. Les montants sont des nombres décimaux exacts dans la devise de l'organisation.