CRcrunchtime
Time Clock Enhanced Service

getAllTimeClockEnhanced

Retrieve employee time clock details.

get/timeclock/v1/getAllTimeClockEnhanced

Request

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

Query parameters

employeeNumberstring

The employee number from the employee record.

laborDatestring required

Labor date to retrieve in format dd-MMM-yy.

locationCodestring required

The Code that identifies the Location in Crunchtime.

posCodestring

POS Code for the Employee.

statusstring

Status (ALL, REVIEWED, POSTED)

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

[
  {
    "timeClockEnhancedDetailDetails": [
      {
        "breakType": "PAID",
        "cashSales": 99999999.9999,
        "cashTips": 99999999.9999,
        "chargeSales": 99999999.9999,
        "chargeTips": 99999999.99,
        "clockIn": "HH:mm MM/dd/yyyy",
        "clockOut": "HH:mm MM/dd/yyyy",
        "clopeningPayRateOr": 99999999.9999,
        "clopeningShiftHoursDiffOr": 99999999.9999,
        "clopeningValueOr": 99999999.9999,
        "completeFlag": "Y",
        "employeeNumber": "AUTO52",
        "exportFlag": "Y",
        "hoursAdjusted": 99999999.9999,
        "hoursMealPeriodPremiumOr": 99999999.9999,
        "hoursMinPaidShiftOr": 99999999.9999,
        "hoursOtAdjusted": 99999999.9999,
        "hoursPaidBreakOr": 99999999.9999,
        "hoursRegAdjusted": 99999999.9999,
        "hoursReportingPayOr": 99999999.9999,
        "hoursSplitShiftOr": 99999999.9999,
        "laborDate": "MM/dd/yyyy",
        "payRateReg": 99999999.9999,
        "payType": "H",
        "payrollCode": "Q1",
        "posCode": "AUTO10",
        "posted": "N",
        "rateMealPeriodPremium": 99999999.9999,
        "rateMinPaidShift": 99999999.9999,
        "ratePaidBreakPremium": 99999999.9999,
        "rateReportingPay": 99999999.9999,
        "rateSplitShiftOr": 99999999.9999,
        "reviewed": "Y",
        "spreadOfHrsAwardedHoursOr": 99999999.9999,
        "spreadOfHrsRate": 99999999.9999,
        "spreadOfHrsValue": 99999999.9999,
        "tippedCreditValueOr": 99999999.9999,
        "valueAdjusted": 99999999.9999,
        "valueMealPeriodPremium": 99999999.9999,
        "valueMinPaidShift": 99999999.9999,
        "valueOtAdjusted": 99999999.9999,
        "valuePaidBreak": 99999999.9999,
        "valueRegAdjusted": 99999999.9999,
        "valueReportingPay": 99999999.9999,
        "valueSplitShift": 99999999.9999,
        "weekEndingDate": "MM/dd/yyyy"
      }
    ],
    "timeClockEnhancedHeaderDetails": {
      "importDataDateTime": "HH:mm MM/dd/yyyy",
      "laborDate": "MM/dd/yyyy",
      "locationCode": "000000"
    }
  }
]

Changes

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