{"openapi":"3.1.0","info":{"title":"GET /api/v1/credit/portfolio","version":"1.0.0","description":"Portfolio, aging, and allowance"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/portfolio":{"get":{"tags":["credit"],"summary":"Portfolio, aging, and allowance","description":"Sums over the book: outstanding by component, past-due aging in the program's allowance buckets with the reserve each implies, month-to-date interest and fee income, originations, payments, write-offs, and the lifetime default rate. Optionally one program.","operationId":"get_portfolio","parameters":[{"name":"program_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Program Id"}},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"As Of"}},{"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_PortfolioResponse_"}}}},"401":{"description":"Unauthorized - Missing/invalid token 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_portfolio_api_v1_credit_portfolio_get"}}},"components":{"schemas":{"PortfolioAgingBucket":{"properties":{"label":{"type":"string","title":"Label"},"from_days":{"type":"integer","title":"From Days"},"to_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"To Days"},"loan_count":{"type":"integer","title":"Loan Count"},"outstanding_cents":{"type":"integer","title":"Outstanding Cents"},"allowance_rate_bps":{"type":"integer","title":"Allowance Rate Bps"},"allowance_cents":{"type":"integer","title":"Allowance Cents"}},"type":"object","required":["label","from_days","loan_count","outstanding_cents","allowance_rate_bps","allowance_cents"],"title":"PortfolioAgingBucket"},"PortfolioResponse":{"properties":{"as_of":{"type":"string","format":"date","title":"As Of"},"program_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Program Id"},"lines_total":{"type":"integer","title":"Lines Total"},"lines_active":{"type":"integer","title":"Lines Active"},"committed_limit_cents":{"type":"integer","title":"Committed Limit Cents"},"loans_open":{"type":"integer","title":"Loans Open"},"loans_past_due":{"type":"integer","title":"Loans Past Due"},"principal_outstanding_cents":{"type":"integer","title":"Principal Outstanding Cents"},"fees_outstanding_cents":{"type":"integer","title":"Fees Outstanding Cents"},"interest_outstanding_cents":{"type":"integer","title":"Interest Outstanding Cents"},"total_outstanding_cents":{"type":"integer","title":"Total Outstanding Cents"},"past_due_outstanding_cents":{"type":"integer","title":"Past Due Outstanding Cents"},"utilisation_bps":{"type":"integer","title":"Utilisation Bps"},"interest_income_mtd_cents":{"type":"integer","title":"Interest Income Mtd Cents"},"fee_income_mtd_cents":{"type":"integer","title":"Fee Income Mtd Cents"},"originated_mtd_cents":{"type":"integer","title":"Originated Mtd Cents"},"payments_mtd_cents":{"type":"integer","title":"Payments Mtd Cents"},"written_off_mtd_cents":{"type":"integer","title":"Written Off Mtd Cents"},"written_off_lifetime_cents":{"type":"integer","title":"Written Off Lifetime Cents"},"default_rate_bps":{"type":"integer","title":"Default Rate Bps"},"allowance_cents":{"type":"integer","title":"Allowance Cents"},"interchange_mtd_cents":{"type":"integer","title":"Interchange Mtd Cents","default":0},"aging":{"items":{"$ref":"#/components/schemas/PortfolioAgingBucket"},"type":"array","title":"Aging"}},"type":"object","required":["as_of","lines_total","lines_active","committed_limit_cents","loans_open","loans_past_due","principal_outstanding_cents","fees_outstanding_cents","interest_outstanding_cents","total_outstanding_cents","past_due_outstanding_cents","utilisation_bps","interest_income_mtd_cents","fee_income_mtd_cents","originated_mtd_cents","payments_mtd_cents","written_off_mtd_cents","written_off_lifetime_cents","default_rate_bps","allowance_cents"],"title":"PortfolioResponse","description":"The book, for the lender: outstanding, aging, income, allowance."},"SuccessEnvelope_PortfolioResponse_":{"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/PortfolioResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[PortfolioResponse]"},"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":[]}]}