πŸ“ Quotes

Sales quotes and estimates

List quotes

get
/api/v1.0/organisation/{org_id}/quotes/

List all quotes for an organization

Authorizations
AuthorizationstringRequired
Path parameters
org_idstringRequired
Query parameters
client_idstringOptional

Filter by client unique_id

expiredstringOptional

Filter expired quotes (true/false)

from_datestringOptional

Filter quotes from this quote_date (YYYY-MM-DD)

searchstringOptional

Search quote_number or title

statusstring Β· enumOptional

Filter by quote status

Possible values:
to_datestringOptional

Filter quotes up to this quote_date (YYYY-MM-DD)

Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_id}/quotes/

Create quote

post
/api/v1.0/organisation/{org_id}/quotes/create/

Create a new quote

Authorizations
AuthorizationstringRequired
Path parameters
org_idstringRequired
Body

Comprehensive serializer for Quote model.

unique_idstring Β· max: 100 Β· nullableOptional
titlestring Β· min: 1Required
descriptionstring Β· nullableOptional
terms_and_conditionsstring Β· nullableOptional
notesstring Β· nullableOptional
quote_numberstring Β· min: 1 Β· max: 100Required
statusstring Β· enumOptional
  • draft - Draft
  • sent - Sent
  • viewed - Viewed by Client
  • accepted - Accepted
  • rejected - Rejected
  • expired - Expired
  • converted - Converted to Invoice
Possible values:
quote_datestring Β· dateOptional
valid_untilstring Β· date Β· nullableOptional
client_idstring Β· min: 1 Β· nullableWrite-onlyOptional
Responses
post
/api/v1.0/organisation/{org_id}/quotes/create/

Retrieve quote

get
/api/v1.0/organisation/{org_id}/quotes/{quote_id}/

Retrieve a specific quote with full details

Authorizations
AuthorizationstringRequired
Path parameters
org_idstringRequired
quote_idstringRequired
Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_id}/quotes/{quote_id}/

Update quote

put
/api/v1.0/organisation/{org_id}/quotes/{quote_id}/update/

Update an existing quote

Authorizations
AuthorizationstringRequired
Path parameters
org_idstringRequired
quote_idstringRequired
Body

Comprehensive serializer for Quote model.

unique_idstring Β· max: 100 Β· nullableOptional
titlestring Β· min: 1Required
descriptionstring Β· nullableOptional
terms_and_conditionsstring Β· nullableOptional
notesstring Β· nullableOptional
quote_numberstring Β· min: 1 Β· max: 100Required
statusstring Β· enumOptional
  • draft - Draft
  • sent - Sent
  • viewed - Viewed by Client
  • accepted - Accepted
  • rejected - Rejected
  • expired - Expired
  • converted - Converted to Invoice
Possible values:
quote_datestring Β· dateOptional
valid_untilstring Β· date Β· nullableOptional
client_idstring Β· min: 1 Β· nullableWrite-onlyOptional
Responses
chevron-right
200Success
application/json
put
/api/v1.0/organisation/{org_id}/quotes/{quote_id}/update/

Update quote

patch
/api/v1.0/organisation/{org_id}/quotes/{quote_id}/update/

Update an existing quote

Authorizations
AuthorizationstringRequired
Path parameters
org_idstringRequired
quote_idstringRequired
Body

Comprehensive serializer for Quote model.

unique_idstring Β· max: 100 Β· nullableOptional
titlestring Β· min: 1Optional
descriptionstring Β· nullableOptional
terms_and_conditionsstring Β· nullableOptional
notesstring Β· nullableOptional
quote_numberstring Β· min: 1 Β· max: 100Optional
statusstring Β· enumOptional
  • draft - Draft
  • sent - Sent
  • viewed - Viewed by Client
  • accepted - Accepted
  • rejected - Rejected
  • expired - Expired
  • converted - Converted to Invoice
Possible values:
quote_datestring Β· dateOptional
valid_untilstring Β· date Β· nullableOptional
client_idstring Β· min: 1 Β· nullableWrite-onlyOptional
Responses
chevron-right
200Success
application/json
patch
/api/v1.0/organisation/{org_id}/quotes/{quote_id}/update/

Perform quote action

get
/api/v1.0/organisation/{org_id}/quotes/{quote_id}/action/

Perform an action on a quote using query parameter.

**Available Actions:**
- `mark_as_draft` - Mark a quote as draft
- `mark_as_sent` - Mark a draft quote as sent to the client
- `mark_as_viewed` - Mark a quote as viewed by the client
- `mark_as_accepted` - Mark a quote as accepted by the client
- `mark_as_rejected` - Mark a quote as rejected
- `mark_as_expired` - Mark a quote as expired
- `duplicate` - Create a duplicate of the quote
- `convert_to_invoice` - Convert an accepted quote to an invoice (requires `invoice_number` and `due_date` parameters)

**Examples:**
- `/quotes/{id}/action?action=mark_as_draft`
- `/quotes/{id}/action?action=mark_as_sent`
- `/quotes/{id}/action?action=mark_as_viewed`
- `/quotes/{id}/action?action=mark_as_accepted`
- `/quotes/{id}/action?action=mark_as_rejected`
- `/quotes/{id}/action?action=mark_as_expired`
- `/quotes/{id}/action?action=duplicate`
- `/quotes/{id}/action?action=convert_to_invoice&invoice_number=INV-001&due_date=2025-12-31`
Authorizations
AuthorizationstringRequired
Path parameters
org_idstringRequired
quote_idstringRequired
Query parameters
actionstring Β· enumRequired

The action to perform on the quote

Possible values:
due_datestringOptional

Payment due date in YYYY-MM-DD format (required when action=convert_to_invoice)

invoice_datestringOptional

Invoice date in YYYY-MM-DD format (optional, defaults to today)

invoice_numberstringOptional

Invoice number (required when action=convert_to_invoice)

Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_id}/quotes/{quote_id}/action/

Last updated