{"openapi":"3.1.0","info":{"title":"GET /api/v1/contracts/{contract_id}/burndown","version":"1.0.0","description":"Per-line hours burndown"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/contracts/{contract_id}/burndown":{"get":{"tags":["contracts"],"summary":"Per-line hours burndown","description":"Hours burndown broken down per order line: attributed drawdowns count against their line; unattributed drawdowns draw the prepaid block pool and are reported on the block subtotal. Per-period billed lines also expose billed hours and derived recognized revenue.","operationId":"get_contract_burndown_api_v1_contracts__contract_id__burndown_get","parameters":[{"name":"contract_id","in":"path","required":true,"schema":{"type":"string","title":"Contract 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"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ContractBurndownResponse_"}}}},"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":{"ContractBlockBurndown":{"properties":{"total_hours":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Total Hours","default":"0"},"used_hours":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Used Hours","default":"0"},"remaining_hours":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Remaining Hours","default":"0"},"unattributed_hours":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Unattributed Hours","default":"0"},"recognized_cents":{"type":"integer","title":"Recognized Cents","default":0},"deferred_remaining_cents":{"type":"integer","title":"Deferred Remaining Cents","default":0}},"type":"object","title":"ContractBlockBurndown","description":"The prepaid block pool: contract-level hours and deferred figures.\n\n``unattributed_hours`` are approved drawdowns with no ``order_line_id`` —\nthey consume the pool but cannot be assigned to a specific line, so when\nseveral prepaid lines exist the pool is the honest reporting level."},"ContractBurndownResponse":{"properties":{"contract_id":{"type":"string","title":"Contract Id"},"block":{"$ref":"#/components/schemas/ContractBlockBurndown"},"lines":{"items":{"$ref":"#/components/schemas/ContractLineBurndown"},"type":"array","title":"Lines"}},"type":"object","required":["contract_id","block"],"title":"ContractBurndownResponse","description":"Per-line hours burndown for a contract (block pool + per-line detail)."},"ContractLineBurndown":{"properties":{"order_line_id":{"type":"string","title":"Order Line Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"billing_rule":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Rule"},"bills_per_period":{"type":"boolean","title":"Bills Per Period","description":"True when the line's hours bill per period instead of drawing down the prepaid block (per-unit lines on a mixed contract).","default":false},"bought_hours":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Bought Hours","description":"Hours/units bought on the line (its qty).","default":"0"},"used_hours":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Used Hours","description":"Approved drawdown hours attributed to the line.","default":"0"},"remaining_hours":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Remaining Hours","description":"bought − used, floored at zero.","default":"0"},"billed_hours":{"anyOf":[{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},{"type":"null"}],"title":"Billed Hours","description":"Hours already carried on non-void period invoices (per-period billed lines only; null for block lines, whose billing is the upfront execution invoice)."},"recognized_cents":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Recognized Cents","description":"Revenue recognized for the line where derivable: per-period billed hours × unit price. Null for block lines — prepaid recognition is pooled at the block level."}},"type":"object","required":["order_line_id"],"title":"ContractLineBurndown","description":"Hours burndown for one order line of the contract.\n\nAttribution: only drawdowns explicitly attributed to the line\n(``order_line_id``) count against it. Unattributed drawdowns draw the\nprepaid block pool and are reported on the block subtotal\n(:class:`ContractBlockBurndown`), never faked into per-line splits."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SuccessEnvelope_ContractBurndownResponse_":{"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/ContractBurndownResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[ContractBurndownResponse]"},"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":[]}]}