{"openapi":"3.1.0","info":{"title":"PATCH /api/v1/contracts/invoices/{invoice_id}","version":"1.0.0","description":"Edit a draft contract invoice"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/contracts/invoices/{invoice_id}":{"patch":{"tags":["contracts"],"summary":"Edit a draft contract invoice","description":"Edit a drafted contract invoice's description, due date, and line items before approval. Line items are replaced wholesale and the invoice total is recomputed from them. Only drafts are editable — approved invoices are already billed.","operationId":"update_contract_invoice_api_v1_contracts_invoices__invoice_id__patch","parameters":[{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","title":"Invoice Id"}},{"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/ContractInvoiceUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ContractInvoiceSummary_"}}}},"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"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"detail":"Resource not found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ContractInvoiceLine":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"quantity":{"type":"number","title":"Quantity","default":1},"unit_price":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Unit Price","description":"Unit price in cents (null for multi-unit lines)."},"amount":{"type":"integer","title":"Amount","description":"Line total in cents.","default":0},"billing_rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Rule"},"order_line_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Line Id"},"prepaid":{"type":"boolean","title":"Prepaid","description":"Server-derived: whether this line books to Deferred Revenue (prepaid) on approval rather than recognizing at billing.","default":false}},"type":"object","title":"ContractInvoiceLine","description":"One line item on a contract-drafted invoice (review-queue detail)."},"ContractInvoiceLineUpdate":{"properties":{"description":{"type":"string","minLength":1,"title":"Description","description":"Line description."},"quantity":{"type":"number","exclusiveMinimum":0.0,"title":"Quantity","description":"Units billed.","default":1},"amount_cents":{"type":"integer","exclusiveMinimum":0.0,"title":"Amount Cents","description":"Line total in cents."},"billing_rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Rule","description":"Revenue treatment for the line: 'prepaid_block' (deferred) or 'manual' (recognized) are honored as explicit overrides; other known rules are echo-back only and re-derived from order_line_id. Omit to keep the server-side derivation."},"order_line_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Line Id","description":"Existing line's originating order line, if any."}},"type":"object","required":["description","amount_cents"],"title":"ContractInvoiceLineUpdate","description":"One replacement line on a draft contract invoice being edited.\n\n``order_line_id`` links the line back to its originating order line (it\nmust belong to the invoice's contract); brand-new lines omit it and are\nstored as ``manual`` lines. ``billing_rule`` routes money on send:\nsending ``prepaid_block`` (defer to Deferred Revenue) or ``manual``\n(recognize at billing) is honored as the reviewer's explicit per-line\nchoice; any other known rule is treated as a UI echo-back and re-derived\nserver-side from the referenced order line (``manual`` when unlinked).\nUnknown values are rejected."},"ContractInvoiceSummary":{"properties":{"id":{"type":"string","title":"Id"},"contract_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contract Id"},"customer_id":{"type":"string","title":"Customer Id"},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number"},"status":{"type":"string","title":"Status"},"total":{"type":"integer","title":"Total","default":0},"amount_paid":{"type":"integer","title":"Amount Paid","description":"Payments received against the invoice, in cents.","default":0},"balance_due":{"type":"integer","title":"Balance Due","description":"Outstanding collectible balance in cents (total − payments − applied credits; 0 for paid/void/uncollectible invoices).","default":0},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"due_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Due Date"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"can_be_sent":{"type":"boolean","title":"Can Be Sent","default":false},"revenue_treatment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revenue Treatment","description":"Manual revenue-tracking label ('earned' / 'deferred' / null). Informational only — posts no journal entry."},"line_items":{"items":{"$ref":"#/components/schemas/ContractInvoiceLine"},"type":"array","title":"Line Items","description":"Line items so a draft can be reviewed/edited in place."}},"type":"object","required":["id","customer_id","status","created_at"],"title":"ContractInvoiceSummary","description":"A contract-drafted invoice in the review queue."},"ContractInvoiceUpdateRequest":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Invoice description/notes."},"due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Date","description":"Invoice due date (YYYY-MM-DD)."},"line_items":{"anyOf":[{"items":{"$ref":"#/components/schemas/ContractInvoiceLineUpdate"},"type":"array","minItems":1},{"type":"null"}],"title":"Line Items","description":"Replacement lines; the total is recomputed from these."}},"type":"object","title":"ContractInvoiceUpdateRequest","description":"Request body for editing a DRAFT contract invoice before approval.\n\nOmitted fields are left untouched. When ``line_items`` is provided it\nreplaces the invoice's lines wholesale and the invoice total is\nrecomputed from them server-side."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SuccessEnvelope_ContractInvoiceSummary_":{"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/ContractInvoiceSummary"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[ContractInvoiceSummary]"},"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":[]}]}