DayZeroAI-native accounting firm

Start free trial

Start a historical cleanup session

POST/api/v1/advisory-firms/{firm_id}/cleanup-sessions

Creates a cleanup session over the given entities and date window, then kicks off the matching workflow. Poll the session for status and counters.

Operation ID: create_cleanup_session_api_v1_advisory_firms__firm_id__cleanup_sessions_post·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

firm_idstringrequired

Request body

Schema: CleanupSessionCreate

date_startstring · daterequired
date_endstring · daterequired
business_idsarray · string: Entities in scope; empty = every active firm business
date_tolerance_daysinteger

Responses

201Successful Response

Schema: SuccessEnvelope_CleanupRunResponse_

successboolean
messagestring
codestring
dataCleanupRunResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error - Invalid data format

Code samples

POST/api/v1/advisory-firms/{firm_id}/cleanup-sessions

bash

curl -X POST 'https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/cleanup-sessions' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "date_start": "2026-01-01",
  "date_end": "2026-01-01"
}'