{"openapi":"3.1.0","info":{"title":"POST /api/v1/headcount-plans/{plan_id}/push-to-budget","version":"1.0.0","description":"Push headcount plan to budget"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/headcount-plans/{plan_id}/push-to-budget":{"post":{"tags":["headcount"],"summary":"Push headcount plan to budget","description":"Write the plan's monthly cost into a draft budget.","operationId":"push_headcount_plan_to_budget","parameters":[{"name":"plan_id","in":"path","required":true,"schema":{"type":"string","title":"Plan 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/HeadcountPushToBudgetRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_HeadcountPushToBudgetResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: due_date: Input should be a valid date","errors":{"due_date":"Input should be a valid date"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"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","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"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"}}}}},"x-fastapi-operation-id":"push_headcount_plan_to_budget_api_v1_headcount_plans__plan_id__push_to_budget_post"}}},"components":{"schemas":{"HeadcountBudgetLinePreview":{"properties":{"ledger_id":{"type":"string","title":"Ledger Id"},"ledger_name":{"type":"string","title":"Ledger Name"},"position_count":{"type":"integer","title":"Position Count"},"month_amounts_cents":{"additionalProperties":{"type":"integer"},"type":"object","title":"Month Amounts Cents","description":"Amount per budget month, keyed YYYY-MM."},"annual_amount_cents":{"type":"integer","title":"Annual Amount Cents"},"replaces_existing_line":{"type":"boolean","title":"Replaces Existing Line","description":"The budget already has a line for this account.","default":false}},"type":"object","required":["ledger_id","ledger_name","position_count","month_amounts_cents","annual_amount_cents"],"title":"HeadcountBudgetLinePreview","description":"What one budget line receives."},"HeadcountPushToBudgetRequest":{"properties":{"budget_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Budget Id","description":"Draft budget to write into. Empty creates a monthly budget for the plan's fiscal year."},"budget_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Budget Name","description":"Name for a new budget."},"dry_run":{"type":"boolean","title":"Dry Run","description":"Return what would be written without writing it.","default":false}},"additionalProperties":false,"type":"object","title":"HeadcountPushToBudgetRequest","description":"Write the plan's monthly cost into a draft budget, one line per account."},"HeadcountPushToBudgetResponse":{"properties":{"dry_run":{"type":"boolean","title":"Dry Run"},"budget_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Budget Id","description":"Budget written to; empty on a preview of a new budget."},"budget_name":{"type":"string","title":"Budget Name"},"lines":{"items":{"$ref":"#/components/schemas/HeadcountBudgetLinePreview"},"type":"array","title":"Lines"},"skipped_positions":{"items":{"$ref":"#/components/schemas/HeadcountSkippedPosition"},"type":"array","title":"Skipped Positions"},"total_cents":{"type":"integer","title":"Total Cents","default":0}},"type":"object","required":["dry_run","budget_name"],"title":"HeadcountPushToBudgetResponse","description":"Result (or preview) of pushing a plan into a budget."},"HeadcountSkippedPosition":{"properties":{"position_id":{"type":"string","title":"Position Id"},"title":{"type":"string","title":"Title"},"reason":{"type":"string","title":"Reason"}},"type":"object","required":["position_id","title","reason"],"title":"HeadcountSkippedPosition","description":"A position left out of the push."},"SuccessEnvelope_HeadcountPushToBudgetResponse_":{"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/HeadcountPushToBudgetResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[HeadcountPushToBudgetResponse]"},"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":[]}]}