Check available retained profits for dividend declaration

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

Reports the retained profit available to distribute for a financial year: cumulative retained earnings to the year end, less what prior board resolutions have already approved for that year. Use it before recording board minutes to confirm a proposed distribution is within the profit sufficiency limit. The financial year end is required.

Query parameters

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

Response

200Profit check result with retained earnings, previously declared, available profit, and a canDeclareDividend boolean.
Show response fields
availableProfitPenceinteger
canDeclareDividendboolean
financialYearEndstring
previouslyDeclaredPenceinteger
retainedEarningsPenceinteger

Error codes

400Missing or invalid financialYearEnd parameter.