{"openapi":"3.1.0","info":{"title":"GET /api/v1/advisory-firms/{firm_id}/tracker-candidates","version":"1.0.0","description":"List match candidates found outside any session"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/advisory-firms/{firm_id}/tracker-candidates":{"get":{"tags":["intercompany-cleanup"],"summary":"List match candidates found outside any session","description":"Pairs the always-on tracker proposed after bank syncs, with no cleanup session attached. Impact-sorted (amount desc), cursor-paginated. Same ``case`` and ``status`` filters as the session list.","operationId":"list_tracker_candidates","parameters":[{"name":"firm_id","in":"path","required":true,"schema":{"type":"string","title":"Firm 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 - 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"}}}},"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_tracker_candidates_api_v1_advisory_firms__firm_id__tracker_candidates_get"}}},"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)."},"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]"},"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":[]}]}