{"openapi":"3.1.0","info":{"title":"GET /api/v1/advisory-firms/{firm_id}/cleanup-sessions","version":"1.0.0","description":"List cleanup sessions for a firm"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/advisory-firms/{firm_id}/cleanup-sessions":{"get":{"tags":["intercompany-cleanup"],"summary":"List cleanup sessions for a firm","operationId":"list_cleanup_sessions","parameters":[{"name":"firm_id","in":"path","required":true,"schema":{"type":"string","title":"Firm Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CleanupSessionListResponse_"}}}},"401":{"description":"Unauthorized - Missing/invalid token 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":"list_cleanup_sessions_api_v1_advisory_firms__firm_id__cleanup_sessions_get"}}},"components":{"schemas":{"CleanupSessionListResponse":{"properties":{"sessions":{"items":{"$ref":"#/components/schemas/CleanupSessionResponse"},"type":"array","title":"Sessions"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["count"],"title":"CleanupSessionListResponse"},"CleanupSessionResponse":{"properties":{"id":{"type":"string","title":"Id"},"advisory_firm_id":{"type":"string","title":"Advisory Firm Id"},"business_ids":{"items":{"type":"string"},"type":"array","title":"Business Ids"},"date_start":{"type":"string","title":"Date Start"},"date_end":{"type":"string","title":"Date End"},"date_tolerance_days":{"type":"integer","title":"Date Tolerance Days"},"status":{"type":"string","title":"Status"},"run_count":{"type":"integer","title":"Run Count"},"last_run_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Run At"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"},"pairs_proposed":{"type":"integer","title":"Pairs Proposed"},"pairs_confirmed":{"type":"integer","title":"Pairs Confirmed"},"orphans_proposed":{"type":"integer","title":"Orphans Proposed"},"orphans_resolved":{"type":"integer","title":"Orphans Resolved"},"total_cents_cleared":{"type":"integer","title":"Total Cents Cleared"},"total_cents_in_scope":{"type":"integer","title":"Total Cents In Scope"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["id","advisory_firm_id","date_start","date_end","date_tolerance_days","status","run_count","pairs_proposed","pairs_confirmed","orphans_proposed","orphans_resolved","total_cents_cleared","total_cents_in_scope"],"title":"CleanupSessionResponse","description":"Session status + the operator's 'how deep am I' counters."},"SuccessEnvelope_CleanupSessionListResponse_":{"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/CleanupSessionListResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CleanupSessionListResponse]"},"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":[]}]}