Pay Cycles

Get payment method by payment method id

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

GET

/gb/pay-cycles/{pay_cycle_id}

curl --request GET \
  --url https://api.catch-e.com/gb/pay-cycles/{pay_cycle_id} \
  --header 'Authorization: <api-key>'

{
  "billing_flag": "yes",
  "description": "<string>",
  "pay_cycle_code": "<string>",
  "pay_cycle_id": "<string>",
  "pay_cycles_per_year": 123,
  "tax_cycles_per_year": 123
}

Authorizations

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

Path Parameters

pay_cycle_idstringrequired

Pay Cycle Id

Maximum string length: 10

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

Response

Success

billing_flagenum<string>

Available options: yes, no

descriptionstring

pay_cycle_codestring

pay_cycle_idstring

pay_cycles_per_yearnumber

tax_cycles_per_yearnumber

Still need help? Ask the team