Employee / Packages

Get a disbursement cycle by disbursement cycle id

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

GET

/sp/disbursement/cycles/{disbursement_cycle_id}

curl --request GET \
  --url https://api.catch-e.com/sp/disbursement/cycles/{disbursement_cycle_id} \
  --header 'Authorization: <api-key>'

{
  "description": "<string>",
  "disbursement_cycle_code": "<string>",
  "disbursement_cycle_id": "<string>",
  "pay_cycles_per_year": 123
}

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

disbursement_cycle_idstringrequired

Maximum string length: 20

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

Success

descriptionstring

disbursement_cycle_codestring

disbursement_cycle_idstring

pay_cycles_per_yearnumber

Still need help? Ask the team