PATCH/businesses/{bid}/business-documents/{id}

Update a certificate or licence

PATCH /businesses/{bid}/business-documents/{id}

Requires the businesses scope.

Only the fields sent change, and each one sent is kept over any later reading. Send null or an empty string to clear a date.

Path parameters

Name	Type		Description
`bid`	string	required	Business id, from `POST /businesses`.
`id`	string	required	Business document id.

Body

Field	Type		Description
`name`	string
`category`	string
`docNumber`	string
`issuer`	string
`notes`	string
`issuedOn`	string
`validUntil`	string

Response

200: { "ok": true, … }

Field	Type		Description
`ok`	boolean	required
`document`	BusinessDocument	required	One of the business's own certificates, licences or approvals (תעודת עוסק מורשה, אישור ניכוי מס במקור, a licence, insurance). Read on upload: `status` is `processing` until the reading lands, and a field you set is never written over by it. Not a ledger record: no report or export reads one.

Errors: 400, 401, 403, 404, 429. Every failure answers { "error", "reason", "hint", "param", "doc_url", "retryable", "request_id" }: branch on reason, and read hint for what to change (https://docs.billos.co.il/errors.md).

const res = await fetch(`${BASE}/businesses/${BID}/business-documents/${DOC_ID}`, { method: 'PATCH', headers: { 'X-Api-Key': KEY, }, }) const data = await res.json() if (!data.ok) throw new Error(data.reason)