POST
/businesses/{bid}/quotes/{id}/appointmentBook an accepted quote as an appointment
POST /businesses/{bid}/quotes/{id}/appointment
Requires the documents scope.
Only an accepted quote. Its customer, title and (for a shekel quote) total fill the appointment; send date and start, and anything else to override. The appointment reads billed once the quote becomes an issued document. Needs the calendar on.
Path parameters
| Name | Type | Description | |
|---|---|---|---|
bid | string | required | Business id, from POST /businesses. |
id | string | required | Quote id. |
Headers
| Name | Type | Description | |
|---|---|---|---|
Idempotency-Key | string | Your own stable id for this call. A retry returns the same row with deduped: true instead of creating a duplicate. Interchangeable with externalRef in the body. |
Body
| Field | Type | Description | |
|---|---|---|---|
partyId | string | A saved party (find or create it first). Optional: a block of time needs no customer. | |
serviceId | string | ||
title | string | ≤120 chars. Default: the service, else the customer, else "פגישה". | |
date | string | YYYY-MM-DD, the Israel calendar day. | |
start | string | HH:MM, local Israel time. | |
minutes | integer | 5..1440. Default: the service, else the calendar's defaultMinutes. | |
priceAgorot | integer | Integer agorot (₪1 = 100). | |
priceMode | string | One of: gross, net. Default gross. | |
location | string | Default: the calendar's first location. One of: business, customer, remote. | |
address | string | ≤300 chars. | |
meetingUrl | string | An http(s) address. | |
notes | string | ≤2000 chars. |
Response
201: { "ok": true, … }
| Field | Type | Description | |
|---|---|---|---|
ok | boolean | required | |
appointment | Appointment | required | An appointment on the business's calendar. Not a document: freely edited and deleted, in no export. |
Errors: 400, 401, 403, 404, 409, 429. Every failure answers { "error", "reason", "hint", "param", "doc_url", "retryable", "request_id" }: branch on reason, and read hint for what to change (https://docs.billos.co.il/errors.md).