VUZDevelopers

Get customer ledger entries

GET
/customers/{customerId}/ledger

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Path Parameters

customerId*string

Customer/Client UUID

Query Parameters

page?number

Page number (1-based)

Default1
limit?number

Items per page (max 100)

Default50
fromDate?string

Filter from date (ISO format)

toDate?string

Filter to date (ISO format)

entryType?array<>

Filter by entry types

documentType?array<string>

Filter by document types

onlyOpen?boolean

Only show open/unpaid items

Defaultfalse
sortBy?string

Sort by field

Default"date"

Value in

  • "date"
  • "amount"
sortOrder?string

Sort order

Default"DESC"

Value in

  • "ASC"
  • "DESC"

Response Body

application/json

curl -X GET "https://example.com/customers/string/ledger"
{  "items": [    {      "id": "550e8400-e29b-41d4-a716-446655440000",      "entryDate": "2025-01-15",      "entryType": "INVOICE",      "transactionType": "DEBIT",      "documentNumber": "INV-60001",      "description": "Tax Invoice #60001",      "debitAmount": 1180,      "creditAmount": 500,      "runningBalance": 680,      "currency": "ILS",      "document": {},      "allocations": [],      "createdAt": "2025-01-15T10:30:00.000Z"    }  ],  "total": 0,  "page": 0,  "limit": 0}