Get customer balance summary
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
Response Body
application/json
curl -X GET "https://example.com/customers/string/ledger/balance"{ "customerId": "550e8400-e29b-41d4-a716-446655440000", "customerName": "ABC Company Ltd", "currentBalance": 2500, "currency": "ILS", "summary": { "totalDebit": 15000, "totalCredit": 12500, "openInvoicesCount": 3, "overdueAmount": 1200, "creditAvailable": 0 }, "aging": { "current": 1300, "days1to30": 800, "days31to60": 400, "days61to90": 0, "over90": 0 }, "lastActivity": { "lastInvoiceDate": "2025-01-15", "lastPaymentDate": "2025-01-20", "lastActivityDate": "2025-01-20" }}