GET Payroll/Entitlements

Returns a list of entitlement / leave pay items.

Request Information

URI Parameters

Name	Description	Type	Additional information
WsAccessKey	The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access.	string	Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred.
FileId	Specifies the file id of the file to perform the operation upon.	integer	Required

Body Parameters

None.

Response Information

Resource Description

PayItemListResponse

Name	Description	Type	Additional information
Items	No documentation available.	Collection of PayItemSummary	None.

Response Formats

application/json, text/json

Sample:

{
  "Items": [
    {
      "Id": 1,
      "Name": "sample string 1"
    },
    {
      "Id": 1,
      "Name": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<PayItemListResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Items>
    <PayItemSummary>
      <Id>1</Id>
      <Name>sample string 1</Name>
    </PayItemSummary>
    <PayItemSummary>
      <Id>1</Id>
      <Name>sample string 1</Name>
    </PayItemSummary>
  </Items>
</PayItemListResponse>