Version 2.4.8 · latest

Ledger entries ledger-entries

Every change to an account balance, each with a balance snapshot taken after posting.

Pick an endpoint to see its example call on the right.

BillingAuthentication: User (some parameters admin only)1 endpoints

Authentication

Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.

X-API-Key

Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).

Conventions

Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.

Times are RFC 3339 (UTC); amounts are in cents.

Writes return 200/201/204 on success; duplicates of a unique key return 409.

GET/api/v2/ledger-entriesList ledger entries

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
pageinteger Page number, starting from 1
Default 1
page_sizeinteger Items per page
Default 20
sortstring Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`
tenant_idinteger Admin only: filter by tenant (a malformed value returns 422). Ignored for tenant credentials, which only see their own tenant's data
kindstring Filter by ledger entry kind.
startstring Entry time from (inclusive), RFC 3339.
endstring Entry time until (exclusive), RFC 3339.

Ledger entries object

FieldTypeDescription
amount_centsinteger Signed: positive for credit, negative for debit.
balance_after_centsinteger Balance snapshot after this entry.
created_atstring Created at
currencystring Currency of the amount (ISO 4217).
desstring Description
idinteger Record ID
kindstring Entry kind, such as recharge or deduction.
order_idinteger Related order ID; empty if none.
tenant_idinteger Owner tenant (user) ID

Responses and errors

Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "code": "validation_failed",
  "detail": "Invalid request parameters",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name is required"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command