{"openapi":"3.1.0","info":{"title":"GET /api/v1/advisory-firms/{firm_id}/settlement-proposals","version":"1.0.0","description":"Pairwise net intercompany positions ready to settle"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/advisory-firms/{firm_id}/settlement-proposals":{"get":{"tags":["intercompany-cleanup"],"summary":"Pairwise net intercompany positions ready to settle","description":"Derived from open elimination entries: who owes whom, net, per entity pair. Largest positions first.","operationId":"get_settlement_proposals_api_v1_advisory_firms__firm_id__settlement_proposals_get","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_SettlementProposalsResponse_"}}}},"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":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SettlementProposalRow":{"properties":{"payer_business_id":{"type":"string","title":"Payer Business Id"},"payer_business_name":{"type":"string","title":"Payer Business Name"},"payee_business_id":{"type":"string","title":"Payee Business Id"},"payee_business_name":{"type":"string","title":"Payee Business Name"},"net_cents":{"type":"integer","title":"Net Cents"},"open_item_count":{"type":"integer","title":"Open Item Count"}},"type":"object","required":["payer_business_id","payer_business_name","payee_business_id","payee_business_name","net_cents","open_item_count"],"title":"SettlementProposalRow","description":"One entity pair's net open intercompany position."},"SettlementProposalsResponse":{"properties":{"proposals":{"items":{"$ref":"#/components/schemas/SettlementProposalRow"},"type":"array","title":"Proposals"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["count"],"title":"SettlementProposalsResponse"},"SuccessEnvelope_SettlementProposalsResponse_":{"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/SettlementProposalsResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[SettlementProposalsResponse]"},"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":[]}]}