{"openapi":"3.1.0","info":{"title":"GET /api/v1/credit/finance/ledger-proof","version":"1.0.0","description":"Ledger integrity proof"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/finance/ledger-proof":{"get":{"tags":["credit"],"summary":"Ledger integrity proof","description":"Verifies every line's register (hash chain, running balance, sequence) and returns a dated report with each line's head hash. `format=pdf` returns the report as a document for auditors.","operationId":"get_ledger_proof","parameters":[{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Defaults to today (UTC).","title":"As Of"},"description":"Defaults to today (UTC)."},{"name":"program_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Program Id"}},{"name":"format","in":"query","required":false,"schema":{"enum":["json","pdf"],"type":"string","default":"json","title":"Format"}},{"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_LedgerProofResponse_"}}}},"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_ledger_proof_api_v1_credit_finance_ledger_proof_get"}}},"components":{"schemas":{"LedgerProofLine":{"properties":{"credit_line_id":{"type":"string","title":"Credit Line Id"},"external_line_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Line Id"},"external_merchant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Merchant Id"},"entry_count":{"type":"integer","title":"Entry Count"},"chain_valid":{"type":"boolean","title":"Chain Valid"},"balance_valid":{"type":"boolean","title":"Balance Valid"},"sequence_valid":{"type":"boolean","title":"Sequence Valid"},"valid":{"type":"boolean","title":"Valid"},"head_sequence_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Head Sequence No"},"head_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Head Hash","description":"The newest entry's hash: what the register commits to."},"computed_balance_cents":{"type":"integer","title":"Computed Balance Cents"},"stored_balance_cents":{"type":"integer","title":"Stored Balance Cents"},"balance_as_of_cents":{"type":"integer","title":"Balance As Of Cents","description":"Sum of the entries dated on or before as_of."},"first_bad_sequence_no":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"First Bad Sequence No"}},"type":"object","required":["credit_line_id","entry_count","chain_valid","balance_valid","sequence_valid","valid","computed_balance_cents","stored_balance_cents","balance_as_of_cents"],"title":"LedgerProofLine","description":"One line's register, verified end to end."},"LedgerProofResponse":{"properties":{"as_of":{"type":"string","format":"date","title":"As Of"},"generated_at":{"type":"string","format":"date-time","title":"Generated At"},"program_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Program Id"},"program_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Program Name"},"method":{"type":"string","title":"Method"},"lines_checked":{"type":"integer","title":"Lines Checked"},"lines_valid":{"type":"integer","title":"Lines Valid"},"lines_invalid":{"type":"integer","title":"Lines Invalid"},"entries_checked":{"type":"integer","title":"Entries Checked"},"chain_failures":{"type":"integer","title":"Chain Failures"},"balance_failures":{"type":"integer","title":"Balance Failures"},"sequence_failures":{"type":"integer","title":"Sequence Failures"},"all_valid":{"type":"boolean","title":"All Valid"},"lines":{"items":{"$ref":"#/components/schemas/LedgerProofLine"},"type":"array","title":"Lines"}},"type":"object","required":["as_of","generated_at","method","lines_checked","lines_valid","lines_invalid","entries_checked","chain_failures","balance_failures","sequence_failures","all_valid"],"title":"LedgerProofResponse","description":"A dated report that every register's hash chain, balance and sequence hold."},"SuccessEnvelope_LedgerProofResponse_":{"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/LedgerProofResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[LedgerProofResponse]"},"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":[]}]}