Get list of employees for payroll generation

GET /api-v1/payroll/employees

Headers

TARGET-ORGANIZATION-ID integer(int32)

ID of organization, for which the operation must be performed
WEAL-TOKEN string Required

API token (can be retrieved from account settings)

Responses

200

OK
Hide response attributes Show response attributes object
- birthday string(date-time)
- endDate string(date-time)
- genderType string
  
  Values are MALE, FEMALE, or OTHER.
- id integer
- isPayrollGenerated boolean
- name string
- orgEmployeeGroupId integer
- orgEmployeeGroupName string
- organizationId integer
- payableToBankId integer
- payrollCurrencyId integer
- salaryType string
  
  Values are MONTHLY or HOURLY.
- staffAccountId integer
- staffId integer
- staffPayslipId integer
- startDate string(date-time)
- tenantId integer
400

400 Bad Request
401

401 Unauthorized
403

403 Access Denied
404

404 Not Found
500

500 Internal Server Error

GET /api-v1/payroll/employees

curl \
 -X GET http://10.10.10.132/api-v1/payroll/employees \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string"

Response examples (200)

[
  {
    "birthday": "2024-05-04T09:42:00+00:00",
    "endDate": "2024-05-04T09:42:00+00:00",
    "genderType": "MALE",
    "id": 42,
    "isPayrollGenerated": true,
    "name": "string",
    "orgEmployeeGroupId": 42,
    "orgEmployeeGroupName": "string",
    "organizationId": 42,
    "payableToBankId": 42,
    "payrollCurrencyId": 42,
    "salaryType": "MONTHLY",
    "staffAccountId": 42,
    "staffId": 42,
    "staffPayslipId": 42,
    "startDate": "2024-05-04T09:42:00+00:00",
    "tenantId": 42
  }
]