Skip to main content
GET
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"

Path Parameters

​
id
string
required

The QuickBooks-assigned unique identifier of the bill to retrieve.

Maximum string length: 36
Example:

"123ABC-1234567890"

Response

200 - application/json

Returns the specified bill.

​
id
string
required

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

Example:

"123ABC-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_bill"
Example:

"qbd_bill"

​
createdAt
string
required

The date and time when this bill 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 bill 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 bill 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"

​
vendor
object | null
required

The vendor who sent this bill for goods or services purchased.

Example:
​
vendorAddress
The Address object · object | null
required

The address of the vendor who sent this bill.

​
payablesAccount
object | null
required

The Accounts-Payable (A/P) account to which this bill is assigned, used for accounts-payable tracking.

IMPORTANT: If this bill is linked to other transactions, this A/P account must match the payablesAccount used in those other transactions.

Example:
​
transactionDate
string<date>
required

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

Example:

"2024-10-01"

​
dueDate
string<date> | null
required

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

Example:

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

​
amountDue
string | null
required

The total monetary amount due for this bill, represented as a decimal string. This equals the sum of the amounts in the bill's expense lines, item lines, and item group lines. The amount due minus any credits or discounts equals the open amount.

Example:

"1000.00"

​
currency
object | null
required

The bill'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 bill'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

​
amountDueInHomeCurrency
string | null
required

The monetary amount due for this bill converted to the home currency of the QuickBooks company file. Represented as a decimal string.

Example:

"1234.56"

​
refNumber
string | null
required

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

"BILL-1234"

​
isPending
boolean | null
required

Indicates whether this bill has not been completed or is in a draft version.

Example:

false

​
terms
object | null
required

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

Example:
​
memo
string | null
required

A memo or note for this bill that appears in the Accounts-Payable register and in reports that include this bill.

Example:

"Office supplies for September"

​
salesTaxCode
object | null
required

The sales-tax code for this bill, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the vendor. This can be overridden on the bill's individual lines.

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:
​
isPaid
boolean | null
required

Indicates whether this bill has been paid in full. When true, openAmount will be 0.

Example:

false

​
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 bill'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 bills to receive this field because it is not returned by default.

​
expenseLines
The Expense Line object · object[]
required

The bill's expense lines, each representing one line in this expense.

​
itemLines
The Item Line object · object[]
required

The bill's item lines, each representing the purchase of a specific item or service.

​
itemGroupLines
The Item Group Line object · object[]
required

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

​
openAmount
string | null
required

The remaining amount still owed on this bill, represented as a decimal string. This equals the bill's amount minus any credits or discounts.

NOTE: Two rare QuickBooks Desktop behaviors can make openAmount unreliable on bills:

  • openAmount can be omitted from bill query responses.
  • A known QuickBooks Desktop bug can cause openAmount to reflect the vendor's aggregate open accounts-payable balance rather than the documented remaining balance for that individual bill.

If you need the amount currently payable on each open bill, use Conductor's /quickbooks-desktop/bills-to-pay endpoint and read bill.amountDue instead of relying on openAmount from the Conductor bills endpoint. The bills-to-pay endpoint is not a general replacement for the Conductor bills endpoint, because it is scoped to open bills and available credits for a vendor and returns bill-payment data rather than full bill records.

If you cannot use /quickbooks-desktop/bills-to-pay and must derive a fallback from Conductor bills endpoint results, re-query the bills with includeLinkedTransactions=true and compute a best-effort open amount as amountDue plus the sum of signed linkedTransactions[].amount values for all entries where linkedTransactions[].linkType is "amount".

Example:

"500.00"

​
customFields
The Custom Field object · object[]
required

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