For the complete documentation index, see llms.txt. This page is also available as Markdown.

Factures

Une facture est un document associé à un client, qui peut être un contact, une organisation ou un contact d'organisation. Ils contiennent des lignes de factures ainsi que des informations générales.

Une facture créée est dans un état brouillon tant qu'elle n'a pas été finalisée.

Create a new invoice with a customerId that can be a contactId or an organizationId

post
Autorisations
AuthorizationstringRequis
Bearer authentication header of the form Bearer <token>.
Paramètres de chemin
customerIdstringRequis
Réponses
post
/v2/billing/invoice/{customerId}

Update billing lines

patch
Autorisations
AuthorizationstringRequis
Bearer authentication header of the form Bearer <token>.
Paramètres de chemin
billingIdstringRequis

ID of the billing to update

Corps
Réponses
200

Billing lines updated successfully

application/json
ou
ou
patch
/v2/billing/{billingId}/lines

Update invoice general informations

patch
Autorisations
AuthorizationstringRequis
Bearer authentication header of the form Bearer <token>.
Paramètres de chemin
invoiceIdstringRequis

ID of the invoice to update

Corps
headerNotestringOptionnel

Custom note to be displayed in the header of the billing

Example: Thank you for your business!
footerNotestringOptionnel

Custom note to be displayed in the footer of the billing

Example: Please pay within 30 days.
generalTermsAndConditionsOfSalestringOptionnel

General terms and conditions of sale to be included in the billing

Example: All goods remain our property until paid in full.
mentionMediatorstringOptionnel

Mention mediateur to be included in the billing

Example: Mention mediateur
otherPaymentMethodstringOptionnel

Other payment method

Example: Lydia
vatMentionnumber · enumOptionnelValeurs possibles:
isOnlinePaymentActivatedbooleanOptionnel

Indicates if online payment is activated for this invoice

Example: true
Réponses
200

Invoice general informations updated successfully

application/json
idstringRequisExample: 123e4567-e89b-12d3-a456-426614174000
numberstringOptionnelExample: INV-2023-001
titlestringOptionnel

Title of the billing document

Example: Invoice Title
typenumber · enumRequisValeurs possibles:
statestring · enumRequisValeurs possibles:
localestring · enumRequisValeurs possibles:
emittedAtnumberRequisExample: 1617187200
archivedAtnumberOptionnelExample: 1617360000
lockedbooleanOptionnelExample: false
finalizablebooleanRequisExample: true
testbooleanRequis
isEditablebooleanRequisExample: true
currencyCodestring · enumRequis

Preferred currency of the customer

Valeurs possibles:
lastDownloadAtnumberOptionnelExample: 1617619200
createdAtnumberRequisExample: 1617619200
updatedAtnumberRequisExample: 1617619200
deliveryDatenumberOptionnelExample: 1619865600
compatibilityVersionstring · enumRequisValeurs possibles:
isDeletablebooleanRequisExample: false
displayDeliveryAddressbooleanRequisExample: true
finalizedAtnumberOptionnelExample: 1617619200
lastSendByEmailAtnumberOptionnelExample: 1617446400
themeIdstringOptionnel

ID of the theme applied to this document when set

Example: 123e4567-e89b-12d3-a456-426614174000
paymentDelaystring · enumRequisValeurs possibles:
dueAtnumberRequisExample: 1619865600
paidAtnumberOptionnelExample: 1617273600
lastReminderSentAtnumberOptionnelExample: 1617532800
isReminderActivatedbooleanRequisExample: true
isOnlinePaymentActivatedbooleanRequisExample: true
isFinalInvoicebooleanRequisExample: true
hasAssociatedTransactionbooleanRequis

Indicates if the customer has an associated transaction

Example: false
includeDiscountDisbursementbooleanRequisExample: true
expiredAtnumberOptionnelExample: 1617619200
canceledAtnumberOptionnelExample: 1617619200
patch
/v2/billing/invoice/{invoiceId}/general-informations

Update invoice timeline

patch
Autorisations
AuthorizationstringRequis
Bearer authentication header of the form Bearer <token>.
Paramètres de chemin
invoiceIdstringRequis

ID of the invoice to update

Corps
emittedAtnumberRequis

The timestamp when the invoice was emitted

Example: 1617187200
paymentDelaystring · enumRequisValeurs possibles:
customDueDatenumberOptionnel

Custom due date for the invoice when payment delay is OTHER

Example: 1619865600
deliveryDatenumber · nullableOptionnel

The timestamp for delivery date

Example: 1617187200
Réponses
200

Invoice timeline updated successfully

application/json
idstringRequisExample: 123e4567-e89b-12d3-a456-426614174000
numberstringOptionnelExample: INV-2023-001
titlestringOptionnel

Title of the billing document

Example: Invoice Title
typenumber · enumRequisValeurs possibles:
statestring · enumRequisValeurs possibles:
localestring · enumRequisValeurs possibles:
emittedAtnumberRequisExample: 1617187200
archivedAtnumberOptionnelExample: 1617360000
lockedbooleanOptionnelExample: false
finalizablebooleanRequisExample: true
testbooleanRequis
isEditablebooleanRequisExample: true
currencyCodestring · enumRequis

Preferred currency of the customer

Valeurs possibles:
lastDownloadAtnumberOptionnelExample: 1617619200
createdAtnumberRequisExample: 1617619200
updatedAtnumberRequisExample: 1617619200
deliveryDatenumberOptionnelExample: 1619865600
compatibilityVersionstring · enumRequisValeurs possibles:
isDeletablebooleanRequisExample: false
displayDeliveryAddressbooleanRequisExample: true
finalizedAtnumberOptionnelExample: 1617619200
lastSendByEmailAtnumberOptionnelExample: 1617446400
themeIdstringOptionnel

ID of the theme applied to this document when set

Example: 123e4567-e89b-12d3-a456-426614174000
paymentDelaystring · enumRequisValeurs possibles:
dueAtnumberRequisExample: 1619865600
paidAtnumberOptionnelExample: 1617273600
lastReminderSentAtnumberOptionnelExample: 1617532800
isReminderActivatedbooleanRequisExample: true
isOnlinePaymentActivatedbooleanRequisExample: true
isFinalInvoicebooleanRequisExample: true
hasAssociatedTransactionbooleanRequis

Indicates if the customer has an associated transaction

Example: false
includeDiscountDisbursementbooleanRequisExample: true
expiredAtnumberOptionnelExample: 1617619200
canceledAtnumberOptionnelExample: 1617619200
patch
/v2/billing/invoice/{invoiceId}/timeline

Finaliser une facture

Une fois que la facture en brouillon est prête, vous pouvez finaliser le document. Une document finalisé ne peut-être modifié par la suite. Un numéro de facture lui sera attribué.

L'ancien endpoint /v2/billing/invoice/{invoiceId}finalize a été déprécié en faveur de celui-ci dessous

Finalize a billing document

patch
Autorisations
AuthorizationstringRequis
Bearer authentication header of the form Bearer <token>.
Paramètres de chemin
billingIdstringRequis

ID of the billing to finalize

Réponses
200

Billing finalized successfully

application/json
ou
ou
ou
patch
/v2/billing/{billingId}/finalize

Télécharger un document

Vous pouvez télécharger un document en format PDF et spécifier la langue appliquée sur le document

Download a billing document

get
Autorisations
AuthorizationstringRequis
Bearer authentication header of the form Bearer <token>.
Paramètres de chemin
billingIdstringRequis
Paramètres de requête
localestring · enumOptionnel

Locale for the PDF generation

Valeurs possibles:
Réponses
200Succès
application/pdf
string · binaryOptionnel
get
/v2/billing/{billingId}/download

Marquer une facture comme payée

Une fois une facture finalisée encaissée, vous pouvez la marquer comme payée en associant un ou plusieurs paiements. La somme des montants des paiements (en centimes) doit correspondre au montant restant à régler de la facture.

Mark an invoice as paid

post

Associates one or more payments to a finalized invoice to record its cashing. The sum of payment amounts (in cents) must match the invoice's remaining amount with tax. Use this endpoint to mark an invoice as paid via the public API.

Autorisations
AuthorizationstringRequis
Bearer authentication header of the form Bearer <token>.
Paramètres de chemin
invoiceIdstringRequis

ID of the invoice to mark as paid

Corps
Réponses
200

Invoice marked as paid successfully

Aucun contenu

post
/v2/accounting-billing/invoice/{invoiceId}/reconciliate

Aucun contenu

Marquer une facture comme non payée

Si une facture a été marquée comme payée par erreur, vous pouvez annuler cet état pour la repasser en non payée. Les paiements associés sont retirés.

Mark an invoice as unpaid

post

Removes the payments associated to an invoice and resets its paid state. Use this endpoint to revert a previously paid invoice.

Autorisations
AuthorizationstringRequis
Bearer authentication header of the form Bearer <token>.
Paramètres de chemin
invoiceIdstringRequis

ID of the invoice to mark as unpaid

Réponses
200

Invoice marked as unpaid successfully

Aucun contenu

post
/v2/accounting-billing/invoice/{invoiceId}/mark-as-unpaid

Aucun contenu

Mis à jour

Ce contenu vous a-t-il été utile ?