Voids an outbound payment.

POST /accounting/outbound-payments/{id}/void

Group: Accounting › Outbound Payments · Operation ID: voidOutboundPayment

Voids one outbound payment and the journal entry behind it, so the money movement is withdrawn from the ledger. Void and delete cover different states. Delete accepts a payment that has not been executed, one that is manuallyRecorded, scheduled, unknown, rejected or cancelled. Void covers a payment that has been executed, one that is successful, partiallySuccessful, manuallyRecorded or processing. manuallyRecorded is in both. Any other status fails with PAYMENT_NOT_VOIDABLE. Voiding is terminal, so a second void fails with PAYMENT_ALREADY_VOIDED. A voidReason is required and is stored on the payment for an auditor to read, so an empty or whitespace-only string is refused. The applications the payment made are released, so the bills or expense reports it paid become open again. The posting period must be open. The response is empty. Read the payment with GET accounting/outbound-payments/:id to see its voided state.

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 outbound payment to void.

Request body

Required, application/json: voidOutboundPaymentInput.

Field	Type	Required	Description
`voidReason`	string	yes	Why the payment is being voided. It is stored on the payment and shown in the audit trail, and an empty or whitespace-only string is refused.

Example:

{
  "voidReason": "Paid the wrong vendor"
}

Response

200 Success

Response headers

Idempotency-Replayed — Present and true only when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent as false.

Errors

Code	Status
`NOT_FOUND`	400
`VOID_REASON_REQUIRED`	400
`PAYMENT_ALREADY_VOIDED`	400
`PAYMENT_NOT_VOIDABLE`	400
`POSTING_PERIOD_CLOSED`	400
`VOID_FAILED`	400
`IDEMPOTENCY_KEY_CONFLICT`	409
`IDEMPOTENCY_PAYLOAD_MISMATCH`	422

Statuses

400 — Invalid request or business failure. Codes: NOT_FOUND, VOID_REASON_REQUIRED, PAYMENT_ALREADY_VOIDED, PAYMENT_NOT_VOIDABLE, POSTING_PERIOD_CLOSED, VOID_FAILED
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
409 — The Idempotency-Key is still being processed by another request.
422 — The Idempotency-Key was already used with a different request payload.
429 — Too many requests
500 — Internal server error