Ledger

Generate ledger report data as JSON using typed report request filters and columns.

Path Parameters

business_slug*string

Business slug that scopes this request. If you do not have one yet, call common_accessible_businesses_list and pick a slug from the response.

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

extend_accounts?boolean

When true, include account-level drill-down rows for supported reports.

append_comparison_columns?boolean

When true and column count is small enough, add comparison columns.

comparison_mode?string

How interleaved Change columns are expressed when comparison is on: amount (default, cents difference) or percent ((left - right) / right * 100). Null when the right-hand period is 0.

amount - amount
percent - percent

Value in

"amount"
"percent"

tag_ids?array<integer>

Optional tag filters. Only entries/documents matching these tags are included in report calculations.

account_number?string

When set, return entry lines only for this account (ledger/reconciliation).

Length1 <= length

document_number?string

When set, return entry lines only for this journal voucher.

Length1 <= length

vat_entry_group?string

When set, return paginated entry lines for this VAT summary line id.

Length1 <= length

entries_page?integer

1-based page index for scoped entry-line requests.

Range1 <= value

Default1

entries_page_size?integer

Page size for scoped entry-line requests. Capped at 200.

Range1 <= value <= 200

Default8

include_entry_lines?boolean

When false, omit entry line arrays from JSON responses and include entries_count instead. Scoped entry requests always return lines.

Defaulttrue

columns*array<>

Columns for period reports. Use date_from and date_to for each column.

Response Body

`application/json`

curl -X POST "https://example.com/v1/business/string/report/ledger/" \  -H "Content-Type: application/json" \  -d '{    "columns": [      {        "date_from": "2019-08-24",        "date_to": "2019-08-24"      }    ]  }'

{  "report_type": "string",  "date_from": "2019-08-24",  "date_to": "2019-08-24",  "attachments_by_document": {    "property1": [      {        "id": 0,        "name": "string",        "type": "string"      }    ],    "property2": [      {        "id": 0,        "name": "string",        "type": "string"      }    ]  },  "accounts": [    {      "number": "string",      "name": "string",      "opening_balance": 0.1,      "closing_balance": 0.1,      "entries": [        {          "number": "string",          "date": "2019-08-24",          "debet": 0.1,          "credit": 0.1,          "balance_csum": 0.1,          "description": "string",          "document_id": 0        }      ],      "totals": {        "property1": 0.1,        "property2": 0.1      }    }  ],  "totals": {    "property1": 0.1,    "property2": 0.1  }}

Ledger

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

Path Parameters

Request Body

Response Body

`application/json`