Undo a dividend set-off

Undoes a set-off through the app's own set-off service and posts the reversal previewed with dividend.setOff.reversePreview: send its confirmation_token and the same Idempotency-Key; if the set-off, either dividend, the dividend's figures or the journal changed since the preview the answer is 412 (preview again). The overpayment is free again; an open dividend owes that amount again, a closed one stays closed (see outstanding_amount_after). Refused with 409 dividend_set_off_in_use while a payment the set-off allowed still stands and 409 nothing_left_to_undo once it is undone; 422 period_closed while the set-off's month is closed. Requires the dividends:action OAuth scope with update_bank_accounts, dividends.pay and dividends.view.

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

Confirmed values used to undo a dividend set-off, including the confirmation token returned by dividend.setOff.reversePreview.

dividend.setOff.reverse: the preview's token, with the same Idempotency-Key.

string
required
length ≤ 8192
Headers
string
required
length ≤ 191

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

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
*/*