Dashboard summary

GET https://app.speybooks.com/api/v1/reports/dashboard

Aggregated dashboard data for the current (or specified) financial period. Returns year-to-date P&L, bank balance, invoice stats, and tax set-aside calculations.

Tax set-aside (v5.1.1)

Computed server-side based on year-to-date figures:

  • Corporation Tax — 19% on profits up to £250k, 25% above
  • VAT set-aside — depends on VAT scheme:
    • Standard: output VAT − input VAT (clamped to ≥ 0)
    • Flat Rate: gross turnover × flat rate %
    • Not registered: £0
  • Available — bank balance minus total set-aside (clamped to ≥ 0)

The dashboard caps the to date at today, showing year-to-date rather than projecting to the period end.

Query parameters

periodId integer optional
Financial period ID (defaults to current)

Response

200 Default Response
Show response fields
bankAccountId string
bankBalance integer
invoices object
Show child attributes
outstanding object
Show child attributes
amount integer
count integer
overdue object
Show child attributes
amount integer
count integer
period object
Show child attributes
id integer
label string
status string
profitLoss object
Show child attributes
expenses integer
netProfit integer
revenue integer
recentTransactions integer
taxSetAside object
Show child attributes
available integer
corporationTax integer
ctRate integer
totalSetAside integer
vatLabel string
vatScheme string
vatSetAside integer