Update business

PUT/api/v1/businesses/{business_id}

Update business details.

This endpoint supports updating standard business information including:

  • Business name, mailbox, properties
  • Teal instance, Stripe account ID
  • Shopify integration details
  • Stripe subscription items (subscription_items)

Note: This endpoint updates business details only.

Args: business_id (str): The ID of the business to update. payload (BusinessUpdateRequest): The updated business details.

Returns: BusinessResponse: The updated business details.

Operation ID: update_business·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

business_idstringrequired

Request body

namestring

Business display name.

logo_urlstring

URL to business logo/avatar image.

default_currencystring

Default currency for the business (USD, CAD, AUD, EUR, or GBP).

tax_year_end_monthinteger

Month when the tax/fiscal year ends (1-12).

start_datestring · date

Date the business started operating (founding date). Distinct from entries_start, which anchors bookkeeping imports.

accounting_basisstring

Default accounting basis for financial reports: 'cash' or 'accrual'. Persisted on the business; also synced to Teal.

mailboxstring

Email prefix for bill forwarding.

inventory_modestring

Inventory module flavor: 'cpg' exposes the Supply Chain map, production recipes, and landed COGS; 'finished_goods' hides the CPG-only surfaces.

ap_approval_enabledboolean

Toggle the AP bill approval workflow for this business. When off (default), bills post directly to 'received'. When on, bills route through 'pending_approval' and only post to the GL once approved.

ap_due_date_basisstring

Which date vendor-bill payment terms count from for bills that arrive via the AP inbox or upload. 'invoice_date' (default) keeps the due date printed on the invoice. 'received_date' runs the terms (vendor default, else business default, else the span the invoice itself implies) from the day the bill was received, so an invoice dated weeks before it reached you isn't created overdue. Applies to bills ingested after the change; existing bills are not rewritten.

auto_rename_counterpartiesboolean

Toggle automated counterparty re-resolution for transactions that already have a counterparty assigned. On by default. Turn off to stop description edits and the tenant-wide regen from re-deriving counterparty names on existing rows. Manually-set counterparties are always protected regardless of this setting.

Responses

200Successful Response

successboolean
messagestring
codestring
dataBusinessResponse

401Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

403Forbidden - Insufficient permissions

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

422Validation Error

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.