{"openapi":"3.1.0","info":{"title":"POST /api/v1/loans/{instrument_id}/accrue-interest","version":"1.0.0","description":"Accrue interest on one loan"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/loans/{instrument_id}/accrue-interest":{"post":{"tags":["loans"],"summary":"Accrue interest on one loan","description":"Accrue interest on one loan through a date.\n\n**Request Body:**\n- `through_date`: Date to accrue through (required).\n- `memo`: Optional journal-entry memo.\n\n**Effect:**\n- Posts an accrual JE: Interest Receivable / Interest Income for a\n  loan we made, Interest Expense / Accrued Interest Payable for debt\n  we owe.\n- The accrued amount is relieved automatically by the next payment.\n\n**Prerequisites:** Loan is active with a positive balance, a stated\ninterest rate, and an accrual period of at least one day.","operationId":"accrue_loan_interest_api_v1_loans__instrument_id__accrue_interest_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/LoanAccrueInterestRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_LoanAccrualResult_"}}}},"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"},"LoanAccrualResult":{"properties":{"instrument_id":{"type":"string","title":"Instrument Id"},"instrument_name":{"type":"string","title":"Instrument Name"},"period_start":{"type":"string","format":"date","title":"Period Start"},"through_date":{"type":"string","format":"date","title":"Through Date"},"days":{"type":"integer","title":"Days"},"interest_cents":{"type":"integer","title":"Interest Cents"},"accrued_interest_cents":{"type":"integer","title":"Accrued Interest Cents"},"journal_entry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Entry Id"}},"type":"object","required":["instrument_id","instrument_name","period_start","through_date","days","interest_cents","accrued_interest_cents"],"title":"LoanAccrualResult","description":"Outcome of accruing interest on one instrument."},"LoanAccrueInterestRequest":{"properties":{"through_date":{"type":"string","format":"date","title":"Through Date"},"memo":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Memo"}},"additionalProperties":false,"type":"object","required":["through_date"],"title":"LoanAccrueInterestRequest","description":"Accrue interest on one loan through a date."},"SuccessEnvelope_LoanAccrualResult_":{"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/LoanAccrualResult"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[LoanAccrualResult]"},"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":[]}]}