Void a fund transfer

Operation ID: voidFundTransfer

Group: Banking › Fund Transfers

Open in the interactive reference

POST /banking/fund-transfers/{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 fund transfer. Voiding doesn't delete the transfer. The transfer, its number, and its audit trail stay. There is no endpoint to delete a fund transfer.

The transfer's journal entry is voided, and no reversing journal entry is created. Amortization schedule journal entries created from the transfer's journal entry are voided too. Any pending approval becomes rejected, and bank transactions matched to the transfer are unmatched.

The transfer's attachments and lines don't change. A void can't be undone.

The transfer's accounting period must be open in every legal entity the transfer involves. An intercompany transfer involves two legal entities, and if the period is closed in either one, the request fails with POSTING_PERIOD_NOT_OPEN.

The response is empty. To see the voided transfer, use GET banking/fund-transfers/:id, where isVoided is true. voidReason is saved on the transfer, but no endpoint returns it.

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 fund transfer you want to void. Example: "9f2c6a10-7d34-4c8e-9b21-5a0f3e6d81b7".

Request body

Required, application/json: voidFundTransferInput.

Field Type Required Description
voidReason string yes The reason the transfer is being voided. It is stored on the transfer and shown in the audit trail. An empty or whitespace-only value is refused. Example: "Duplicate of FT-881". 
{
  "voidReason": "Duplicate of FT-881"
}

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
FUND_TRANSFER_ALREADY_VOIDED 400
POSTING_PERIOD_NOT_OPEN 400
VOID_FAILED 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses