Deletes an outbound payment.

DELETE /accounting/outbound-payments/{id}

Group: Accounting › Outbound Payments · Operation ID: deleteOutboundPayment

The response is empty. The documents the payment settled are released back to unpaid. Only a payment that has not moved money can be deleted, one that is manually recorded, scheduled, rejected, cancelled or of unknown status. Any other status fails with PAYMENT_NOT_EDITABLE, and that payment must be voided instead with POST accounting/outbound-payments/:id/void. A payment whose posting period is closed or locked fails with POSTING_PERIOD_CLOSED. A draft payment skips both checks.

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 delete.

Response

200 Success

Response headers

Errors

Code Status
NOT_FOUND 400
PAYMENT_NOT_EDITABLE 400
POSTING_PERIOD_CLOSED 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses