Update an existing supplier

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

Path Parameters

id*string

Supplier UUID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

nameHe?string

Supplier name in Hebrew

Lengthlength <= 255

nameEn?string

Supplier name in English

Lengthlength <= 255

businessNumber?string

Israeli business number

Lengthlength <= 20

vatNumber?string

VAT number

Lengthlength <= 20

email?string

Supplier email

phone?string

Supplier phone

address?string

Supplier address

city?string

Supplier city

website?string

Supplier website

contactPerson?string

Contact person name

defaultCategoryId?string

Default expense category ID

vatRecognitionRate?number

Override VAT recognition rate (0-1)

Range0 <= value <= 1

incomeTaxRecognitionRate?number

Override income tax recognition rate (0-1)

Range0 <= value <= 1

defaultCurrency?string

Default currency

paymentTermsDays?number

Payment terms in days

bankName?string

Bank name

bankBranch?string

Bank branch number

bankAccountNumber?string

Bank account number

isFavorite?boolean

Mark as favorite

isActive?boolean

Is active

metadata?

Free-form metadata (notes, tags)

Response Body

`application/json`

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

{  "id": "string",  "businessId": "string",  "nameHe": "string",  "nameEn": "string",  "businessNumber": "string",  "vatNumber": "string",  "email": "string",  "phone": "string",  "address": "string",  "city": "string",  "website": "string",  "contactPerson": "string",  "defaultCategoryId": "string",  "vatRecognitionRate": 0,  "incomeTaxRecognitionRate": 0,  "defaultCurrency": "string",  "paymentTermsDays": 0,  "isActive": true,  "isFavorite": true,  "expenseCount": 0,  "totalExpenseAmount": 0,  "lastExpenseDate": "2019-08-24T14:15:22Z",  "source": "manual",  "metadata": {},  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}