Draft a dividend

Drafts a dividend as the dividend wizard does: kind (final or interim), profit_year, declaration_date, the gross total_amount, the shareholder split (allocations, which must add up to the total; each an active shareholder) and solvency_confirmed: true, the director's statutory confirmation, recorded for the connected user. SDC and GeSY are rated provisionally. Nothing posts: declare it with dividend.declarePreview then dividend.declare (a final always; an interim to pay it later or in instalments), or, for an interim paid in one event, match its bank line with reconciliationMatch.create (candidate_type dividend). Idempotency-Key is required. Refusals name the reason: dividend_refused (the dividend module refused the draft, for example a split that does not add up to the total) or dividend_currency_unsupported (the company's base currency is not EUR). Requires the dividends:write OAuth scope and dividends.create.

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

Fields accepted to draft a dividend. The schema identifies required and optional values.

Draft a dividend, as the dividend wizard's Save does. Nothing posts until
dividend.declare (or, for an interim paid in one event, until its bank line
is matched with reconciliationMatch.create, candidate_type dividend).

string
enum
required

final (declared by the shareholders, then paid) or interim (the directors'; paid in one event, or declared now and paid later).

Allowed:
integer
required
2000 to 2100

The financial year whose profits are distributed.

date
required

The resolution date: the tax point for SDC and GeSY once declared.

date | null

Intended payment date. Rates an interim paid in one event provisionally; it is re-rated at the date the bank line moved.

number
required
0.01 to 999999999999

Gross dividend in EUR; the shareholder split must add up to it.

boolean
required

The director's statutory solvency confirmation, given by the connected user. Must be true.

string | null

Notes printed on the resolution.

allocations
array of objects
required
length between 1 and 100
allocations*
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
*/*