Generate an Account Statement for a Custom Date Range

Use this endpoint to generate a formal account statement for any date range you choose. The response gives you the account’s opening balance at the start of the period, a structured summary of all movements (debits and credits) that occurred within that window, and the resulting closing balance at the end. This is the right endpoint to use when reconciling accounts, producing period-end reports, or exporting data for external accounting systems.

Endpoint

GET /api/v1/accounts/{accountId}/statement

Authorization

Requires an API key with the ACCOUNTS_READ scope. Pass your key in the Authorization header using the Bearer scheme.

Authorization: Bearer <api-key>

Parameters

string (UUID)

required

The unique identifier of the account for which you want to generate a statement. Must be a valid UUID corresponding to an account in your tenant.

string (ISO 8601 datetime)

required

The inclusive start of the statement period. Entries with an occurredAt on or after this datetime are included in the movements.Example: 2024-01-01T00:00:00Z

string (ISO 8601 datetime)

required

The inclusive end of the statement period. Entries with an occurredAt on or before this datetime are included in the movements.Example: 2024-06-30T23:59:59Z

Both from and to are required for this endpoint. Requests that omit either parameter will receive a 400 error. Additionally, from must be earlier than or equal to to.

Request example

curl --request GET \
  --url "https://api.your-domain.com/api/v1/accounts/a1b2c3d4-e5f6-7890-abcd-ef1234567890/statement?from=2024-01-01T00%3A00%3A00Z&to=2024-06-30T23%3A59%3A59Z" \
  --header "Authorization: Bearer <api-key>"

Response

string (UUID)

required

The unique identifier of the account, echoed back from the request.

string

required

The ISO 4217 currency code of the account (e.g. USD, BRL).

string (ISO 8601)

required

The inclusive start of the statement period, echoed back from the request. Not nested under a period object.

string (ISO 8601)

required

The inclusive end of the statement period, echoed back from the request.

number

required

The account balance at the instant immediately before the from timestamp — i.e. the balance computed from all entries posted prior to the start of the requested period. This is your starting point for reconciliation.

array

required

The individual journal lines that occurred within the statement period, ordered ascending by occurredAt. Not an aggregate summary object — if you need totals, sum this array yourself.

Show movement object

string (UUID)

required

The parent transaction this movement belongs to.

string

required

DEBIT or CREDIT.

number

required

The unsigned amount of this movement, in the account’s currency.

string

Optional human-readable description, if one was provided when the entry was created.

string (ISO 8601)

required

Timestamp of the underlying transaction.

number

required

The account balance at the instant immediately after the to timestamp. This is your ending balance for the period.

Response example

{
  "accountId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "currency": "USD",
  "from": "2024-01-01T00:00:00Z",
  "to": "2024-06-30T23:59:59Z",
  "openingBalance": 5000.00,
  "movements": [
    {
      "transactionId": "f0a1b2c3-d4e5-6789-abcd-ef0123456789",
      "type": "DEBIT",
      "amount": 500.00,
      "description": "Customer payment — Invoice #1042",
      "occurredAt": "2024-06-10T11:22:33Z"
    },
    {
      "transactionId": "e9f0a1b2-c3d4-5678-efab-0123456789cd",
      "type": "CREDIT",
      "amount": 200.00,
      "description": "Supplier disbursement — PO #88",
      "occurredAt": "2024-06-08T09:14:00Z"
    }
  ],
  "closingBalance": 14824.50
}

To generate a monthly statement for an entire year, you can issue twelve sequential requests — one per calendar month — using the same accountId. The closingBalance of each month will equal the openingBalance of the next, making it easy to verify continuity.

Error codes

Code	Meaning
400	Invalid request. Common causes: `from` or `to` is missing, `accountId` is not a valid UUID, or `from` is a datetime that falls after `to`. The response body will include a `message` field describing the specific error.
401	Missing or invalid API key.
403	Your API key does not have the `ACCOUNTS_READ` scope.
404	No account with the given `accountId` exists in your tenant.

Accounts

Transactions

Settlements

Reconciliation

Compliance

Administration

Generate an Account Statement for a Custom Date Range

Endpoint

Authorization

Parameters

Request example

Response

Response example

Error codes

​Endpoint

​Authorization

​Parameters

​Request example

​Response

​Response example

​Error codes

Endpoint

Authorization

Parameters

Request example

Response

Response example

Error codes