{
 "openapi": "3.1.0",
 "info": {
  "title": "Workforce Cost Plans (Accounting)",
  "version": "20261030b",
  "description": "People are between forty and seventy per cent of the cost base, so the budget is mostly a workforce plan whether anybody calls it one or not."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "workforce-plans": {
    "type": "object",
    "required": [
     "code",
     "name",
     "fiscal_year",
     "period_from",
     "period_to"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "code": {
      "type": "string",
      "description": "Code"
     },
     "name": {
      "type": "string",
      "description": "Name"
     },
     "fiscal_year": {
      "type": "integer",
      "description": "Fiscal year"
     },
     "version": {
      "type": "string",
      "description": "Version",
      "enum": [
       "plan",
       "budget",
       "forecast",
       "actual",
       "simulation",
       "baseline"
      ]
     },
     "baseline_plan_id": {
      "type": "string",
      "format": "uuid",
      "description": "Compare against"
     },
     "period_from": {
      "type": "string",
      "format": "date",
      "description": "From"
     },
     "period_to": {
      "type": "string",
      "format": "date",
      "description": "To"
     },
     "currency": {
      "type": "string",
      "description": "Currency"
     },
     "cost_center_id": {
      "type": "string",
      "format": "uuid",
      "description": "Cost center"
     },
     "merit_increase_pct": {
      "type": "string",
      "format": "decimal",
      "description": "Merit increase %"
     },
     "promotion_budget_pct": {
      "type": "string",
      "format": "decimal",
      "description": "Promotion budget %"
     },
     "attrition_pct": {
      "type": "string",
      "format": "decimal",
      "description": "Attrition %"
     },
     "benefit_load_pct": {
      "type": "string",
      "format": "decimal",
      "description": "Benefit load %"
     },
     "employer_tax_pct": {
      "type": "string",
      "format": "decimal",
      "description": "Employer tax %"
     },
     "opening_headcount": {
      "type": "string",
      "format": "decimal",
      "description": "Opening headcount",
      "readOnly": true
     },
     "closing_headcount": {
      "type": "string",
      "format": "decimal",
      "description": "Closing headcount",
      "readOnly": true
     },
     "average_fte": {
      "type": "string",
      "format": "decimal",
      "description": "Average fte",
      "readOnly": true
     },
     "total_base_cost": {
      "type": "string",
      "format": "decimal",
      "description": "Total base cost",
      "readOnly": true
     },
     "total_loaded_cost": {
      "type": "string",
      "format": "decimal",
      "description": "Total loaded cost",
      "readOnly": true
     },
     "hire_count": {
      "type": "integer",
      "description": "Hire count",
      "readOnly": true
     },
     "leaver_count": {
      "type": "integer",
      "description": "Leaver count",
      "readOnly": true
     },
     "status": {
      "type": "string",
      "description": "Status",
      "readOnly": true
     },
     "submitted_by": {
      "type": "string",
      "format": "uuid",
      "description": "Submitted by",
      "readOnly": true
     },
     "approved_by": {
      "type": "string",
      "format": "uuid",
      "description": "Approved by",
      "readOnly": true
     },
     "approved_at": {
      "type": "string",
      "format": "date-time",
      "description": "Approved at",
      "readOnly": true
     },
     "calculated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Calculated at",
      "readOnly": true
     },
     "notes": {
      "type": "string",
      "description": "Notes"
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "xf_text_1": {
      "type": "string",
      "description": "Xf text 1",
      "readOnly": true
     },
     "xf_text_2": {
      "type": "string",
      "description": "Xf text 2",
      "readOnly": true
     },
     "xf_text_3": {
      "type": "string",
      "description": "Xf text 3",
      "readOnly": true
     },
     "xf_text_4": {
      "type": "string",
      "description": "Xf text 4",
      "readOnly": true
     },
     "xf_text_5": {
      "type": "string",
      "description": "Xf text 5",
      "readOnly": true
     },
     "xf_num_1": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 1",
      "readOnly": true
     },
     "xf_num_2": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 2",
      "readOnly": true
     },
     "xf_num_3": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 3",
      "readOnly": true
     },
     "xf_date_1": {
      "type": "string",
      "format": "date",
      "description": "Xf date 1",
      "readOnly": true
     },
     "xf_date_2": {
      "type": "string",
      "format": "date",
      "description": "Xf date 2",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "readOnly": true
     },
     "updated_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/accounting/workforce-plans": {
   "get": {
    "summary": "list workforce-plans",
    "operationId": "list_workforce_plans_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create workforce-plans",
    "operationId": "create_workforce_plans_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/workforce-plans/{id}": {
   "get": {
    "summary": "get workforce-plans",
    "operationId": "get_workforce_plans_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change workforce-plans",
    "operationId": "change_workforce_plans_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete workforce-plans",
    "operationId": "delete_workforce_plans_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/workforce-plans/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_workforce_plans_0_6",
    "description": "Body keys: overrides, preview, withLines",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/workforce-plans/{parentId}/lines": {
   "get": {
    "summary": "Lines",
    "operationId": "action_workforce_plans_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "Lines",
    "operationId": "action_workforce_plans_1_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/accounting/workforce-plans/{parentId}/lines/{lineId}": {
   "put": {
    "summary": "Lines",
    "operationId": "action_workforce_plans_0_7",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "Lines",
    "operationId": "action_workforce_plans_1_7",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}