Employee / Packages

Get package item by package item id

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

GET

/sp/package/items/{package_item_id}

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

{
  "_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"
}

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_idstringrequired

Maximum string length: 10

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

Response

Success

_embeddedobject

Show child attributes

add_gst_flagenum<string>

Add GST flag

Available options: yes, no

benefit_typeenum<string>

Benefit type

Available options: type-1, type-2, exempt

cap_typeenum<string>

Cap type

Available options: primary, meal

employee_contribution_flagenum<string>default:no

Employee Contribution Flag

Available options: yes, no

gst_flagenum<string>

GST flag

Available options: yes, no

modulestring

Module

package_item_codestring

Package Item Code

package_item_idstring

Package Item Id

package_namestring

Package name

posting_map_idstring

Posting Map Id

sp_profile_table_nameenum<string>

Available options: sp_package_item_profile_cars, sp_remote_area_benefits

tax_methodenum<string>

Tax method

Available options: pre-tax, post-tax

Still need help? Ask the team