ZEzernio
Ledger

Get ledger balances

Changed on

Returns the balance of each bucket (for example accruing, owed, payable) for one ledger scope.

These return an empty balances object:

  • A scope owned by another team.
  • For a profile-scoped key (or a member limited to some profiles), any scope other than campaign and participant scopes of campaigns under its profiles.
get/v1/ledger/balances

Request

  • Base URL
    https://zernio.com/api
  • URL
    https://zernio.com/api/v1/ledger/balances
  • Auth
    HTTP bearer

Query parameters

scopeTypestring required

Scope type, for example participant or campaign.

scopeIdstring required

Scope identifier.

currencystring

Lowercase ISO 4217 currency code.

Response

Balances per bucket in cents

scopeTypestring
scopeIdstring
currencystring
balancesobject

Bucket name to balance in cents (credits minus debits)

Changes