Sign in

v1

latestOpenAPI 3.1.02026-08-065163115.0 KB
Statements

List statements

This endpoint allows you to retrieve a list of balances for the required period for a given business.

get/v1/businesses/{client_id}/statements

Path parameters

client_idinteger required
Example:123

The ID of the business.

Query parameters

offsetinteger
Example:50

Offset to retrieve items from.

limitinteger
Example:50

Number of items per page.

start_datestring date required

The start date for this statement in UTC.

end_datestring date required

The end date for this statement in UTC.

Response

OK

countinteger

The total number of daily balance records for the given period.

nextstring

The URL to the next page of daily balance records.

previousstring

The URL to the previous page of daily balance records.

start_datestring date

The start date for this statement in UTC.

end_datestring date

The end date for this statement in UTC.

currencystring

The currency of the statement.

opening_balancenumber

The opening balance of the statement.

closing_balancenumber

The closing balance of the statement.

Example response

{
  "count": 100,
  "next": "offset=50&limit=50",
  "previous": "offset=0&limit=50",
  "start_date": "2024-01-01",
  "end_date": "2024-01-31",
  "currency": "AUD",
  "opening_balance": 1000,
  "closing_balance": 1000,
  "daily_balances": [
    {
      "date": "2024-01-01",
      "opening_balance": 1000,
      "closing_balance": 1000,
      "id": "e33b7c61-5124-4ba0-b238-e4c573133715",
      "created": "2024-01-01T00:00:00Z",
      "updated": "2024-01-01T00:00:00Z"
    }
  ]
}