Get quotes

GET

quotes

Authorizations

Authorization

string

header

required

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

Query Parameters

take

number | null

default:

Required range: 0 < x < 100

skip

number | null

default:

Required range: x > 0

status

Available options:

all,

draft,

pending_approval,

changes_requested,

approved,

pending_signature,

signed,

voided

status__in

Available options:

all,

draft,

pending_approval,

changes_requested,

approved,

pending_signature,

signed,

voided

status__notIn

Available options:

all,

draft,

pending_approval,

changes_requested,

approved,

pending_signature,

signed,

voided

customer_id

string

customer_id__not

string

customer_id__isNull

string

customer_id__isNotNull

string

customer_id__equals

string

customer_id__contains

string

customer_id__startsWith

string

customer_id__endWith

string

Response

200 - application/json

data

object[]

required

List of Quote.

data.amount

number

required

Estimated contract value.

data.attachments

object[]

required

List of documents attached to the quote.

data.automatically_start_subscription

boolean

required

Whether the subscription should be automatically started when the quote is signed.

data.collect_custom_property_ids

string[]

required

IDs of the customer custom properties required to be filled during the signature flow.

data.collect_payment_details

boolean

required

Collect customer payment method mandate during signature flow or not.

data.comments

string | null

required

Custom comments displayed on the quote.

data.created_at

string | null

required

UTC date time string in the ISO 8601 format.

data.crm_opportunity_id

string | null

required

ID of the related opportunity/deal in the connected CRM.

data.customer_id

string

required

ID of the customer.

data.expires_at

string | null

required

Quote expiration date. UTC date time string in the ISO 8601 format.

data.id

string

required

Quote ID.

data.invoicing_entity_id

string

required

ID of the invoicing entity attached to the quote.

data.number

string

required

Quote sequential number.

data.signed_file

object

required

Final signed quote (manually uploaded).

data.status

enum<string>

required

Quote status.

draft: The quote is a draft.
pending_approval: The quote is pending manager review and approval.
changes_requested: Some changes have been requested following manager review.
approved: The quote is approved and ready to be sent to the customer.
pending_signature: The quote is awaiting the customer's signature.
signed: The quote is signed and fully finalized.
voided: The quote is voided.

Available options:

draft

data.subscription_id

string | null

required

ID of the current subscription attached to the quote. The get subscription endpoint (GET /v2/subscriptions/{id}) can be used to retrieve the related details.

data.template_id

string | null

required

ID of the quote template.

data.terms

string | null

required

Custom quotation terms.

data.url

string | null

required

URL to access the quote publicly. Only applies to the pending_signature or signed quote.

API documentation

Integrations

Analytics

Billable events

Companies

Coupons

Custom properties

Customers

Customers > Credits

Customers > Payment methods

Integrations

Invoices

Invoicing entities

OAuth2

Organisations

Payments

Plans

Price configurations

Products

Quotes

Subscriptions

Taxes

Third-party apps

Wallets

Webhooks

Authorizations

Query Parameters

Response