latestOpenAPI 3.0.0Apache 2.02026-07-2638645559.8 KB

436b47b78bf4

Invoices

Update an invoice

Update an invoice by id

post/apps/{appId}/invoices/{id}

Path parameters

appIdinteger required

The identifier of the Sinao application you are using. Each application corresponds to a company and an accounting. A user can have several Sinao applications. To retrieve the identifiers of its applications, you must call the endpoint /apps.

idinteger required

ID of invoice

Query parameters

idinteger

type'organization' | 'person'

namestring nullable

Customer name obtained from customer object or set manually

addressstring nullable

Customer addresss (street number and address) obtained from customer object or set manually

address2string nullable

Customer address subline obtained from customer object or set manually

locationstring nullable

Customer address location (city, postal code and country) obtained from customer object or set manually

detailsstring nullable

idinteger

type'organization' | 'person'

namestring nullable

Third account name obtained from customer object or set manually

addressstring nullable

Third account addresss (street number and address) obtained from customer object or set manually

locationstring nullable

Third account address location (city, postal code and country) obtained from customer object or set manually

titlestring nullable

idinteger

detailstring

Description of the product or service

action'sell' | 'rent'

quantitynumber double

Quantity of product or service

amount_accuratelyinteger

Price without taxes in cents + 3 decimales, example : 9899000 = 98,99€ || 1 = 0,00001€

amount_with_taxesboolean

Used when there is a difference of 1 cent when starting from the amount with taxes

amountinteger

Price without taxes in cents

vat_percentinteger

VAT rate in cents

accountobject

unitystring

Unity, hours, days, meters, liters..

total_quantitystring

Information about total quantity to sell, only for display

designationstring

quantitystring

quantity_namestring

info_total_quantitystring

amountstring

subtotalstring

duestring

vat_percentstring

discountstring

List columns to display

referencestring nullable

Free variable not display in document

namestring

amountinteger

percentinteger

currencystring

legal_noticestring nullable

Legal mentions

bank_details_idinteger nullable

exemptedboolean

specify if exempted or not

reasonstring nullable

example : micro for microentrepreneur

articlestring nullable

{"stackTrail":"paths:/apps/{appId}/invoices/{id}:post:parameters:13:schema:items","oasType":"schema","type":"unknown"}

metadatastring[] nullable

downpaymentsinteger[] nullable

downpayment_cashinteger nullable

avoid_ofinteger nullable

delivered_atstring date-time nullable

payment_periodinteger nullable

Days count before considere this invoice as late

expected_payment_deadline_atstring date nullable

payment_methodsstring

Accepted methods of payment for this invoice. Methods comma separated

author_user_idinteger nullable

Author id of the invoice

detailsstring nullable

is_auto_finalizeboolean

Automatically finalize the invoice when written_at is set

is_auto_send_emailboolean

Automatically send email when invoice is unpaid

delivery_addressstring nullable

Delivery address if different from contact_infos address, null otherwise

delivery_address2string nullable

Delivery address subline if different from contact_infos address, null otherwise

delivery_detailsstring nullable

Delivery details

delivery_locationstring nullable

Delivery address location if different from contact_infos address, null otherwise

delivery_establishment_idinteger nullable

Delivery establishment id if different from contact_infos address, null otherwise

delivery_emailstring nullable

Delivery establishment contact email if different from contact_infos address, null otherwise

delivery_namestring nullable

Delivery establishment contact name if different from contact_infos address, null otherwise

delivery_phonestring nullable

Delivery establishment contact phone if different from contact_infos address, null otherwise

Response

Success

Invoice required— unresolved $ref