{"openapi":"3.1.0","info":{"title":"GET /api/v1/headcount-plans/{plan_id}/projection","version":"1.0.0","description":"Headcount projection"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/headcount-plans/{plan_id}/projection":{"get":{"tags":["headcount"],"summary":"Headcount projection","description":"Month by position grid of fully loaded cost.","operationId":"get_headcount_projection","parameters":[{"name":"plan_id","in":"path","required":true,"schema":{"type":"string","title":"Plan Id"}},{"name":"months","in":"query","required":false,"schema":{"type":"integer","maximum":36,"minimum":1,"description":"Months to project","default":12,"title":"Months"},"description":"Months to project"},{"name":"start_month","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^\\d{4}-(0[1-9]|1[0-2])$"},{"type":"null"}],"description":"First month, YYYY-MM (default: January of the fiscal year)","title":"Start Month"},"description":"First month, YYYY-MM (default: January of the fiscal year)"},{"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_HeadcountProjectionResponse_"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"error":"not_found","message":"Resource not found","code":"NOT_FOUND_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error - Request body or parameters failed validation","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-fastapi-operation-id":"get_headcount_projection_api_v1_headcount_plans__plan_id__projection_get"}}},"components":{"schemas":{"HeadcountProjectionResponse":{"properties":{"plan_id":{"type":"string","title":"Plan Id"},"plan_name":{"type":"string","title":"Plan Name"},"months":{"items":{"type":"string"},"type":"array","title":"Months","description":"Month keys, YYYY-MM."},"rows":{"items":{"$ref":"#/components/schemas/HeadcountProjectionRow"},"type":"array","title":"Rows"},"monthly_totals_cents":{"items":{"type":"integer"},"type":"array","title":"Monthly Totals Cents"},"monthly_headcount":{"items":{"type":"integer"},"type":"array","title":"Monthly Headcount","description":"Positions active in each month."},"total_cents":{"type":"integer","title":"Total Cents","default":0}},"type":"object","required":["plan_id","plan_name","months"],"title":"HeadcountProjectionResponse","description":"Month by position grid of fully loaded cost."},"HeadcountProjectionRow":{"properties":{"position_id":{"type":"string","title":"Position Id"},"title":{"type":"string","title":"Title"},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Department"},"status":{"$ref":"#/components/schemas/PositionStatusEnum"},"ledger_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ledger Id"},"ledger_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ledger Name"},"amounts_cents":{"items":{"type":"integer"},"type":"array","title":"Amounts Cents","description":"Loaded cost per month, aligned with `months`."},"total_cents":{"type":"integer","title":"Total Cents"}},"type":"object","required":["position_id","title","status","amounts_cents","total_cents"],"title":"HeadcountProjectionRow","description":"One position across the projection months."},"PositionStatusEnum":{"type":"string","enum":["planned","approved","filled","cancelled"],"title":"PositionStatusEnum"},"SuccessEnvelope_HeadcountProjectionResponse_":{"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/HeadcountProjectionResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[HeadcountProjectionResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}