{"openapi":"3.1.0","info":{"title":"POST /api/v1/ledgers/cleanup/analyze","version":"1.0.0","description":"Analyse the chart of accounts for cleanup"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/ledgers/cleanup/analyze":{"post":{"tags":["ledgers"],"summary":"Analyse the chart of accounts for cleanup","description":"Deterministic cleanup analysis: near-duplicate accounts, accounts with no recent activity, wrong account types, single-child parents and naming inconsistencies. Saves a draft plan; nothing is changed.","operationId":"analyze_coa_cleanup","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CoaCleanupAnalyzeRequest"},{"type":"null"}],"title":"Payload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CoaCleanupPlanResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: due_date: Input should be a valid date","errors":{"due_date":"Input should be a valid date"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"error":"not_found","message":"Resource not found","code":"NOT_FOUND_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"analyze_coa_cleanup_api_v1_ledgers_cleanup_analyze_post"}}},"components":{"schemas":{"CoaCleanupActionResponse":{"properties":{"id":{"type":"string","title":"Id"},"kind":{"type":"string","enum":["merge","inactivate","retype","reparent","rename"],"title":"Kind"},"disposition":{"type":"string","enum":["proposed","manual","protected"],"title":"Disposition"},"enabled":{"type":"boolean","title":"Enabled","description":"Runs when the plan is approved."},"ledger_id":{"type":"string","title":"Ledger Id","description":"The account the action changes (a merge's source)."},"ledger_name":{"type":"string","title":"Ledger Name"},"reason":{"type":"string","title":"Reason"},"evidence":{"additionalProperties":true,"type":"object","title":"Evidence","description":"Counts, last activity and similarity the detector used."},"affects_locked_period":{"type":"boolean","title":"Affects Locked Period","default":false},"irreversible":{"type":"boolean","title":"Irreversible","description":"A merge undo cannot put back exactly; approval needs the confirmation text.","default":false},"manual_reasons":{"items":{"type":"string"},"type":"array","title":"Manual Reasons"},"protected_references":{"items":{"type":"string"},"type":"array","title":"Protected References"},"override_cross_type":{"type":"boolean","title":"Override Cross Type","default":false},"status":{"type":"string","enum":["pending","applied","skipped","failed"],"title":"Status","default":"pending"},"result_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Result Note"},"to_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Name"},"to_account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Account Number"},"from_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From Type"},"to_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Type"},"from_sub_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From Sub Type"},"to_sub_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Sub Type"},"from_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From Parent Id"},"to_parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Parent Id"},"target_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Id"},"target_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Name"}},"type":"object","required":["id","kind","disposition","enabled","ledger_id","ledger_name","reason"],"title":"CoaCleanupActionResponse"},"CoaCleanupAnalyzeRequest":{"properties":{"inactivity_months":{"type":"integer","maximum":60.0,"minimum":3.0,"title":"Inactivity Months","description":"Months without activity before an account is a candidate to inactivate.","default":12}},"additionalProperties":false,"type":"object","title":"CoaCleanupAnalyzeRequest"},"CoaCleanupPlanResponse":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Null for an analysis that was not saved."},"business_id":{"type":"string","title":"Business Id"},"status":{"type":"string","enum":["draft","filed","applied","partially_applied","discarded"],"title":"Status"},"actions":{"items":{"$ref":"#/components/schemas/CoaCleanupActionResponse"},"type":"array","title":"Actions"},"findings":{"additionalProperties":true,"type":"object","title":"Findings"},"summary":{"additionalProperties":true,"type":"object","title":"Summary"},"params":{"additionalProperties":true,"type":"object","title":"Params"},"plan_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Hash"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"pending_change_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pending Change Id"},"pending_change_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pending Change Status"},"review_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Review Url"},"automation_run_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Automation Run Id"},"applied_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Applied At"},"requires_confirmation_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requires Confirmation Text","description":"Text the approval note must contain when the plan has irreversible merges."},"guarantees":{"items":{"type":"string"},"type":"array","title":"Guarantees"}},"type":"object","required":["business_id","status","actions"],"title":"CoaCleanupPlanResponse"},"SuccessEnvelope_CoaCleanupPlanResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/CoaCleanupPlanResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CoaCleanupPlanResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}