Employee / Packages

Get package items for employees

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

GET

/sp/employee/package/items

curl --request GET \
  --url 'https://api.catch-e.com/sp/employee/package/items?driver_id=%3Cstring%3E&status_flag=active&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "sp_employee_package_items": [
      {
        "_embedded": {
          "disbursement_cycle": {
            "description": "<string>",
            "disbursement_cycle_code": "<string>",
            "disbursement_cycle_id": "<string>",
            "pay_cycles_per_year": 123
          },
          "driver": {
            "accountant_contact_name": "",
            "accountant_contact_phone": "",
            "accountant_firm_name": "",
            "address_id_home": null,
            "address_id_post": null,
            "addresses": {
              "home": {
                "address_1": "<string>",
                "address_2": "<string>",
                "address_detail_pid": "GAVIC424617164",
                "area": "<string>",
                "country_id": "<string>",
                "postcode": "<string>",
                "state": "VIC"
              },
              "post": {
                "address_1": "<string>",
                "address_2": "<string>",
                "address_detail_pid": "GAVIC424617164",
                "area": "<string>",
                "country_id": "<string>",
                "postcode": "<string>",
                "state": "VIC"
              }
            },
            "allowances": 0,
            "annual_salary": 0,
            "asset_bank_accounts": 123,
            "asset_bank_accounts_description": "",
            "asset_furniture": 123,
            "asset_furniture_description": "",
            "asset_investment_properties": 123,
            "asset_investment_properties_description": "",
            "asset_motor_vehicle": 123,
            "asset_motor_vehicle_description": "",
            "asset_other_investments": 123,
            "asset_other_investments_description": "",
            "asset_resident_property": 123,
            "asset_resident_property_description": "",
            "asset_shares": 123,
            "asset_shares_description": "",
            "asset_super": 123,
            "asset_super_description": "",
            "ato_loan_flag": "no",
            "australian_resident": "yes",
            "card_account_number": "",
            "client_cost_centre_id": "0",
            "client_id": "",
            "contact_note": "<string>",
            "corporate_type_id_previous_employer": "0",
            "created": "0000-00-00 00:00:00",
            "credit_check_authorised_flag": "yes",
            "date_of_birth": null,
            "driver_claims_flag": "yes",
            "driver_employment_type_id": "0",
            "driver_id": "0",
            "driver_id_external": "0",
            "driver_lic_exp": null,
            "driver_licence": null,
            "driver_licence_card_number": null,
            "driver_licence_state": "VIC",
            "driver_occupation_code_id": "0",
            "employee_alias": "",
            "employee_area": null,
            "employee_end": "0000-00-00",
            "employee_group": null,
            "employee_no": null,
            "employee_pay_office": null,

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

driver_idstringqueryrequired

Driver Id

Maximum string length: 10

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

status_flagenum<string>[]querydefault:active

Optional status flag

Maximum array length: 20

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

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team