{"openapi":"3.1.0","info":{"title":"GET /api/v1/counterparty-naming/payee-lines","version":"1.0.0","description":"Preview giving processor lines back to their payees"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/counterparty-naming/payee-lines":{"get":{"tags":["counterparty-naming"],"summary":"Preview giving processor lines back to their payees","description":"Bank lines such as ``GUSTO CND - Laura Combs - US contractor payment`` pay the person named in the description. Lists the rows still stored under the processor (or no name) that would take the payee's name, the saved renames of the processor that would be removed, and rows named something else that need a person's judgement. Nothing is changed.","operationId":"preview_payee_lines","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"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_PayeeLinePreviewResponse_"}}}},"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":"preview_payee_lines_api_v1_counterparty_naming_payee_lines_get"}}},"components":{"schemas":{"PayeeLineAlias":{"properties":{"id":{"type":"string","title":"Id"},"key_name":{"type":"string","title":"Key Name","description":"Processor the saved rename is keyed on, as saved."},"display_name":{"type":"string","title":"Display Name","description":"Payee name the rename shows for every processor row."},"transaction_count":{"type":"integer","title":"Transaction Count","description":"Transactions currently displayed under this rename."}},"type":"object","required":["id","key_name","display_name","transaction_count"],"title":"PayeeLineAlias"},"PayeeLineMove":{"properties":{"from_name":{"type":"string","title":"From Name","description":"Name the rows are stored under now (the processor)."},"to_name":{"type":"string","title":"To Name","description":"Payee the description names."},"transaction_count":{"type":"integer","title":"Transaction Count"}},"type":"object","required":["from_name","to_name","transaction_count"],"title":"PayeeLineMove"},"PayeeLinePreviewResponse":{"properties":{"transaction_count":{"type":"integer","title":"Transaction Count","description":"Rows that would be renamed."},"plan_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Hash","description":"Digest of the rows and saved renames the apply would change. Pass it as plan_hash to apply_counterparty_payee_lines."},"moves":{"items":{"$ref":"#/components/schemas/PayeeLineMove"},"type":"array","title":"Moves","description":"Most transactions first; at most 200."},"aliases":{"items":{"$ref":"#/components/schemas/PayeeLineAlias"},"type":"array","title":"Aliases","description":"Saved renames that would be removed."},"review_count":{"type":"integer","title":"Review Count"},"review":{"items":{"$ref":"#/components/schemas/PayeeLineReviewRow"},"type":"array","title":"Review","description":"Newest first; at most 50."}},"type":"object","required":["transaction_count","review_count"],"title":"PayeeLinePreviewResponse"},"PayeeLineReviewRow":{"properties":{"transaction_id":{"type":"string","title":"Transaction Id"},"date":{"type":"string","title":"Date","description":"Transaction date, YYYY-MM-DD."},"description":{"type":"string","title":"Description"},"stored_name":{"type":"string","title":"Stored Name","description":"Name the row is stored under."},"description_names":{"type":"string","title":"Description Names","description":"Payee the description names."},"amount_cents":{"type":"integer","title":"Amount Cents"}},"type":"object","required":["transaction_id","date","description","stored_name","description_names","amount_cents"],"title":"PayeeLineReviewRow"},"SuccessEnvelope_PayeeLinePreviewResponse_":{"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/PayeeLinePreviewResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[PayeeLinePreviewResponse]"},"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":[]}]}