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

Body

application/json
​
bankAccountId
string
required

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.

Maximum string length: 36
Example:

"80000001-1234567890"

​
transactionDate
string<date>
required

The date written on this check, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-10-01"

​
payeeId
string

The person or company who will receive this check.

Maximum string length: 36
Example:

"80000001-1234567890"

​
refNumber
string

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. When left blank in this create request, this field will be left blank in QuickBooks (i.e., it does not auto-increment).

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

Maximum length: 11 characters.

Maximum string length: 11
Example:

"CHECK-1234"

​
memo
string

The memo that is printed on this check.

Maximum length: 4095 characters.

Maximum string length: 4095
Example:

"Payment for office supplies - Invoice INV-1234"

​
address
object

The address that is printed on the check.

​
isQueuedForPrint
boolean

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

Example:

true

​
salesTaxCodeId
string

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 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.

Maximum string length: 36
Example:

"80000001-1234567890"

​
exchangeRate
number

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

Example:

1.2345

​
externalId
string<uuid>

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.

IMPORTANT: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.

Example:

"12345678-abcd-1234-abcd-1234567890ab"

​
applyToTransactions
object[]

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.

Minimum array length: 1
​
expenseLines
object[]

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

Minimum array length: 1
​
itemLines
object[]

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

Minimum array length: 1
​
itemGroupLines
object[]

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.

Minimum array length: 1

Response

200 - application/json

Returns the newly created check.

​
id
string
required

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

Example:

"123ABC-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_check"
Example:

"qbd_check"

​
createdAt
string
required

The date and time when this check 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 check 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 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.

Example:

"1721172183"

​
bankAccount
object
required

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.

Example:
​
payee
object | null
required

The person or company who will receive this check.

Example:
​
refNumber
string | null
required

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.

Example:

"CHECK-1234"

​
transactionDate
string<date>
required

The date written on this check, in ISO 8601 format (YYYY-MM-DD).

Example:

"2024-10-01"

​
amount
string
required

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.

Example:

"1000.00"

​
currency
object | null
required

The check'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 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).

Example:

1.2345

​
amountInHomeCurrency
string | null
required

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

Example:

"1234.56"

​
memo
string | null
required

The memo that is printed on this check.

Example:

"Payment for office supplies - Invoice INV-1234"

​
address
The Address object · object | null
required

The address that is printed on the check.

​
isPending
boolean | null
required

Indicates whether this check has not been completed.

Example:

false

​
isQueuedForPrint
boolean | null
required

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

Example:

true

​
salesTaxCode
object | null
required

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 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:
​
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 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.

​
expenseLines
The Expense Line object · object[]
required

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

​
itemLines
The Item Line object · object[]
required

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

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

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.

​
customFields
The Custom Field object · object[]
required

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