200Successful Response
Schema: SuccessEnvelope_BusinessResponse_
successbooleanmessagestringcodestringdataBusinessResponse
/api/v1/businesses/{business_id}Update business details.
This endpoint supports updating standard business information including:
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.
Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.
business_idstringrequiredSchema: BusinessUpdateRequest
namestringBusiness display name.
name_aliasesarray · stringOther names the business goes by (up to 20). find_business matches them as well as the name. Replaces the list; send [] to clear it.
logo_urlstringURL to business logo/avatar image.
default_currencystringDefault currency for the business (USD, CAD, AUD, EUR, or GBP).
tax_year_end_monthintegerMonth when the tax/fiscal year ends (1-12).
start_datestring · dateDate the business started operating (founding date). Distinct from entries_start, which anchors bookkeeping imports.
accounting_basisstringDefault accounting basis for financial reports: 'cash' or 'accrual'. Persisted on the business.
mailboxstringEmail prefix for bill forwarding.
inventory_modestringInventory module flavor: 'cpg' exposes the Supply Chain map, production recipes, and landed COGS; 'finished_goods' hides the CPG-only surfaces.
ap_approval_enabledbooleanToggle 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_basisstringWhich 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.
ar_subledger_modestringWhere invoice and payment journal entries post the receivable. 'off' (default) uses the one Accounts Receivable ledger. 'per_customer' posts each customer's receivable to its own 'AR - <Customer Name>' child ledger of Accounts Receivable (created on first use, or an existing 'AR - X' ledger is adopted). Applies to entries posted after the change; run POST /ar/subledgers/backfill to move historical entries.
auto_link_new_counterpartiesbooleanToggle automatic registry linking for NEW customers and vendors (creation hooks, identity layer, nightly sweep). On by default. Turn off to keep new masters unlinked until a person links them; existing links are untouched.
auto_rename_counterpartiesbooleanToggle 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.
stripe_payout_sibling_matchingbooleanMatch a Stripe payout with no deposit in this business to a Stripe-looking deposit in a sibling business of the same firm that has no Stripe account. null (default) = on only when the firm has exactly one such sibling; true/false force it.
agent_close_business_dayintegerBusiness day of the month (1-23, -1 = the last one) on which the Agent window starts closing the month that just ended: DayZero sends close.window_opened that day (Fed bank-holiday calendar, New York date). null or 0 turns it off.
Schema: SuccessEnvelope_BusinessResponse_
successbooleanmessagestringcodestringdataBusinessResponseSchema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.