file-signatureDevis

Un devis est un document associé à un client (contact, organisation ou contact d'organisation). Il contient des lignes ainsi que des informations générales. Le devis peut être de type estimate (devis) ou purchase_order (bon de commande).

Un devis créé est dans un état brouillon tant qu'il n'a pas été finalisé. Une fois finalisé, il peut être signé/refusé par le client, et donner lieu à des acomptes ou à une facture finale.

Créer un devis

L'identifiant customerId peut correspondre à un contactId ou à un organizationId. Précisez estimateType pour créer un devis (estimate) ou un bon de commande (purchase_order).

Create a new estimate 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
Corps
estimateTypestring · enumOptionnelValeurs possibles:
Réponses
chevron-right
201

Estimate created 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: 1617619200
compatibilityVersionstring · enumRequisValeurs possibles:
isDeletablebooleanRequisExample: true
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:
expiredAtnumberRequisExample: 1619865600
refusedAtnumberOptionnelExample: 1619865600
signedAtnumberOptionnelExample: 1619865600
withElectronicSignaturebooleanRequisExample: true
dueAtnumberOptionnelExample: 1619865600
hasFinalInvoicebooleanRequisExample: true
includeDiscountDisbursementbooleanRequisExample: true
post
/v2/billing/estimate/{customerId}

Mettre à jour les lignes du devis

Les lignes d'un devis sont mises à jour via l'endpoint partagé de billing.

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
patch
/v2/billing/{billingId}/lines

Mettre à jour les informations générales

Update estimate general informations

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

ID of the estimate 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:
Réponses
patch
/v2/billing/estimate/{estimateId}/general-informations

Mettre à jour la timeline (dates d'émission, expiration, etc.)

Update estimate timeline

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

ID of the estimate 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
expiredAtnumberRequis

The timestamp when the estimate expired

Example: 1617187200
Réponses
patch
/v2/billing/estimate/{estimateId}/timeline

Mettre à jour la langue du devis

Update estimate locale

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

ID of the estimate to update

Corps
localestring · enumRequisValeurs possibles:
Réponses
put
/v2/billing/estimate/{estimateId}/locale

Mettre à jour la devise du devis

Update asset currency

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

ID of the estimate to update

Corps
currencystring · enumRequis

Preferred currency of the customer

Valeurs possibles:
currencyRatenumberOptionnel

The conversion rate from the billing currency to the new currency

Example: 1.2
Réponses
put
/v2/billing/estimate/{estimateId}/currency

Configurer les acomptes (advance lines)

Permet de définir la liste des acomptes (échéancier) attachés au devis. Chaque acompte sera matérialisable en facture d'acompte une fois le devis finalisé.

Update estimate advance lines

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

ID of the estimate to update

Corps
Réponses
patch
/v2/billing/estimate/{estimateId}/advance-lines

Finaliser un devis

Une fois le devis prêt, finalisez-le pour lui attribuer un numéro officiel. Un devis finalisé ne peut plus être modifié.

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
patch
/v2/billing/{billingId}/finalize

Signer / Refuser un devis

Une fois finalisé, un devis (ou bon de commande) peut être signé ou refusé par le client. Les opérations inverses (unsign, unrefuse) permettent de revenir en arrière.

Signer

Sign estimate or purchase order

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

ID of the estimate or purchase order to sign

Réponses
patch
/v2/billing/estimate/{estimateId}/sign

Annuler la signature

Unsign estimate or purchase order

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

ID of the estimate or purchase order to unsign

Réponses
patch
/v2/billing/estimate/{estimateId}/unsign

Refuser

Refuse estimate or purchase order

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

ID of the estimate or purchase order to refuse

Réponses
patch
/v2/billing/estimate/{estimateId}/refuse

Annuler le refus

Unrefuse estimate or purchase order

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

ID of the estimate or purchase order to unrefuse

Réponses
patch
/v2/billing/estimate/{estimateId}/unrefuse

Créer une facture d'acompte depuis un devis

Create invoice advance

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

ID of the estimate to update

Réponses
post
/v2/billing/estimate/{id}/advance

Télécharger un devis

Vous pouvez télécharger un devis en 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
get
/v2/billing/{billingId}/download

Mis à jour

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