Retrieve a bill check payment

Retrieves a bill check payment by ID.

IMPORTANT: If you need to fetch multiple specific bill check payments by ID, use the list endpoint instead with the ids parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.

get/quickbooks-desktop/bill-check-payments/{id}

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the bill check payment to retrieve.

Example:123ABC-1234567890

The QuickBooks-assigned unique identifier of the bill check payment to retrieve.

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.

Response

Returns the specified 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

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

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

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.

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"
    }
  ]
}

Changes

Changed in 5 of the 46 revisions of this API.89556

Jul 2, 2026daabb801a1731See the full diff
- ●
  added the new unknown enum value to the // response property for the response status
  response-property-enum-value-added
May 2, 20261de07095c4b71See the full diff
- ●
  for the path request parameter id, the maxLength was set to 36
  request-parameter-max-length-set
Apr 20, 202610d4e9ebd1df3110See the full diff
- ▲
  response property amountInHomeCurrency list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property appliedToTransactions/items/amount list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property appliedToTransactions/items/balanceRemaining list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property appliedToTransactions/items/discountAmount list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property appliedToTransactions/items/linkedTransactions/items/amount list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property appliedToTransactions/items/linkedTransactions/items/linkType list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property appliedToTransactions/items/linkedTransactions/items/refNumber list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property appliedToTransactions/items/refNumber list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property appliedToTransactions/items/transactionDate list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property bankAccount/fullName list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property bankAccount/id list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property exchangeRate list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property externalId list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property isQueuedForPrint list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property memo list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property refNumber list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  the // response's property type changed from object null to no type for status
  response-property-type-changed
- ▲
  the // response's property type changed from object null to no type for status
  response-property-type-changed
- ▲
  the response's property type changed from object null to no type for status
  response-property-type-changed
- ▲
  the response's property type changed from object null to no type for status
  response-property-type-changed
- ▲
  the response's property type changed from object null to no type for status
  response-property-type-changed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ○
  added subschema #2 to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the // response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the // response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  removed the amount enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the quantity enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the undefined enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed subschema #2 from the response property oneOf list for the response status
  response-property-one-of-removed
Apr 20, 20268e0b7df2044d27334See the full diff
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property //// became nullable for the status
  response-property-became-nullable
- ▲
  the response property //// became nullable for the status
  response-property-became-nullable
- ▲
  the response property //// became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  added subschema #2 to the response property oneOf list for the response status
  response-property-one-of-added
- ▲
  the // response's property type changed from no type to object null for status
  response-property-type-changed
- ▲
  the // response's property type changed from no type to object null for status
  response-property-type-changed
- ▲
  the response's property type changed from no type to object null for status
  response-property-type-changed
- ▲
  the response's property type changed from no type to object null for status
  response-property-type-changed
- ▲
  the response's property type changed from no type to object null for status
  response-property-type-changed
- ●
  added the new amount enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new quantity enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new undefined enum value to the //// response property for the response status
  response-property-enum-value-added
- ○
  removed subschema #2 from the response property anyOf list for the response status
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 from the // response property anyOf list for the response status
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 from the // response property anyOf list for the response status
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 from the response property anyOf list for the response status
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 from the response property anyOf list for the response status
  response-property-any-of-removed
- ○
  removed subschema #1 subschema #2 from the response property anyOf list for the response status
  response-property-any-of-removed
- ○
  response property amountInHomeCurrency list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property appliedToTransactions/items/amount list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property appliedToTransactions/items/balanceRemaining list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property appliedToTransactions/items/discountAmount list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property appliedToTransactions/items/linkedTransactions/items/amount list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property appliedToTransactions/items/linkedTransactions/items/linkType list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property appliedToTransactions/items/linkedTransactions/items/refNumber list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property appliedToTransactions/items/refNumber list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property appliedToTransactions/items/transactionDate list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property bankAccount/fullName list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property bankAccount/id list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property exchangeRate list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property externalId list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property isQueuedForPrint list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property memo list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  response property refNumber list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  the //// response's property pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ was removed for the status
  response-property-pattern-removed
- ○
  the response's property pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ was removed for the status
  response-property-pattern-removed
- ○
  added the required property /// to the response with the status
  response-required-property-added
- ○
  added the required property /// to the response with the status
  response-required-property-added
- ○
  added the required property /// to the response with the status
  response-required-property-added
- ○
  added the required property /// to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
Apr 20, 20265f832f6956753112See the full diff
- ▲
  response property amountInHomeCurrency list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property appliedToTransactions/items/amount list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property appliedToTransactions/items/balanceRemaining list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property appliedToTransactions/items/discountAmount list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property appliedToTransactions/items/linkedTransactions/items/amount list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property appliedToTransactions/items/linkedTransactions/items/linkType list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property appliedToTransactions/items/linkedTransactions/items/refNumber list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property appliedToTransactions/items/refNumber list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property appliedToTransactions/items/transactionDate list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property bankAccount/fullName list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property bankAccount/id list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property exchangeRate list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property externalId list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property isQueuedForPrint list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property memo list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property refNumber list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  the // response's property type changed from object null to no type for status
  response-property-type-changed
- ▲
  the // response's property type changed from object null to no type for status
  response-property-type-changed
- ▲
  the response's property type changed from object null to no type for status
  response-property-type-changed
- ▲
  the response's property type changed from object null to no type for status
  response-property-type-changed
- ▲
  the response's property type changed from object null to no type for status
  response-property-type-changed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ○
  added subschema #2 to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the // response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the // response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  removed the amount enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the quantity enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed the undefined enum value from the //// response property for the response status
  response-property-enum-value-removed
- ○
  removed subschema #2 from the response property oneOf list for the response status
  response-property-one-of-removed
- ○
  the //// response's property pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ was added for the status
  response-property-pattern-added
- ○
  the response's property pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ was added for the status
  response-property-pattern-added

Full history