Retrieve Pay Headers

Prev Next
Get
/hcm-rest-api/rest/1/ukgpayheader

Query Standards

Finder

Following row finders are available for data filtering and optimizing request performance.

  • Select Paid Cheque

Select Paid Cheque

Recommended finder parameters. Refer to Query Parameters for example.

Parameter Description Sample
companyCode Company Code 001
payRunCode Pay Run Code WK
employeeNum Employee Number 007
payPeriod Pay Period 1
payYear Pay Year 2023
Security
HTTP
Type basic

Basic authentication

Query parameters
finder
string
ExampleselectPaidChq;companyCode=001, payRunCode=WK, employeeNum=007, payPeriod=1, payYear=2023
limit
integer
Example500
offset
integer
Example0
totalResults
boolean
Exampletrue
orderBy
string
ExampleEmpNo:desc
Responses
200

Successful response