Preview undoing a dividend set-off

Shows the reversal dividend.setOff.reverse will post for a set-off (its id from dividend.show's set_offs), writing nothing: the same journal with debit and credit swapped, dated as the set-off, and the dividend's outstanding amount after. Refused with 409 dividend_set_off_in_use while a payment the set-off allowed still stands (undo that payment first) and 409 nothing_left_to_undo once it is undone; 422 period_closed while the set-off's month is closed. Requires Idempotency-Key (reuse it on the commit), 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

Proposed values used to preview undoing a dividend set-off without persisting changes.

dividend.setOff.reversePreview: what undoing a dividend set-off posts. Takes no body.

Headers
string
required
length ≤ 191

Required operation-specific request key. This requirement does not imply durable public API response replay.

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