{"openapi":"3.1.0","info":{"title":"GET /api/v1/invoices/scheduled","version":"1.0.0","description":"Upcoming scheduled invoices"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/invoices/scheduled":{"get":{"tags":["invoices"],"summary":"Upcoming scheduled invoices","description":"Forward-looking list of invoices that will auto-draft on their scheduled day — future occurrences of active recurring invoice templates and upcoming contract billing periods — within the horizon.","operationId":"get_scheduled_invoices_api_v1_invoices_scheduled_get","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":365,"minimum":1,"description":"Horizon in days to project scheduled invoices forward (default 90).","default":90,"title":"Days"},"description":"Horizon in days to project scheduled invoices forward (default 90)."},{"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_ScheduledInvoiceListResponse_"}}}},"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":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ScheduledInvoiceItem":{"properties":{"scheduled_date":{"type":"string","format":"date","title":"Scheduled Date","description":"Date the invoice is projected to auto-draft."},"amount_cents":{"type":"integer","title":"Amount Cents","description":"Projected invoice amount in cents (0 when not determinable).","default":0},"customer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Name","description":"Customer the invoice will bill, when known."},"source":{"type":"string","enum":["recurring_template","contract"],"title":"Source","description":"What drives this scheduled invoice."},"source_id":{"type":"string","title":"Source Id","description":"ID of the recurring template or contract behind this item."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Human-readable description of the scheduled invoice."}},"type":"object","required":["scheduled_date","source","source_id"],"title":"ScheduledInvoiceItem","description":"One projected upcoming scheduled invoice."},"ScheduledInvoiceListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ScheduledInvoiceItem"},"type":"array","title":"Items"}},"type":"object","title":"ScheduledInvoiceListResponse","description":"List of upcoming scheduled invoices, sorted by date ascending."},"SuccessEnvelope_ScheduledInvoiceListResponse_":{"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/ScheduledInvoiceListResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[ScheduledInvoiceListResponse]"},"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":[]}]}