Concepts
Clients
The customers you bill — private individuals, sole proprietors, or companies.
A client is who you bill on a document — an end customer of your store, or a business
customer. Only name is required; everything else is optional.
{
"name": "Dana Cohen",
"type": "private",
"email": "dana@example.com",
"phone": "+972-50-7654321"
}Client type
type determines the tax documentation the client can legally be issued:
type | Meaning | VAT number required? |
|---|---|---|
private (default) | Individual consumer | No |
osek_morshe | Registered sole proprietor (עוסק מורשה) | Yes |
osek_patur | VAT-exempt sole proprietor (עוסק פטור) | No |
company_ltd | Incorporated company (חברה בע"מ) | Yes |
Create and look up
POST /api/v1/clients # requires clients:write
GET /api/v1/clients # requires clients:read — paginated, filterable
GET /api/v1/clients/{id} # requires clients:readPOST /clients on the public API does not de-duplicate by name or email — calling it
twice with the same customer's details creates two client records. If your integration
syncs the same customer repeatedly (e.g. on every order), keep your own mapping from your
store's customer ID → the VUZ client.id you got back the first time, and only call
GET /clients/{id} on subsequent syncs. See Idempotency for the
equivalent gap on the documents endpoint.