Skip to main content
POST
JavaScript

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

The ID of the End-User to receive this request.

Example:

"end_usr_1234567abcdefg"

Body

application/json
​
customerId
string
required

The customer or customer-job associated with this estimate.

Maximum string length: 36
Example:

"80000001-1234567890"

​
transactionDate
string<date>
required

The date of this estimate, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-10-01"

​
classId
string

The estimate's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default. A class defined here is automatically used in this estimate's line items unless overridden at the line item level.

Maximum string length: 36
Example:

"80000001-1234567890"

​
documentTemplateId
string

The predefined template in QuickBooks that determines the layout and formatting for this estimate when printed or displayed.

Maximum string length: 36
Example:

"80000001-1234567890"

​
refNumber
string

The case-sensitive user-defined reference number for this estimate, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user. When left blank in this create request, this field will be left blank in QuickBooks (i.e., it does not auto-increment).

Maximum length: 11 characters.

Maximum string length: 11
Example:

"EST-1234"

​
billingAddress
object

The estimate's billing address.

​
shippingAddress
object

The estimate's shipping address.

​
isActive
boolean
default:true

Indicates whether this estimate is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

Example:

true

​
purchaseOrderNumber
string

The customer's Purchase Order (PO) number associated with this estimate. This field is often used to cross-reference the estimate with the customer's purchasing system.

Maximum length: 25 characters.

Maximum string length: 25
Example:

"PO-1234"

​
termsId
string

The estimate's payment terms, defining when payment is due and any applicable discounts.

Maximum string length: 36
Example:

"80000001-1234567890"

​
dueDate
string<date>

The date by which this estimate must be paid, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-10-31"

​
salesRepresentativeId
string

The estimate's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.

Maximum string length: 36
Example:

"80000001-1234567890"

​
shipmentOrigin
string

The origin location from where the product associated with this estimate is shipped. This is the point at which ownership and liability for goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB" for this field, which stands for "freight on board". This field is informational and has no accounting implications.

Maximum length: 13 characters.

Maximum string length: 13
Example:

"San Francisco, CA"

​
salesTaxItemId
string

The sales-tax item used to calculate the actual tax amount for this estimate's transactions by applying a specific tax rate collected for a single tax agency. Unlike salesTaxCode, which only indicates general taxability, this field drives the actual tax calculation and reporting.

Maximum string length: 36
Example:

"80000001-1234567890"

​
memo
string

A memo or note for this estimate that appears in reports, but not on the estimate. Use customerMessage to add a note to this estimate.

Maximum length: 4095 characters.

Maximum string length: 4095
Example:

"Proposal for website redesign"

​
customerMessageId
string

The message to display to the customer on the estimate.

Maximum string length: 36
Example:

"80000001-1234567890"

​
isQueuedForEmail
boolean

Indicates whether this estimate is included in the queue of documents for QuickBooks to email to the customer.

Example:

true

​
salesTaxCodeId
string

The sales-tax code for this estimate, determining whether it is taxable or non-taxable. This can be overridden at the transaction-line level.

Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns the default non-taxable sales-tax code configured in the company file to all sales.

Maximum string length: 36
Example:

"80000001-1234567890"

​
otherCustomField
string

A built-in custom field for additional information specific to this estimate. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all estimates for convenience. Developers often use this field for tracking information that doesn't fit into other standard QuickBooks fields. Unlike otherCustomField1 and otherCustomField2, which are line item fields, this exists at the transaction level. Hidden by default in the QuickBooks UI.

Maximum length: 29 characters.

Maximum string length: 29
Example:

"Special handling required"

​
exchangeRate
number

The market exchange rate between this estimate's currency and the home currency in QuickBooks at the time of this transaction. Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).

Example:

1.2345

​
externalId
string<uuid>

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

IMPORTANT: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.

Example:

"12345678-abcd-1234-abcd-1234567890ab"

​
lines
object[]

The estimate's line items, each representing a single product or service quoted.

IMPORTANT: You must specify lines, lineGroups, or both when creating an estimate.

Minimum array length: 1
​
lineGroups
object[]

The estimate's line item groups, each representing a predefined set of related items.

IMPORTANT: You must specify lines, lineGroups, or both when creating an estimate.

Minimum array length: 1

Response

200 - application/json

Returns the newly created estimate.

​
id
string
required

The unique identifier assigned by QuickBooks to this estimate. This ID is unique across all transaction types.

Example:

"123ABC-1234567890"

​
objectType
string
required

The type of object. This value is always "qbd_estimate".

Allowed value: "qbd_estimate"
Example:

"qbd_estimate"

​
createdAt
string
required

The date and time when this estimate was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

Example:

"2025-01-01T12:34:56.000Z"

​
updatedAt
string
required

The date and time when this estimate was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

Example:

"2025-02-01T12:34:56.000Z"

​
revisionNumber
string
required

The current QuickBooks-assigned revision number of this estimate object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

Example:

"1721172183"

​
customer
object
required

The customer or customer-job associated with this estimate.

Example:
​
class
object | null
required

The estimate's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default. A class defined here is automatically used in this estimate's line items unless overridden at the line item level.

Example:
​
documentTemplate
object | null
required

The predefined template in QuickBooks that determines the layout and formatting for this estimate when printed or displayed.

Example:
​
transactionDate
string<date>
required

The date of this estimate, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-10-01"

​
refNumber
string | null
required

The case-sensitive user-defined reference number for this estimate, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user.

Example:

"EST-1234"

​
billingAddress
The Address object · object | null
required

The estimate's billing address.

​
shippingAddress
The Address object · object | null
required

The estimate's shipping address.

​
isActive
boolean
required

Indicates whether this estimate is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

Example:

true

​
purchaseOrderNumber
string | null
required

The customer's Purchase Order (PO) number associated with this estimate. This field is often used to cross-reference the estimate with the customer's purchasing system.

Example:

"PO-1234"

​
terms
object | null
required

The estimate's payment terms, defining when payment is due and any applicable discounts.

Example:
​
dueDate
string<date> | null
required

The date by which this estimate must be paid, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-10-31T00:00:00.000Z"

​
salesRepresentative
object | null
required

The estimate's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.

Example:
​
shipmentOrigin
string | null
required

The origin location from where the product associated with this estimate is shipped. This is the point at which ownership and liability for goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB" for this field, which stands for "freight on board". This field is informational and has no accounting implications.

Example:

"San Francisco, CA"

​
subtotal
string
required

The subtotal of this estimate, which is the sum of all estimate lines before taxes and payments are applied, represented as a decimal string.

Example:

"1000.00"

​
salesTaxItem
object | null
required

The sales-tax item used to calculate the actual tax amount for this estimate's transactions by applying a specific tax rate collected for a single tax agency. Unlike salesTaxCode, which only indicates general taxability, this field drives the actual tax calculation and reporting.

Example:
​
salesTaxPercentage
string | null
required

The sales tax percentage applied to this estimate, represented as a decimal string.

Example:

"0.07"

​
salesTaxTotal
string | null
required

The total amount of sales tax charged for this estimate, represented as a decimal string.

Example:

"10.00"

​
totalAmount
string
required

The total monetary amount of this estimate, equivalent to the sum of the amounts in lines and lineGroups, represented as a decimal string.

Example:

"1000.00"

​
currency
object | null
required

The estimate's currency. For built-in currencies, the name and code are standard ISO 4217 international values. For user-defined currencies, all values are editable.

Example:
​
exchangeRate
number | null
required

The market exchange rate between this estimate's currency and the home currency in QuickBooks at the time of this transaction. Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).

Example:

1.2345

​
totalAmountInHomeCurrency
string | null
required

The total monetary amount of this estimate converted to the home currency of the QuickBooks company file. Represented as a decimal string.

Example:

"1234.56"

​
memo
string | null
required

A memo or note for this estimate that appears in reports, but not on the estimate. Use customerMessage to add a note to this estimate.

Example:

"Proposal for website redesign"

​
customerMessage
object | null
required

The message to display to the customer on the estimate.

Example:
​
isQueuedForEmail
boolean | null
required

Indicates whether this estimate is included in the queue of documents for QuickBooks to email to the customer.

Example:

true

​
salesTaxCode
object | null
required

The sales-tax code for this estimate, determining whether it is taxable or non-taxable. This can be overridden at the transaction-line level.

Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks Desktop. If QuickBooks Desktop is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it assigns the default non-taxable sales-tax code configured in the company file to all sales.

Example:
​
otherCustomField
string | null
required

A built-in custom field for additional information specific to this estimate. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all estimates for convenience. Developers often use this field for tracking information that doesn't fit into other standard QuickBooks fields. Unlike otherCustomField1 and otherCustomField2, which are line item fields, this exists at the transaction level. Hidden by default in the QuickBooks UI.

Example:

"Special handling required"

​
externalId
string | null
required

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

Example:

"12345678-abcd-1234-abcd-1234567890ab"

​
linkedTransactions
The Linked Transaction object · object[]
required

The estimate's linked transactions, such as payments applied, credits used, or associated purchase orders.

IMPORTANT: You must specify the parameter includeLinkedTransactions when fetching a list of estimates to receive this field because it is not returned by default.

​
lines
The Estimate Line object · object[]
required

The estimate's line items, each representing a single product or service quoted.

​
lineGroups
The Estimate Line Group object · object[]
required

The estimate's line item groups, each representing a predefined set of related items.

​
customFields
The Custom Field object · object[]
required

The custom fields for the estimate object, added as user-defined data extensions, not included in the standard QuickBooks object.