{"openapi":"3.1.0","info":{"title":"GET /api/v1/counterparty-naming/rename-impact","version":"1.0.0","description":"Preview what a remembered rename would also relabel (deprecated)"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/counterparty-naming/rename-impact":{"get":{"tags":["counterparty-naming"],"summary":"Preview what a remembered rename would also relabel (deprecated)","description":"For a rename of ``transaction_ids`` to ``new_name`` with ``remember=true`` (a saved rename), counts the OTHER transactions the saved rename would relabel: rows on the same registry entries (``other_rows_by_registry``) and rows with the same raw name (``other_rows_by_name``). Rows renamed by hand keep their own name and are not counted. ``processor_guarded`` is true when some rows belong to a payment processor that pays many parties; those are renamed on their own. Nothing is changed. Deprecated: use ``POST /counterparty-naming/rename-impact`` (ids in the body, no 1000-id cap). Kept for one release.","operationId":"counterparty_rename_impact","deprecated":true,"parameters":[{"name":"transaction_ids","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":40000,"description":"Comma-separated transaction UUIDs to rename (at most 1000).","title":"Transaction Ids"},"description":"Comma-separated transaction UUIDs to rename (at most 1000)."},{"name":"new_name","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":500,"title":"New Name"}},{"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_RenameImpactResponse_"}}}},"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":"counterparty_rename_impact_api_v1_counterparty_naming_rename_impact_get"}}},"components":{"schemas":{"RenameImpactResponse":{"properties":{"other_rows_by_registry":{"type":"integer","title":"Other Rows By Registry","description":"Other transactions on the selected rows' registry entries that the registry-keyed saved rename would relabel.","default":0},"other_rows_by_name":{"type":"integer","title":"Other Rows By Name","description":"Other transactions with one of the selected rows' raw names (or named by a saved rename pointing at one) that the name-keyed saved rename would relabel.","default":0},"registry_canonical_names":{"items":{"type":"string"},"type":"array","title":"Registry Canonical Names","description":"Canonical names of the registry entries that would get the saved rename."},"processor_guarded":{"type":"boolean","title":"Processor Guarded","description":"True when some selected rows belong to a payment processor that pays many parties (Gusto, ADP, PayPal, Stripe, Bill.com, ...): those rows are renamed on their own and no saved rename is made for them.","default":false},"would_alias_key":{"anyOf":[{"type":"string","enum":["registry","name"]},{"type":"null"}],"title":"Would Alias Key","description":"``registry`` when a registry-keyed saved rename would be written, ``name`` when only name-keyed ones would, null when none."},"wire":{"type":"boolean","title":"Wire","description":"True when some selected rows are wires or bank transfers: they are renamed on their own and no saved rename is made for them, because the registry match of a wire is the correspondent bank.","default":false},"wire_other_rows":{"type":"integer","title":"Wire Other Rows","description":"Other transactions the saved rename on the wire rows would have relabelled (the collateral the guard prevented).","default":0}},"type":"object","title":"RenameImpactResponse","description":"What a ``remember=true`` rename of some transactions would also change."},"SuccessEnvelope_RenameImpactResponse_":{"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/RenameImpactResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[RenameImpactResponse]"},"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":[]}]}