Skip to main content
POST
/
v1
/
workforce
/
calculations
Create a workforce calculation
curl --request POST \
  --url https://api.plane.com/v1/workforce/calculations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "plan": "<string>",
  "positions": [
    {
      "positions.job": "<string>",
      "positions.location": {},
      "positions.location.country": "<string>",
      "positions.location.subdivision": "<string>",
      "positions.employer": {},
      "positions.starts": "<string>",
      "positions.ends": "<string>",
      "positions.compensation": {},
      "positions.compensation.amount": "<string>",
      "positions.compensation.currency": "<string>",
      "positions.compensation.unit": "<string>",
      "positions.compensation.basis": "<string>",
      "positions.compensation.frequency": "<string>",
      "positions.compensation.source": {}
    }
  ],
  "period": {
    "period.starts": "<string>",
    "period.ends": "<string>",
    "period.frequency": "<string>"
  },
  "currency": "<string>",
  "metadata": {}
}
'
{
  "plan": "wfp_R8mK2pQ9xL4s"
}

Documentation Index

Fetch the complete documentation index at: https://docs.plane.com/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to calculate future workforce cost without creating a worker. Create a calculation from either a saved workforce plan or inline position input. Calculations are immutable snapshots.

​
Parameters

​
plan
string
Workforce plan ID. When provided, Plane calculates the current positions in the plan using the plan’s period and currency unless overridden.
​
positions
array
Inline positions to calculate.
​
period
object
Calculation period. Required when using inline positions; optional when calculating from a plan.
​
currency
string
Three-letter ISO currency code for calculation totals. When omitted, Plane uses the first position’s compensation currency.
​
metadata
object
Set of key-value pairs attached to the calculation.

​
Returns

Returns the created Workforce calculation object. Provide either plan or positions, but not both. 
{
  "plan": "wfp_R8mK2pQ9xL4s"
}