Axiym

Get an Account Statement

Period-scoped ledger statement for a single account: opening/closing aggregates plus the posted movements in posting order. The statement is self-checking — openingBalance plus totalCredited minus totalDebited equals closingBalance, and each entry carries the running balance. Without from/to the statement covers the whole account history.

Authorization

Default
AuthorizationBearer <token>

In: header

Path Parameters

accountId*string

Account identifier (UUID).

Formatuuid

Query Parameters

first?integer

Maximum number of items to return (page size).

Range1 <= value <= 100
Default20
after?string

Cursor for the next page, from the previous response's pageInfo.endCursor.

from?string

First calendar day of the period (UTC), inclusive. The period bounds apply to the posting time of the movement.

Formatdate
to?string

Last calendar day of the period (UTC), inclusive. Adjacent statements chain without gaps: June to=2026-06-30 is followed by July from=2026-07-01.

Formatdate
type?string

Filter by credit or debit direction.

Allowed values

  • "CREDIT"
  • "DEBIT"

Header Parameters

X-Request-Id?string

Client-generated unique id for this request (UUID recommended), used for end-to-end tracing. Echoed back in the X-Request-Id response header and recorded in Axiym logs — quote it when contacting support. If omitted, Axiym generates one.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json