{"openapi":"3.1.0","info":{"title":"POST /api/v1/credit/loans/{loan_id}/write-off","version":"1.0.0","description":"Write off a loan"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/loans/{loan_id}/write-off":{"post":{"tags":["credit"],"summary":"Write off a loan","description":"Charges a loan off under the collections policy (D-31). Omit the amount to write off everything outstanding and close the loan; supply one to reduce principal only and leave it open.","operationId":"write_off_credit_loan","parameters":[{"name":"loan_id","in":"path","required":true,"schema":{"type":"string","title":"Loan 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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditLoanWriteOffRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CreditLoanWriteOffResponse_"}}}},"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/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"}}}},"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":"write_off_credit_loan_api_v1_credit_loans__loan_id__write_off_post"}}},"components":{"schemas":{"CreditLoanWriteOffRequest":{"properties":{"written_off_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Written Off On","description":"Defaults to today."},"amount_cents":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Amount Cents","description":"Principal to write off. Omit to write the loan off in full."},"memo":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Memo"}},"additionalProperties":false,"type":"object","title":"CreditLoanWriteOffRequest","description":"Charge off a loan under the collections policy (D-31)."},"CreditLoanWriteOffResponse":{"properties":{"loan_id":{"type":"string","title":"Loan Id"},"written_off_on":{"type":"string","format":"date","title":"Written Off On"},"principal_cents":{"type":"integer","title":"Principal Cents"},"fee_cents":{"type":"integer","title":"Fee Cents"},"interest_cents":{"type":"integer","title":"Interest Cents"},"total_cents":{"type":"integer","title":"Total Cents"},"full":{"type":"boolean","title":"Full"},"status":{"$ref":"#/components/schemas/LoanStatusEnum"},"remaining_outstanding_cents":{"type":"integer","title":"Remaining Outstanding Cents"}},"type":"object","required":["loan_id","written_off_on","principal_cents","fee_cents","interest_cents","total_cents","full","status","remaining_outstanding_cents"],"title":"CreditLoanWriteOffResponse"},"LoanStatusEnum":{"type":"string","enum":["active","past_due","paid","written_off"],"title":"LoanStatusEnum","description":"Per-transaction loan state (FRD v2 §10.5 status vocabulary).\n\nThe API status is authoritative; a client must not compute it from\ndates or balances."},"SuccessEnvelope_CreditLoanWriteOffResponse_":{"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/CreditLoanWriteOffResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CreditLoanWriteOffResponse]"},"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":[]}]}