Void Credit Card Entry

POST /banking/credit-card-entries/{id}/void

Group: Banking › Credit Card Entries · Operation ID: voidCreditCardEntry

Voids the credit card entry with the given identifier. Voiding cannot be undone.

Voids the credit card entry and the journal entry behind it. Voiding is not deleting: the entry, its number and the audit trail all stay, and the ledger effect is withdrawn. There is no delete endpoint for a credit card entry.

Voiding cannot be undone. A second void fails with CREDIT_CARD_ENTRY_ALREADY_VOIDED.

voidReason is required and is stored on the entry for the audit trail. An empty or whitespace-only string is refused.

The journal entry is marked voided and no reversing entry is posted. Amortization-schedule journal entries derived from it are voided too, any pending approval becomes rejected, and bank transactions matched to the entry are unmatched. Attachments and lines are left unchanged.

The posting period must be open. An entry with no entity or no posting period cannot have its journal entry voided and fails with MISSING_POSTING_CONTEXT.

The response is empty. Read the entry back with GET banking/credit-card-entries/:id to see its voided state. voidReason is not published by any read endpoint, so it appears in the audit trail rather than over the API.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "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 for the credit card entry to void.

Request body

Required, application/json: voidCreditCardEntryInput.

Field Type Required Description
voidReason string yes Why the entry is being voided. It is stored on the entry for the audit trail. An empty or whitespace-only string is refused.

Example:

{
  "voidReason": "Duplicate of CCE-2201"
}

Response

200 Success

Response headers

Errors

Code Status
NOT_FOUND 400
VOID_REASON_REQUIRED 400
CREDIT_CARD_ENTRY_ALREADY_VOIDED 400
POSTING_PERIOD_NOT_OPEN 400
MISSING_POSTING_CONTEXT 400
VOID_FAILED 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses