List all estimates

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 EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Example:

"end_usr_1234567abcdefg"

Query Parameters

ids

string[]

Filter for specific estimates by their QuickBooks-assigned unique identifier(s).

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

Example:

["123ABC-1234567890"]

refNumbers

string[]

Filter for specific estimates by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user.

IMPORTANT: If you include this parameter, QuickBooks will ignore all other query parameters for this request.

NOTE: If any of the values you specify in this parameter are not found, the request will return an error.

Example:

["ESTIMATE-1234"]

limit

integer

default:150

The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the cursor parameter. Each response will include a nextCursor value that can be passed to subsequent requests to retrieve the next page of results.

Required range: 1 <= x <= 150

Example:

150

cursor

string

The pagination token to fetch the next set of results when paginating with the limit parameter. Do not include this parameter on the first call. Use the nextCursor value returned in the previous response to request subsequent results.

Example:

"12345678-abcd-abcd-example-1234567890ab"

updatedAfter

string

Filter for estimates updated on or after this date/time. Accepts the following ISO 8601 formats:

date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the start of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T00:00:00).
datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.

Example:

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

updatedBefore

string

Filter for estimates updated on or before this date/time. Accepts the following ISO 8601 formats:

date-only (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the end of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T23:59:59).
datetime without timezone (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer.
datetime with timezone (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone.

Example:

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

transactionDateFrom

string<date>

Filter for estimates whose date field is on or after this date, in ISO 8601 format (YYYY-MM-DD).

NOTE: QuickBooks Desktop interprets this date as the start of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T00:00:00).

Example:

"2025-01-01"

transactionDateTo

string<date>

Filter for estimates whose date field is on or before this date, in ISO 8601 format (YYYY-MM-DD).

NOTE: QuickBooks Desktop interprets this date as the end of the specified day in the local timezone of the end-user's computer (e.g., 2025-01-01 → 2025-01-01T23:59:59).

Example:

"2025-02-01"

customerIds

string[]

Filter for estimates created for these customers.

Example:

["80000001-1234567890"]

accountIds

string[]

Filter for estimates associated with these accounts.

Example:

["80000001-1234567890"]

refNumberContains

string

Filter for estimates whose refNumber contains this substring.

NOTE: If you use this parameter, you cannot also use refNumberStartsWith or refNumberEndsWith.

Example:

"EST-1234"

refNumberStartsWith

string

Filter for estimates whose refNumber starts with this substring.

NOTE: If you use this parameter, you cannot also use refNumberContains or refNumberEndsWith.

Example:

"EST"

refNumberEndsWith

string

Filter for estimates whose refNumber ends with this substring.

NOTE: If you use this parameter, you cannot also use refNumberContains or refNumberStartsWith.

Example:

"1234"

refNumberFrom

string

Filter for estimates whose refNumber is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.

Example:

"EST-0001"

refNumberTo

string

Filter for estimates whose refNumber is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.

Example:

"EST-9999"

currencyIds

string[]

Filter for estimates in these currencies.

Example:

["80000001-1234567890"]

includeLineItems

boolean

default:true

Whether to include line items in the response. Defaults to true.

Example:

true

includeLinkedTransactions

boolean

default:false

Whether to include linked transactions in the response. Defaults to false. For example, a payment linked to the corresponding estimate.

Example:

false

Response

200 - application/json

Returns a list of estimates.

objectType

string

required

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

Allowed value: "list"

Example:

"list"

url

string

required

The endpoint URL where this list can be accessed.

Example:

"/v1/quickbooks-desktop/estimates"

data

The Estimate object · object[]

required

The array of estimates.

Show child attributes

data.id

string

required

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

Example:

"123ABC-1234567890"

data.objectType

string

required

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

Allowed value: "qbd_estimate"

Example:

"qbd_estimate"

data.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"

data.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"

data.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"

data.customer

object

required

The customer or customer-job associated with this estimate.

Show child attributes

data.customer.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.customer.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Acme Corporation"
}

data.class

object

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.

Show child attributes

data.class.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.class.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Web Development"
}

data.documentTemplate

object

required

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

Show child attributes

data.documentTemplate.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.documentTemplate.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Estimate Template"
}

data.transactionDate

string<date>

required

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

Example:

"2024-10-01"

data.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"

data.billingAddress

The Address object · object

required

The estimate's billing address.

Show child attributes

data.billingAddress.line1

string | null

required

The first line of the address (e.g., street, PO Box, or company name).

Example:

"Conductor Labs Inc."

data.billingAddress.line2

string | null

required

The second line of the address, if needed (e.g., apartment, suite, unit, or building).

Example:

"540 Market St."

data.billingAddress.line3

string | null

required

The third line of the address, if needed.

Example:

"Suite 100"

data.billingAddress.line4

string | null

required

The fourth line of the address, if needed.

Example:

""

data.billingAddress.line5

string | null

required

The fifth line of the address, if needed.

Example:

""

data.billingAddress.city

string | null

required

The city, district, suburb, town, or village name of the address.

Example:

"San Francisco"

data.billingAddress.state

string | null

required

The state, county, province, or region name of the address.

Example:

"CA"

data.billingAddress.postalCode

string | null

required

The postal code or ZIP code of the address.

Example:

"94110"

data.billingAddress.country

string | null

required

The country name of the address.

Example:

"United States"

data.billingAddress.note

string | null

required

A note written at the bottom of the address in the form in which it appears, such as the invoice form.

Example:

"Conductor HQ"

data.shippingAddress

The Address object · object

required

The estimate's shipping address.

Show child attributes

data.shippingAddress.line1

string | null

required

The first line of the address (e.g., street, PO Box, or company name).

Example:

"Conductor Labs Inc."

data.shippingAddress.line2

string | null

required

The second line of the address, if needed (e.g., apartment, suite, unit, or building).

Example:

"540 Market St."

data.shippingAddress.line3

string | null

required

The third line of the address, if needed.

Example:

"Suite 100"

data.shippingAddress.line4

string | null

required

The fourth line of the address, if needed.

Example:

""

data.shippingAddress.line5

string | null

required

The fifth line of the address, if needed.

Example:

""

data.shippingAddress.city

string | null

required

The city, district, suburb, town, or village name of the address.

Example:

"San Francisco"

data.shippingAddress.state

string | null

required

The state, county, province, or region name of the address.

Example:

"CA"

data.shippingAddress.postalCode

string | null

required

The postal code or ZIP code of the address.

Example:

"94110"

data.shippingAddress.country

string | null

required

The country name of the address.

Example:

"United States"

data.shippingAddress.note

string | null

required

A note written at the bottom of the address in the form in which it appears, such as the invoice form.

Example:

"Conductor HQ"

data.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

data.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"

data.terms

object

required

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

Show child attributes

data.terms.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.terms.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Net 30"
}

data.dueDate

string<date> | null

required

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

Example:

"2024-10-31"

data.salesRepresentative

object

required

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

Show child attributes

data.salesRepresentative.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.salesRepresentative.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Jane Doe"
}

data.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"

data.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"

data.salesTaxItem

object

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.

Show child attributes

data.salesTaxItem.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.salesTaxItem.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "State Sales Tax"
}

data.salesTaxPercentage

string | null

required

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

Example:

"0.07"

data.salesTaxTotal

string | null

required

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

Example:

"10.00"

data.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"

data.currency

object

required

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

Show child attributes

data.currency.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.currency.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "USD"
}

data.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

data.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"

data.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"

data.customerMessage

object

required

The message to display to the customer on the estimate.

Show child attributes

data.customerMessage.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.customerMessage.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Thank you for your business!"
}

data.isQueuedForEmail

boolean | null

required

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

Example:

true

data.salesTaxCode

object

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. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.

Show child attributes

data.salesTaxCode.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.salesTaxCode.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Non"
}

data.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"

data.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"

data.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.

Show child attributes

data.linkedTransactions.id

string

required

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

Example:

"123ABC-1234567890"

data.linkedTransactions.objectType

string

required

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

Allowed value: "qbd_linked_transaction"

Example:

"qbd_linked_transaction"

data.linkedTransactions.transactionType

enum<string>

required

The type of transaction for this linked transaction.

Available options:

ar_refund_credit_card,

bill,

bill_payment_check,

bill_payment_credit_card,

build_assembly,

charge,

check,

credit_card_charge,

credit_card_credit,

credit_memo,

deposit,

estimate,

inventory_adjustment,

invoice,

item_receipt,

journal_entry,

liability_adjustment,

paycheck,

payroll_liability_check,

purchase_order,

receive_payment,

sales_order,

sales_receipt,

sales_tax_payment_check,

transfer,

vendor_credit,

ytd_adjustment,

unknown

Example:

"invoice"

data.linkedTransactions.transactionDate

string<date>

required

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

Example:

"2024-10-01"

data.linkedTransactions.refNumber

string | null

required

The case-sensitive user-defined reference number for this linked transaction, 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:

"LINK-1234"

data.linkedTransactions.linkType

enum<string> | null

required

Indicates the nature of the link between the transactions: amount denotes an amount-based link (e.g., an invoice linked to a payment), and quantity denotes a quantity-based link (e.g., an invoice created from a sales order based on the quantity of items received).

Available options:

amount,

quantity,

Example:

"amount"

data.linkedTransactions.amount

string | null

required

The monetary amount of this linked transaction, represented as a decimal string.

Example:

"1000.00"

data.lines

The Estimate Line object · object[]

required

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

Show child attributes

data.lines.id

string

required

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

Example:

"456DEF-1234567890"

data.lines.objectType

string

required

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

Allowed value: "qbd_estimate_line"

Example:

"qbd_estimate_line"

data.lines.item

object

required

The item associated with this estimate line. This can refer to any good or service that the business buys or sells, including item types such as a service item, inventory item, or special calculation item like a discount item or sales-tax item.

Show child attributes

data.lines.item.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.lines.item.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Widget A"
}

data.lines.description

string | null

required

A description of this estimate line.

Example:

"Graphic illustrations for website redesign"

data.lines.quantity

number | null

required

The quantity of the item associated with this estimate line. This field cannot be cleared.

NOTE: Do not use this field if the associated item is a discount item.

Example:

5

data.lines.unitOfMeasure

string | null

required

The unit-of-measure used for the quantity in this estimate line. Must be a valid unit within the item's available units of measure.

Example:

"Each"

data.lines.overrideUnitOfMeasureSet

object

required

Specifies an alternative unit-of-measure set when updating this estimate line's unitOfMeasure field (e.g., "pound" or "kilogram"). This allows you to select units from a different set than the item's default unit-of-measure set, which remains unchanged on the item itself. The override applies only to this specific line. For example, you can sell an item typically measured in volume units using weight units in a specific transaction by specifying a different unit-of-measure set with this field.

Show child attributes

data.lines.overrideUnitOfMeasureSet.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.lines.overrideUnitOfMeasureSet.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Volume Units"
}

data.lines.rate

string | null

required

The price per unit for this estimate line. If both rate and amount are specified, rate will be ignored. If both quantity and amount are specified but not rate, QuickBooks will use them to calculate rate. Represented as a decimal string. This field cannot be cleared.

Example:

"10.00"

data.lines.ratePercent

string | null

required

The price of this estimate line expressed as a percentage. Typically used for discount or markup items.

Example:

"10.5"

data.lines.class

object

required

The estimate line'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. If a class is specified for the entire parent transaction, it is automatically applied to all estimate lines unless overridden here, at the transaction line level.

Show child attributes

data.lines.class.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.lines.class.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Web Development"
}

data.lines.amount

string | null

required

The monetary amount of this estimate line, represented as a decimal string. If both quantity and rate are specified but not amount, QuickBooks will calculate amount using the rate and any markup you supply. The calculation is amount = (quantity * rate) * (1 + markupRate) when markupRate is provided, or amount = (quantity * rate) * (1 + markupRatePercent/100) when markupRatePercent is provided. If amount, rate, and quantity are all unspecified, QuickBooks will calculate amount based on a quantity of 1 and the suggested rate. This field cannot be cleared.

Example:

"1000.00"

data.lines.inventorySite

object

required

The site location where inventory for the item associated with this estimate line is stored.

Show child attributes

data.lines.inventorySite.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.lines.inventorySite.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Main Warehouse"
}

data.lines.inventorySiteLocation

object

required

The specific location (e.g., bin or shelf) within the inventory site where the item associated with this estimate line is stored.

Show child attributes

data.lines.inventorySiteLocation.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.lines.inventorySiteLocation.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Aisle 3, Shelf B"
}

data.lines.salesTaxCode

object

required

The sales-tax code for this estimate line, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the parent transaction or the associated item.

Show child attributes

data.lines.salesTaxCode.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.lines.salesTaxCode.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Non"
}

data.lines.markupRate

string | null

required

The markup that will be passed on to the customer for this item on this estimate line. amount = (quantity * rate) * (1 + markupRate)

Example:

"0.2"

data.lines.markupRatePercent

string | null

required

The markup, expressed as a percentage, that will be passed on to the customer for this item on this estimate line. amount = (quantity * rate) * (1 + markupRatePercent/100)

Example:

"20.0"

data.lines.otherCustomField1

string | null

required

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

Example:

"Special handling required"

data.lines.otherCustomField2

string | null

required

A second built-in custom field for additional information specific to this estimate line. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all estimate lines for convenience. Like otherCustomField1, developers often use this field for tracking information that doesn't fit into other standard QuickBooks fields. Hidden by default in the QuickBooks UI.

Example:

"Always ship with a spare"

data.lines.customFields

The Custom Field object · object[]

required

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

Show child attributes

data.lines.customFields.ownerId

string

required

The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an ownerId of "0") for all objects.

Example:

"0"

data.lines.customFields.name

string

required

The name of the custom field, unique for the specified ownerId. For public custom fields, this name is visible as a label in the QuickBooks UI.

Example:

"Customer Rating"

data.lines.customFields.type

enum<string>

required

The data type of this custom field.

Available options:

amount_type,

date_time_type,

integer_type,

percent_type,

price_type,

quantity_type,

string_1024_type,

string_255_type

Example:

"string_1024_type"

data.lines.customFields.value

string

required

The value of this custom field. The maximum length depends on the field's data type.

Example:

"Premium"

data.lineGroups

The Estimate Line Group object · object[]

required

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

Show child attributes

data.lineGroups.id

string

required

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

Example:

"456DEF-1234567890"

data.lineGroups.objectType

string

required

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

Allowed value: "qbd_estimate_line_group"

Example:

"qbd_estimate_line_group"

data.lineGroups.itemGroup

object

required

The estimate line group's item group, representing a predefined set of items bundled because they are commonly purchased together or grouped for faster entry.

Show child attributes

data.lineGroups.itemGroup.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.lineGroups.itemGroup.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Office Supplies Bundle"
}

data.lineGroups.description

string | null

required

A description of this estimate line group.

Example:

"Standard widget bulk package"

data.lineGroups.quantity

number | null

required

The quantity of the item group associated with this estimate line group. This field cannot be cleared.

NOTE: Do not use this field if the associated item group is a discount item group.

Example:

5

data.lineGroups.unitOfMeasure

string | null

required

The unit-of-measure used for the quantity in this estimate line group. Must be a valid unit within the item's available units of measure.

Example:

"Each"

data.lineGroups.overrideUnitOfMeasureSet

object

required

Specifies an alternative unit-of-measure set when updating this estimate line group's unitOfMeasure field (e.g., "pound" or "kilogram"). This allows you to select units from a different set than the item's default unit-of-measure set, which remains unchanged on the item itself. The override applies only to this specific line. For example, you can sell an item typically measured in volume units using weight units in a specific transaction by specifying a different unit-of-measure set with this field.

Show child attributes

data.lineGroups.overrideUnitOfMeasureSet.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.lineGroups.overrideUnitOfMeasureSet.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Volume Units"
}

data.lineGroups.shouldPrintItemsInGroup

boolean

required

Indicates whether the individual items in this estimate line group and their separate amounts appear on printed forms.

Example:

true

data.lineGroups.totalAmount

string

required

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

Example:

"1000.00"

data.lineGroups.lines

The Estimate Line object · object[]

required

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

Show child attributes

data.lineGroups.lines.id

string

required

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

Example:

"456DEF-1234567890"

data.lineGroups.lines.objectType

string

required

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

Allowed value: "qbd_estimate_line"

Example:

"qbd_estimate_line"

data.lineGroups.lines.item

object

required

Show child attributes

data.lineGroups.lines.item.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.lineGroups.lines.item.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Widget A"
}

data.lineGroups.lines.description

string | null

required

A description of this estimate line.

Example:

"Graphic illustrations for website redesign"

data.lineGroups.lines.quantity

number | null

required

The quantity of the item associated with this estimate line. This field cannot be cleared.

NOTE: Do not use this field if the associated item is a discount item.

Example:

5

data.lineGroups.lines.unitOfMeasure

string | null

required

The unit-of-measure used for the quantity in this estimate line. Must be a valid unit within the item's available units of measure.

Example:

"Each"

data.lineGroups.lines.overrideUnitOfMeasureSet

object

required

Show child attributes

data.lineGroups.lines.overrideUnitOfMeasureSet.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.lineGroups.lines.overrideUnitOfMeasureSet.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Volume Units"
}

data.lineGroups.lines.rate

string | null

required

Example:

"10.00"

data.lineGroups.lines.ratePercent

string | null

required

The price of this estimate line expressed as a percentage. Typically used for discount or markup items.

Example:

"10.5"

data.lineGroups.lines.class

object

required

Show child attributes

data.lineGroups.lines.class.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.lineGroups.lines.class.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Web Development"
}

data.lineGroups.lines.amount

string | null

required

Example:

"1000.00"

data.lineGroups.lines.inventorySite

object

required

The site location where inventory for the item associated with this estimate line is stored.

Show child attributes

data.lineGroups.lines.inventorySite.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.lineGroups.lines.inventorySite.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Main Warehouse"
}

data.lineGroups.lines.inventorySiteLocation

object

required

The specific location (e.g., bin or shelf) within the inventory site where the item associated with this estimate line is stored.

Show child attributes

data.lineGroups.lines.inventorySiteLocation.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.lineGroups.lines.inventorySiteLocation.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Aisle 3, Shelf B"
}

data.lineGroups.lines.salesTaxCode

object

required

The sales-tax code for this estimate line, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the parent transaction or the associated item.

Show child attributes

data.lineGroups.lines.salesTaxCode.id

string | null

required

The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types.

Example:

"80000001-1234567890"

data.lineGroups.lines.salesTaxCode.fullName

string | null

required

The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own name, separated by colons. Not case-sensitive.

Example:

"Parent:Child:Grandchild"

Example:

{
  "id": "80000001-1234567890",
  "fullName": "Non"
}

data.lineGroups.lines.markupRate

string | null

required

The markup that will be passed on to the customer for this item on this estimate line. amount = (quantity * rate) * (1 + markupRate)

Example:

"0.2"

data.lineGroups.lines.markupRatePercent

string | null

required

The markup, expressed as a percentage, that will be passed on to the customer for this item on this estimate line. amount = (quantity * rate) * (1 + markupRatePercent/100)

Example:

"20.0"

data.lineGroups.lines.otherCustomField1

string | null

required

Example:

"Special handling required"

data.lineGroups.lines.otherCustomField2

string | null

required

Example:

"Always ship with a spare"

data.lineGroups.lines.customFields

The Custom Field object · object[]

required

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

Show child attributes

data.lineGroups.lines.customFields.ownerId

string

required

Example:

"0"

data.lineGroups.lines.customFields.name

string

required

The name of the custom field, unique for the specified ownerId. For public custom fields, this name is visible as a label in the QuickBooks UI.

Example:

"Customer Rating"

data.lineGroups.lines.customFields.type

enum<string>

required

The data type of this custom field.

Available options:

amount_type,

date_time_type,

integer_type,

percent_type,

price_type,

quantity_type,

string_1024_type,

string_255_type

Example:

"string_1024_type"

data.lineGroups.lines.customFields.value

string

required

The value of this custom field. The maximum length depends on the field's data type.

Example:

"Premium"

data.lineGroups.customFields

The Custom Field object · object[]

required

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

Show child attributes

data.lineGroups.customFields.ownerId

string

required

Example:

"0"

data.lineGroups.customFields.name

string

required

The name of the custom field, unique for the specified ownerId. For public custom fields, this name is visible as a label in the QuickBooks UI.

Example:

"Customer Rating"

data.lineGroups.customFields.type

enum<string>

required

The data type of this custom field.

Available options:

amount_type,

date_time_type,

integer_type,

percent_type,

price_type,

quantity_type,

string_1024_type,

string_255_type

Example:

"string_1024_type"

data.lineGroups.customFields.value

string

required

The value of this custom field. The maximum length depends on the field's data type.

Example:

"Premium"

data.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.

Show child attributes

data.customFields.ownerId

string

required

Example:

"0"

data.customFields.name

string

required

The name of the custom field, unique for the specified ownerId. For public custom fields, this name is visible as a label in the QuickBooks UI.

Example:

"Customer Rating"

data.customFields.type

enum<string>

required

The data type of this custom field.

Available options:

amount_type,

date_time_type,

integer_type,

percent_type,

price_type,

quantity_type,

string_1024_type,

string_255_type

Example:

"string_1024_type"

data.customFields.value

string

required

The value of this custom field. The maximum length depends on the field's data type.

Example:

"Premium"

nextCursor

string | null

required

The nextCursor is a pagination token returned in the response when you use the limit parameter in your request. To retrieve subsequent pages of results, include this token as the value of the cursor request parameter in your following API calls.

NOTE: The nextCursor value remains constant throughout the pagination process for a specific list instance; continue to use the same nextCursor token in each request to fetch additional pages.

Example:

"12345678-abcd-abcd-example-1234567890ab"

remainingCount

number | null

required

The number of objects remaining to be fetched.

Example:

10

hasMore

boolean

required

Indicates whether there are more objects to be fetched.

QuickBooks Desktop API

Core Resources

Utilities

Transactions

General

Items

More

Authorizations

Headers

Query Parameters

Response