Developers
API referenceReferenceReports

Report entries

List entry lines for one account or one document, paginated in the database. Account-scoped responses carry the running balance and the opening and closing balances of the window.

GET
/v1/business/{business_slug}/report/entries/

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.

Query Parameters

account_number?string

Return entries booked on this account. Mutually exclusive with document_number.

Length1 <= length
date_from?string

Start of the window (YYYY-MM-DD). Defaults to the earliest accounting period start, which makes running balances accumulate from inception.

Formatdate
date_to?string

End of the window (YYYY-MM-DD). Defaults to unbounded.

Formatdate
document_number?string

Return entries belonging to this document. Mutually exclusive with account_number.

Length1 <= length
page?integer

1-based page index. Pages beyond the last one return the last page.

Range1 <= value
Default1
page_size?integer

Entries per page. Capped at 200.

Range1 <= value <= 200
Default8
tag_ids?array<integer>

Only include entries whose document carries one of these tags.

Response Body

application/json

curl -X GET "https://example.com/v1/business/string/report/entries/"
{  "count": 0,  "next": 0,  "prev": 0,  "size": 0,  "page": 0,  "page_count": 0,  "page_size": 0,  "results": [    {      "id": 0,      "number": "string",      "date": "2019-08-24",      "description": "string",      "account_number": "string",      "account_name": "string",      "debet": 0.1,      "credit": 0.1,      "amount": 0,      "balance_csum": 0,      "document_id": 0    }  ],  "meta": {    "account_number": "string",    "account_name": "string",    "document_number": "string",    "opening_balance": 0,    "page_opening_balance": 0,    "closing_balance": 0,    "debet_total": 0.1,    "credit_total": 0.1,    "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"      }    ]  }}