Get a dividend

Returns one dividend with its shareholder split, totals, remittance deadline, statutory documents and the journal entries it posted. outstanding_amount is the net still owed on this dividend: its net less its payments and the earlier overpayments used on it. shareholder_balance (null where the new Reconcile is not on for the company) is the balance as at today: unpaid_here (unpaid on this dividend, zero unless it is declared and not yet paid), carried_from (earlier dividends of the same shareholders that were paid too much, each with the amount paid too much and what of it this dividend can still use), owed_in_all (what is owed to them after those overpayments) and set_offs (the overpayments used on or from this dividend). The ETag header is the If-Match value for dividend.declare and dividend.void. Requires the dividends:read OAuth scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
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
*/*