OverviewProductsPlatformsAPI ReferenceResources
Ledger

Get ledger balances

GEThttps://zernio.com/api/v1/ledger/balances

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.

Authentication

AuthorizationBearer tokenRequired

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

Query parameters

scopeTypestringRequired

Scope type, for example participant or campaign.

scopeIdstringRequired

Scope identifier.

currencystringDefault usd

Lowercase ISO 4217 currency code.

Responses

Success· the request worked

Errors· the request failed

GET/v1/ledger/balances
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.ledger.getLedgerBalances({  query: {    scopeType: 'string',    scopeId: 'scope_abc123',  },});console.log(data);
{  "scopeType": "string",  "scopeId": "string",  "currency": "string",  "balances": {    "property1": 0,    "property2": 0  }}
OpenAPI specification
Was this page helpful?