GET
/
quickbooks-desktop
/
estimates
import Conductor from 'conductor-node';

const client = new Conductor({
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});

async function main() {
  // Automatically fetches more pages as needed.
  for await (const estimate of client.qbd.estimates.list({ conductorEndUserId: 'end_usr_1234567abcdefg' })) {
    console.log(estimate.id);
  }
}

main();
{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/estimates",
  "data": [
    {
      "id": "123ABC-1234567890",
      "objectType": "qbd_estimate",
      "createdAt": "2021-10-01T17:34:56.000Z",
      "updatedAt": "2021-10-01T20:45:30.000Z",
      "revisionNumber": "1721172183",
      "customer": {
        "id": "80000001-1234567890",
        "fullName": "Acme Corporation"
      },
      "class": {
        "id": "80000001-1234567890",
        "fullName": "Web Development"
      },
      "documentTemplate": {
        "id": "80000001-1234567890",
        "fullName": "Estimate Template"
      },
      "transactionDate": "2021-10-01",
      "refNumber": "EST-1234",
      "billingAddress": {
        "line1": "Conductor Labs Inc.",
        "line2": "540 Market St.",
        "line3": "Suite 100",
        "line4": "",
        "line5": "",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94110",
        "country": "United States",
        "note": "Conductor HQ"
      },
      "shippingAddress": {
        "line1": "Conductor Labs Inc.",
        "line2": "540 Market St.",
        "line3": "Suite 100",
        "line4": "",
        "line5": "",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94110",
        "country": "United States",
        "note": "Conductor HQ"
      },
      "isActive": true,
      "purchaseOrderNumber": "PO-1234",
      "terms": {
        "id": "80000001-1234567890",
        "fullName": "Net 30"
      },
      "dueDate": "2021-10-31",
      "salesRepresentative": {
        "id": "80000001-1234567890",
        "fullName": "Jane Doe"
      },
      "shipmentOrigin": "San Francisco, CA",
      "subtotal": "1000.00",
      "salesTaxItem": {
        "id": "80000001-1234567890",
        "fullName": "State Sales Tax"
      },
      "salesTaxPercentage": "0.07",
      "salesTaxTotal": "10.00",
      "totalAmount": "1000.00",
      "currency": {
        "id": "80000001-1234567890",
        "fullName": "USD"
      },
      "exchangeRate": 1.2345,
      "totalAmountInHomeCurrency": "1234.56",
      "memo": "Proposal for website redesign",
      "customerMessage": {
        "id": "80000001-1234567890",
        "fullName": "Thank you for your business!"
      },
      "isQueuedForEmail": true,
      "salesTaxCode": {
        "id": "80000001-1234567890",
        "fullName": "Non"
      },
      "otherCustomField": "Special handling required",
      "externalId": "12345678-abcd-1234-abcd-1234567890ab",
      "linkedTransactions": [
        {
          "id": "123ABC-1234567890",
          "objectType": "qbd_linked_transaction",
          "transactionType": "invoice",
          "transactionDate": "2021-10-01",
          "refNumber": "LINK-1234",
          "linkType": "amount",
          "amount": "1000.00"
        }
      ],
      "lines": [
        {
          "id": "456DEF-1234567890",
          "objectType": "qbd_estimate_line",
          "item": {
            "id": "80000001-1234567890",
            "fullName": "Widget A"
          },
          "description": "Graphic illustrations for website redesign",
          "quantity": 5,
          "unitOfMeasure": "Each",
          "overrideUnitOfMeasureSet": {
            "id": "80000001-1234567890",
            "fullName": "Volume Units"
          },
          "rate": "10.00",
          "ratePercent": "10.5",
          "class": {
            "id": "80000001-1234567890",
            "fullName": "Web Development"
          },
          "amount": "1000.00",
          "inventorySite": {
            "id": "80000001-1234567890",
            "fullName": "Main Warehouse"
          },
          "inventorySiteLocation": {
            "id": "80000001-1234567890",
            "fullName": "Aisle 3, Shelf B"
          },
          "salesTaxCode": {
            "id": "80000001-1234567890",
            "fullName": "Non"
          },
          "markupRate": "0.2",
          "markupRatePercent": "20.0",
          "otherCustomField1": "Special handling required",
          "otherCustomField2": "Always ship with a spare",
          "customFields": [
            {
              "ownerId": "0",
              "name": "Customer Rating",
              "type": "string_1024_type",
              "value": "Premium"
            }
          ]
        }
      ],
      "lineGroups": [
        {
          "id": "456DEF-1234567890",
          "objectType": "qbd_estimate_line_group",
          "itemGroup": {
            "id": "80000001-1234567890",
            "fullName": "Office Supplies Bundle"
          },
          "description": "Standard widget bulk package",
          "quantity": 5,
          "unitOfMeasure": "Each",
          "overrideUnitOfMeasureSet": {
            "id": "80000001-1234567890",
            "fullName": "Volume Units"
          },
          "shouldPrintItemsInGroup": true,
          "totalAmount": "1000.00",
          "lines": [
            {
              "id": "456DEF-1234567890",
              "objectType": "qbd_estimate_line",
              "item": {
                "id": "80000001-1234567890",
                "fullName": "Widget A"
              },
              "description": "Graphic illustrations for website redesign",
              "quantity": 5,
              "unitOfMeasure": "Each",
              "overrideUnitOfMeasureSet": {
                "id": "80000001-1234567890",
                "fullName": "Volume Units"
              },
              "rate": "10.00",
              "ratePercent": "10.5",
              "class": {
                "id": "80000001-1234567890",
                "fullName": "Web Development"
              },
              "amount": "1000.00",
              "inventorySite": {
                "id": "80000001-1234567890",
                "fullName": "Main Warehouse"
              },
              "inventorySiteLocation": {
                "id": "80000001-1234567890",
                "fullName": "Aisle 3, Shelf B"
              },
              "salesTaxCode": {
                "id": "80000001-1234567890",
                "fullName": "Non"
              },
              "markupRate": "0.2",
              "markupRatePercent": "20.0",
              "otherCustomField1": "Special handling required",
              "otherCustomField2": "Always ship with a spare",
              "customFields": [
                {
                  "ownerId": "0",
                  "name": "Customer Rating",
                  "type": "string_1024_type",
                  "value": "Premium"
                }
              ]
            }
          ],
          "customFields": [
            {
              "ownerId": "0",
              "name": "Customer Rating",
              "type": "string_1024_type",
              "value": "Premium"
            }
          ]
        }
      ],
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "nextCursor": "12345678-abcd-abcd-example-1234567890ab",
  "remainingCount": 10,
  "hasMore": true
}

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 and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 00:00:00 of that day.

Example:

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

​
updatedBefore
string

Filter for estimates updated on or before this date and time, in ISO 8601 format (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is assumed to be 23:59:59 of that day.

Example:

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

​
transactionDateFrom
string

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

Example:

"2021-01-01"

​
transactionDateTo
string

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

Example:

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

The response is of type object.