The employment object keeps track of users' most recent employment data: employer name, manager name, employer address, etc. The employment data is associated with the link_id
that is obtained from Truv's Income and Employment product type.
Attributes
The attributes of the Employment
:
Attribute | Type | Description |
---|---|---|
id | string | The Unique ID of the selected employee |
is_active | boolean | Indicates whether the employment is still active |
job_title | string | The job title of the employee |
job_type | string | The job types of the employee. There are five job types: F - Full Time P - Part Time S - Seasonal D - Daily C - Contract |
start_date | date | Date of the Employee's initial employment |
original_hire_date | date | The original hire date of the employee |
end_date | date | The employee's end date |
income | string | Base income amount not including commission or bonuses |
income_unit | string | The pay interval the income field refers to: YEARLY - Annual income, MONTHLY - Monthly income, WEEKLY - Weekly income, DAILY - Daily income, HOURLY - Hourly income |
pay_rate | string | Payment rate per pay cycle |
pay_frequency | string | Pay frequency: M - Monthly, SM - Semi-Monthly, W - Weekly, BW - Bi-Weekly, A - Annually, C - Commission |
external_last_updated | date | Indicates the date when employment data was last updated on the payroll provider side |
derived_fields | array of strings | An array of derived fields |
missing_data_fields | array of strings | List of the data fields which are missing in the payroll API response |
manager_name | string | The supervisor name of the employee |
company | object | The employee company's information |
name | string | Company name |
address | object | Company address |
street | string | The street on which the company is located |
city | string | The city in which the company is located |
state | string | The state in which the company is located |
zip | string | The zip code to which the company belongs |
country | string | The country in which the company is located |
phone | string | The company phone number |
ein | string | Employer Identification Number |
Endpoints
Available endpoint list for Employment:
Endpoint |
---|
Get Employment Data - GET/link/{link_id}/employment |
Sample Object
The example object returned by the Get Employment Data endpoint:
{
"id": "24d7e80942ce4ad58a93f70ce4115f5c",
"income": "70000.00",
"income_unit": "YEARLY",
"pay_rate": "6500.00",
"pay_frequency": "M",
"is_active": false,
"job_title": "PR associate",
"job_type": "F",
"start_date": "2018-01-01",
"original_hire_date": "2017-06-21",
"end_date": "2022-12-11",
"external_last_updated": "2022-12-11",
"derived_fields": [
"is_active"
],
"missing_data_fields": [
"w2s"
],
"manager_name": "Jenny McDouglas",
"company": {
"name": "Facebook Demo",
"address": {
"street": "1 Morgan Ave",
"city": "Los Angeles",
"state": "CA",
"zip": "90210",
"country": "US"
},
"phone": "6503087300",
"ein": "12-345678"
}
}