Update a check
Updates an existing check.
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 update.
Body
The current QuickBooks-assigned revision number of the check object you are updating, which you can get by fetching the object first. Provide the most recent revisionNumber
to ensure you're working with the latest data; otherwise, the update will return an error.
The address that is printed on the check.
Transactions to be paid by this check. This will create a link between this check and the specified transactions.
IMPORTANT: By default, QuickBooks will not return any information about the linked transactions in this endpoint's response even when this request is successful. To see the transactions linked via this field, refetch the check and check the linkedTransactions
response field. If fetching a list of checks, you must also specify the parameter includeLinkedTransactions=true
to see the linkedTransactions
response field.
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.
When true
, removes all existing expense lines associated with this check. To modify or add individual expense lines, use the field expenseLines
instead.
When true
, removes all existing item lines associated with this check. To modify or add individual item lines, use the field itemLines
instead.
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 check's expense lines, each representing one line in this expense.
IMPORTANT:
-
Including this array in your update request will REPLACE all existing expense lines for the check with this array. To keep any existing expense lines, you must include them in this array even if they have not changed. Any expense lines not included will be removed.
-
To add a new expense line, include it here with the
id
field set to-1
. -
If you do not wish to modify any expense lines, omit this field entirely to keep them unchanged.
Indicates whether this check is included in the queue of documents for QuickBooks to print.
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.
IMPORTANT:
-
Including this array in your update request will REPLACE all existing item group lines for the check with this array. To keep any existing item group lines, you must include them in this array even if they have not changed. Any item group lines not included will be removed.
-
To add a new item group line, include it here with the
id
field set to-1
. -
If you do not wish to modify any item group lines, omit this field entirely to keep them unchanged.
The check's item lines, each representing the purchase of a specific item or service.
IMPORTANT:
-
Including this array in your update request will REPLACE all existing item lines for the check with this array. To keep any existing item lines, you must include them in this array even if they have not changed. Any item lines not included will be removed.
-
To add a new item line, include it here with the
id
field set to-1
. -
If you do not wish to modify any item lines, omit this field entirely to keep them unchanged.
The memo that is printed on this check.
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 sales-tax code for this check, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the payee. This can be overridden on the check's individual lines.
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.
The date written on this check, in ISO 8601 format (YYYY-MM-DD).
Response
The address that is printed on the check.
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 monetary amount of this check converted to the home currency of the QuickBooks company file. Represented as a decimal string.
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 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 check's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.
The custom fields for the check object, added as user-defined data extensions, not included in the standard QuickBooks object.
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 check's expense lines, each representing one line in this expense.
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.
The unique identifier assigned by QuickBooks to this check. This ID is unique across all transaction types.
Indicates whether this check has not been completed.
Indicates whether this check is included in the queue of documents for QuickBooks to print.
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 check's item lines, each representing the purchase of a specific item or service.
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 memo that is printed on this check.
The type of object. This value is always "qbd_check"
.
"qbd_check"
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 current QuickBooks-assigned revision number of this check 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.
The sales-tax code for this check, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the payee. This can be overridden on the check's individual lines.
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.
The date written on this check, in ISO 8601 format (YYYY-MM-DD).
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.