employment-terms

Find employment terms

Retrieves a list of all resources from the service.

get/employment-terms

Request

  • Base URL: https://api.hoorayhr.io
  • URL: https://api.hoorayhr.io/employment-terms
  • Auth: API key in header authorization

Response

success

idinteger

Unique id of the employment term

titlestring

Title of the employment term. For system terms, this cannot be changed by users

type'TEXT' | 'CURRENCY' | 'NUMBER' | 'BOOLEAN'

Determines the type of the values for assignments for this employment term

frequency'CONTINUOUS' | 'ONE_OFF'

Frequency of the employment term

systemType'SALARY' | 'WORKING_HOURS' | 'WAGE_TAX' nullable

System type of the employment term.

createdAtstring date-time

Creation date of the employment term

updatedAtstring date-time

Last updated date of the employment term

Example response

[
  {
    "id": 1,
    "title": "Salary",
    "type": "CURRENCY",
    "frequency": "CONTINUOUS",
    "systemType": "SALARY",
    "createdAt": "2022-02-15T14:01:17.516Z",
    "updatedAt": "2022-02-23T14:01:17.516Z",
    "salarySubTypes": [
      {
        "id": 1,
        "name": "Holiday allowance",
        "createdAt": "2022-02-15T14:01:17.516Z",
        "updatedAt": "2022-02-23T14:01:17.516Z"
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.