The workplace object

Represents the location where an employee works.

Use this object to specify where wages were earned in a Payroll Item. A company can have any number of workplaces.

Note: Adding or removing an employee's workplace can change the required withholding information for that employee. Consult the Employee Onboarding API for more information.

{
  "id": "wrk_oRgjEaRycoCPuS5TqVkm",
  "name": "New York Office",
  "address": {
    "line1": "200 Park Ave",
    "line2": null,
    "city": "New York",
    "state": "NY",
    "postal_code": "10166",
    "country": "US"
  },
  "company": "com_P7JPeBhb8hH23iiReDQ5",
  "active": true,
  "metadata": {}
}

Attribute

Description

id
string

Unique identifier for the workplace.

name
string

Human-readable name identifying the workplace.

address
object

Address of the workplace.

company
string

ID of the company that this workplace relates to.

active
boolean

Indicates whether the workplace can be associated with an employee for payroll.

metadata
object

Additional loosely structured information to associate with the workplace.