List dividends

GEThttps://app.speybooks.com/api/v1/dividends/

Returns a paginated list of dividends, most recent first, optionally filtered by director or by financial year end. Default pagination is the first page at fifty per page.

Query parameters

directorIdstringoptional
Filter by director ID (e.g. dir_1).
financialYearstringoptional
Filter by financial year end date (YYYY-MM-DD).
pageintegeroptionalDefault: 1
Page number. Default 1.
min: 1
perPageintegeroptionalDefault: 50
Results per page. Default 50, maximum 100.
min: 1 · max: 100

Response

200Paginated list of dividends with director names.
Show response fields
dividendsarray<object>
Show child attributes
amountPenceinteger
datestring
directorNamestring
idstring
statusstring
voucherNumberstring

Error codes

400Invalid director ID format.