CRcrunchtime
Supplemental Wage Service

getSupplementalWagesByPage

Retrieve details of supplemental wages by page number.

get/supplementalwage/v1/getSupplementalWagesByPage

Request

  • Base URL
    //webservices-test.net-chef.com (relative, and the document’s source URL is not known)
  • URL
    //webservices-test.net-chef.com/supplementalwage/v1/getSupplementalWagesByPage
  • Auth
    none declared. Required headers: authenticationtoken, password, sitename, userid

Query parameters

employeeNumberstring

The employee number from the employee record.

laborDatestring required

The Labor Date to retrieve, in format dd-MMM-yy.

locationCodestring

The Code that identifies the Location in Crunchtime.

pageNumberinteger

Retrieve one or more records by pageNumber. Use to retrieve data in smaller chunks. If left blank, the default is 1.

posCodestring

The POS Code for the Position.

supplementalWageCodestring

The Code number for the Supplemental Wage.

pageSizeinteger

Number of items to display per page.

includeNullboolean

Specify 'true' to output null data elements.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

hasNextboolean
totalPagesinteger

Example response

{
  "supplementalWageDetails": [
    {
      "supplementalWageDetailDetails": [
        {
          "employeeNumber": "000-R01",
          "hourlyFlag": "Y",
          "hourlyValue": 9.1,
          "laborDate": "MM/dd/yyyy",
          "lumpSumFlag": "Y",
          "lumpSumValue": 10.2,
          "posCode": "000-R01",
          "supplementalWageCode": "PTO1",
          "dailyLumpSumFlag": "Y",
          "dailyLumpSumValue": 1050.25
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.