Sign in

v48

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-262621423.8 MB

Create a check

Creates a non-payroll check from a bank account. QuickBooks uses this request for direct expense disbursements; to pay vendor bills or payroll liabilities you must use the dedicated bill-payment or payroll transactions instead.

post/quickbooks-desktop/checks

Headers

Conductor-End-User-Idstring required

The ID of the End-User to receive this request.

Example:end_usr_1234567abcdefg

The ID of the End-User to receive this request.

Request body

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

payeeIdstring

The person or company who will receive this check.

refNumberstring

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.

transactionDatestring date required

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

memostring

The memo that is printed on this check.

isQueuedForPrintboolean

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

salesTaxCodeIdstring

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.

exchangeRatenumber

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

externalIdstring 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 request

{
  "bankAccountId": "80000001-1234567890",
  "payeeId": "80000001-1234567890",
  "refNumber": "CHECK-1234",
  "transactionDate": "2024-10-01",
  "memo": "Payment for office supplies - Invoice INV-1234",
  "address": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "isQueuedForPrint": true,
  "salesTaxCodeId": "80000001-1234567890",
  "exchangeRate": 1.2345,
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "applyToTransactions": [
    {
      "transactionId": "123ABC-1234567890",
      "amount": "1000.00"
    }
  ],
  "expenseLines": [
    {
      "accountId": "80000001-1234567890",
      "amount": "1000.00",
      "memo": "New office chair",
      "payeeId": "80000001-1234567890",
      "classId": "80000001-1234567890",
      "salesTaxCodeId": "80000001-1234567890",
      "billingStatus": "billable",
      "salesRepresentativeId": "80000001-1234567890",
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "value": "Premium"
        }
      ]
    }
  ],
  "itemLines": [
    {
      "itemId": "80000001-1234567890",
      "inventorySiteId": "80000001-1234567890",
      "inventorySiteLocationId": "80000001-1234567890",
      "serialNumber": "SN1234567890",
      "lotNumber": "LOT2023-001",
      "expirationDate": "2025-12-31",
      "description": "High-quality widget with custom engraving",
      "quantity": 5,
      "unitOfMeasure": "Each",
      "cost": "1000.00",
      "amount": "1000.00",
      "customerId": "80000001-1234567890",
      "classId": "80000001-1234567890",
      "salesTaxCodeId": "80000001-1234567890",
      "billingStatus": "billable",
      "overrideItemAccountId": "80000001-1234567890",
      "linkToTransactionLine": {
        "transactionId": "123ABC-1234567890",
        "transactionLineId": "456DEF-1234567890"
      },
      "salesRepresentativeId": "80000001-1234567890",
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "value": "Premium"
        }
      ]
    }
  ],
  "itemGroupLines": [
    {
      "itemGroupId": "80000001-1234567890",
      "quantity": 5,
      "unitOfMeasure": "Each",
      "inventorySiteId": "80000001-1234567890",
      "inventorySiteLocationId": "80000001-1234567890",
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "value": "Premium"
        }
      ]
    }
  ]
}

Response

Returns the newly created check.

idstring required

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

objectType'qbd_check' required

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

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

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

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

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

transactionDatestring date required

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

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

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

amountInHomeCurrencystring nullable required

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

memostring nullable required

The memo that is printed on this check.

isPendingboolean nullable required

Indicates whether this check has not been completed.

isQueuedForPrintboolean nullable required

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

externalIdstring nullable 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 response

{
  "id": "123ABC-1234567890",
  "objectType": "qbd_check",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "bankAccount": {
    "id": "80000001-1234567890",
    "fullName": "Checking"
  },
  "payee": {
    "id": "80000001-1234567890",
    "fullName": "Corporate:Sales:Marketing"
  },
  "refNumber": "CHECK-1234",
  "transactionDate": "2024-10-01",
  "amount": "1000.00",
  "currency": {
    "id": "80000001-1234567890",
    "fullName": "USD"
  },
  "exchangeRate": 1.2345,
  "amountInHomeCurrency": "1234.56",
  "memo": "Payment for office supplies - Invoice INV-1234",
  "address": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "isQueuedForPrint": true,
  "salesTaxCode": {
    "id": "80000001-1234567890",
    "fullName": "Non"
  },
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "linkedTransactions": [
    {
      "id": "123ABC-1234567890",
      "objectType": "qbd_linked_transaction",
      "transactionType": "invoice",
      "transactionDate": "2024-10-01",
      "refNumber": "LINK-1234",
      "linkType": "amount",
      "amount": "1000.00"
    }
  ],
  "expenseLines": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_expense_line",
      "account": {
        "id": "80000001-1234567890",
        "fullName": "Expenses:Office Supplies"
      },
      "amount": "1000.00",
      "memo": "New office chair",
      "payee": {
        "id": "80000001-1234567890",
        "fullName": "Acme Corporation"
      },
      "class": {
        "id": "80000001-1234567890",
        "fullName": "Office Supplies"
      },
      "salesTaxCode": {
        "id": "80000001-1234567890",
        "fullName": "Non"
      },
      "billingStatus": "billable",
      "salesRepresentative": {
        "id": "80000001-1234567890",
        "fullName": "Jane Doe"
      },
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "itemLines": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_item_line",
      "item": {
        "id": "80000001-1234567890",
        "fullName": "Widget A"
      },
      "inventorySite": {
        "id": "80000001-1234567890",
        "fullName": "Main Warehouse"
      },
      "inventorySiteLocation": {
        "id": "80000001-1234567890",
        "fullName": "Aisle 3, Shelf B"
      },
      "serialNumber": "SN1234567890",
      "lotNumber": "LOT2023-001",
      "expirationDate": "2025-12-31",
      "description": "High-quality widget with custom engraving",
      "quantity": 5,
      "unitOfMeasure": "Each",
      "overrideUnitOfMeasureSet": {
        "id": "80000001-1234567890",
        "fullName": "Volume Units"
      },
      "cost": "1000.00",
      "amount": "1000.00",
      "customer": {
        "id": "80000001-1234567890",
        "fullName": "Acme Corporation"
      },
      "class": {
        "id": "80000001-1234567890",
        "fullName": "Installation:Residential"
      },
      "salesTaxCode": {
        "id": "80000001-1234567890",
        "fullName": "Non"
      },
      "billingStatus": "billable",
      "salesRepresentative": {
        "id": "80000001-1234567890",
        "fullName": "Jane Doe"
      },
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "itemGroupLines": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_item_group_line",
      "itemGroup": {
        "id": "80000001-1234567890",
        "fullName": "Office Supplies Bundle"
      },
      "description": "Standard widget bulk package",
      "quantity": 5,
      "unitOfMeasure": "Each",
      "overrideUnitOfMeasureSet": {
        "id": "80000001-1234567890",
        "fullName": "Volume Units"
      },
      "totalAmount": "1000.00",
      "itemLines": [
        {
          "id": "456DEF-1234567890",
          "objectType": "qbd_item_line",
          "item": {
            "id": "80000001-1234567890",
            "fullName": "Widget A"
          },
          "inventorySite": {
            "id": "80000001-1234567890",
            "fullName": "Main Warehouse"
          },
          "inventorySiteLocation": {
            "id": "80000001-1234567890",
            "fullName": "Aisle 3, Shelf B"
          },
          "serialNumber": "SN1234567890",
          "lotNumber": "LOT2023-001",
          "expirationDate": "2025-12-31",
          "description": "High-quality widget with custom engraving",
          "quantity": 5,
          "unitOfMeasure": "Each",
          "overrideUnitOfMeasureSet": {
            "id": "80000001-1234567890",
            "fullName": "Volume Units"
          },
          "cost": "1000.00",
          "amount": "1000.00",
          "customer": {
            "id": "80000001-1234567890",
            "fullName": "Acme Corporation"
          },
          "class": {
            "id": "80000001-1234567890",
            "fullName": "Installation:Residential"
          },
          "salesTaxCode": {
            "id": "80000001-1234567890",
            "fullName": "Non"
          },
          "billingStatus": "billable",
          "salesRepresentative": {
            "id": "80000001-1234567890",
            "fullName": "Jane Doe"
          },
          "customFields": [
            {
              "ownerId": "0",
              "name": "Customer Rating",
              "type": "string_1024_type",
              "value": "Premium"
            }
          ]
        }
      ],
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}