{"openapi":"3.1.0","info":{"title":"GET /api/v1/transfer-review","version":"1.0.0","description":"Transactions that look wrongly booked as transfers"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/transfer-review":{"get":{"tags":["transfer-review"],"summary":"Transactions that look wrongly booked as transfers","description":"Transactions in Transfers Between Accounts whose own data does not say transfer (no Plaid transfer or card-payment category, no transfer or card-payment wording), newest first. Each names the row it was most likely paired with, any learned rule that keeps routing the vendor to Transfers, and `after`: what marking it not a transfer would do.","operationId":"get_transfer_review","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":200,"title":"Limit"}},{"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_TransferReviewResponse_"}}}},"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":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"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"}}}}},"x-fastapi-operation-id":"get_transfer_review_api_v1_transfer_review_get"}}},"components":{"schemas":{"SuccessEnvelope_TransferReviewResponse_":{"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/TransferReviewResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[TransferReviewResponse]"},"TransferReviewAfter":{"properties":{"action":{"type":"string","enum":["book","suggest","uncategorized"],"title":"Action","description":"`book`: booked to `ledger_name`. `suggest`: left in Uncategorized with `ledger_name` held as a suggestion to confirm (see `hold_reason`). `uncategorized`: nothing matched; left in Uncategorized for review."},"ledger_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ledger Id"},"ledger_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ledger Name"},"hold_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hold Reason","description":"Why a suggestion is held: `auto_categorize_off` or `below_threshold`"}},"type":"object","required":["action"],"title":"TransferReviewAfter","description":"Where \"Not a transfer\" would send the row."},"TransferReviewResponse":{"properties":{"suspects":{"items":{"$ref":"#/components/schemas/TransferReviewSuspect"},"type":"array","title":"Suspects"},"count":{"type":"integer","title":"Count","description":"Suspect rows found (suspects may be capped)"},"transfers_checked":{"type":"integer","title":"Transfers Checked","description":"Transfer-coded rows checked"},"auto_categorize_enabled":{"type":"boolean","title":"Auto Categorize Enabled","description":"The business's auto-categorize switch. Off: history and pattern matches are held as suggestions instead of booked.","default":true}},"type":"object","required":["suspects","count","transfers_checked"],"title":"TransferReviewResponse","description":"Transactions booked as transfers that look like ordinary activity."},"TransferReviewSuspect":{"properties":{"transaction_id":{"type":"string","title":"Transaction Id"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"amount_cents":{"type":"integer","title":"Amount Cents","default":0},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"counterparty":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty"},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name"},"has_transfer_evidence":{"type":"boolean","title":"Has Transfer Evidence","description":"Plaid labels it a transfer or card payment, or the description says transfer / card payment"},"locked":{"type":"boolean","title":"Locked","description":"In a closed accounting period; cannot be changed","default":false},"partner":{"anyOf":[{"$ref":"#/components/schemas/TransferReviewTransaction"},{"type":"null"}],"description":"The transfer-coded row on another account it was most likely paired with"},"learned_rule_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Learned Rule Id","description":"A learned rule that keeps sending this vendor to Transfers"},"learned_rule_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Learned Rule Name"},"after":{"anyOf":[{"$ref":"#/components/schemas/TransferReviewAfter"},{"type":"null"}],"description":"What marking it not a transfer would do"}},"type":"object","required":["transaction_id","has_transfer_evidence"],"title":"TransferReviewSuspect","description":"A transaction booked as a transfer with no transfer evidence of its own."},"TransferReviewTransaction":{"properties":{"transaction_id":{"type":"string","title":"Transaction Id"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"amount_cents":{"type":"integer","title":"Amount Cents","default":0},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"counterparty":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty"},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name"},"has_transfer_evidence":{"type":"boolean","title":"Has Transfer Evidence","description":"Plaid labels it a transfer or card payment, or the description says transfer / card payment"}},"type":"object","required":["transaction_id","has_transfer_evidence"],"title":"TransferReviewTransaction","description":"One transfer-coded transaction."},"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":[]}]}