VUZDevelopers

Open customer credit balance (יתרת זכות ללקוח) — money received that is not yet applied to an invoice

GET
/documents/customer-credit

The AR mirror of the supplier-advance balance. A customer's credit is the money the business has already RECEIPTED but not yet applied to any invoice: an advance/on-account receipt, or the excess of a receipt that over-covered the invoice it was linked to.

Where the money lives in the GL: a standalone receipt on a VAT-registered business credits the 2350 unearned-revenue / customer-advance LIABILITY at issue (the ARE W1-EXT advance flow); applying it to an invoice draws that liability down against the receivable (Dr 2350 / Cr AR). So the credit reported here is the un-recognized part of that liability, per client.

How it is spent: link the same receipt to the client's next invoice (POST /documents/:invoiceId/link-receipts) — the allocation model already caps each link at the receipt's unallocated remainder, so a credit can be consumed across several future invoices.

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

Query Parameters

clientId?string

Restrict to one client (omit for every client with an open credit)

Response Body

curl -X GET "https://example.com/documents/customer-credit"
Empty