v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Supplemental Wage Service

getAllSupplementalWagesV1

Retrieve details of supplemental wages by location.

get/supplementalwage/v1/getAllSupplementalWages

Query parameters

employeeNumberstring

The employee number from the employee record.

laborDatestring required

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

locationCodestring required

The Code that identifies the Location in Crunchtime.

posCodestring

The POS Code for the Position.

The Code number for the Supplemental Wage.string

Supplemental wage code to retrieve.

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

Example response

[
  {
    "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
      }
    ]
  }
]