Employee / Packages

Get Package item defaults

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

GET

/sp/package/item/defaults

curl --request GET \
  --url 'https://api.catch-e.com/sp/package/item/defaults?package_item_id=%3Cstring%3E&disbursement_type_default=claim&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "sp_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
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/sp/package/item/defaults"
    }
  }
}

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

Query Parameters

package_item_idstringquery

Package item id

Maximum string length: 10

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

disbursement_type_defaultenum<string>query

Disbursement type default

Available options: claim, periodic, recurring

pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Optional page size

Required range: -1 <= x <= 2147483647

Response

Success

_embeddedobject

Show child attributes

_linksobject

Still need help? Ask the team