VUZDevelopers

Create a new client

POST
/clients

Creates a new client associated with a business. Clients represent customers or entities that receive invoices/receipts.

Israeli Client Types:

  • PRIVATE (לקוח פרטי): Individual customer, no VAT requirements
  • OSEK_MORSHE (עוסק מורשה): Sole proprietor/freelancer, requires 9-digit VAT number
  • COMPANY_LTD (חברה בע"מ): Incorporated company, requires 9-digit company registration number

Required Fields:

  • name: Client full name or business name (Hebrew or English)
  • type: Client type (private, osek_morshe, company_ltd)
  • phone: Contact phone number (required for communication)
  • businessId: The business this client belongs to (multi-tenant scoping)

VAT Number Rules:

  • REQUIRED for osek_morshe and company_ltd types
  • Must be exactly 9 digits
  • Optional for private type
  • Validated against Israeli VAT number format

Multi-Tenant Scoping: Client is automatically linked to specified businessId. User must own the business to create clients for it.

Example Use Case: Adding a new business client "חברת טכנולוגיה בע״מ" (Tech Company Ltd) with VAT number 512345678 to manage billing and invoice generation.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/clients" \  -H "Content-Type: application/json" \  -d '{    "name": "דוד כהן"  }'
{  "id": "770e8400-e29b-41d4-a716-446655440000",  "name": "דוד כהן",  "type": "private",  "phone": "+972-50-7654321",  "email": "david.cohen@example.com",  "address": "רחוב דיזנגוף 50, תל אביב, 6433109",  "vatNumber": "512345678",  "contactPerson": "שרה לוי",  "notes": "לקוח VIP - תנאי תשלום מיוחדים",  "isActive": true,  "origin": "web",  "businessId": "660e8400-e29b-41d4-a716-446655440000",  "userId": "550e8400-e29b-41d4-a716-446655440000",  "createdAt": "2025-01-10T08:00:00.000Z",  "updatedAt": "2025-11-06T14:30:00.000Z",  "portalEnabled": false,  "portalSlug": "my-business",  "portalUrl": "https://app.vuz.co.il/portal/my-business",  "portalLastLoginAt": "2019-08-24T14:15:22Z",  "portalInviteSentAt": "2019-08-24T14:15:22Z"}