Employee

The Payroll API provides the Employee resource for viewing employee information. The information below describes how to use the resource to view employee information.

Employee object
Field Data type Description
id String Unique identifier for this employee.
firstName String Employee’s first name.
middleName String Employee’s middle name.
lastName String Employee’s last name.
gender String Each tax jurisdictions supports different set of genders, such as MALE, FEMALE, OTHER.
alternateIds.id String Alternate identifier for the employee. Allows multiple domain IDs for this entity. Typically used for data migration.
alternateIds.nameSpace String Alternate namespace for the employee. Allows multiple namespaces for this entity. Typically used for data migration.
employmentStatus.active Boolean Indicates whether the employment status is currently active.
employmentStatus.detailedStatus String Detailed employment status, such as Active, Paid Leave, Unpaid Leave, Not On Payroll, Terminated, orDeceased.
payrollEmployeeDetails.paySchedule.name String Name of the employer pay schedule.
payrollEmployeeDetails.paySchedule.frequency String Frequency of the pay periods for this pay schedule: EVERY_WEEK, EVERY_OTHER_WEEK, TWICE_A_MONTH, EVERY_MONTH, UNSPECIFIED
payrollEmployeeDetails.paySchedule.referenceDates.initialPayDate String Pay period dates of the pay schedule.
contactInfo.primaryAddress.city String Employee’s city.
contactInfo.primaryAddress.country String Employee’s country.
contactInfo.primaryAddress.postalCode String Employee’s postal code.
contactInfo.primaryAddress.state String Employee’s state.
contactInfo.primaryAddress.streetAddressLine1 String Line 1 of the employee’s street address.
contactInfo.primaryAddress.streetAddressLine2 String Line 2 of the employee’s street address.
contactInfo.primaryAddress.streetAddressLine3 String Line 3 of the employee’s street address.
primaryEmailAddress.email String Employee’s email address.
primaryPhoneNumber.number String Employee’s phone number.
primaryPhoneNumber.originalNumber String Employee’s original phone number.
employmentDetail.hireDate Date Employee’s hire date.
employmentDetail.jobTitle String Employee’s current job title.
employmentDetail.terminationDate Date If the employee has been terminated, the date the termination occurred.
payroll.employeeDetails.workLocation.addressComponents.city String Work location city.
payroll.employeeDetails.workLocation.addressComponents.state String Work location state.
payroll.employeeDetails.workLocation.addressComponents.country String Work location country.
payroll.employeeDetails.workLocation.addressComponents.postalCode String Work location postal code.
payroll.employeeDetails.workLocation.addressComponents.streetAddressLine1 String First line of the work location street address.
payroll.employeeDetails.workLocation.addressComponents.streetAddressLine2 String Second line of the work location street address.
payroll.employeeDetails.workLocation.addressComponents.streetAddressLine3 String Third line of the work location street address.
Read employee information

Scope: qb.employee.read

Request

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
  query EmployeesQuery($orderBy: [WorkerManagement_EmployeeConnectionOrderBy!]
      $filter: WorkerManagement_EmployeeConnectionFilter!)
  {
      workerManagementEmployees(orderBy: $orderBy, filter: $filter) {
          edges {
            node {
              id
              firstName
              middleName
              lastName
              gender
              alternateIds {
                id
                nameSpace
              }
              employmentStatus {
                active
                detailedStatus
              }
              payrollEmployeeDetails {
                paySchedule {
                  name
                  frequency
                  referenceDates {
                    ... on Payroll_PayScheduleAbsoluteReferenceDates {
                      initialPayDate
                    }
                  }
                }
              }
              contactInfo {
                primaryAddress {
                  city
                  country
                  postalCode
                  state
                  streetAddressLine1
                  streetAddressLine2
                  streetAddressLine3
                }
                primaryEmailAddress {
                  email
                }
                primaryPhoneNumber {
                  number
                  originalNumber
                }
              }
              employmentDetail {
                hireDate
                jobTitle
                terminationDate
              }
              payrollEmployeeDetails {
               workLocation {
                  addressComponents {
                    city
                    country
                    postalCode
                    state
                    streetAddressLine1
                    streetAddressLine2
                    streetAddressLine3
                  }
                }
              }
            }
          }
          pageInfo {
            endCursor
            hasNextPage
            hasPreviousPage
            startCursor
          }
          totalCount
        }
      }

Input variable

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
  {
   "orderBy": [
      "FIRSTNAME_ASC",
      "EMPLOYMENTDETAIL_HIREDATE_ASC"
  ],
  "filter": {
     "employeeId": {
       "in": ["1"]
  }
      "employmentStatus": {
          "active": {
          "eq": true
          }
        }
      }
  }

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
  {
    "data": {
      "workerManagementEmployees": {
        "edges": [
          {
            "node": {
              "id": "1",
              "firstName": "first",
              "middleName": "null",
              "lastName": "One",
              "gender": "null",
              "alternateIds": [
                {
                  "id":    "djQuMTo5MTMwMzU3NTQxODMxOTc2OjlkNjk5ZTk2MDg:1",
                  "nameSpace": "Intuit.sbseg.v4"
                }
              ],
              "employmentStatus": {
                "active": true,
                "detailedStatus": "ACTIVE"
              },
              "payrollEmployeeDetails": {
                "paySchedule": {
                    "name": "Every Friday",
                    "frequency": "EVERY_WEEK",
                    "referenceDates": [
                      {
                        "initialPayDate": "2024-06-14T00:00:00.000Z"
                      }
                    ]
                  },
                  "workLocation": {
                    "addressComponents": {
                      "city": "Mountain View",
                      "country": null,
                      "postalCode": "94043",
                      "state": "CA",
                      "streetAddressLine1": "123 Marine Street",
                      "streetAddressLine2": null,
                      "streetAddressLine3": null
                    }
                  }
                },
              "contactInfo": {
                "primaryAddress": {
                  "city": "Mountain View",
                  "country": "USA",
                  "postalCode": "94043-4802",
                  "state": "CA",
                  "streetAddressLine1": "123 Hope Ave",
                  "streetAddressLine2": null,
                  "streetAddressLine3": null
                },
                "primaryEmailAddress": null,
                "primaryPhoneNumber": null
              },
              "employmentDetail": {
                "hireDate": "2024-06-01",
                "jobTitle": null,
                "terminationDate": null
              },
            }
          }
         ],
        "pageInfo": {
          "endCursor": "0",
          "hasNextPage": false,
          "hasPreviousPage": false,
          "startCursor": "0"
        },
        "totalCount": 1
      }
    }
  }