Preview a dividend declaration

Rates every shareholder at the declaration date (the tax point) and shows the declaration journal the commit will post: Dr Dividend disbursed (gross), Cr Dividends payable (net), Cr SDC and GeSY withholding payable; the remittance deadline, the distributable profit (a warning, never a block) and the confirmation token. Refuses with period_locked when the declaration date is closed, dividend_not_draft when the dividend is no longer a draft and dividend_already_paid for an interim already paid in one event. Writes nothing. Requires Idempotency-Key (reuse it on the commit) and the dividends:action OAuth scope.

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 a dividend declaration without persisting changes.

Preview declaring a draft dividend. The body is empty.

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