GET api/LeaveClass

Retrieves leave class configuration data with optional filtering by leave type.

Request Information

URI Parameters

(i.e.queryString parameters in the form ?param1={param1}&param2={param2})

Name	Description	Type	Additional information
page	Page number (default: 1)	integer	Default value is 1
pageSize	Number of records per page (default: 1000)	integer	Default value is 1000
leaveType	Optional leave type filter (e.g., A = Annual, S = Sick, R = RDO, L = Long Service)	string	None.

Body Parameters

None.

Response Information

Resource Description

Leave class configuration records grouped under a company identifier.

LeaveClassResponseView

Name	Description	Type	Additional information
companyId	Gets or sets the company (payroll database) identifier.	integer	None.
leaveTypes	Gets or sets the list of leave type configurations.	Collection of LeaveClassView	None.
page	Gets or sets the current page number.	integer	None.
pageSize	Gets or sets the page size.	integer	None.
totalCount	Gets or sets the total record count.	integer	None.
totalPages	Gets or sets the total number of pages.	integer	None.
countThisPage	Gets or sets the count of records for this page.	integer	None.
hasPreviousPage	Gets or sets whether there is a previous page.	boolean	None.
hasNextPage	Gets or sets whether there is a next page.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "companyId": 1,
  "leaveTypes": [
    {
      "leaveTypesId": 2,
      "leaveType": "sample string 3",
      "classCode": 4,
      "description": "sample string 5",
      "leaveCode": "sample string 6",
      "prorataEntitle": 1.0,
      "prorataEach": "sample string 7",
      "prorataPeriod": 1.0,
      "prorataPeriodEach": "sample string 8",
      "entitleMax": 1.0,
      "entitleEach": "sample string 9",
      "entitlePeriod": 1.0,
      "entitlePeriodEach": "sample string 10",
      "isHourly": "sample string 11",
      "accrualRate": 1.0,
      "alPublicHoliday": "sample string 12",
      "slClassification": "sample string 13"
    },
    {
      "leaveTypesId": 2,
      "leaveType": "sample string 3",
      "classCode": 4,
      "description": "sample string 5",
      "leaveCode": "sample string 6",
      "prorataEntitle": 1.0,
      "prorataEach": "sample string 7",
      "prorataPeriod": 1.0,
      "prorataPeriodEach": "sample string 8",
      "entitleMax": 1.0,
      "entitleEach": "sample string 9",
      "entitlePeriod": 1.0,
      "entitlePeriodEach": "sample string 10",
      "isHourly": "sample string 11",
      "accrualRate": 1.0,
      "alPublicHoliday": "sample string 12",
      "slClassification": "sample string 13"
    }
  ],
  "page": 2,
  "pageSize": 3,
  "totalCount": 4,
  "totalPages": 5,
  "countThisPage": 6,
  "hasPreviousPage": true,
  "hasNextPage": true
}