{"openapi":"3.1.0","info":{"title":"POST /api/v1/loans/{instrument_id}/write-off","version":"1.0.0","description":"Write off a loan"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/loans/{instrument_id}/write-off":{"post":{"tags":["loans"],"summary":"Write off a loan","description":"Write off all (default) or part of a loan's balance.\n\n**Request Body:**\n- `principal_cents`: Principal to write off (optional; omit for the\n  full remaining balance).\n- `write_off_date`: Effective date (optional, defaults to today).\n- `memo`: Optional journal-entry memo.\n\n**Effect:**\n- Loans we made post to Bad Debt Expense; debt we owe posts to Debt\n  Forgiveness Income.\n- A full write-off also clears accrued unpaid interest and marks the\n  loan `written_off`.","operationId":"write_off_loan_api_v1_loans__instrument_id__write_off_post","parameters":[{"name":"instrument_id","in":"path","required":true,"schema":{"type":"string","title":"Instrument 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/LoanWriteOffRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_LoanWriteOffResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"detail":"Invalid request parameters"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"detail":"Resource not found"}}}},"409":{"description":"Conflict - Resource already exists","content":{"application/json":{"example":{"detail":"Resource already exists"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"LoanWriteOffRequest":{"properties":{"write_off_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Write Off Date"},"principal_cents":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Principal Cents","description":"Principal to write off; omit for the full remaining balance."},"memo":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Memo"}},"additionalProperties":false,"type":"object","title":"LoanWriteOffRequest","description":"Write off all (default) or part of a loan's balance."},"LoanWriteOffResponse":{"properties":{"instrument_id":{"type":"string","title":"Instrument Id"},"instrument_name":{"type":"string","title":"Instrument Name"},"principal_written_off_cents":{"type":"integer","title":"Principal Written Off Cents"},"interest_written_off_cents":{"type":"integer","title":"Interest Written Off Cents"},"remaining_balance_cents":{"type":"integer","title":"Remaining Balance Cents"},"status":{"type":"string","title":"Status"},"journal_entry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Entry Id"}},"type":"object","required":["instrument_id","instrument_name","principal_written_off_cents","interest_written_off_cents","remaining_balance_cents","status"],"title":"LoanWriteOffResponse","description":"Outcome of a loan write-off."},"SuccessEnvelope_LoanWriteOffResponse_":{"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/LoanWriteOffResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[LoanWriteOffResponse]"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}