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
Field | Type | Description |
---|---|---|
id | string | Identifier for the employee, unique to the business in the accounting service provider. |
employeeName | string | Name of the employee as recorded in the accounting service provider. |
employeeNumber | string | Employee number as recorded in the accounting service provider. |
emailAddress | string | Employee's primary email address. |
birthDate | string | Employee's birth date. |
phone | string | Employee's phone number. |
gender | string | Employee's gender, either: |
hiredDate | string | Employee's hire date. |
releasedDate | string | Employee's release date. |
isOrganization | boolean | Indicates if the employee represents an organization or not. |
address | array | An Address |
status | string | Employee current status, either: |
sourceModifiedData | string | Date the record was last changed in the accounting service provider. |
Example 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"
}
Updated 5 months ago