Reports

Read-only accounting and tax reports. These endpoints are mostly date-bounded queries with few URI links between resources, so they are catalogued here rather than drawn as a large relationship diagram.

← Back to entity map hub

Why this cluster is different

Report resources aggregate ledger data for a period. They do not typically expose create/update/delete flows or require parent URIs on list. Relationships to operational resources (contacts, projects, categories) are implicit in the underlying transactions, not as REST links on the report response.

Use the Foundations, Sales, Purchases, and Banking clusters to understand where report numbers originate.

Resource catalogue

Resource Official docs SDK Typical inputs
Profit & loss Profit & loss Not yet Date range
Balance sheet Balance sheet Not yet As-of date
Trial balance Trial balance Not yet Date range
Cashflow Cashflow Not yet Date range
Transactions Transactions Not yet Date range, category filters
VAT returns VAT returns Not yet Period
Sales tax Sales tax Not yet Configuration / periods
Sales tax periods Sales tax periods Not yet Period
Corporation tax returns Corporation tax returns Not yet Period
Income tax returns Income tax returns Not yet Period
Self assessment returns Self assessment returns Not yet Period
Final accounts reports Final accounts reports Not yet Period

Loose relationships (conceptual)

flowchart LR
  Operational[Operational_resources]
  Ledger[Ledger_entries]
  Reports[Report_endpoints]
  Operational --> Ledger
  Ledger --> Reports

Operational resources (invoices, bills, expenses, bank explanations, journal sets) post to categories. Reports read aggregated category balances - there is no GET /profit_and_loss?invoice= style URI graph in the public API.

Access levels

Most report endpoints require Tax, Accounting & Users (level 7) or Full (level 8). Confirm the minimum access level on each official docs page before scoping OAuth permissions for an integration.

SDK sequencing note

Reports belong in layer 7 - implement after the operational clusters that feed the ledger. Company tax timeline may complement VAT and corporation tax work but does not replace these report endpoints.

If you need URI-linked data rather than aggregates, prefer:


Copyright © Mark Heydon. Distributed under the MIT licence.

This site uses Just the Docs, a documentation theme for Jekyll.