Employee / Packages

Get driver pay cycle details by driver id

This method requires the EmployeePackageItems:Get permission to be associated with your role.

GET

/sp/employee/{driver_id}/pay-cycle-details

curl --request GET \
  --url https://api.catch-e.com/sp/employee/{driver_id}/pay-cycle-details \
  --header 'Authorization: <api-key>'

{
  "pay_cycle": "<string>",
  "pay_cycle_code": "<string>",
  "payroll_date": "2023-12-25"
}

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

driver_idstringrequired

Maximum string length: 10

Pattern: ^[1-9]{1}[0-9]*$

Success

pay_cyclestring

pay_cycle_codestring

payroll_datestring

Still need help? Ask the team