{"openapi":"3.1.0","info":{"title":"GET /api/v1/recurring/{template_id}/history","version":"1.0.0","description":"Get recurring template history"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/recurring/{template_id}/history":{"get":{"tags":["recurring"],"summary":"Get recurring template history","description":"Get all bills or invoices generated from this recurring template.","operationId":"get_recurring_template_history","parameters":[{"name":"template_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Template Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum items to return","default":50,"title":"Limit"},"description":"Maximum items to return"},{"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_RecurringTemplateHistoryResponse_"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, 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":"get_recurring_template_history_api_v1_recurring__template_id__history_get"}}},"components":{"schemas":{"GeneratedDocumentItem":{"properties":{"id":{"type":"string","title":"Id"},"document_type":{"$ref":"#/components/schemas/RecurrenceTypeEnum-Output"},"status":{"type":"string","title":"Status"},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount"},"amount_in_dollars":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount In Dollars"},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"vendor_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Name"},"customer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Name"}},"type":"object","required":["id","document_type","status","created_at"],"title":"GeneratedDocumentItem","description":"A document generated from a recurring template.","example":{"amount":350000,"amount_in_dollars":3500.0,"created_at":"2026-02-01T01:00:00Z","description":"Monthly office rent","document_type":"bill","due_date":"2026-02-16","id":"bill-uuid","status":"forecasted","vendor_name":"Property Management LLC"},"examples":[{"amount":350000,"amount_in_dollars":3500.0,"created_at":"2026-02-01T01:00:00Z","description":"Monthly office rent","document_type":"bill","due_date":"2026-02-16","id":"bill-uuid","status":"forecasted","vendor_name":"Property Management LLC"}]},"RecurrenceTypeEnum-Output":{"type":"string","enum":["invoice","bill","journal_entry"],"title":"RecurrenceTypeEnum","description":"Type of recurring document."},"RecurringTemplateHistoryResponse":{"properties":{"template_id":{"type":"string","title":"Template Id"},"template_name":{"type":"string","title":"Template Name"},"document_type":{"$ref":"#/components/schemas/RecurrenceTypeEnum-Output"},"total_generated":{"type":"integer","title":"Total Generated"},"items":{"items":{"$ref":"#/components/schemas/GeneratedDocumentItem"},"type":"array","title":"Items"}},"type":"object","required":["template_id","template_name","document_type","total_generated","items"],"title":"RecurringTemplateHistoryResponse","description":"Response for template generation history.","example":{"document_type":"bill","items":[{"amount":350000,"amount_in_dollars":3500.0,"created_at":"2026-01-01T01:00:00Z","document_type":"bill","due_date":"2026-01-16","id":"bill-uuid-1","status":"paid"}],"template_id":"template-uuid","template_name":"Monthly Rent","total_generated":3},"examples":[{"document_type":"bill","items":[{"amount":350000,"amount_in_dollars":3500.0,"created_at":"2026-01-01T01:00:00Z","document_type":"bill","due_date":"2026-01-16","id":"bill-uuid-1","status":"paid"}],"template_id":"template-uuid","template_name":"Monthly Rent","total_generated":3}]},"SuccessEnvelope_RecurringTemplateHistoryResponse_":{"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/RecurringTemplateHistoryResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[RecurringTemplateHistoryResponse]"},"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":[]}]}