Workforce calculation

{
  "id": "wfc_V6nP3qR9tY2m",
  "object": "workforce.calculation",
  "status": "calculated",
  "plan": "wfp_R8mK2pQ9xL4s",
  "currency": "CAD",
  "period": {
    "starts": "2026-09-01",
    "ends": "2026-10-31",
    "frequency": "monthly"
  },
  "headcount": "1.0",
  "cost": {
    "total": "26400.00",
    "cash": "26400.00",
    "accrual": "0.00"
  },
  "periods": [
    {
      "period": "2026-09",
      "headcount": "1.0",
      "cost": "13200.00",
      "line_items": [
        {
          "position": "pos_kP9r2NqW6mT4",
          "name": "Regular earnings",
          "amount": "10000.00",
          "currency": "CAD",
          "source": {
            "type": "position",
            "id": "pos_kP9r2NqW6mT4"
          }
        },
        {
          "position": "pos_kP9r2NqW6mT4",
          "name": "Employer health tax",
          "amount": "3200.00",
          "currency": "CAD",
          "source": {
            "type": "labor.tax",
            "id": "ltx_Q4mR8tK2pL9x"
          }
        }
      ]
    }
  ],
  "created": "2026-05-27T12:00:00Z"
}

A Workforce::Calculation is an immutable cost and headcount snapshot for a set of positions over a period. It can be created from a workforce plan or from inline position inputs before a worker exists.

Attributes

string

Unique identifier for the calculation, e.g. wfc_V6nP3qR9tY2m.

string

The object type. Always workforce.calculation.

string

The calculation status. Currently calculated.

string

Workforce plan ID when the calculation was created from a plan.

string

Three-letter ISO currency code for calculation totals.

object

The period covered by the calculation.

Show child attributes

string

Start date of the calculation period.

string

End date of the calculation period.

string

Period frequency. Currently monthly.

string

Average headcount over the calculation period.

object

Total calculation cost.

Show child attributes

string

Total projected cost.

string

Projected cash cost.

string

Projected accrual cost.

array

Periodized calculation rows. Each row includes period, headcount, cost, and minimal line_items. Line items are display/provenance rows: use name for display, source.object for the dereferenceable object when it differs from the rollup family, source.type for rollups, and source.id to trace the input that produced the row.

string

Timestamp of when the calculation was created.

{
  "id": "wfc_V6nP3qR9tY2m",
  "object": "workforce.calculation",
  "status": "calculated",
  "plan": "wfp_R8mK2pQ9xL4s",
  "currency": "CAD",
  "period": {
    "starts": "2026-09-01",
    "ends": "2026-10-31",
    "frequency": "monthly"
  },
  "headcount": "1.0",
  "cost": {
    "total": "26400.00",
    "cash": "26400.00",
    "accrual": "0.00"
  },
  "periods": [
    {
      "period": "2026-09",
      "headcount": "1.0",
      "cost": "13200.00",
      "line_items": [
        {
          "position": "pos_kP9r2NqW6mT4",
          "name": "Regular earnings",
          "amount": "10000.00",
          "currency": "CAD",
          "source": {
            "type": "position",
            "id": "pos_kP9r2NqW6mT4"
          }
        },
        {
          "position": "pos_kP9r2NqW6mT4",
          "name": "Employer health tax",
          "amount": "3200.00",
          "currency": "CAD",
          "source": {
            "type": "labor.tax",
            "id": "ltx_Q4mR8tK2pL9x"
          }
        }
      ]
    }
  ],
  "created": "2026-05-27T12:00:00Z"
}

Update a workforce plan

Create a workforce calculation

⌘I

Working with the API

Core Resources

HR

Workforce

Benefits

Payments

Payroll

Documents

Time

Labor

Legal

Attributes

​Attributes

Attributes