{"openapi":"3.1.0","info":{"title":"GET /api/v1/advisory-firms/{firm_id}/cleanup-sessions/{session_id}/candidates","version":"1.0.0","description":"List match candidates for a session"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/advisory-firms/{firm_id}/cleanup-sessions/{session_id}/candidates":{"get":{"tags":["intercompany-cleanup"],"summary":"List match candidates for a session","description":"Impact-sorted (amount desc), cursor-paginated. Filter by ``case`` (internal_transfer | parent_intercompany | data_gap | hidden_detail) and ``status`` (proposed | confirmed | rejected | applied).","operationId":"list_session_candidates_api_v1_advisory_firms__firm_id__cleanup_sessions__session_id__candidates_get","parameters":[{"name":"firm_id","in":"path","required":true,"schema":{"type":"string","title":"Firm Id"}},{"name":"session_id","in":"path","required":true,"schema":{"type":"string","title":"Session Id"}},{"name":"case","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by case type","title":"Case"},"description":"Filter by case type"},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by status","title":"Status"},"description":"Filter by status"},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","pattern":"^(next|prev)$","default":"next","title":"Direction"}},{"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_MatchCandidateListResponse_"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"detail":"Resource not found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CandidateLeg":{"properties":{"transaction_id":{"type":"string","title":"Transaction Id"},"business_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Id"},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Name"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"amount_cents":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount Cents"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name"}},"type":"object","required":["transaction_id"],"title":"CandidateLeg","description":"One side of a candidate, ready for mirror-layout rendering."},"ExpectedCounterparty":{"properties":{"map_entry_id":{"type":"string","title":"Map Entry Id"},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name"}},"type":"object","required":["map_entry_id"],"title":"ExpectedCounterparty","description":"Where the engine believes the missing leg lives (Case B)."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"MatchCandidateListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/MatchCandidateResponse"},"type":"array","title":"Items"},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"prev_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Cursor"},"has_next":{"type":"boolean","title":"Has Next","default":false},"has_prev":{"type":"boolean","title":"Has Prev","default":false}},"type":"object","title":"MatchCandidateListResponse","description":"Cursor-paginated, impact-sorted candidate list."},"MatchCandidateResponse":{"properties":{"id":{"type":"string","title":"Id"},"cleanup_session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cleanup Session Id"},"case_type":{"type":"string","title":"Case Type"},"status":{"type":"string","title":"Status"},"amount_cents":{"type":"integer","title":"Amount Cents"},"date_delta_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Date Delta Days"},"confidence":{"type":"integer","title":"Confidence"},"confidence_factors":{"additionalProperties":true,"type":"object","title":"Confidence Factors"},"leg_a":{"anyOf":[{"$ref":"#/components/schemas/CandidateLeg"},{"type":"null"}]},"leg_b":{"anyOf":[{"$ref":"#/components/schemas/CandidateLeg"},{"type":"null"}]},"expected_counterparty":{"anyOf":[{"$ref":"#/components/schemas/ExpectedCounterparty"},{"type":"null"}]},"resolved_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resolved At"}},"type":"object","required":["id","case_type","status","amount_cents","confidence"],"title":"MatchCandidateResponse","description":"A proposed pair or classified orphan with its explanation."},"SuccessEnvelope_MatchCandidateListResponse_":{"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/MatchCandidateListResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[MatchCandidateListResponse]"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}