Retrieve a check
Retrieves a check by ID.
Authorizations
Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}"
).
Headers
The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}"
).
Path Parameters
The QuickBooks-assigned unique identifier of the check to retrieve.
Response
A check is a transaction that represents a paper check.
The unique identifier assigned by QuickBooks to this check. This ID is unique across all transaction types.
The type of object. This value is always "qbd_check"
.
"qbd_check"
The date and time when this check 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.
The date and time when this check 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.
The current revision number of this check, 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.
The bank account from which the funds are being drawn for this check; e.g., Checking or Savings. This check will decrease the balance of this account.
The person or company who will receive this check.
The case-sensitive user-defined reference number for this check, 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.
The date written on this check, in ISO 8601 format (YYYY-MM-DD).
The total monetary amount of this check, represented as a decimal string. This equals the sum of the amounts in the check's expense lines, item lines, and item group lines.
The check's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.
The market exchange rate between this check'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).
The total amount for this check converted to the home currency of the QuickBooks company file. Represented as a decimal string.
The memo that is printed on this check.
The address that is printed on the check.
Indicates whether this check is pending approval or completion. If true
, the check is in a draft state and has not been finalized.
Indicates whether this check is included in the queue of documents for QuickBooks to print.
The sales-tax code associated with this check, determining whether transactions in this account are taxable or non-taxable. It's used to assign a default tax status to all transactions for this check. 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.
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.
The check'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 checks to receive this field because it is not returned by default.
The check's expense lines, each representing one line in this expense.
The check's item lines, each representing the purchase of a specific item or service.
The check's item group lines, each representing a predefined set of items bundled together because they are commonly purchased together or grouped for faster entry.
The custom fields for the check object, added as user-defined data extensions, not included in the standard QuickBooks object.