{"openapi":"3.1.0","info":{"title":"POST /api/v1/counterparty-naming/merge","version":"1.0.0","description":"Merge counterparty groups into one name"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/counterparty-naming/merge":{"post":{"tags":["counterparty-naming"],"summary":"Merge counterparty groups into one name","description":"Re-points every transaction in the source groups to ``target_name`` (and ``target_registry_id`` when given), marks them user-edited so re-syncs keep the name, and remembers each folded-in raw string as an alias so future ingests display the chosen name.","operationId":"merge_counterparties","parameters":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MergeCounterpartiesRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_MergeCounterpartiesResponse_"}}}},"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/invalid token 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":"merge_counterparties_api_v1_counterparty_naming_merge_post"}}},"components":{"schemas":{"CounterpartyRef":{"properties":{"counterparty_name":{"type":"string","maxLength":500,"minLength":1,"title":"Counterparty Name"},"registry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry Id"}},"type":"object","required":["counterparty_name"],"title":"CounterpartyRef","description":"Identifies one counterparty group as shown on the Counterparties page.\n\nThe page groups transactions by *display* name plus registry link, so a\nref carries both: ``registry_id`` when the group is registry-linked\n(transactions are matched by that id), otherwise the raw/aliased name\n(transactions are matched by name, case-insensitively, including raw\nstrings whose alias displays as this name)."},"MergeCounterpartiesRequest":{"properties":{"sources":{"items":{"$ref":"#/components/schemas/CounterpartyRef"},"type":"array","maxItems":200,"minItems":1,"title":"Sources","description":"Groups to fold into the target."},"target_name":{"type":"string","maxLength":500,"minLength":1,"title":"Target Name","description":"Name every merged transaction gets."},"target_registry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Registry Id","description":"Registry entry the merged transactions should link to. Pass the registry_id of the chosen canonical group when it is linked; omit to leave the merged transactions unlinked."}},"type":"object","required":["sources","target_name"],"title":"MergeCounterpartiesRequest"},"MergeCounterpartiesResponse":{"properties":{"target_name":{"type":"string","title":"Target Name"},"target_registry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Registry Id"},"sources_merged":{"type":"integer","title":"Sources Merged"},"transactions_updated":{"type":"integer","title":"Transactions Updated"}},"type":"object","required":["target_name","sources_merged","transactions_updated"],"title":"MergeCounterpartiesResponse"},"SuccessEnvelope_MergeCounterpartiesResponse_":{"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/MergeCounterpartiesResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[MergeCounterpartiesResponse]"},"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":[]}]}