Accounts and money

Retrieve a monthly account statement

Derives one UTC calendar month's opening balance, immutable receipt-linked ledger lines, running balances, and closing balance directly from the ledger's own history. Live periods and line dates use ledger booking time. In sandbox each line is dated and filed by its operation's Product value date when it has one, as sandbox finance reports are, and the opening carries every earlier-dated line. Refuses the statement if any line lacks exact terminal evidence, if the deltas do not reconcile, or if the month exceeds 50,000 lines (in sandbox with value dates, the account's whole history to the cutoff).

get/v1/accounts/{accountId}/statements/{period}

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/accounts/{accountId}/statements/{period}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

accountIdstring required

Hyperscale account ID

periodstring required

UTC calendar month in YYYY-MM form

Query parameters

productIdstring

Hyperscale product ID

cutoffstring date-time
cursorstring
limitinteger

Headers

X-Hyperscale-Environment'sandbox' | 'live'

Response

Success

accountIdstring required

Hyperscale account ID

closingBalancestring required

Negative only on a contra claim account, where it is what the owner owes.

currency'SAR' required
environment'sandbox' | 'live' required
finalizedboolean required
openingBalancestring required

Negative only on a contra claim account, where it is what the owner owes.

periodstring required

UTC calendar month in YYYY-MM form

periodEndExclusivestring date-time required
periodStartstring date-time required
tenantIdstring required

Organization tenant ID

productIdstring

Hyperscale product ID

asOfstring date-time required

The statement's business time: in sandbox the Product clock when one is set, otherwise the cutoff.

cutoffstring date-time required
observedAtstring date-time

Sandbox only: the host instant the ledger was read at, equal to the cutoff.

totalLinesinteger required
nextCursorstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.