PATCH
/businesses/{bid}Update a business
PATCH /businesses/{bid}
Requires the businesses scope.
Profile, branding, the bank account (bankDetails) and requireAllocation. The tax id and dealer type of a business that has already issued documents are not editable.
Path parameters
| Name | Type | Description | |
|---|---|---|---|
bid | string | required | Business id, from POST /businesses. |
Body
| Field | Type | Description | |
|---|---|---|---|
name | string | ||
address | string | ||
phone | string | ||
email | string | ||
requireAllocation | boolean | Strict mode for allocation numbers. | |
branding | Branding | Appearance of the rendered PDF. Stored once per business; a logo is stored as a file and referenced by hash, never re-frozen into each document. | |
bankDetails | object | The account customers pay into by bank transfer. Printed under the totals of a חשבון עסקה (300) and a חשבונית מס (305) while onDocuments is true, frozen into each document at issue; never on a receipt, an invoice-receipt or a credit note. A known Israeli bank (by name or code) prints with its Bank of Israel code, e.g. "בנק לאומי (10)". null clears it. | |
bankDetails.bankName | string | Bank name or its Bank of Israel code (max 80). | |
bankDetails.branch | string | Branch number (max 80). | |
bankDetails.account | string | Account number (max 80). Required for anything to print. | |
bankDetails.beneficiary | string | Account holder name (max 80). | |
bankDetails.onDocuments | boolean | Print the account on proformas and tax invoices. |
Response
200: { "ok": true, … }
| Field | Type | Description | |
|---|---|---|---|
ok | boolean | required | |
business | Business | required | One Israeli dealer (עוסק), one of your end users. |
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).