v4

latestOpenAPI 3.0.12026-07-3189233676.2 KB

Employment

List all employments

The endpoint returns a list of all employments.

get/v1/links/{link_id}/employments/

Response

incomestring decimal nullable

Income amount not including commission or bonuses

The pay interval the income field refers to:

YEARLY - Annual income,
MONTHLY - Monthly income,
WEEKLY - Weekly income,
DAILY - Daily income,
HOURLY - Hourly income

pay_ratestring decimal nullable

Payment rate per pay cycle

pay_frequency'M' | 'SM' | 'W' | 'BW' | 'A' | 'SA' | 'C' | 'null' nullable

Pay frequency:

M - Monthly,
SM - Semi-Monthly,
W - Weekly,
BW - Bi-Weekly,
A - Annually,
SA - Semiannually,
C - Commission

idstring required

Unique ID

is_activeboolean nullable

Indicates whether the employment is still active

job_titlestring nullable

Employee's job title

job_type'F' | 'P' | 'S' | 'D' | 'C' | 'V' | 'null' nullable

Employee's job type:

F - Full Time,
P - Part Time,
S - Seasonal,
D - Daily (per diem),
C - Contract,
V - Volunteer

start_datestring date nullable required

Employee's hire date

original_hire_datestring date nullable

Original hire date

end_datestring date nullable

Employee's end date

external_last_updatedstring date nullable

Indicates the date when employment data was last updated on the Payroll Provider side

derived_fieldsstring[]

Array of derived fields

missing_data_fieldsstring[]

List of the data fields which are missing in the payroll API response

manager_namestring nullable

Supervisor's name

Example response

[
  {
    "income": "70000.00",
    "income_unit": "YEARLY",
    "pay_rate": "6500.00",
    "pay_frequency": "M",
    "id": "24d7e80942ce4ad58a93f70ce4115f5c",
    "job_title": "PR associate",
    "job_type": "F",
    "start_date": "2018-01-01",
    "original_hire_date": "2017-06-21",
    "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": "770493581"
    }
  }
]