{"openapi":"3.1.0","info":{"title":"GET /api/v1/revenue-schedules","version":"1.0.0","description":"List revenue schedules"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/revenue-schedules":{"get":{"tags":["revenue-schedules"],"summary":"List revenue schedules","description":"List deferred-revenue tranches across all sources.","operationId":"list_revenue_schedules_api_v1_revenue_schedules_get","parameters":[{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/RevenueSourceEnum"},{"type":"null"}],"description":"Filter by source","title":"Source"},"description":"Filter by source"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"description":"Page size","default":100,"title":"Limit"},"description":"Page size"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Offset","default":0,"title":"Offset"},"description":"Offset"},{"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_RevenueScheduleListResponse_"}}}},"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"},"RevenueScheduleListResponse":{"properties":{"schedules":{"items":{"$ref":"#/components/schemas/RevenueScheduleResponse"},"type":"array","title":"Schedules"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["schedules","count"],"title":"RevenueScheduleListResponse","description":"List of deferred-revenue tranches."},"RevenueScheduleResponse":{"properties":{"id":{"type":"string","title":"Id"},"source":{"$ref":"#/components/schemas/RevenueSourceEnum"},"source_key":{"type":"string","title":"Source Key"},"reference_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Type"},"reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Id"},"recognition_method":{"type":"string","title":"Recognition Method"},"period_start":{"type":"string","format":"date","title":"Period Start"},"period_end":{"type":"string","format":"date","title":"Period End"},"amount_cents":{"type":"integer","title":"Amount Cents"},"currency":{"type":"string","title":"Currency"},"revenue_ledger_name":{"type":"string","title":"Revenue Ledger Name"},"recognized":{"type":"boolean","title":"Recognized"},"recognized_at":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Recognized At"},"journal_entry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Entry Id"},"booking_journal_entry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Booking Journal Entry Id"},"fulfilled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Fulfilled At"}},"type":"object","required":["id","source","source_key","recognition_method","period_start","period_end","amount_cents","currency","revenue_ledger_name","recognized"],"title":"RevenueScheduleResponse","description":"A single deferred-revenue tranche."},"RevenueSourceEnum":{"type":"string","enum":["asc606","shopify_subscription","preorder","stripe_subscription","recharge","manual"],"title":"RevenueSourceEnum","description":"Originating system for a deferred-revenue schedule row."},"SuccessEnvelope_RevenueScheduleListResponse_":{"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/RevenueScheduleListResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[RevenueScheduleListResponse]"},"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":[]}]}