Void an outbound payment

Operation ID: voidOutboundPayment

Group: Accounting › Outbound Payments

Open in the interactive reference

POST /accounting/outbound-payments/{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 an outbound payment. The payment's journal entry is voided with it, and the vendor bills or expense reports it paid become open again.

Only a payment whose status is 'successful', 'partiallySuccessful', 'manuallyRecorded', or 'processing' can be voided. For a payment that is already voided, the request fails with PAYMENT_ALREADY_VOIDED, and for any other status with PAYMENT_NOT_VOIDABLE. The accounting period of the payment's journal entry must be open for the payment's legal entity.

A payment that hasn't been executed can be deleted with DELETE accounting/outbound-payments/:id instead, and a 'manuallyRecorded' payment can be either voided or deleted.

The response is empty. To see the voided payment, use GET accounting/outbound-payments/:id.

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 outbound payment you want to void. Example: "3f1a8c25-9d47-4e60-b892-0c5a7e3b1d84".

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: "Paid the wrong vendor". 
{
  "voidReason": "Paid the wrong vendor"
}

Response

200 Success

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

Response headers

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