Employments

Learn about the /employments endpoint.

Employment objects contain information related to the employment information of the user: employment status and type, hire and termination dates, etc. The data in an employment object is tied to a particular payroll account that the user has connected via Argyle Link.

The employment object

AttributeTypeDescription
idstring uuidUnique ID of the employment object associated with a user's payroll account.
accountstring uuidID of the payroll account associated with the employment object.
employerstringThe name of the company or entity that employs the user.
statusstringStatus of employment.

Possible values: active, inactive, terminated, retired.
typestringType of employment. Generally, you file Form 1099 for a contractor and Form W-2 for all other types of employment.

Possible values:

- full-time
- part-time
- contractor
- seasonal
- temporary
- other
job_titlestringThe current job title of the user. The value will usually be a free-form text returned from the payroll provider—for example, sales associate, driver.
hire_datetimestring datetimeThe date when the user was hired by the employer. Timestamps follow the ISO 8601 standard.
termination_datetimestring datetimeThe date when the user's employment was terminated by the employer. Timestamps follow the ISO 8601 standard.
termination_reasonstringReason for the termination event. Free-form text entry provided by the employer or payroll provider.
base_pay.amountintegerA fixed amount of money paid to a user, not including any bonuses, commission, or other discretionary incentives.
base_pay.periodstringThe unit of time base_pay.amount corresponds to. biweekly occurs every two weeks while semimonthly occurs twice a month.

Possible values:

- hourly
- weekly
- biweekly
- semimonthly
- monthly
- annual
- salary (used only when this value is explicitly recorded by the payroll provider and no additional information regarding pay period timeframe is provided)
base_pay.currencystringA user's base pay currency. Currencies follow the ISO 4217 format.
pay_cyclestringThe frequency at which the user gets paid. biweekly occurs every two weeks while semimonthly occurs twice a month.

Possible values:

- daily
- weekly
- biweekly
- semimonthly
- monthly
- quarterly
platform_ids.employee_idstringA unique ID assigned to a user by an employer.
platform_ids.position_idstringA unique ID assigned to a position by an employer.
platform_ids.platform_user_idstringA unique ID assigned to a user by a payroll provider.
platform_user_id
*deprecated
stringDeprecated in favor of platform_ids.platform_user_id
metadatastringMetadata holds additional available, often unstructured, information about this data resource.
created_atstring
timestamp
Time at which the employment object was created. Timestamps follow the ISO 8601 standard.
updated_atstring
timestamp
Time at which the employment object was last updated. Timestamps follow the ISO 8601 standard.

Endpoints

These are the endpoints available for employments.

Endpoints
Retrieve an employment - GET /employments/:id
List employments - GET /employments

Example object

{
    "id": "857b4aad-1a55-4200-84f7-311cd3dc3432",
    "account": "021a1749-6973-4e47-a82a-307008ca88cc",
    "employer": "walmart",
    "created_at": "2020-10-27T17:29:08.724441Z",
    "updated_at": "2020-10-27T17:29:08.724520Z",
    "status": "active",
    "type": "part-time",
    "job_title": "cashier",
    "hire_datetime": "2018-10-27T17:29:08.724441Z",
    "termination_datetime": null,
    "termination_reason": null,
    "base_pay": {
        "amount": 36400,
        "period": "annual",
        "currency": "USD"
    },
    "pay_cycle": "monthly",
    "platform_ids": {
        "employee_id": "47FJ06ON8",
        "position_id": "INA609028",
        "platform_user_id": "H3WTY0FHMQ24ERDN"
    },
    "metadata": {}
}