Use an earlier dividend overpayment

Posts the set-off previewed with dividend.setOff.preview through the app's own set-off service: the same body, the preview's confirmation_token, the same Idempotency-Key and the bank line's ETag as If-Match; if the line, either dividend or the journal changed since the preview the answer is 412 (preview again). Then pay the rest of the dividend from the line as the app does. The answer is the set-off (id, undo_handle), the journal it posted and both dividends' figures after. Refusals are those of the preview. Undo it with dividend.setOff.reverse. 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 use an earlier dividend overpayment, including the confirmation token returned by dividend.setOff.preview.

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

uuid
required

The dividend it is used on: declared and paid in parts.

uuid
required

The earlier dividend of the same shareholders that was paid too much.

number
required
≤ 999999999999

At most what it was paid too much and what is still unpaid here after the line.

string
required
length ≤ 8192
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.

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