{"openapi":"3.1.0","info":{"title":"POST /api/v1/credit/sandbox/walks","version":"1.0.0","description":"Record a walk of Appendix B"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/sandbox/walks":{"post":{"tags":["credit"],"summary":"Record a walk of Appendix B","description":"Sandbox only. Keeps the result of a walk run by the validator (`scripts/admin/credit/validate_tie_e2e.py`) as the sandbox's last walk, which the live business's launch checklist reads. The walk passes only if every step was judged and matched: a step with a null `passed` is not a pass. The statements' close and due dates are read from the line and stored with it. Staging the book records a walk too; this one replaces it as the latest.","operationId":"record_sandbox_walk","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/SandboxWalkRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_SandboxWalkResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: due_date: Input should be a valid date","errors":{"due_date":"Input should be a valid date"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"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"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"error":"not_found","message":"Resource not found","code":"NOT_FOUND_001","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":"record_sandbox_walk_api_v1_credit_sandbox_walks_post"}}},"components":{"schemas":{"SandboxWalkRequest":{"properties":{"program_id":{"type":"string","title":"Program Id","description":"The program the walk ran on."},"credit_line_id":{"type":"string","title":"Credit Line Id","description":"The line the walk opened."},"steps":{"items":{"$ref":"#/components/schemas/SandboxWalkStep"},"type":"array","maxItems":500,"minItems":1,"title":"Steps","description":"Every step the validator judged, in the order it ran them."}},"additionalProperties":false,"type":"object","required":["program_id","credit_line_id","steps"],"title":"SandboxWalkRequest"},"SandboxWalkResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The walk record's id."},"passed":{"type":"boolean","title":"Passed","description":"True only when every step was judged and matched."},"steps_failed":{"items":{"type":"string"},"type":"array","title":"Steps Failed","description":"Names of the steps that did not match."},"steps_unjudged":{"items":{"type":"string"},"type":"array","title":"Steps Unjudged","description":"Names of the steps not judged."},"statements":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Statements","description":"The line's statements as the sandbox holds them: period start, close (`issued_on`) and `due_date`, amount due."}},"type":"object","required":["id","passed","steps_failed","steps_unjudged","statements"],"title":"SandboxWalkResponse"},"SandboxWalkStep":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","description":"What was checked, e.g. `March close date`."},"expected":{"title":"Expected","description":"The contract's value."},"actual":{"title":"Actual","description":"What the sandbox returned."},"passed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Passed","description":"True when it matched, false when it did not, null when the step was not judged. A null step is not a pass."}},"additionalProperties":false,"type":"object","required":["name"],"title":"SandboxWalkStep"},"SuccessEnvelope_SandboxWalkResponse_":{"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/SandboxWalkResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[SandboxWalkResponse]"},"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":[]}]}