List all bill check payments

QuickBooks Desktop API

Welcome to Conductor's new QuickBooks Desktop API (alpha)
Accounts
Bill Check Payments
- The Bill Check Payment object
- POST
  Create a bill check payment
- POST
  Update a bill check payment
- GET
  Retrieve a bill check payment
- GET
  List all bill check payments
Bill Credit Card Payments
Bills
Checks
Classes
Credit Card Charges
Credit Card Credits
Customers
Date-Driven Terms
Estimates
Inventory Assembly Items
Inventory Items
Inventory Sites
Invoices
Journal Entries
Non-Inventory Items
Purchase Orders
Receive-Payments
Sales Orders
Sales Receipts
Sales-Tax Codes
Sales-Tax Items
Service Items
Standard Terms
Transfers
Vendors

GET

quickbooks-desktop

bill-check-payments

ids

array

refNumbers

array

limit

integer

cursor

string

updatedAfter

string

updatedBefore

string

transactionDateFrom

string

transactionDateTo

string

vendorIds

array

accountIds

array

refNumberContains

string

refNumberStartsWith

string

refNumberEndsWith

string

refNumberFrom

string

refNumberTo

string

currencyIds

array

includeLineItems

boolean

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 bill check payments 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 bill check payments 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 bill check payments 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 bill check payments 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 bill check payments created on or after this date, in ISO 8601 format (YYYY-MM-DD).

transactionDateTo

string

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

vendorIds

string[]

Filter for bill check payments sent to these vendors. These are the vendors who sent the bills paid by these checks.

accountIds

string[]

Filter for bill check payments associated with these accounts.

refNumberContains

string

Filter for bill check payments whose refNumber contains this substring. For checks, this is the check number. NOTE: If you use this parameter, you cannot also use refNumberStartsWith or refNumberEndsWith.

refNumberStartsWith

string

Filter for bill check payments whose refNumber starts with this substring. For checks, this is the check number. NOTE: If you use this parameter, you cannot also use refNumberContains or refNumberEndsWith.

refNumberEndsWith

string

Filter for bill check payments whose refNumber ends with this substring. For checks, this is the check number. NOTE: If you use this parameter, you cannot also use refNumberContains or refNumberStartsWith.

refNumberFrom

string

Filter for bill check payments 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 bill check payments 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 bill check payments in these currencies.

includeLineItems

boolean

default: true

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

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 bill check payments.

data.id

string

required

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

data.objectType

string

required

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

Allowed value: "qbd_bill_check_payment"

data.createdAt

string

required

The date and time when this bill check payment was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

data.updatedAt

string

required

The date and time when this bill check payment was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

data.revisionNumber

string

required

The current revision number of this bill check payment 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.

data.vendor

object | null

required

The vendor who sent the bill(s) that this bill check payment is paying and who will receive this payment.

IMPORTANT: This vendor must match the vendor on the bill(s) specified in applyToTransactions.

data.payablesAccount

object | null

required

The Accounts-Payable (A/P) account to which this bill check payment is assigned, used to track the amount owed. If not specified, QuickBooks Desktop will use its default A/P account.

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

data.transactionDate

string

required

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

data.bankAccount

object

required

The bank account from which the funds are being drawn for this bill check payment; e.g., Checking or Savings. This bill check payment will decrease the balance of this account.

data.amount

string | null

required

The monetary amount of this bill check payment, represented as a decimal string.

data.currency

object | null

required

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

data.exchangeRate

number | null

required

The market exchange rate between this bill check payment'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).

data.amountInHomeCurrency

string | null

required

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

data.refNumber

string | null

required

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

IMPORTANT: For checks, this field is the check number.

data.memo

string | null

required

A memo or note for this bill check payment.

data.address

object | null

required

The address that is printed on the bill check payment.

data.isQueuedForPrint

boolean | null

required

Indicates whether this bill check payment is included in the queue of documents for QuickBooks to print.

data.externalId

string | null

required

A globally unique identifier (GUID) you can provide for tracking this object in your external system.

IMPORTANT: Must be formatted as a valid GUID; otherwise, QuickBooks will return an error. This field is immutable and can only be set during object creation.

data.appliedToTransactions

object[]

required

The bill(s) paid by this bill check payment.

data.appliedToTransactions.transactionId

string

required

The ID of the receivable transaction to which this payment is applied.

data.appliedToTransactions.transactionType

enum<string>

required

The type of transaction for this receivable 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

data.appliedToTransactions.transactionDate

string

required

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

data.appliedToTransactions.refNumber

string | null

required

The case-sensitive user-defined reference number for this receivable 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.

data.appliedToTransactions.balanceRemaining

string | null

required

The outstanding balance of this receivable transaction after applying any credits or payments. Represented as a decimal string.

data.appliedToTransactions.amount

string | null

required

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

data.appliedToTransactions.discountAmount

string | null

required

The monetary amount by which to reduce the receivable transaction's receivable amount, represented as a decimal string.

data.appliedToTransactions.discountAccount

object | null

required

The financial account used to track this receivable transaction's discount.

data.appliedToTransactions.discountClass

object | null

required

The class used to track this receivable transaction's discount.

data.appliedToTransactions.linkedTransactions

object[]

required

The receivable transaction'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 receivable transactions to receive this field because it is not returned by default.

data.customFields

object[]

required

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

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.

Retrieve a bill check payment The Bill Credit Card Payment object