Update current business (from x-business-id header)

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.

businessName?string

Business name (Hebrew or English). This is the legal business name that appears on documents.

Length2 <= length <= 100

businessNameEn?string

Business name in English. Used for international invoices and generating the business identifier.

Length2 <= length <= 100

legalName?string

Legal name (שם חוקי) — the registered legal entity, which may differ from the trade name (businessName). Pre-filled with businessName at registration; editable at any time.

Lengthlength <= 100

showLegalNameOnDocuments?boolean

Whether the legal name (שם חוקי) line is printed on issued documents. Defaults to true. Display-only — the legal name stays stored either way. Toggling never affects already-issued documents (frozen per-document at finalization).

documentSubline?string

Document sub-line (שורת משנה) — a short tagline shown under the business name on documents.

Lengthlength <= 60

businessIdentifier?string

Business identifier - unique slug (alphanumeric, hyphens, and underscores only, no spaces or special characters). If not provided, will be auto-generated from business name.

Match^[a-zA-Z0-9_-]+$

Length3 <= length <= 50

businessType?string

Business type for Israeli tax compliance

Default"osek_murshe"

Value in

"osek_patur"
"osek_murshe"
"limited_company"

accountingBasis?string

Accounting basis for tax reporting

Default"cash"

Value in

"cash"
"accrual"

ownerPhone?string

Owner WhatsApp phone number (with country code). Used for conversational accounting interface. Must be unique.

Match^\+[0-9]{10,15}$

vatRate?number

VAT rate as percentage (e.g., 17 for 17%, 18 for 18%). Must be between 0 and 100. Default is 18 for Israeli standard VAT.

Range0 <= value <= 100

Default18

currency?string

Currency code (ISO 4217). Default is ILS for Israeli New Shekel.

Default"ILS"

Value in

"ILS"
"USD"
"EUR"

purchaseOrderStartNumber?number

Starting number for purchase order documents (הזמנת רכש)

Default10000

quoteStartNumber?number

Starting number for quote documents (הצעת מחיר)

Default20000

dealBillStartNumber?number

Starting number for deal bill documents (חשבון עסקה)

Default40000

taxInvoiceStartNumber?number

Starting number for tax invoice documents (חשבונית מס)

Default50000

taxInvoiceReceiptStartNumber?number

Starting number for tax invoice-receipt documents (חשבונית מס/קבלה)

Default60000

creditNoteStartNumber?number

Starting number for credit note documents (זיכוי)

Default70000

receiptStartNumber?number

Starting number for receipt documents (קבלה)

Default80000

deliveryNoteStartNumber?number

Starting number for delivery note documents (תעודת משלוח)

Default90000

language?string

Preferred language for documents and communication (he=Hebrew, en=English)

Default"he"

Value in

"he"
"en"

defaultTerms?|

Default terms and conditions text for invoices (Hebrew or English)

vatNumber?|

Israeli VAT registration number (מספר עוסק מורשה / ח.פ). Must be 9-10 digits.

Match^\d{9,10}$

address?|

Business address (Hebrew or English). Full address for documents.

email?|

Business email address

businessMeta?|

Business metadata (logo URL, signature, branding colors, etc.)

trialEndDate?|

Trial period end date (ISO 8601)

Formatdate-time

isOnTrial?boolean

Whether the business is currently on trial

Defaultfalse

isActive?boolean

Whether the business account is active

Defaulttrue

themeId?|

Theme ID for document styling

Formatuuid

economicSectorId?|

Economic sector ID (CBS classification) for AI expense recognition

Formatuuid

description?|

Free-text business description used as SECONDARY context for AI expense recognition. Captured during onboarding (e.g. via WhatsApp first-image flow) when economicSectorId is unavailable. Helps the AI determine VAT/income-tax recognition for ambiguous receipts.

Lengthlength <= 1000

gaClientId?|

GA4 client_id captured at signup. Used for server-side Measurement Protocol conversion events.

utmSource?|

UTM source from the campaign that drove the signup

utmMedium?|

UTM medium from the campaign that drove the signup

utmCampaign?|

UTM campaign from the campaign that drove the signup

metaEventId?|

Meta event_id generated by the browser Pixel when firing CompleteRegistration. Sent so the server-side Meta CAPI fire can reuse the SAME event_id for deduplication (browser Pixel + server CAPI count as one conversion, not two). Not persisted.

Response Body

`application/json`

curl -X PATCH "https://example.com/businesses/current" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "660e8400-e29b-41d4-a716-446655440000",  "businessName": "עסק של נאור - ייעוץ עסקי",  "businessType": "osek_murshe",  "accountingBasis": "cash",  "vatNumber": "123456789",  "vatRate": 17,  "address": "רחוב הרצל 123, תל אביב, 6777102",  "phone": "+972-50-1234567",  "email": "naor@business.co.il",  "ownerPhone": "+972-50-1234567",  "legalName": "נאור דהן",  "showLegalNameOnDocuments": true,  "documentSubline": "פתרונות תוכנה וייעוץ טכנולוגי",  "isActive": true,  "language": "he",  "currency": "ILS",  "logoUrl": "/api/v1/files/logos/660e8400-e29b-41d4-a716-446655440000.png",  "receiptStartNumber": 50001,  "taxInvoiceReceiptStartNumber": 65001,  "creditNoteStartNumber": 80001,  "taxInvoiceStartNumber": 60001,  "quoteStartNumber": 90001,  "dealBillStartNumber": 70001,  "userId": "550e8400-e29b-41d4-a716-446655440000",  "economicSectorId": "880e8400-e29b-41d4-a716-446655440000",  "economicSector": {},  "createdAt": "2025-01-15T10:00:00.000Z",  "updatedAt": "2025-11-06T14:30:00.000Z"}

Update current business (from x-business-id header)

Authorization

Request Body

Response Body

200application/json

`application/json`