Proposals
Sales quotation / devis.
List proposals
- Method:
GET /obapi/v1/proposals - Headers:
Authorization: Bearer {apikey}
| Parameter | Type | Required | Description |
|---|---|---|---|
page |
integer | no | Page number (default: 1) |
per_page |
integer | no | Items per page (default: 50, max: 200) |
date_start |
string | no | From date (YYYY-MM-DD) |
date_end |
string | no | To date (YYYY-MM-DD) |
status |
string | no | draft, validated, signed, refused, billed |
sort |
string | no | date_asc, date_desc (default), ref_asc, ref_desc |
Get a single proposal
- Method:
GET /obapi/v1/proposals/{id}
Status values
| Value | Description |
|---|---|
draft |
Draft proposal |
validated |
Sent to customer |
signed |
Accepted by customer |
refused |
Refused by customer |
billed |
Invoice created |
Response (single)
{
"proposal": {
"id": "205",
"ref": "PR2405-0012",
"customer_ref": "Your ref 123",
"date_proposal": "2024-05-10",
"date_expiry": "2024-06-10",
"date_delivery": "2024-07-01",
"signed_at": null,
"validated_at": "2024-05-10T14:00:00Z",
"created_at": "2024-05-09T09:30:00Z",
"updated_at": "2024-05-10T14:00:00Z",
"status": "validated",
"payment_terms": "Net 30 days",
"payment_method": "Bank transfer",
"total_excl_tax": "5000.00",
"total_vat": "1000.00",
"total_incl_tax": "6000.00",
"multicurrency_code": "EUR",
"public_note": "",
"lines": [
{
"id": "410",
"position": 1,
"product_ref": "CONSULTING-01",
"product_label": "Consulting service",
"product_type": "service",
"description": "Technical consulting - May 2024",
"quantity": "50.00",
"unit": "hour",
"unit_price_excl_tax": "100.00",
"discount_percent": "0.00",
"vat_rate": "20.000",
"total_excl_tax": "5000.00",
"total_vat": "1000.00",
"total_incl_tax": "6000.00",
"date_start": "2024-05-01",
"date_end": "2024-05-31"
}
]
}
}Download PDF
GET /obapi/v1/download/{id}?type=proposal