Skip to main content
POST
/
v1
/
quotes
Error
A valid request URL is required to generate request examples
{
  "id": "a3f1d7d0-ef1d-4b2e-aad2-123456789abc",
  "status": "draft",
  "customerId": "c5f3e9f2-gh3f-6d4g-ccf4-345678901cde",
  "currency": "EUR",
  "createdAt": "2024-01-15T10:00:00.000Z",
  "updatedAt": "2024-01-15T11:30:00.000Z",
  "vatRate": 20,
  "items": [
    {
      "id": "item_1",
      "description": "Private office rental - Monthly",
      "quantity": 2,
      "unitPrice": 300
    }
  ],
  "netTotal": 600,
  "taxTotal": 120,
  "grossTotal": 720,
  "expiresInDays": 30,
  "note": "Special pricing for long-term commitment"
}

Body

application/json
​
status
enum<string>
required

Current status of the quote. DRAFT: being prepared, SENT: sent to customer, ACCEPTED: customer accepted, REJECTED: customer rejected.

Available options:
draft,
sent,
accepted,
rejected
Example:

"draft"

​
customerId
string<uuid>
required

Unique identifier (UUID) of the customer this quote is for

Example:

"c5f3e9f2-gh3f-6d4g-ccf4-345678901cde"

​
currency
enum<string>
required

ISO 4217 currency code used for all amounts in this quote. Defaults to EUR if not specified.

Available options:
EUR,
USD,
GBP,
CAD,
AUD
Example:

"EUR"

​
vatRate
number
required

VAT (Value Added Tax) rate applied to the quote, expressed as a percentage (e.g., 20 for 20% VAT).

Required range: 0 <= x <= 100
Example:

20

​
netTotal
number
required

Total amount excluding VAT (HT - Hors Taxes). Sum of all line item totals before tax.

Required range: x >= 0
Example:

600

​
taxTotal
number
required

Total VAT amount (TVA - Taxe sur la Valeur Ajoutée) calculated on the net total.

Required range: x >= 0
Example:

120

​
grossTotal
number
required

Total amount including VAT (TTC - Toutes Taxes Comprises). This is the final amount the customer would pay if they accept the quote.

Required range: x >= 0
Example:

720

​
items
object[]
required

List of items to include in the quote. Each item must have a description, quantity, and unit price. At least one item is required.

Example:
[
  {
    "description": "Private office rental - Monthly",
    "quantity": 2,
    "unitPrice": 300
  }
]
​
expiresInDays
number

Number of days until the quote expires. After expiration, the quote may no longer be valid or convertible to an invoice.

Required range: x >= 1
Example:

30

​
note
string

Optional internal note or comments about the quote. Not visible to the customer.

Example:

"Special pricing for long-term commitment"

Response

Quote created successfully in DRAFT status. Use the PATCH endpoint to update or finalize it.

​
id
string<uuid>
required

Unique identifier (UUID) of the quote

Example:

"a3f1d7d0-ef1d-4b2e-aad2-123456789abc"

​
status
enum<string>
required

Current status of the quote. DRAFT: being prepared, SENT: sent to customer, ACCEPTED: customer accepted, REJECTED: customer rejected.

Available options:
draft,
sent,
accepted,
rejected
Example:

"draft"

​
customerId
string<uuid>
required

Unique identifier (UUID) of the customer this quote is for

Example:

"c5f3e9f2-gh3f-6d4g-ccf4-345678901cde"

​
currency
enum<string>
required

ISO 4217 currency code used for all amounts in this quote. Defaults to EUR if not specified.

Available options:
EUR,
USD,
GBP,
CAD,
AUD
Example:

"EUR"

​
createdAt
string<date-time>
required

Date and time when the quote was created. Format: ISO 8601 date-time string.

Example:

"2024-01-15T10:00:00.000Z"

​
updatedAt
string<date-time>
required

Date and time when the quote was last modified. Format: ISO 8601 date-time string.

Example:

"2024-01-15T11:30:00.000Z"

​
vatRate
number
required

VAT (Value Added Tax) rate applied to the quote, expressed as a percentage (e.g., 20 for 20% VAT).

Required range: 0 <= x <= 100
Example:

20

​
items
object[]
required

List of items included in this quote. Each item represents a product or service being quoted with quantity and pricing.

Example:
[
  {
    "id": "item_1",
    "description": "Private office rental - Monthly",
    "quantity": 2,
    "unitPrice": 300
  }
]
​
netTotal
number
required

Total amount excluding VAT (HT - Hors Taxes). Sum of all line item totals before tax.

Required range: x >= 0
Example:

600

​
taxTotal
number
required

Total VAT amount (TVA - Taxe sur la Valeur Ajoutée) calculated on the net total.

Required range: x >= 0
Example:

120

​
grossTotal
number
required

Total amount including VAT (TTC - Toutes Taxes Comprises). This is the final amount the customer would pay if they accept the quote.

Required range: x >= 0
Example:

720

​
expiresInDays
number

Number of days until the quote expires. After expiration, the quote may no longer be valid or convertible to an invoice.

Required range: x >= 1
Example:

30

​
note
string

Optional internal note or comments about the quote. Not visible to the customer.

Example:

"Special pricing for long-term commitment"