Void a vendor bill

Operation ID: voidVendorBill

Group: Accounting › Vendor Bills

Open in the interactive reference

POST /accounting/vendor-bills/{id}/void

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Voids a vendor bill. Backs the vendor bill out of the general ledger by voiding its journal entry. No reversing journal entry is created. Voiding isn't deleting: the bill keeps its number and its audit trail.

Only an approved bill with a journal entry and no payments can be voided, and its accounting period must be open. To back a bill out on a date you choose, for example when its period is closed, use POST accounting/vendor-bills/:id/reverse.

A voided bill can't be approved, rejected, voided again or reversed. The response is empty.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier of the vendor bill you want to void. Example: "3f1a8c25-9d47-4e60-b892-0c5a7e3b1d84".

Request body

Required, application/json: voidVendorBillInput.

Field Type Required Description
voidReason string yes Why the bill is being voided. Stored on the bill and shown in the audit trail. An empty or whitespace-only string is refused. Example: "Duplicate of VB-295012". 
{
  "voidReason": "Duplicate of VB-295012"
}

Response

200 Success

{
  "data": {},
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
NOT_FOUND 400
BILL_NOT_APPROVED 400
BILL_ALREADY_VOIDED 400
BILL_PAID 400
WITHHOLDING_REMITTED 400
BILL_NOT_POSTED 400
POSTING_PERIOD_CLOSED 400
BILL_ALREADY_REVERSED 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses