Sign in

Void a bill check payment

Voids a bill check payment by setting its amount to zero while keeping a record of it in QuickBooks. The void will fail if the bill check payment is currently in use or has any linked transactions that are in use.

post/quickbooks-desktop/bill-check-payments/{id}/void

Path parameters

idstring required

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

Example:123ABC-1234567890

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

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 a confirmation of the void with the ID of the voided bill check payment.

idstring required

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

objectType'qbd_bill_check_payment' required

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

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

refNumberstring nullable required

The case-sensitive user-defined reference number of the voided bill check payment.

voidedboolean required

Indicates whether the bill check payment was voided.

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",
  "refNumber": "CHECK-1234",
  "voided": true
}

Changes

Changed in 3 of the 46 revisions of this API.111