{"openapi":"3.1.0","info":{"title":"POST /api/v1/credit/cycles/close","version":"1.0.0","description":"Close cycles and create their draws"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/cycles/close":{"post":{"tags":["credit"],"summary":"Close cycles and create their draws","description":"Closes every cycle whose period has ended: fixes the principal, computes the disbursement fee and the full-term interest once, and sets the due date. Idempotent — a cycle already closed is skipped. Pass `dry_run` to see what would close without writing.","operationId":"close_cycles_api_v1_credit_cycles_close_post","parameters":[{"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/CycleCloseRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CycleCloseResponse_"}}}},"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"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CycleCloseRequest":{"properties":{"credit_line_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Line Id","description":"Limit to one line. Omit to sweep the business."},"as_of":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"As Of","description":"Treat this as today. Defaults to the current date."},"issue_statements":{"type":"boolean","title":"Issue Statements","description":"Also mark closed cycles issued.","default":true},"dry_run":{"type":"boolean","title":"Dry Run","default":false}},"additionalProperties":false,"type":"object","title":"CycleCloseRequest","description":"Close cycles whose period has ended (internal job).\n\nIdempotent: a cycle already closed is skipped, never closed twice."},"CycleCloseResponse":{"properties":{"closed":{"type":"integer","title":"Closed"},"skipped":{"type":"integer","title":"Skipped"},"dry_run":{"type":"boolean","title":"Dry Run"},"results":{"items":{"$ref":"#/components/schemas/CycleCloseResult"},"type":"array","title":"Results"}},"type":"object","required":["closed","skipped","dry_run"],"title":"CycleCloseResponse","description":"Result of a close sweep."},"CycleCloseResult":{"properties":{"cycle_id":{"type":"string","title":"Cycle Id"},"credit_line_id":{"type":"string","title":"Credit Line Id"},"period_start":{"type":"string","format":"date","title":"Period Start"},"period_end":{"type":"string","format":"date","title":"Period End"},"closed_on":{"type":"string","format":"date","title":"Closed On"},"due_date":{"type":"string","format":"date","title":"Due Date"},"principal_cents":{"type":"integer","title":"Principal Cents"},"disbursement_fee_cents":{"type":"integer","title":"Disbursement Fee Cents"},"interest_cents":{"type":"integer","title":"Interest Cents"},"amount_due_cents":{"type":"integer","title":"Amount Due Cents"},"settlement_count":{"type":"integer","title":"Settlement Count"}},"type":"object","required":["cycle_id","credit_line_id","period_start","period_end","closed_on","due_date","principal_cents","disbursement_fee_cents","interest_cents","amount_due_cents","settlement_count"],"title":"CycleCloseResult","description":"What one cycle close produced."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SuccessEnvelope_CycleCloseResponse_":{"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/CycleCloseResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CycleCloseResponse]"},"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":[]}]}