Skip to main content
POST
/
api
/
public
/
v1
/
quotes
cURL
curl --request POST \
  --url https://api.boxpilote.fr/api/public/v1/quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer": {
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "phone": "<string>",
    "type": "Particulier",
    "name": "<string>"
  },
  "total_amount": 123,
  "sub_total_amount": 123,
  "vat_amount": 123,
  "expiration_date": "<string>",
  "payment_method": "<string>",
  "payment_terms": "<string>",
  "quote_items": [
    {
      "item_type": "<string>",
      "description": "<string>",
      "quantity": 123,
      "amount_ht": 123,
      "vat_rate": 123,
      "total_ht": 123,
      "unit": "<string>",
      "order": 123,
      "size": 123,
      "is_option": true,
      "one_time": true,
      "type": "<string>",
      "discountType": "<string>",
      "discountValue": 123,
      "discountAmount": 123
    }
  ],
  "deposit": 123,
  "type": "<string>",
  "billing_period": 123,
  "opportunity_id": "<string>"
}
'
{
  "success": true,
  "quoteId": "<string>",
  "quote_number": "<string>",
  "createdAt": "<string>",
  "pdf_url": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
customer
object
required

Customer data. If email already exists, the quote is linked to the existing customer.

total_amount
number
required

Total amount including VAT in euros

sub_total_amount
number
required

Subtotal excluding VAT in euros

vat_amount
number
required

VAT amount in euros

expiration_date
string
required

Quote expiration date (ISO 8601)

payment_method
string
required

Payment method (e.g. SEPA Direct Debit)

payment_terms
string
required

Payment terms (e.g. On receipt)

quote_items
object[]
required

Quote line items (at least one)

Minimum array length: 1
deposit
number

Deposit in euros (optional)

type
string

Quote type (optional)

billing_period
number

Billing period, default: 1 (optional)

opportunity_id
string

Linked opportunity ID (optional)

Response

Quote created

success
boolean

Creation success

quoteId
string

Created quote ID

quote_number
string | null

Quote number

createdAt
string

Creation date

pdf_url
string | null

PDF URL if generation succeeded