Employees

Overview

From the Employees endpoint, you can retrieve a list of all employees for a specified business. See Employees endpoint for more details

Data Model

FieldTypeDescription
id string Identifier for the employee, unique to the business in the accounting service provider.
employeeName
sortable
stringName of the employee as recorded in the accounting service provider.
employeeNumber
sortable
stringEmployee number as recorded in the accounting service provider.
emailAddress stringEmployee's primary email address.
birthDatestring
See Date
Employee's birth date.
phone stringEmployee's phone number.
genderstringEmployee's gender, either:
male
female
hiredDate
sortable
string
See Date
Employee's hire date.
releasedDate
sortable
string
See Date
Employee's release date.
isOrganizationbooleanIndicates if the employee represents an organization or not.
addressarrayAn Address
status
sortable, filterable
stringEmployee current status, either:
unknown
active
archived
sourceModifiedData
sortable, filterable
string
See Date
Date the record was last changed in the accounting service provider.

Example Data

{
  "data":
  [
    {
      "id": "1",
      "employeeNumber": "304",
      "employeeName": "Jane Smith",
      "emailAddress": "[email protected]",
      "birthDate": "1990-01-01",
      "phone": "8889990000",
      "gender": "male",
      "hiredDate": "2018-01-01",
      "releasedDate": "2021-03-01",
      "isOrganization": false,
      "address":
      {
        "type": "billing",
        "line1": "1234 Park Street",
        "line2": "Suite 1000",
        "city": "Toronto",
        "region": "ON",
        "country": "CAN",
        "postalCode": "A0B1C2"
      },
      "status": "active",
      "sourceModifiedDate": "2021-03-09T08:49:36.035Z"
    }
  ]
}

Did this page help you?