Employee / Packages

Get package item pay cycles by package item pay cycle id

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

GET

/sp/package/item/pay-cycles/{package_item_pay_cycle_id}

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

{
  "_embedded": {
    "package_item": {
      "_embedded": {
        "package_item_defaults": {
          "compress_flag_default": "yes",
          "cycles_default": 0,
          "disbursement_type_default": "yes",
          "inertia_flag_default": "yes",
          "package_item_default_id": "<string>",
          "package_item_id": "<string>",
          "pay_cycle_type_default": "REG12",
          "substantiation_flag_default": "yes",
          "supplier_id_default": "<string>",
          "supplier_id_edit_flag": "yes",
          "total_deduction_default": 0
        }
      },
      "add_gst_flag": "yes",
      "benefit_type": "type-1",
      "cap_type": "primary",
      "employee_contribution_flag": "no",
      "gst_flag": "yes",
      "module": "<string>",
      "package_item_code": "<string>",
      "package_item_id": "<string>",
      "package_name": "<string>",
      "posting_map_id": "<string>",
      "sp_profile_table_name": "sp_package_item_profile_cars",
      "tax_method": "pre-tax"
    },
    "pay_cycle": {
      "billing_flag": "yes",
      "description": "<string>",
      "pay_cycle_code": "<string>",
      "pay_cycle_id": "<string>",
      "pay_cycles_per_year": 123,
      "tax_cycles_per_year": 123
    }
  },
  "package_item_id": "<string>",
  "package_item_pay_cycle_id": "<string>",
  "pay_cycle_code": "<string>",
  "pay_cycle_id": "<string>",
  "pay_cycle_type": "REG12",
  "pay_cycles_per_year": 123,
  "status_flag": "active"
}

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

package_item_pay_cycle_idstringrequired

Maximum string length: 20

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

Response

Success

_embeddedobject

Show child attributes

package_item_idstring

Package Item Id

package_item_pay_cycle_idstring

Package Item Pay Cycle Id

pay_cycle_codestring

Pay Cycle Code

pay_cycle_idstring

Pay Cycle Id

pay_cycle_typeenum<string>

Package Cycle Type

Available options: REG12, 11MTHS

pay_cycles_per_yearnumber

Pay Cycles Per Year

status_flagenum<string>

Status Flag

Available options: active, inactive

Still need help? Ask the team