Undo bank transaction

Undoes one booking (bookingId) of a bank transaction as the app's Undo does: a bill or invoice payment, or a direct categorization. The line is open to reconcile again; a booking that needs a manual prior-period adjustment is refused with 422. A booking of a payment over several bills or invoices (its root, or one document's booking, as reconciliationMatch.create with candidates or the app's multi-document payment books it) is refused with 422 match_is_part_of_payment: reverse the whole payment with reconciliationMatch.unmatch (preview, then commit) and the match id in error.fields.match_id. Requires Idempotency-Key and If-Match with the bank transaction's latest ETag (412 when stale). This action reverses or offsets existing accounting effects. Requires the bank-transactions:action OAuth scope with update_bank_accounts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Body Params

Fields accepted to undo bank transaction. The schema identifies required and optional values.

Headers
string
required
length ≤ 191

Required unique key whose request hash and terminal response are stored durably for 24 hours.

string

Required. ETag from the latest representation; a stale value returns 412 precondition_failed. Send this header, not the standard If-Match: some HTTP intermediaries evaluate a standard If-Match themselves and can answer 412 even though the change was applied. Never send both; both with different ETags returns 400 conflicting_precondition_headers.

string
deprecated

Accepted with the same value and meaning as Cybooks-If-Match, but do not send it: an intermediary can answer 412 to it after the change was applied. Send Cybooks-If-Match instead.

string
enum

Optional. return=minimal answers data as id, version, etag, reconciliation_state and booked_transaction_ids only, with Preference-Applied: return=minimal. A replay of the same Idempotency-Key is answered by the preference the replay sends.

Allowed:
Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*