Update business
update_businessUpdate the business's own profile fields (name, contact details, industry, currency, tax rate, and the like). To change only the free-text description use set_business_description, or only a single tag use set_business_tag.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | This business's id. Optional — defaults to the authenticated token's own business; supply only to target a specific business. | |
| age | No | Age of the business (label, e.g. how long it has been trading). | |
| tag | No | Unique public vanity tag/slug for the business (used in its public page URL and for segmentation). | |
| bank | No | Bank name for the account shown on invoices. | |
| city | No | City / town. | |
| logo | No | Business logo image URL (or data URI). | |
| name | No | Trading / display name of the business. | |
| about | No | Short description / bio of the business shown on public pages. | |
| alert | No | ||
| phone | No | Business contact phone number. | |
| region | No | State / province / region. | |
| suburb | No | Suburb. | |
| address | No | Street address line 1. | |
| charity | No | Whether the business is a charity / non-profit. | |
| country | No | Country (name or code). | |
| details | No | Nested profile details. Currently carries the legal entity type and the subscription billing contact. | |
| product | No | Whether the business sells products (goods). | |
| service | No | Whether the business sells services. | |
| webhook | No | Webhook URL to notify on business events. | |
| website | No | Business website URL. | |
| address2 | No | Street address line 2. | |
| currency | No | Business base currency, ISO 4217 (e.g. "ZAR", "USD"). | |
| industry | No | Industry the business operates in. | |
| referrer | No | How the business was referred (referral source). | |
| salestax | No | Whether sales tax / VAT is enabled for the business. | |
| showbank | No | Whether to show the business's bank details on invoices. | |
| turnover | No | Annual turnover in the base currency. | |
| twitchid | No | Twitch channel id, for the Twitch / streamer integration. | |
| employees | No | Number of employees (as a label / band). | |
| sdlnumber | No | SDL (skills development levy) reference number. | |
| taxregime | No | Tax regime the business is registered under. | |
| uifnumber | No | UIF (unemployment insurance fund) reference number. | |
| vatnumber | No | VAT registration number. | |
| branchcode | No | Bank branch code shown on invoices. | |
| experience | No | Founder's business / industry experience (label). | |
| payenumber | No | PAYE (payroll income-tax) reference number. | |
| postalcode | No | Postal / ZIP code. | |
| quotenotes | No | Default notes text placed on new quotes. | |
| quotetitle | No | Default heading / title used on quotes (e.g. "Quote", "Estimate", "Cost Estimate"). Offered from the business locale's own quoteTitles list; unset renders the built-in "Quote". | |
| accountname | No | Bank account holder name shown on invoices. | |
| accounttype | No | Bank account type (e.g. "cheque", "savings"). | |
| invoicenotes | No | Default notes text placed on new invoices. | |
| invoicetitle | No | Default heading / title used on invoices. | |
| lastreviewed | No | Date the business's books were last reviewed (ISO 8601). | |
| quotemessage | No | Default customer-facing message on new quotes. | |
| salestaxcron | No | Cron expression driving sales-tax return reminders / automation. | |
| salestaxrate | No | Default sales-tax / VAT rate as a decimal fraction (e.g. 0.15 = 15%). | |
| accountnumber | No | Bank account number shown on invoices. | |
| invoicebankid | No | Id of the bank account to display on invoices. | |
| invoiceoffset | No | Starting offset added to auto-generated invoice numbers. | |
| paymentbankid | No | Id of the bank account payments are collected into. | |
| customizations | No | JSON string of UI / branding customizations for the business. | |
| featurepreview | No | Whether the business opts into preview / beta features. | |
| invoicemessage | No | Default customer-facing message on new invoices. | |
| openingbalance | No | Opening cash / bank balance carried into the books, in the base currency. | |
| salestaxdueday | No | Day of the period on which the sales-tax return is due. | |
| salestaxnumber | No | Sales-tax / VAT registration number. | |
| incometaxnumber | No | Income-tax reference number. | |
| paymentpagelogo | No | Logo image URL shown on the hosted payment page. | |
| paymentpagename | No | Display name shown on the hosted payment page. | |
| proofofdelivery | No | Whether proof-of-delivery capture is enabled. | |
| tradesourcecode | No | SARS trade / source code classifying the business's main activity. | |
| salestaxschedule | No | Sales-tax filing schedule (e.g. monthly / bi-monthly). | |
| streamelementsid | No | StreamElements account id, for the StreamElements integration. | |
| vanitypageaction | No | Call-to-action mode for the business's public vanity page, e.g. "donate" or "pay". | |
| financialstartday | No | Day of the month the financial year starts (1-31). | |
| salestaxexclusive | No | Default for whether new invoice / product line items are entered VAT-exclusive (price shown ex-VAT, tax added on top) rather than inclusive. | |
| streamelementsjwt | No | StreamElements JWT credential for the integration. | |
| registrationnumber | No | Company registration number. | |
| financialstartmonth | No | Month the financial year starts (month name or number). | |
| paymentpagedisabled | No | Whether the public payment page is disabled. | |
| salestaxrecoverable | No | Whether input sales tax / VAT is recoverable for the business. |