{"openapi":"3.1.0","info":{"title":"POST /api/v1/revenue-schedules/preorders","version":"1.0.0","description":"Book a pre-order"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/revenue-schedules/preorders":{"post":{"tags":["revenue-schedules"],"summary":"Book a pre-order","description":"Collect pre-order cash to deferred revenue (releases on fulfillment).","operationId":"book_preorder_api_v1_revenue_schedules_preorders_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/PreorderBookRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_RevenueScheduleResponse_"}}}},"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":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"PreorderBookRequest":{"properties":{"order_reference":{"type":"string","title":"Order Reference","description":"Stable pre-order identifier (idempotency key)"},"amount_cents":{"type":"integer","exclusiveMinimum":0.0,"title":"Amount Cents","description":"Merchandise amount in cents"},"order_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Order Date","description":"Cash-collection date (defaults to today)"},"receive_via":{"type":"string","title":"Receive Via","description":"Debit account for the booking: 'cash', 'ar', or 'clearing'","default":"clearing"},"revenue_ledger_name":{"type":"string","title":"Revenue Ledger Name","description":"Revenue ledger credited on fulfillment","default":"Pre-order Revenue"},"currency":{"type":"string","maxLength":3,"title":"Currency","default":"USD"},"reference_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference Id","description":"Originating object id"}},"type":"object","required":["order_reference","amount_cents"],"title":"PreorderBookRequest","description":"Book a manual pre-order to deferred revenue (point-in-time release)."},"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_RevenueScheduleResponse_":{"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/RevenueScheduleResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[RevenueScheduleResponse]"},"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":[]}]}