{"openapi":"3.1.0","info":{"title":"GET /api/v1/counterparty-defaults/conflicts","version":"1.0.0","description":"Pre-check conflicts for a counterparty default"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/counterparty-defaults/conflicts":{"get":{"tags":["counterparty-defaults"],"summary":"Pre-check conflicts for a counterparty default","description":"Bank rules and other defaults that already decide this counterparty.\n\nCall before saving a default so the UI can say \"rule X sends this\ncounterparty to Y\" (the same list create / update return).","operationId":"get_counterparty_default_conflicts","parameters":[{"name":"counterparty_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Counterparty Name"}},{"name":"registry_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry Id"}},{"name":"ledger_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The category the default would book; when given, only entries booking a different category are returned","title":"Ledger Id"},"description":"The category the default would book; when given, only entries booking a different category are returned"},{"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"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CounterpartyDefaultConflictsResponse_"}}}},"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"}}}},"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":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"get_counterparty_default_conflicts_api_v1_counterparty_defaults_conflicts_get"}}},"components":{"schemas":{"CounterpartyDefaultConflict":{"properties":{"type":{"type":"string","enum":["bank_rule","default"],"title":"Type"},"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"ledger_id":{"type":"string","title":"Ledger Id"},"ledger_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ledger Name"}},"type":"object","required":["type","id","name","ledger_id"],"title":"CounterpartyDefaultConflict","description":"A bank rule or another default that disagrees with a default.\n\n``type = \"bank_rule\"``: an enabled rule whose counterparty condition\nmatches this counterparty and books ``ledger_id``. A rule a person wrote\noutranks the default; an auto-learned rule loses to it.\n``type = \"default\"``: another default for the same counterparty under\nthe other key kind (registry entry vs name)."},"CounterpartyDefaultConflictsResponse":{"properties":{"conflicts":{"items":{"$ref":"#/components/schemas/CounterpartyDefaultConflict"},"type":"array","title":"Conflicts"}},"type":"object","title":"CounterpartyDefaultConflictsResponse","description":"Pre-check: what a default for this counterparty would disagree with."},"SuccessEnvelope_CounterpartyDefaultConflictsResponse_":{"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/CounterpartyDefaultConflictsResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CounterpartyDefaultConflictsResponse]"},"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":[]}]}