Declare a dividend

Declares the draft through the app's own dividend service and posts exactly the previewed journal; the resolution is generated afterwards. Send the preview's confirmation_token, the same Idempotency-Key and the preview's etag as If-Match; if the dividend or its figures changed since the preview the answer is 412 (preview again). Pay it by matching each bank line with reconciliationMatch.create (candidate_type dividend): a declared dividend takes instalments up to what is outstanding (a single payment may exceed the net by no more than the withholding). Requires the dividends:action OAuth scope and dividends.create.

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 declare a dividend, including the confirmation token returned by dividend.declarePreview.

string
required
length ≤ 8192

The token from dividend.declarePreview, sent with the same Idempotency-Key and the preview's etag as If-Match.

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