Skip to main content
A Workforce::Plan is a persistent hiring or headcount scenario. It groups positions over a planning window and can point to the latest immutable workforce calculation snapshot.

Attributes

string
Unique identifier for the plan, e.g. wfp_R8mK2pQ9xL4s.
string
The object type. Always workforce.plan.
string
Human-readable plan name.
string
Plan status. One of draft, approved, or archived.
string
Start date for the planning window.
string
End date for the planning window.
string
Planning frequency. Currently monthly.
string
Three-letter ISO currency code used for plan-level calculation rollups.
array
Positions currently attached to the plan.
string
ID of the latest calculation snapshot attached to the plan.
object
Set of key-value pairs attached to the plan.
string
Timestamp of when the plan was created.
string
Timestamp of when the plan was last updated.