v48

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

Create a bill check payment

Records a check payment against one vendor’s open bills. Each bill allocation must include a payment amount, discount, or vendor credit, and the accounts payable account has to match the one used on the bills you’re closing.

post/quickbooks-desktop/bill-check-payments

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

vendorIdstring 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; otherwise, QuickBooks will say the transactionId in applyToTransactions "does not exist".

payablesAccountIdstring

The Accounts-Payable (A/P) account to which this bill check payment is assigned, used for accounts-payable tracking. If omitted, QuickBooks Desktop uses the default A/P account configured in the company file.

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

transactionDatestring date required

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

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

isQueuedForPrintboolean

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

refNumberstring

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

memostring

A memo or note for this bill check payment.

exchangeRatenumber

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

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

{
  "vendorId": "80000001-1234567890",
  "payablesAccountId": "80000001-1234567890",
  "transactionDate": "2024-10-01",
  "bankAccountId": "80000001-1234567890",
  "isQueuedForPrint": true,
  "refNumber": "CHECK-1234",
  "memo": "Payment for office supplies - Invoice INV-1234",
  "exchangeRate": 1.2345,
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "applyToTransactions": [
    {
      "transactionId": "123ABC-1234567890",
      "paymentAmount": "25.00",
      "applyCredits": [
        {
          "creditTransactionId": "ABCDEF-1234567890",
          "appliedAmount": "100.00"
        }
      ],
      "discountAmount": "50.00",
      "discountAccountId": "80000001-1234567890",
      "discountClassId": "80000001-1234567890"
    }
  ]
}

Response

Returns the newly created bill check payment.

idstring required

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

objectType'qbd_bill_check_payment' required

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

createdAtstring required

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

transactionDatestring date required

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

amountstring required

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

exchangeRatenumber nullable required

amountInHomeCurrencystring nullable required

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

refNumberstring nullable required

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

memostring nullable required

A memo or note for this bill check payment.

isQueuedForPrintboolean nullable required

Indicates whether this bill check payment 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_bill_check_payment",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "vendor": {
    "id": "80000001-1234567890",
    "fullName": "Suppliers:ABC Office Supplies"
  },
  "payablesAccount": {
    "id": "80000001-1234567890",
    "fullName": "Accounts-Payable"
  },
  "transactionDate": "2024-10-01",
  "bankAccount": {
    "id": "80000001-1234567890",
    "fullName": "Checking"
  },
  "amount": "1000.00",
  "currency": {
    "id": "80000001-1234567890",
    "fullName": "USD"
  },
  "exchangeRate": 1.2345,
  "amountInHomeCurrency": "1234.56",
  "refNumber": "CHECK-1234",
  "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,
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "appliedToTransactions": [
    {
      "transactionId": "123ABC-1234567890",
      "transactionType": "invoice",
      "transactionDate": "2024-10-01",
      "refNumber": "TXN-1234",
      "balanceRemaining": "100.00",
      "amount": "1000.00",
      "discountAmount": "50.00",
      "discountAccount": {
        "id": "80000001-1234567890",
        "fullName": "Discount Account"
      },
      "discountClass": {
        "id": "80000001-1234567890",
        "fullName": "Discounts"
      },
      "linkedTransactions": [
        {
          "id": "123ABC-1234567890",
          "objectType": "qbd_linked_transaction",
          "transactionType": "invoice",
          "transactionDate": "2024-10-01",
          "refNumber": "LINK-1234",
          "linkType": "amount",
          "amount": "1000.00"
        }
      ]
    }
  ],
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}