Sign in
SaleInvoices

Create a new draft invoice

post/v1/saleinvoices

Request body

balancenumber double

Balance

cancellationCreditIdinteger nullable

Credit ID which cancel this invoice

cancellationCreditNumberstring nullable

Credit number which cancel this invoice

cancelledCreditIdinteger nullable

ID of the credit that THIS invoice cancels (set when the invoice was issued to offset a credit)

cancelledCreditNumberstring nullable

Number of the credit that THIS invoice cancels

customerElectronicAddressstring nullable

Customer electronic address

customerIdinteger nullable

Customer ID

customerNamestring nullable

Customer name

customerNumberstring nullable

Customer number

customerOrderReferencestring nullable

Customer order reference

customerSiretstring nullable

Customer SIRET

customerType'Business' | 'Consumer' | 'Government'
customerVatNumberstring nullable

Customer VAT number

datestring date nullable

Date

eInvoicingInvoiceIdstring nullable

E-invoicing identifier assigned by the platform

eInvoicingProviderIdstring nullable

E-invoicing platform (PDP) identifier

eInvoicingStatus'ApiUploaded' | 'ApiInvalid' | 'ApiValidated' | 'ApiSent' | 'ApiRejected' | 'ApiReceived' | 'ApiAcknowledged' | 'ApiAccepted' | 'FrSubmitted' | 'FrSent' | 'FrReceived' | 'FrMadeAvailable' | 'FrAcknowledged' | 'FrAccepted' | 'FrPartlyAccepted' | 'FrDisputed' | 'FrOnHold' | 'FrCompleted' | 'FrRefused' | 'FrPaymentSent' | 'FrPaymentReceived' | 'FrRejected' | 'FrInadmissible' | 'FrVised' | 'FrCancelled' | 'FrRoutingError' | 'FrDirectPaymentRequest' | 'FrFactored' | 'FrFactoredConfidential' | 'FrPayableAccountChange' | 'FrNotFactored' | 'AozAuthError' | 'AozError' | 'AozInvalid' | 'AozProcessed' | 'PpfValidated' | 'PpfValidatedAck' | 'PpfValidatedAckError' | 'PpfValidatedRejected' | 'PpfRefused' | 'PpfRefusedAck' | 'PpfRefusedAckError' | 'PpfRefusedRejected' | 'PpfPaymentReceived' | 'PpfPaymentReceivedAck' | 'PpfPaymentReceivedAckError' | 'PpfPaymentReceivedRejected' | 'PpfRejected' | 'PpfRejectedAck' | 'PpfRejectedAckError' | 'PpfRejectedRejected' | 'PpfFlow1' | 'PpfFlow1Ack' | 'PpfFlow1AckError' | 'PpfFlow1ResponseOk' | 'PpfFlow1Rejected'
footerNotesstring nullable

Footer notes to be print

grossTaxExcludedAmountnumber double

Gross tax excluded amount

headerNotesstring nullable

Header notes to be print

idinteger

Invoice ID

internalIdstring nullable

ID used in your system

internalNotesstring nullable

Internal notes

isCancelledboolean

Indicates whether invoice is cancelled

isDraftboolean

Indicates whether invoice is draft. Otherwise invoice cannot be modified

isPaidboolean

Indicates whether invoice is paid

isProformaboolean

Indicates whether invoice is proforma

liableToVatboolean nullable

Indicates whether the document is liable to VAT

metadataobject nullable

Metadata

numberstring nullable

Number

overduenumber double

Overdue

pdfUrlstring nullable

Pdf url

publicLinkstring nullable

Public link

region'FR' | 'EU' | 'IE' | 'DOM' | 'Corse' | 'Monaco'
replacedByinteger nullable

Replacement invoice ID

sentAtstring date-time nullable

Sent at

shippingAmountnumber double

Shipping amount

subjectstring nullable

Subject

taxAmountnumber double

Total tax amount

taxExcludedAmountnumber double

Tax excluded amount (discount included)

taxIncludedAmountnumber double

Tax included amount

useTaxIncludedPricesboolean

Indicates whether invoice prices and amount are tax included

vatMode'Auto' | 'Debit' | 'Collection'
vatNotestring nullable

VAT note to print

vatReverseChargeboolean

VAT reverse charge

vendorReferencestring nullable

Vendor reference to be print

Response

OK

balancenumber double

Balance

cancellationCreditIdinteger nullable

Credit ID which cancel this invoice

cancellationCreditNumberstring nullable

Credit number which cancel this invoice

cancelledCreditIdinteger nullable

ID of the credit that THIS invoice cancels (set when the invoice was issued to offset a credit)

cancelledCreditNumberstring nullable

Number of the credit that THIS invoice cancels

customerElectronicAddressstring nullable

Customer electronic address

customerIdinteger nullable

Customer ID

customerNamestring nullable

Customer name

customerNumberstring nullable

Customer number

customerOrderReferencestring nullable

Customer order reference

customerSiretstring nullable

Customer SIRET

customerType'Business' | 'Consumer' | 'Government'
customerVatNumberstring nullable

Customer VAT number

datestring date nullable

Date

eInvoicingInvoiceIdstring nullable

E-invoicing identifier assigned by the platform

eInvoicingProviderIdstring nullable

E-invoicing platform (PDP) identifier

eInvoicingStatus'ApiUploaded' | 'ApiInvalid' | 'ApiValidated' | 'ApiSent' | 'ApiRejected' | 'ApiReceived' | 'ApiAcknowledged' | 'ApiAccepted' | 'FrSubmitted' | 'FrSent' | 'FrReceived' | 'FrMadeAvailable' | 'FrAcknowledged' | 'FrAccepted' | 'FrPartlyAccepted' | 'FrDisputed' | 'FrOnHold' | 'FrCompleted' | 'FrRefused' | 'FrPaymentSent' | 'FrPaymentReceived' | 'FrRejected' | 'FrInadmissible' | 'FrVised' | 'FrCancelled' | 'FrRoutingError' | 'FrDirectPaymentRequest' | 'FrFactored' | 'FrFactoredConfidential' | 'FrPayableAccountChange' | 'FrNotFactored' | 'AozAuthError' | 'AozError' | 'AozInvalid' | 'AozProcessed' | 'PpfValidated' | 'PpfValidatedAck' | 'PpfValidatedAckError' | 'PpfValidatedRejected' | 'PpfRefused' | 'PpfRefusedAck' | 'PpfRefusedAckError' | 'PpfRefusedRejected' | 'PpfPaymentReceived' | 'PpfPaymentReceivedAck' | 'PpfPaymentReceivedAckError' | 'PpfPaymentReceivedRejected' | 'PpfRejected' | 'PpfRejectedAck' | 'PpfRejectedAckError' | 'PpfRejectedRejected' | 'PpfFlow1' | 'PpfFlow1Ack' | 'PpfFlow1AckError' | 'PpfFlow1ResponseOk' | 'PpfFlow1Rejected'
footerNotesstring nullable

Footer notes to be print

grossTaxExcludedAmountnumber double

Gross tax excluded amount

headerNotesstring nullable

Header notes to be print

idinteger

Invoice ID

internalIdstring nullable

ID used in your system

internalNotesstring nullable

Internal notes

isCancelledboolean

Indicates whether invoice is cancelled

isDraftboolean

Indicates whether invoice is draft. Otherwise invoice cannot be modified

isPaidboolean

Indicates whether invoice is paid

isProformaboolean

Indicates whether invoice is proforma

liableToVatboolean nullable

Indicates whether the document is liable to VAT

metadataobject nullable

Metadata

numberstring nullable

Number

overduenumber double

Overdue

pdfUrlstring nullable

Pdf url

publicLinkstring nullable

Public link

region'FR' | 'EU' | 'IE' | 'DOM' | 'Corse' | 'Monaco'
replacedByinteger nullable

Replacement invoice ID

sentAtstring date-time nullable

Sent at

shippingAmountnumber double

Shipping amount

subjectstring nullable

Subject

taxAmountnumber double

Total tax amount

taxExcludedAmountnumber double

Tax excluded amount (discount included)

taxIncludedAmountnumber double

Tax included amount

useTaxIncludedPricesboolean

Indicates whether invoice prices and amount are tax included

vatMode'Auto' | 'Debit' | 'Collection'
vatNotestring nullable

VAT note to print

vatReverseChargeboolean

VAT reverse charge

vendorReferencestring nullable

Vendor reference to be print