Reports
Which report to call, and the column dates each one requires.
Report endpoints return JSON. They do not post a document. The business slug comes from list businesses.
Period reports take columns with date_from and date_to (YYYY-MM-DD) on each column. Point-in-time reports take columns with date_at. Both shapes are required arrays. Optional fields are on the reference page. Do not add a comparison column unless you set the fields that page documents.
Period reports (date_from, date_to)
| Report | Operation |
|---|---|
| Income statement | Income statement |
| Income statement, short | Income statement - Short |
| Balance sheet specifications | Balance sheet specifications |
| Equity changes | Equity changes |
| EU VAT report | EU VAT report |
| Journal | Journal |
| Ledger | Ledger |
| VAT statement | VAT statement |
{
"columns": [
{ "date_from": "2024-01-01", "date_to": "2024-01-31" }
]
}name on a column is an optional label. The dates above are an example of the format, not a reporting period you should assume.
Point-in-time reports (date_at)
| Report | Operation |
|---|---|
| Balance sheet | Balance sheet |
| Balance sheet, short | Balance sheet - Short |
{
"columns": [
{ "date_at": "2024-01-31" }
]
}Periods and entry lines
Accounting periods and VAT periods are not reports. List them with Accounting periods - List and VAT periods - List.
Report entries is a GET. It is not one of the column reports above.
These calls are reads. Saving a report into the ledger means creating a document with the operations on that page, not re-posting the report body.