Check available retained profits for dividend declaration

GET https://app.speybooks.com/api/v1/dividends/profit-check

Checks the available retained profits for a dividend declaration. Returns the current retained earnings balance minus any already-declared dividends for the specified financial year end. Used to validate that a proposed dividend is legally distributable.

Query parameters

financialYearEnd string required
Financial year end date (YYYY-MM-DD). Required.
pattern: ^\d{4}-\d{2}-\d{2}$

Response

200 Profit check result with retained earnings, previously declared, available profit, and a canDeclareDividend boolean.
Show response fields
availableProfitPence integer
canDeclareDividend boolean
financialYearEnd string
previouslyDeclaredPence integer
retainedEarningsPence integer

Error codes

400 Missing or invalid financialYearEnd parameter.