GET
/
quickbooks-desktop
/
bills

Authorizations

Authorization
string
headerrequired

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}}").

Query Parameters

ids
string[]

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

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

refNumbers
string[]

Filter for specific bills 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.

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
cursor
string

The pagination token to fetch the next set of results when paginating with the limit parameter. Retrieve this value from the nextCursor field in the previous response. If omitted, the API returns the first page of results.

updatedAfter
string

Filter for bills 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.

updatedBefore
string

Filter for bills 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.

transactionDateFrom
string

Filter for bills created on or after this date, in ISO 8601 format (YYYY-MM-DD).

transactionDateTo
string

Filter for bills created on or before this date, in ISO 8601 format (YYYY-MM-DD).

vendorIds
string[]

Filter for bills received from these vendors.

accountIds
string[]

Filter for bills associated with these accounts.

refNumberContains
string

Filter for bills whose refNumber contains this substring. NOTE: If you use this parameter, you cannot also use refNumberStartsWith or refNumberEndsWith.

refNumberStartsWith
string

Filter for bills whose refNumber starts with this substring. NOTE: If you use this parameter, you cannot also use refNumberContains or refNumberEndsWith.

refNumberEndsWith
string

Filter for bills whose refNumber ends with this substring. NOTE: If you use this parameter, you cannot also use refNumberContains or refNumberStartsWith.

refNumberFrom
string

Filter for bills 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.

refNumberTo
string

Filter for bills 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.

currencyIds
string[]

Filter for bills in these currencies.

paymentStatus
enum<string>
default: all

Filter for bills that are paid, not paid, or both.

Available options:
all,
paid,
not_paid
includeLineItems
boolean
default: true

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

includeLinkedTransactions
boolean
default: false

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

Response

200 - application/json
objectType
string
required

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

Allowed value: "list"
url
string
required

The endpoint URL where this list can be accessed.

data
object[]
required

The array of bills.

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.

remainingCount
number | null
required

The number of objects remaining to be fetched.

hasMore
boolean
required

Indicates whether there are more objects to be fetched.