Axiym

Get account statement

Returns the posted credits and debits for one partner-owned account, including its opening balance, closing balance, and movement totals.

Use the statement to reconcile the partnership's payments and other ledger movements. The balances follow this equation:

openingBalance + totalCredited - totalDebited = closingBalance

If from and to are omitted, the statement covers the account's full 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

Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the X-Request-Id response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json