- One employment is always designated as primary.
- Employments, compensations, roles and reportings that are effective now are designated as current.
- Current compensation, classification, role and reporting values for each employment are available directly on the Employment object.
- Values from the current primary employment are available directly on the Worker object.
worker.classification.type
,
worker.compensation.amount
, or worker.role.title
without having to iterate over worker’s employments:
Here’s an example payload with employments and compensations expanded, to show what this looks like in practice:
employments
).
This allows us to keep responses simple for most of our users, while accommodating the needs of larger, more complicated organizations.
Attributes
Unique identifier for the object, e.g.
wr_cNqYX2J3s9bI2Aa
.Employee number assigned by the company. Optional.
An object with email addresses associated with this worker.
The worker’s date of birth.
The worker’s phone number.
The worker’s tax and national IDs. This field is not included by default. To include it in the response, expand the
ids
field.The worker’s original start date. Note that this attribute is freely editable and doesn’t always
line up with the start date of the worker’s Employment object. This can be useful for representing
someone’s start date before they were onboarded on Plane.
The worker’s termination date. Note that this attribute is freely editable and doesn’t always line
up with end dates of the worker’s Employment object. This can be useful when importing historical
data about workers that will not be onboarded onto Plane.
The worker’s job title. Matches
title
on the worker’s current primary employment
Role object.The worker’s current status. One of
pending
, active
, terminated
, cancelled
, paused
or
undefined
.An dicionary of worker’s current addresses.
The person’s gender as displayed on their legal ID. International regulations require either
male
or female
. May be required to determine tax liability or benefits eligiblity in certain
countries.The person’s marital status, e.g.
married
or single
. Optional. May be required to determine
tax liability or benefits eligiblity in certain countries.The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2).
An Employment object representing the worker’s current
primary employment.
A Compensation object representing the worker’s current
compensation in their current primary employment.
A Location object representing the worker’s work location in their
current primary employment.
A Classification object representing the worker’s
current classification in their current primary employment.
A Role object representing the worker’s current rule in their
current primary employment.