Delete business

DELETE /api/v1/businesses/{business_id}

Delete a business and all associated resources (async via Temporal).

Safety: requires a JSON body with confirm_name matching the business's name (case-insensitive, trimmed). Guards against single-click muscle-memory deletes — this endpoint wipes ~80 related tables via a Temporal workflow and is irreversible.

Cleanup Process:

For each Plaid connection:
- Teal API cleanup (transactions, journal entries, source accounts, ledgers)
- Local DB cleanup (Transactions → Line Entries → Journal Entries → Ledgers)
- PlaidItem deletion
- Plaid token revocation
Teal instance deletion
User associations cleanup
Business record deletion

Operation ID: delete_business_api_v1_businesses__business_id__delete · 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_id string required

Query

confirm_delete boolean default: False

Responses

204 Successful Response

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

DELETE /api/v1/businesses/{business_id}

bash

curl -X DELETE 'https://api.ondayzero.com/api/v1/businesses/{business_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d ''

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/businesses/{business_id}', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {}

response = httpx.delete("https://api.ondayzero.com/api/v1/businesses/{business_id}", headers=headers, json=payload)
data = response.json()