1. Invoicing
  2. Quotes

Quotes

quotes
copy
Click to Copy

A quote is an estimate of the invoice with the charges likely to occur when customers buy an item. A quote can be converted to a regular invoice once the customer accepts it.

Related Tables

Tables referencing quotes.id
quote_line_item_tiers quote_line_items quote_discounts quote_line_item_discounts quote_line_item_taxes

Columns

No match found
id string, not null
Primary Key
The quote number. Acts as an identifier for the quote and is typically generated sequentially.
subscription_id string, null
Foreign Key subscriptions.id
The identifier of the subscription this quote belongs to.
invoice_id string, null
Foreign Key invoices.id
The identifier of the invoice generated while converting this quote.
customer_id string, not null
Foreign Key customers.id
The identifier of the customer this quote belongs to.
business_entity_id string, null
Foreign Key business_entities.id
The unique ID of the business entity of this quote. .
amount_due long, null, default=0
Amount due (in cents) for the first quote line group.
amount_paid long, null, default=0
Existing outstanding payments (in cents), if any, applied to the first quote line group.
billing_address_city string, null
The name of the city.
billing_address_company string, null
The company name.
billing_address_country string, null
The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.
billing_address_email string, null
The email address.
billing_address_first_name string, null
The first name of the billing contact.
billing_address_last_name string, null
The last name of the billing contact.
billing_address_line1 string, null
Address line 1.
billing_address_line2 string, null
Address line 2.
billing_address_line3 string, null
Address line 3.
billing_address_phone string, null
The phone number.
billing_address_state string, null
State or province.
billing_address_state_code string, null
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada, and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).
billing_address_validation_status string, null, default=not_validated
The address verification status.
billing_address_zip string, null
Zip or postal code. The number of characters is validated according to the rules specified here.
charge_on_acceptance long, null, default=0
Charge on acceptance. Applicable when multi-billing cycle quotes are enabled.
contract_term_end timestamp, null
Specifies the contract term’s end date. It indicates when the action set in action_at_term_end gets triggered.
contract_term_start timestamp, null
Specifies the contract term’s start date.
contract_term_termination_fee long, null
Specifies the charge to be applied for terminating the contract term.
credits_applied long, null, default=0
Credits applied (in cents) for the first quote line group.
currency_code string, not null
The currency code (ISO 4217 format) of the quote.
date timestamp, not null
Creation date of the quote. Typically, this is the date on which the quote is generated.
name string, null
The quote name will be used as the PDF name of the quote.
notes string, null
List of notes associated with this quote.
operation_type string, not null
The type of operation.
po_number string, null
Purchase order number.
price_type string, not null, default=tax_exclusive
The price type of the quote.
resource_version long, null
Version number of this table. The resource_version is updated with a new timestamp in milliseconds for every change made to the table. This field will be present only if the table has been updated after 2016-09-28.
shipping_address_city string, null
The name of the city.
shipping_address_company string, null
The company name.
shipping_address_country string, null
The shipping address country of the customer. Must be one of ISO 3166 alpha-2 country code.
shipping_address_email string, null
The email address.
shipping_address_first_name string, null
The first name of the contact.
shipping_address_index null
The index number of the subscription to which the item price is added. Provide a unique number between 0 and 4 (inclusive) for each subscription that is to be created.
shipping_address_last_name string, null
The last name of the contact.
shipping_address_line1 string, null
Address line 1.
shipping_address_line2 string, null
Address line 2.
shipping_address_line3 string, null
Address line 3.
shipping_address_phone string, null
The phone number.
shipping_address_state string, null
The state/province name.
shipping_address_state_code string, null
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada, and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).
shipping_address_validation_status string, null, default=not_validated
The address verification status.
shipping_address_zip string, null
Zip or postal code. The number of characters is validated according to the rules specified here.
status string, not null
Current status of this quote.
sub_total long, not null
Subtotal (in cents) of the first quote line group.
tax_category string, null
Specifies the customer's category for the Goods and Services Tax (GST). This field is returned only if you've configured GST for the India region.
total long, null, default=0
Total (in cents) of the first quote line group.
total_payable long, null
Total contract value. Applicable when multi-billing cycle quotes are enabled.
updated_at timestamp, null
Timestamp indicating when this quote was last updated.
valid_till timestamp, not null
The quote will be valid until this date. After this date, the quote will be marked as closed.
vat_number string, null
VAT/Tax registration number of the customer. Learn more.
vat_number_prefix string, null
An overridden value for the first two characters of the full VAT number. Only applicable specifically for customers with billing_address country as XI (which is United Kingdom - Northern Ireland).

When you have enabled EU VAT in 2021 or have manually enabled the Brexit configuration, you have the option of setting billing_address country as XI. That’s the code for United Kingdom - Northern Ireland. The first two characters of the VAT number in such a case is XI by default. However, if the VAT number was registered in the UK, the value should be GB. Set vat_number_prefix to GB for such cases.
version null, default=1
Version of the quote.