{"openapi":"3.1.0","info":{"title":"GET /api/v1/credit/sweeps/runs/{run_id}","version":"1.0.0","description":"Get one daily-sweep run"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/sweeps/runs/{run_id}":{"get":{"tags":["credit"],"summary":"Get one daily-sweep run","description":"One run with every step.","operationId":"get_sweep_run","parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}},{"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_CreditSweepRunResponse_"}}}},"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":"get_sweep_run_api_v1_credit_sweeps_runs__run_id__get"}}},"components":{"schemas":{"CreditSweepRunResponse":{"properties":{"id":{"type":"string","title":"Id"},"as_of":{"type":"string","format":"date","title":"As Of"},"started_at":{"type":"string","format":"date-time","title":"Started At"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At"},"duration_ms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration Ms"},"trigger":{"type":"string","enum":["scheduled","manual","sandbox_advance"],"title":"Trigger"},"status":{"type":"string","enum":["running","succeeded","partial","failed"],"title":"Status"},"steps":{"items":{"$ref":"#/components/schemas/SweepStepResult"},"type":"array","title":"Steps"},"ledger_checks":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Ledger Checks","description":"lines_verified, chain_failures, balance_failures, sequence_failures, credit_balance_failures (a credit balance that is not the sum of its entries) and failed_lines."},"totals":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Totals","description":"accrued_loans, interest_cents, periods_closed, notices_sent, payments_settled and payments_returned."},"errors":{"items":{"type":"string"},"type":"array","title":"Errors"},"actor_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Actor Label","description":"Who started it. Null for the nightly schedule."}},"type":"object","required":["id","as_of","started_at","trigger","status"],"title":"CreditSweepRunResponse","description":"One run of the daily sweep for one business."},"SuccessEnvelope_CreditSweepRunResponse_":{"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/CreditSweepRunResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CreditSweepRunResponse]"},"SweepStepAttempt":{"properties":{"at":{"type":"string","format":"date-time","title":"At"},"actor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Actor"},"status":{"type":"string","enum":["succeeded","failed","skipped"],"title":"Status"},"counts":{"additionalProperties":true,"type":"object","title":"Counts"},"duration_ms":{"type":"integer","title":"Duration Ms","default":0},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"}},"type":"object","required":["at","status"],"title":"SweepStepAttempt","description":"One operator re-run of a step."},"SweepStepResult":{"properties":{"name":{"type":"string","title":"Name"},"status":{"type":"string","enum":["succeeded","failed","skipped"],"title":"Status"},"counts":{"additionalProperties":true,"type":"object","title":"Counts"},"duration_ms":{"type":"integer","title":"Duration Ms","default":0},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Why a step was skipped, or what a failed check found."},"reruns":{"items":{"$ref":"#/components/schemas/SweepStepAttempt"},"type":"array","title":"Reruns"}},"type":"object","required":["name","status"],"title":"SweepStepResult","description":"How one step of the sweep went."},"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":[]}]}