Skip to main content
Glama

Update business

update_business

Update 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

TableJSON Schema
NameRequiredDescriptionDefault
idNoThis business's id. Optional — defaults to the authenticated token's own business; supply only to target a specific business.
ageNoAge of the business (label, e.g. how long it has been trading).
tagNoUnique public vanity tag/slug for the business (used in its public page URL and for segmentation).
bankNoBank name for the account shown on invoices.
cityNoCity / town.
logoNoBusiness logo image URL (or data URI).
nameNoTrading / display name of the business.
aboutNoShort description / bio of the business shown on public pages.
alertNo
phoneNoBusiness contact phone number.
regionNoState / province / region.
suburbNoSuburb.
addressNoStreet address line 1.
charityNoWhether the business is a charity / non-profit.
countryNoCountry (name or code).
detailsNoNested profile details. Currently carries the legal entity type and the subscription billing contact.
productNoWhether the business sells products (goods).
serviceNoWhether the business sells services.
webhookNoWebhook URL to notify on business events.
websiteNoBusiness website URL.
address2NoStreet address line 2.
currencyNoBusiness base currency, ISO 4217 (e.g. "ZAR", "USD").
industryNoIndustry the business operates in.
referrerNoHow the business was referred (referral source).
salestaxNoWhether sales tax / VAT is enabled for the business.
showbankNoWhether to show the business's bank details on invoices.
turnoverNoAnnual turnover in the base currency.
twitchidNoTwitch channel id, for the Twitch / streamer integration.
employeesNoNumber of employees (as a label / band).
sdlnumberNoSDL (skills development levy) reference number.
taxregimeNoTax regime the business is registered under.
uifnumberNoUIF (unemployment insurance fund) reference number.
vatnumberNoVAT registration number.
branchcodeNoBank branch code shown on invoices.
experienceNoFounder's business / industry experience (label).
payenumberNoPAYE (payroll income-tax) reference number.
postalcodeNoPostal / ZIP code.
quotenotesNoDefault notes text placed on new quotes.
quotetitleNoDefault 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".
accountnameNoBank account holder name shown on invoices.
accounttypeNoBank account type (e.g. "cheque", "savings").
invoicenotesNoDefault notes text placed on new invoices.
invoicetitleNoDefault heading / title used on invoices.
lastreviewedNoDate the business's books were last reviewed (ISO 8601).
quotemessageNoDefault customer-facing message on new quotes.
salestaxcronNoCron expression driving sales-tax return reminders / automation.
salestaxrateNoDefault sales-tax / VAT rate as a decimal fraction (e.g. 0.15 = 15%).
accountnumberNoBank account number shown on invoices.
invoicebankidNoId of the bank account to display on invoices.
invoiceoffsetNoStarting offset added to auto-generated invoice numbers.
paymentbankidNoId of the bank account payments are collected into.
customizationsNoJSON string of UI / branding customizations for the business.
featurepreviewNoWhether the business opts into preview / beta features.
invoicemessageNoDefault customer-facing message on new invoices.
openingbalanceNoOpening cash / bank balance carried into the books, in the base currency.
salestaxduedayNoDay of the period on which the sales-tax return is due.
salestaxnumberNoSales-tax / VAT registration number.
incometaxnumberNoIncome-tax reference number.
paymentpagelogoNoLogo image URL shown on the hosted payment page.
paymentpagenameNoDisplay name shown on the hosted payment page.
proofofdeliveryNoWhether proof-of-delivery capture is enabled.
tradesourcecodeNoSARS trade / source code classifying the business's main activity.
autofxadjustmentNoWhen true, settle_bills books the FX gain/loss line on a cross-currency bill payment (within 3%) without asking for confirmation. Off by default: the line is proposed and the user confirms it.
salestaxscheduleNoSales-tax filing schedule (e.g. monthly / bi-monthly).
streamelementsidNoStreamElements account id, for the StreamElements integration.
vanitypageactionNoCall-to-action mode for the business's public vanity page, e.g. "donate" or "pay".
financialstartdayNoDay of the month the financial year starts (1-31).
salestaxexclusiveNoDefault for whether new invoice / product line items are entered VAT-exclusive (price shown ex-VAT, tax added on top) rather than inclusive.
streamelementsjwtNoStreamElements JWT credential for the integration.
registrationnumberNoCompany registration number.
financialstartmonthNoMonth the financial year starts (month name or number).
paymentpagedisabledNoWhether the public payment page is disabled.
salestaxrecoverableNoWhether input sales tax / VAT is recoverable for the business.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / details / properties / payrollsettings
      Added value: +{
      +  "additionalProperties": {
      +    "anyOf": [
      +      {
      +        "type": "array"
      +      },
      +      {
      +        "type": "boolean"
      +      },
      +      {
      +        "type": "integer"
      +      },
      +      {
      +        "type": "null"
      +      },
      +      {
      +        "type": "number"
      +      },
      +      {
      +        "type": "object"
      +      },
      +      {
      +        "type": "string"
      +      }
      +    ]
      +  },
      +  "description": "The business's answers to its country's payroll pack: `settings[].id` -> value, plus \"jurisdiction\" -> a `jurisdictions[].code`. Replace semantics: send the whole map. A key or value the pack does not declare is refused {error, reason \"payrollsettings-invalid\", message} and nothing changes. PROD-2403.",
      +  "type": "object"
      +}
  2. Changed1 schema field changed
    • addedInput schema / properties / autofxadjustment
      Added value: +{
      +  "description": "When true, settle_bills books the FX gain/loss line on a cross-currency bill payment (within 3%) without asking for confirmation. Off by default: the line is proposed and the user confirms it.",
      +  "type": "boolean"
      +}
  3. Changed1 schema field changed
    • addedInput schema / properties / quotetitle
      Added value: +{
      +  "description": "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\".",
      +  "type": "string"
      +}
  4. Changed1 schema field changed
    • addedInput schema / properties / details / properties / registrations
      Added value: +{
      +  "additionalProperties": {
      +    "type": "string"
      +  },
      +  "description": "Statutory registration numbers as a keyed map (locale slug -> value), e.g. {\"paye\": \"7610...\"}. Replace semantics: send the whole map; the server stores it verbatim, capped at 32 keys (key ^[a-z0-9_]{1,32}$, value <=64 chars). PROD-1343.",
      +  "type": "object"
      +}
  5. Changed2 schema fields changed
    • changedInput schema / properties / details / description
      Previous value: -"Nested profile details. Currently carries the legal entity type."New value: +"Nested profile details. Currently carries the legal entity type and the subscription billing contact."
    • addedInput schema / properties / details / properties / billingcontact
      Added value: +{
      +  "description": "Owner-maintained billing/receipt email for this business's own stub subscription (PROD-1158). Blank or \"$delete\" clears it; unset falls back to the business email.",
      +  "type": "string"
      +}
  6. Changed71 schema fields changed
    • addedInput schema / properties / about / description
      Added value: +"Short description / bio of the business shown on public pages."
    • addedInput schema / properties / accountname / description
      Added value: +"Bank account holder name shown on invoices."
    • addedInput schema / properties / accountnumber / description
      Added value: +"Bank account number shown on invoices."
    • addedInput schema / properties / accounttype / description
      Added value: +"Bank account type (e.g. \"cheque\", \"savings\")."
    • addedInput schema / properties / address / description
      Added value: +"Street address line 1."
    • addedInput schema / properties / address2 / description
      Added value: +"Street address line 2."
    • addedInput schema / properties / age / description
      Added value: +"Age of the business (label, e.g. how long it has been trading)."
    • addedInput schema / properties / bank / description
      Added value: +"Bank name for the account shown on invoices."
    • addedInput schema / properties / branchcode / description
      Added value: +"Bank branch code shown on invoices."
    • addedInput schema / properties / charity / description
      Added value: +"Whether the business is a charity / non-profit."
    • addedInput schema / properties / city / description
      Added value: +"City / town."
    • addedInput schema / properties / country / description
      Added value: +"Country (name or code)."
    • addedInput schema / properties / currency / description
      Added value: +"Business base currency, ISO 4217 (e.g. \"ZAR\", \"USD\")."
    • addedInput schema / properties / customizations / description
      Added value: +"JSON string of UI / branding customizations for the business."
    • addedInput schema / properties / details / description
      Added value: +"Nested profile details. Currently carries the legal entity type."
    • addedInput schema / properties / details / properties / entitytype / description
      Added value: +"Legal entity type of the business (validated against the business's locale-specific options)."
    • addedInput schema / properties / employees / description
      Added value: +"Number of employees (as a label / band)."
    • addedInput schema / properties / experience / description
      Added value: +"Founder's business / industry experience (label)."
    • addedInput schema / properties / featurepreview / description
      Added value: +"Whether the business opts into preview / beta features."
    • addedInput schema / properties / financialstartday / description
      Added value: +"Day of the month the financial year starts (1-31)."
    • addedInput schema / properties / financialstartmonth / description
      Added value: +"Month the financial year starts (month name or number)."
    • addedInput schema / properties / id / description
      Added value: +"This business's id. Optional — defaults to the authenticated token's own business; supply only to target a specific business."
    • addedInput schema / properties / incometaxnumber / description
      Added value: +"Income-tax reference number."
    • addedInput schema / properties / industry / description
      Added value: +"Industry the business operates in."
    • addedInput schema / properties / invoicebankid / description
      Added value: +"Id of the bank account to display on invoices."
    • addedInput schema / properties / invoicemessage / description
      Added value: +"Default customer-facing message on new invoices."
    • addedInput schema / properties / invoicenotes / description
      Added value: +"Default notes text placed on new invoices."
    • addedInput schema / properties / invoiceoffset / description
      Added value: +"Starting offset added to auto-generated invoice numbers."
    • addedInput schema / properties / invoicetitle / description
      Added value: +"Default heading / title used on invoices."
    • addedInput schema / properties / lastreviewed / description
      Added value: +"Date the business's books were last reviewed (ISO 8601)."
    • addedInput schema / properties / logo / description
      Added value: +"Business logo image URL (or data URI)."
    • addedInput schema / properties / name / description
      Added value: +"Trading / display name of the business."
    • addedInput schema / properties / openingbalance / description
      Added value: +"Opening cash / bank balance carried into the books, in the base currency."
    • addedInput schema / properties / payenumber / description
      Added value: +"PAYE (payroll income-tax) reference number."
    • addedInput schema / properties / paymentbankid / description
      Added value: +"Id of the bank account payments are collected into."
    • addedInput schema / properties / paymentpagedisabled / description
      Added value: +"Whether the public payment page is disabled."
    • addedInput schema / properties / paymentpagelogo / description
      Added value: +"Logo image URL shown on the hosted payment page."
    • addedInput schema / properties / paymentpagename / description
      Added value: +"Display name shown on the hosted payment page."
    • addedInput schema / properties / phone / description
      Added value: +"Business contact phone number."
    • addedInput schema / properties / postalcode / description
      Added value: +"Postal / ZIP code."
    • addedInput schema / properties / product / description
      Added value: +"Whether the business sells products (goods)."
    • addedInput schema / properties / proofofdelivery / description
      Added value: +"Whether proof-of-delivery capture is enabled."
    • addedInput schema / properties / quotemessage / description
      Added value: +"Default customer-facing message on new quotes."
    • addedInput schema / properties / quotenotes / description
      Added value: +"Default notes text placed on new quotes."
    • addedInput schema / properties / referrer / description
      Added value: +"How the business was referred (referral source)."
    • addedInput schema / properties / region / description
      Added value: +"State / province / region."
    • addedInput schema / properties / registrationnumber / description
      Added value: +"Company registration number."
    • addedInput schema / properties / salestax / description
      Added value: +"Whether sales tax / VAT is enabled for the business."
    • addedInput schema / properties / salestaxcron / description
      Added value: +"Cron expression driving sales-tax return reminders / automation."
    • addedInput schema / properties / salestaxdueday / description
      Added value: +"Day of the period on which the sales-tax return is due."
    • addedInput schema / properties / salestaxexclusive / description
      Added value: +"Default for whether new invoice / product line items are entered VAT-exclusive (price shown ex-VAT, tax added on top) rather than inclusive."
    • addedInput schema / properties / salestaxnumber / description
      Added value: +"Sales-tax / VAT registration number."
    • addedInput schema / properties / salestaxrate / description
      Added value: +"Default sales-tax / VAT rate as a decimal fraction (e.g. 0.15 = 15%)."
    • addedInput schema / properties / salestaxrecoverable / description
      Added value: +"Whether input sales tax / VAT is recoverable for the business."
    • addedInput schema / properties / salestaxschedule / description
      Added value: +"Sales-tax filing schedule (e.g. monthly / bi-monthly)."
    • addedInput schema / properties / sdlnumber / description
      Added value: +"SDL (skills development levy) reference number."
    • addedInput schema / properties / service / description
      Added value: +"Whether the business sells services."
    • addedInput schema / properties / showbank / description
      Added value: +"Whether to show the business's bank details on invoices."
    • addedInput schema / properties / streamelementsid / description
      Added value: +"StreamElements account id, for the StreamElements integration."
    • addedInput schema / properties / streamelementsjwt / description
      Added value: +"StreamElements JWT credential for the integration."
    • addedInput schema / properties / suburb / description
      Added value: +"Suburb."
    • addedInput schema / properties / tag / description
      Added value: +"Unique public vanity tag/slug for the business (used in its public page URL and for segmentation)."
    • addedInput schema / properties / taxregime / description
      Added value: +"Tax regime the business is registered under."
    • addedInput schema / properties / tradesourcecode / description
      Added value: +"SARS trade / source code classifying the business's main activity."
    • addedInput schema / properties / turnover / description
      Added value: +"Annual turnover in the base currency."
    • addedInput schema / properties / twitchid / description
      Added value: +"Twitch channel id, for the Twitch / streamer integration."
    • addedInput schema / properties / uifnumber / description
      Added value: +"UIF (unemployment insurance fund) reference number."
    • addedInput schema / properties / vanitypageaction / description
      Added value: +"Call-to-action mode for the business's public vanity page, e.g. \"donate\" or \"pay\"."
    • addedInput schema / properties / vatnumber / description
      Added value: +"VAT registration number."
    • addedInput schema / properties / webhook / description
      Added value: +"Webhook URL to notify on business events."
    • addedInput schema / properties / website / description
      Added value: +"Business website URL."
  7. First observed

TDQS

Score is being calculated.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources