Jump to

• Request
• Response
• Examples

Get time card details

post

/bi/v1/{orgIdentifier}/getTimeCardDetails

Gets time card and related sales information for all or a specified employee in a given location. When the changedSinceUTC request parameter is used, time cards without a clock out date time will continue to be returned. The labor management calculation engine runs every 15 minutes, and those time cards will then show updated hours and pay information. The time card information returned, represents the most recent and current status of this time card. This requires the use of payroll preprocessing within labor management.

The API is first available in version 20.2

Request

Path Parameters

• orgIdentifier(required): string
  Unique identifier of the organization name

Body ()

The request body defines the details of the API request.

Root Schema : timeCardDetailsRequestPayload

Type: object

Request payload for Time Card Details

Show Source

• applicationName: string
  Title: Application name

  Maximum Length: 128

  The name of the application which is accessing the API.
• busDt(required): string(date)
  Title: Business date

  The business date associated with this time card. Either busDt or postedDt have to be present in the request. If both are present, they are connect with an "AND" logic.
• changedSinceUTC: string(date-time)
  Title: Changed since date time UTC

  When this parameter is passed in the request, it compares to the lastUpdatedDateTime of the time card to return all time cards changed since that date and time. BusDt or PostedDt are additional filters on the return. To query all delta changes to time cards happening on a given date, use the PostedDt parameter together with the changedSinceUTC parameter. ChangedSinceUTC parameter should then be set to the curUTC date time returned by the previous call to the endpoint.
• empNum: integer
  Title: Employee object number

  Maximum Length: 10

  The object number of the employee associated to this time card. EmpNum (optional) or extPayrollID (optional) Only one of the parameters is allowed at one time.
• extPayrollID: string
  Title: The external payrollID

  Maximum Length: 32

  The external payrollID of the employee if entered and used in the enterprise. EmpNum (optional) or extPayrollID (optional) Only one of the parameters is allowed at one time.
• include: string
  Title: Include

  Maximum Length: 2000

  List of objects to include in response
• includeAdjustments: boolean
  Title: Include adjustments

  This parameter triggers the inclusion of the adjustments array in the response. Default is "false".
• locRef(required): string
  Title: Location reference

  Maximum Length: 99

  The location reference, this may be a store number or name depending on the organization.
• postedDt: string(date)
  Title: Posted date

  The date when this time card was inserted into the cloud. Either postedDt or busDt have to be present in the request. If both are present, they are connect with an "AND" logic.
• searchCriteria: string
  Title: Search criteria

  Maximum Length: 2000

  Search criteria to filter results based on field value

{
    "description":"Request payload for Time Card Details",
    "properties":{
        "applicationName":{
            "type":"string",
            "description":"The name of the application which is accessing the API.",
            "title":"Application name",
            "maxLength":128
        },
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value",
            "title":"Search criteria",
            "maxLength":2000
        },
        "include":{
            "type":"string",
            "description":"List of objects to include in response",
            "title":"Include",
            "maxLength":2000
        },
        "busDt":{
            "type":"string",
            "description":"The business date associated with this time card. Either busDt or postedDt have to be present in the request. If both are present, they are connect with an \"AND\" logic.",
            "title":"Business date",
            "format":"date"
        },
        "postedDt":{
            "type":"string",
            "description":"The date when this time card was inserted into the cloud. Either postedDt or busDt have to be present in the request. If both are present, they are connect with an \"AND\" logic.",
            "title":"Posted date",
            "format":"date"
        },
        "locRef":{
            "type":"string",
            "description":"The location reference, this may be a store number or name depending on the organization.",
            "title":"Location reference",
            "maxLength":99
        },
        "includeAdjustments":{
            "type":"boolean",
            "description":"This parameter triggers the inclusion of the adjustments array in the response. Default is \"false\".",
            "title":"Include adjustments"
        },
        "empNum":{
            "type":"integer",
            "description":"The object number of the employee associated to this time card. EmpNum (optional) or extPayrollID (optional) Only one of the parameters is allowed at one time.",
            "title":"Employee object number",
            "maxLength":10
        },
        "extPayrollID":{
            "type":"string",
            "description":"The external payrollID of the employee if entered and used in the enterprise. EmpNum (optional) or extPayrollID (optional) Only one of the parameters is allowed at one time.",
            "title":"The external payrollID",
            "maxLength":32
        },
        "changedSinceUTC":{
            "type":"string",
            "description":"When this parameter is passed in the request, it compares to the lastUpdatedDateTime of the time card to return all time cards changed since that date and time. BusDt or PostedDt are additional filters on the return. To query all delta changes to time cards happening on a given date, use the PostedDt parameter together with the changedSinceUTC parameter. ChangedSinceUTC parameter should then be set to the curUTC date time returned by the previous call to the endpoint.",
            "title":"Changed since date time UTC",
            "format":"date-time"
        }
    },
    "required":[
        "locRef",
        "busDt",
        "PostedDt"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : timeCardDetailsResponse

Type: object

The response body contains information about the control totals for the specified business date and location.

Show Source

• businessDates(required): array businessDates
  An array of business dates, containing time cards for the business date defined in the busDt attribute that were inserted or updated in the cloud on the specified postedDt.
• curUTC(required): string(date-time)
  Title: The current UTC date and time

  The current UTC date and time when the request is made.
• locRef(required): string
  Title: Location reference

  Maximum Length: 99

  The location reference, this may be a store number or name depending on the organization

{
    "description":"The response body contains information about the control totals for the specified business date and location.",
    "properties":{
        "curUTC":{
            "type":"string",
            "description":"The current UTC date and time when the request is made. ",
            "title":"The current UTC date and time",
            "format":"date-time"
        },
        "locRef":{
            "type":"string",
            "description":"The location reference, this may be a store number or name depending on the organization",
            "title":"Location reference",
            "maxLength":99
        },
        "businessDates":{
            "type":"array",
            "description":"An array of business dates, containing time cards for the business date defined in the busDt attribute that were inserted or updated in the cloud on the specified postedDt.",
            "items":{
                "$ref":"#/definitions/timeCardDetailsBusinessDates"
            }
        }
    },
    "required":[
        "curUTC",
        "locRef",
        "businessDates"
    ]
}

Nested Schema : businessDates

Type: array

An array of business dates, containing time cards for the business date defined in the busDt attribute that were inserted or updated in the cloud on the specified postedDt.

Show Source

• Array of: object timeCardDetailsBusinessDates
  An array of business dates, containing time cards for the business date defined in the busDt attribute that were inserted or updated in the cloud on the specified postedDt.

{
    "type":"array",
    "description":"An array of business dates, containing time cards for the business date defined in the busDt attribute that were inserted or updated in the cloud on the specified postedDt.",
    "items":{
        "$ref":"#/definitions/timeCardDetailsBusinessDates"
    }
}

Nested Schema : timeCardDetailsBusinessDates

Type: object

An array of business dates, containing time cards for the business date defined in the busDt attribute that were inserted or updated in the cloud on the specified postedDt.

Show Source

• busDt(required): string(date)
  Title: The business date

  The business date for this time card
• timeCardDetails(required): array timeCardDetails
  An array of time card details

{
    "description":"An array of business dates, containing time cards for the business date defined in the busDt attribute that were inserted or updated in the cloud on the specified postedDt.",
    "properties":{
        "busDt":{
            "type":"string",
            "description":"The business date for this time card",
            "title":"The business date",
            "format":"date"
        },
        "timeCardDetails":{
            "type":"array",
            "description":"An array of time card details",
            "items":{
                "$ref":"#/definitions/timeCardDetails"
            }
        }
    },
    "required":[
        "busDt",
        "timeCardDetails"
    ]
}

Nested Schema : timeCardDetails

Type: array

An array of time card details

Show Source

• Array of: object timeCardDetails
  An array of time card details.

{
    "type":"array",
    "description":"An array of time card details",
    "items":{
        "$ref":"#/definitions/timeCardDetails"
    }
}

Nested Schema : timeCardDetails

Type: object

An array of time card details.

Show Source

• addedUTC(required): string(date-time)
  Title: Added date time in UTC

  The date and time in UTC timezone, that the time card was initially created in the cloud.
• adjustments: array adjustments
  An array of adjustments made to the time card. Only returned if request param includeAdjustments is set to true and if adjustments exist for the time card.
• chrgRcpts: number
  Title: Charged receipts

  The value of receipts recorded by tenders configured to post to this total, such as credit cards or room charges. Only tenders that include a non-zero charged tip are included in this total. The value does not include the tip amount. This attribute will not be returned in the response if value is 0 or null.
• chrgTips: number
  Title: Charged tips

  The value of tips posted to charge payments such as credit cards or room charges. Tenders can be programmed to automatically calculate any overtendered amount as a charged tip. Charged tips can also be entered through a direct access key. A charged tip is posted to the employee associated with the check. This attribute will not be returned in the response if value is 0 or null.
• clkInAuthEmpNum: integer
  Title: Clock In authorizing employee object number

  Maximum Length: 10

  The object number of the employee authorizing the clock in. This joins to getEmployeeDimensions. This attribute will not be returned in the response if value is 0 or null.
• clkInLcl(required): string(date-time)
  Title: Clock in date and time

  Date and time in local store timezone when the employee clocked in.
• clkInStatus(required): integer
  Title: Clock in status

  Maximum Length: 5

  The clock in status.
  Possible values are:
  

  Value	Description
  0	None
  65	Early From Break
  67	Late From Break
  68	Schedule Disabled
  69	Early
  76	Late
  78	Not Scheduled
  82	Revenue Center Changed
  84	On Time

• clkInUTC(required): string(date-time)
  Title: Clock in date and time in UTC

  Date and time in UTC timezone when the employee clocked in.
• clkOutAuthEmpNum: integer
  Title: Clock Out authorizing employee object number

  Maximum Length: 10

  The object number of the employee authorizing the clock out. This joins to getEmployeeDimensions. This attribute will not be returned in the response if value is 0 or null.
• clkOutLcl: string(date-time)
  Title: Clock out date and time

  Date and time in local store timezone when the employee clocked out. This attribute will not be returned in the response if value is 0 or null.
• clkOutStatus: integer
  Title: The clock out status

  Maximum Length: 5

  The clock out status. This attribute will not be returned in the response if value is 0 or null.
  Possible values are:
  

  Value	Description
  Null	Employee still clocked in
  0	None
  66	On Break
  68	Schedule Disabled
  69	Early
  76	Late
  77	Manager Clock Out
  78	Not Scheduled
  80	Paid Break
  82	Revenue Center Changed
  84	On Time
  85	Auto Clock Out
  86	Scheduled Clock Out

• clkOutUTC: string(date-time)
  Title: Clock out date and time in UTC

  Date and time in UTC timezone when the employee clocked out. This attribute will not be returned in the response if value is 0 or null.
• drctTips: number
  Title: Declared cash tips

  Cash tips that a customer directly gives to an employee, such as a waiter or bartender. Employees use the Direct Tips function to enter the amount of tips they received in cash, or can be prompted to declare direct tips when clocking out. This information is added to Tip Totals and in reports. It is used for income tax purposes. This attribute will not be returned in the response if value is 0 or null.
• empNum(required): integer
  Title: Employee object number

  Maximum Length: 10

  The object number of the employee associated to this time card. This joins to getEmployeeDimensions.
• extPayrollID: string
  Title: Employee external payrollID

  Maximum Length: 32

  The external payrollID of the employee if entered and used in the enterprise. This attribute will not be returned in the response if value is 0 or null.
• grossRcpts: number
  Title: Gross receipts

  The monetary value of receipts recorded by tenders configured to post to this total. Gross Receipts include all sales that are tippable. The amount may or may not include taxes, depending on POS configuration. More details can be found here: https://docs.oracle.com/en/industries/food-beverage/back-office/20.1/rarrg/c_common_calc_tips.htm#TipsDefinitions-7711219F. This attribute will not be returned in the response if value is 0 or null.
• indirTips: number
  Title: Indirect tips

  Cash tips that an employee (like a bus person) receives indirectly from servers or bartenders (as opposed to directly from the customer). Employees use the Indirect Tips function to enter the amount of tips they've received in cash. They can also be prompted to declare indirect tips when clocking out. This information is added to Tips Totals in reports and is used for income tax purposes. This attribute will not be returned in the response if value is 0 or null.
• jcNum(required): integer
  Title: Job code object number

  Maximum Length: 10

  The object number of the job code that the employee used to clock in with. This joins to getJobCodeDimensions.
• jobCodeRef: integer
  Title: Employee external payrollID

  Maximum Length: 10

  Do not use. Use jcNum instead. This attribute is optional and is not returned by default, regardless of whether it is null or not.
• lastUpdatedUTC(required): string(date-time)
  Title: Last Updated Date Time in UTC

  The date and time in UTC timezone, that the time card was last updated in the cloud. The optional PostedDt request parameter is compared to the date portion of this attribute.
• ovt1Hrs: number
  Title: Number of overtime level 1 hours worked

  Number of overtime level 1 hours worked. This attribute will not be returned in the response if value is 0 or null.
• ovt1Pay: number
  Title: Overtime level 1 pay

  Overtime level 1 pay. This attribute will not be returned in the response if value is 0 or null.
• ovt2Hrs: number
  Title: Number of overtime level 2 hours worked

  Number of overtime level 2 hours worked. This attribute will not be returned in the response if value is 0 or null.
• ovt2Pay: number
  Title: Overtime level 2 pay

  Overtime level 2 pay. This attribute will not be returned in the response if value is 0 or null.
• ovt3Hrs: number
  Title: Number of overtime level 3 hours worked

  Number of overtime level 3 hours worked. This attribute will not be returned in the response if value is 0 or null.
• ovt3Pay: number
  Title: Overtime level 3 pay

  Overtime level 3 pay. This attribute will not be returned in the response if value is 0 or null.
• ovt4Hrs: number
  Title: Number of overtime level 4 hours worked

  Number of overtime level 4 hours worked. This attribute will not be returned in the response if value is 0 or null.
• ovt4Pay: number
  Title: Overtime level 4 pay

  Overtime level 4 pay. This attribute will not be returned in the response if value is 0 or null.
• payrollID: string
  Title: Employee payrollID

  Maximum Length: 32

  The payrollID of the employee, assigned by Labor Management. This attribute will not be returned in the response if value is 0 or null.
• payRt: number
  Title: Regular pay rate

  Regular pay rate. This attribute will not be returned in the response if value is 0 or null.
• premHrs: number
  Title: Number of hours worked eligible for premium pay

  Number of hours worked eligible for premium pay. This attribute will not be returned in the response if value is 0 or null.
• premPay: number
  Title: Premium pay

  Premium Pay. This attribute will not be returned in the response if value is 0 or null.
• regHrs: number
  Title: Number of regular hours worked

  Number of regular hours worked. This attribute will not be returned in the response if value is 0 or null.
• regPay: number
  Title: Regular pay

  Regular pay. This attribute will not be returned in the response if value is 0 or null.
• rvcNum(required): integer
  Title: Revenue center object number

  Maximum Length: 10

  The object number of the revenue center the employee clocked in. This joins to getRevenueCenterDimensions.
• shftNum: integer
  Title: Shift number

  Maximum Length: 19

  The shift number. This increments on every clock in if the following recommended configuration is completed: https://docs.oracle.com/en/industries/food-beverage/back-office/20.1/rause/c_gross_sales_tips.htm#VisibilityOfGrossSalesAndTips-228C1574. This attribute will not be returned in the response if value is 0 or null.
• shftType(required): integer
  Title: Shift type

  Maximum Length: 1

  Shift Type.
  Possible values are:
  

  Value	Description
  0	working shift
  1	paid break
  2	unpaid break

• svcTips: number
  Title: Service charge tips

  The amount of Service Charges that are set to post to the Service Charge total on tip reports. More details can be found here: https://docs.oracle.com/en/industries/food-beverage/back-office/20.1/rarrg/c_common_calc_tips.htm#TipsDefinitions-7711219F. This attribute will not be returned in the response if value is 0 or null.
• tcId(required): integer
  Title: Time card ID

  Maximum Length: 10

  Unique identifier for the time card
• tipsPd: number
  Title: Tips paid

  The sum of all direct charged tips that are configured to add automatically to Tips Paid and/ or recorded manually through a Tips Paid key. More details can be found here: https://docs.oracle.com/en/industries/food-beverage/back-office/20.1/rarrg/c_common_calc_tips.htm#TipsDefinitions-7711219F. This attribute will not be returned in the response if value is 0 or null.

{
    "description":"An array of time card details.",
    "properties":{
        "tcId":{
            "type":"integer",
            "description":"Unique identifier for the time card",
            "title":"Time card ID",
            "maxLength":10
        },
        "lastUpdatedUTC":{
            "type":"string",
            "description":"The date and time in UTC timezone, that the time card was last updated in the cloud. The optional PostedDt request parameter is compared to the date portion of this attribute.",
            "title":"Last Updated Date Time in UTC",
            "format":"date-time"
        },
        "addedUTC":{
            "type":"string",
            "description":"The date and time in UTC timezone, that the time card was initially created in the cloud.",
            "title":"Added date time in UTC",
            "format":"date-time"
        },
        "empNum":{
            "type":"integer",
            "description":"The object number of the employee associated to this time card. This joins to getEmployeeDimensions.",
            "title":"Employee object number",
            "maxLength":10
        },
        "payrollID":{
            "type":"string",
            "description":"The payrollID of the employee, assigned by Labor Management. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Employee payrollID",
            "maxLength":32
        },
        "extPayrollID":{
            "type":"string",
            "description":"The external payrollID of the employee if entered and used in the enterprise. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Employee external payrollID",
            "maxLength":32
        },
        "jobCodeRef":{
            "type":"integer",
            "description":"Do not use. Use jcNum instead. This attribute is optional and is not returned by default, regardless of whether it is null or not.",
            "title":"Employee external payrollID",
            "maxLength":10
        },
        "clkInAuthEmpNum":{
            "type":"integer",
            "description":"The object number of the employee authorizing the clock in. This joins to getEmployeeDimensions. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Clock In authorizing employee object number",
            "maxLength":10
        },
        "clkOutAuthEmpNum":{
            "type":"integer",
            "description":"The object number of the employee authorizing the clock out. This joins to getEmployeeDimensions. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Clock Out authorizing employee object number",
            "maxLength":10
        },
        "jcNum":{
            "type":"integer",
            "description":"The object number of the job code that the employee used to clock in with. This joins to getJobCodeDimensions.",
            "title":"Job code object number",
            "maxLength":10
        },
        "rvcNum":{
            "type":"integer",
            "description":"The object number of the revenue center the employee clocked in. This joins to getRevenueCenterDimensions.",
            "title":"Revenue center object number",
            "maxLength":10
        },
        "shftNum":{
            "type":"integer",
            "description":"The shift number. This increments on every clock in if the following recommended configuration is completed: https://docs.oracle.com/en/industries/food-beverage/back-office/20.1/rause/c_gross_sales_tips.htm#VisibilityOfGrossSalesAndTips-228C1574. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Shift number",
            "maxLength":19
        },
        "clkInLcl":{
            "type":"string",
            "description":"Date and time in local store timezone when the employee clocked in.",
            "title":"Clock in date and time",
            "format":"date-time"
        },
        "clkInUTC":{
            "type":"string",
            "description":"Date and time in UTC timezone when the employee clocked in.",
            "title":"Clock in date and time in UTC",
            "format":"date-time"
        },
        "clkInStatus":{
            "type":"integer",
            "description":"The clock in status. <br>Possible values are:<br><table><tr><th>Value</th><th>Description</th></tr><tr><td>0</td><td>None</td></tr><tr><td>65</td><td>Early From Break</td></tr><tr><td>67</td><td>Late From Break</td></tr><tr><td>68</td><td>Schedule Disabled</td></tr><tr><td>69</td><td>Early</td></tr><tr><td>76</td><td>Late</td></tr><tr><td>78</td><td>Not Scheduled</td></tr><tr><td>82</td><td>Revenue Center Changed</td></tr><tr><td>84</td><td>On Time</td></tr></table>",
            "title":"Clock in status",
            "maxLength":5
        },
        "clkOutLcl":{
            "type":"string",
            "description":"Date and time in local store timezone when the employee clocked out. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Clock out date and time",
            "format":"date-time"
        },
        "clkOutUTC":{
            "type":"string",
            "description":"Date and time in UTC timezone when the employee clocked out. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Clock out date and time in UTC",
            "format":"date-time"
        },
        "clkOutStatus":{
            "type":"integer",
            "description":"The clock out status. This attribute will not be returned in the response if value is 0 or null. <br>Possible values are:<br><table><tr><th>Value</th><th>Description</th></tr><tr><td>Null</td><td>Employee still clocked in</td></tr><tr><td>0</td><td>None</td></tr><tr><td>66</td><td>On Break</td></tr><tr><td>68</td><td>Schedule Disabled</td></tr><tr><td>69</td><td>Early</td></tr><tr><td>76</td><td>Late</td></tr><tr><td>77</td><td>Manager Clock Out</td></tr><tr><td>78</td><td>Not Scheduled</td></tr><tr><td>80</td><td>Paid Break</td></tr><tr><td>82</td><td>Revenue Center Changed</td></tr><tr><td>84</td><td>On Time</td></tr><tr><td>85</td><td>Auto Clock Out</td></tr><tr><td>86</td><td>Scheduled Clock Out</td></tr></table>",
            "title":"The clock out status",
            "maxLength":5
        },
        "payRt":{
            "type":"number",
            "description":"Regular pay rate. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Regular pay rate"
        },
        "regHrs":{
            "type":"number",
            "description":"Number of regular hours worked. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Number of regular hours worked"
        },
        "regPay":{
            "type":"number",
            "description":"Regular pay. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Regular pay"
        },
        "ovt1Hrs":{
            "type":"number",
            "description":"Number of overtime level 1 hours worked. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Number of overtime level 1 hours worked"
        },
        "ovt1Pay":{
            "type":"number",
            "description":"Overtime level 1 pay. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Overtime level 1 pay"
        },
        "ovt2Hrs":{
            "type":"number",
            "description":"Number of overtime level 2 hours worked. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Number of overtime level 2 hours worked"
        },
        "ovt2Pay":{
            "type":"number",
            "description":"Overtime level 2 pay. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Overtime level 2 pay"
        },
        "ovt3Hrs":{
            "type":"number",
            "description":"Number of overtime level 3 hours worked. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Number of overtime level 3 hours worked"
        },
        "ovt3Pay":{
            "type":"number",
            "description":"Overtime level 3 pay. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Overtime level 3 pay"
        },
        "ovt4Hrs":{
            "type":"number",
            "description":"Number of overtime level 4 hours worked. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Number of overtime level 4 hours worked"
        },
        "ovt4Pay":{
            "type":"number",
            "description":"Overtime level 4 pay. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Overtime level 4 pay"
        },
        "premHrs":{
            "type":"number",
            "description":"Number of hours worked eligible for premium pay. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Number of hours worked eligible for premium pay"
        },
        "premPay":{
            "type":"number",
            "description":"Premium Pay. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Premium pay"
        },
        "shftType":{
            "type":"integer",
            "description":"Shift Type. <br>Possible values are:<br><table><tr><th>Value</th><th>Description</th></tr><tr><td>0</td><td>working shift</td></tr><tr><td>1</td><td>paid break</td></tr><tr><td>2</td><td>unpaid break</td></tr></table>",
            "title":"Shift type",
            "maxLength":1
        },
        "grossRcpts":{
            "type":"number",
            "description":"The monetary value of receipts recorded by tenders configured to post to this total. Gross Receipts include all sales that are tippable. The amount may or may not include taxes, depending on POS configuration. More details can be found here: https://docs.oracle.com/en/industries/food-beverage/back-office/20.1/rarrg/c_common_calc_tips.htm#TipsDefinitions-7711219F. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Gross receipts"
        },
        "chrgRcpts":{
            "type":"number",
            "description":"The value of receipts recorded by tenders configured to post to this total, such as credit cards or room charges. Only tenders that include a non-zero charged tip are included in this total. The value does not include the tip amount. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Charged receipts"
        },
        "chrgTips":{
            "type":"number",
            "description":"The value of tips posted to charge payments such as credit cards or room charges. Tenders can be programmed to automatically calculate any overtendered amount as a charged tip. Charged tips can also be entered through a direct access key. A charged tip is posted to the employee associated with the check. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Charged tips"
        },
        "drctTips":{
            "type":"number",
            "description":"Cash tips that a customer directly gives to an employee, such as a waiter or bartender. Employees use the Direct Tips function to enter the amount of tips they received in cash, or can be prompted to declare direct tips when clocking out. This information is added to Tip Totals and in reports. It is used for income tax purposes. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Declared cash tips"
        },
        "indirTips":{
            "type":"number",
            "description":"Cash tips that an employee (like a bus person) receives indirectly from servers or bartenders (as opposed to directly from the customer). Employees use the Indirect Tips function to enter the amount of tips they've received in cash. They can also be prompted to declare indirect tips when clocking out. This information is added to Tips Totals in reports and is used for income tax purposes. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Indirect tips"
        },
        "svcTips":{
            "type":"number",
            "description":"The amount of Service Charges that are set to post to the Service Charge total on tip reports. More details can be found here: https://docs.oracle.com/en/industries/food-beverage/back-office/20.1/rarrg/c_common_calc_tips.htm#TipsDefinitions-7711219F.  This attribute will not be returned in the response if value is 0 or null.",
            "title":"Service charge tips"
        },
        "tipsPd":{
            "type":"number",
            "description":"The sum of all direct charged tips that are configured to add automatically to Tips Paid and/ or recorded manually through a Tips Paid key. More details can be found here: https://docs.oracle.com/en/industries/food-beverage/back-office/20.1/rarrg/c_common_calc_tips.htm#TipsDefinitions-7711219F. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Tips paid"
        },
        "adjustments":{
            "type":"array",
            "description":"An array of adjustments made to the time card. Only returned if request param includeAdjustments  is set to true and if adjustments exist for the time card.",
            "items":{
                "$ref":"#/definitions/adjustments"
            }
        }
    },
    "required":[
        "busDt",
        "shftType",
        "clkInStatus",
        "clkInUTC",
        "clkInLcl",
        "rvcNum",
        "jcNum",
        "empNum",
        "addedUTC",
        "lastUpdatedUTC",
        "tcId"
    ]
}

Nested Schema : adjustments

Type: array

An array of adjustments made to the time card. Only returned if request param includeAdjustments is set to true and if adjustments exist for the time card.

Show Source

• Array of: object adjustments
  An array of adjustments made to the time card. It is an optional array and requires the "includeAdjustments" request parameter to be set to true to be included in the response. The array contains the previous information of the changed attributes of the time card.

{
    "type":"array",
    "description":"An array of adjustments made to the time card. Only returned if request param includeAdjustments  is set to true and if adjustments exist for the time card.",
    "items":{
        "$ref":"#/definitions/adjustments"
    }
}

Nested Schema : adjustments

Type: object

An array of adjustments made to the time card. It is an optional array and requires the "includeAdjustments" request parameter to be set to true to be included in the response. The array contains the previous information of the changed attributes of the time card.

Show Source

• adjId(required): integer
  Title: Adjustment record unique identifier

  Maximum Length: 10

  Unique identifier for this adjustment record.
• adjUTC(required): string(date-time)
  Title: Adjustment date and time in UTC

  Date and time in UTC timezone when the adjustment happened.
• mgrName: string
  Title: Manager name

  Maximum Length: 50

  The name of the manager who performed the adjustment. This attribute will not be returned in the response if value is null.
• prevClkInLcl: string(date-time)
  Title: Previous clock in date and time

  The clock in date and time in the store's timezone, before it was changed. This attribute will not be returned in the response if value is 0 or null.
• prevClkInUTC: string(date-time)
  Title: Previous clock in date and time in UTC

  The clock in date and time in UTC timezone, before it was changed. This attribute will not be returned in the response if value is 0 or null.
• prevClkOutLcl: string(date-time)
  Title: Previous clock out date and time

  The clock out date and time in the store's timezone, before it was changed. This attribute will not be returned in the response if value is 0 or null.
• prevClkOutUTC: string(date-time)
  Title: Previous clock out date and time in UTC

  The clock out date and time in UTC timezone, before it was changed. This attribute will not be returned in the response if value is 0 or null.
• prevDrctTips: number
  Title: Previous direct tips amount

  The direct tips amount, before it was changed. This attribute will not be returned in the response if value is 0 or null.
• prevIndirTipsPd: number
  Title: Previous indirect tips amount

  The indirect tips amount, before it was changed. This attribute will not be returned in the response if value is 0 or null.
• prevJcNum: integer
  Title: Previous job code

  Maximum Length: 10

  The job code object number before it was changed. This attribute will not be returned in the response if value is 0 or null.
• prevRVCNum: integer
  Title: Previous revenue center object number

  Maximum Length: 10

  The revenue center object number before it was changed. This attribute will not be returned in the response if value is 0 or null.
• rsn: string
  Title: The reason provided for the change(s)

  Maximum Length: 40

  The reason provided for the change(s). This attribute will not be returned in the response if value is 0 or null.

{
    "description":"An array of adjustments made to the time card. It is an optional array and requires the \"includeAdjustments\" request parameter to be set to true to be included in the response. The array contains the previous information of the changed attributes of the time card.",
    "properties":{
        "adjId":{
            "type":"integer",
            "description":"Unique identifier for this adjustment record.",
            "title":"Adjustment record unique identifier",
            "maxLength":10
        },
        "adjUTC":{
            "type":"string",
            "description":"Date and time in UTC timezone when the adjustment happened.",
            "title":"Adjustment date and time in UTC",
            "format":"date-time"
        },
        "mgrName":{
            "type":"string",
            "description":"The name of the manager who performed the adjustment. This attribute will not be returned in the response if value is null.",
            "title":"Manager name",
            "maxLength":50
        },
        "prevJcNum":{
            "type":"integer",
            "description":"The job code object number before it was changed. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Previous job code",
            "maxLength":10
        },
        "prevRVCNum":{
            "type":"integer",
            "description":"The revenue center object number before it was changed. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Previous revenue center object number",
            "maxLength":10
        },
        "prevClkInLcl":{
            "type":"string",
            "description":"The clock in date and time in the store's timezone, before it was changed. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Previous clock in date and time",
            "format":"date-time"
        },
        "prevClkInUTC":{
            "type":"string",
            "description":"The clock in date and time in UTC timezone, before it was changed. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Previous clock in date and time in UTC",
            "format":"date-time"
        },
        "prevClkOutLcl":{
            "type":"string",
            "description":"The clock out date and time in the store's timezone, before it was changed. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Previous clock out date and time",
            "format":"date-time"
        },
        "prevClkOutUTC":{
            "type":"string",
            "description":"The clock out date and time in UTC timezone, before it was changed. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Previous clock out date and time in UTC",
            "format":"date-time"
        },
        "prevDrctTips":{
            "type":"number",
            "description":"The direct tips amount, before it was changed. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Previous direct tips amount"
        },
        "prevIndirTipsPd":{
            "type":"number",
            "description":"The indirect tips amount, before it was changed. This attribute will not be returned in the response if value is 0 or null.",
            "title":"Previous indirect tips amount"
        },
        "rsn":{
            "type":"string",
            "description":"The reason provided for the change(s). This attribute will not be returned in the response if value is 0 or null.",
            "title":"The reason provided for the change(s)",
            "maxLength":40
        }
    },
    "required":[
        "adjId",
        "adjUTC"
    ]
}

400 Response

Bad Request

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail: string
  Title: Error Description

  The description of the error
• o:errorCode(required): integer
  Title: Oracle Error Code

  Oracle error code
• status: integer
  Title: Status

  HTTP Response Code
• title(required): string
  Title: Title

  High level description of the error
• type(required): string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle Error Code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error Description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP Response Code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

401 Response

Unauthorized

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail: string
  Title: Error Description

  The description of the error
• o:errorCode(required): integer
  Title: Oracle Error Code

  Oracle error code
• status: integer
  Title: Status

  HTTP Response Code
• title(required): string
  Title: Title

  High level description of the error
• type(required): string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle Error Code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error Description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP Response Code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

403 Response

Service Unavailable

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail: string
  Title: Error Description

  The description of the error
• o:errorCode(required): integer
  Title: Oracle Error Code

  Oracle error code
• status: integer
  Title: Status

  HTTP Response Code
• title(required): string
  Title: Title

  High level description of the error
• type(required): string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle Error Code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error Description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP Response Code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

404 Response

Resource Not Found

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail: string
  Title: Error Description

  The description of the error
• o:errorCode(required): integer
  Title: Oracle Error Code

  Oracle error code
• status: integer
  Title: Status

  HTTP Response Code
• title(required): string
  Title: Title

  High level description of the error
• type(required): string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle Error Code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error Description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP Response Code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

Default Response

Unexpected Error

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail: string
  Title: Error Description

  The description of the error
• o:errorCode(required): integer
  Title: Oracle Error Code

  Oracle error code
• status: integer
  Title: Status

  HTTP Response Code
• title(required): string
  Title: Title

  High level description of the error
• type(required): string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle Error Code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error Description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP Response Code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

Back to Top

Examples

The following example shows how to view time card and related sales information for a specified employee in a given location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL

curl -i -X POST -H "Authorization: Bearer 
  
   " -H "Content-Type:application/json" -d {"busDt":"2020-10-20","locRef":"1234"} https://baseurl/bi/v1/orgidentifier/getTimeCardDetails 
  

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK  Date: Tue, 20 Oct 2020 21:24:33 GMT  Transfer-Encoding: chunked  Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
 "curUTC": "2024-05-31T17:59:59",
 "locRef": "1234",
 "businessDates": [{
  "busDt": "2024-05-31",
  "timeCardDetails": [{
   "tcId": 15253,
   "lastUpdatedUTC": "2024-05-31T10:00:00",
   "addedUTC": "2024-05-31T10:00:00",
   "empNum": 1234,
   "payrollID": "12345",
   "extPayrollID": "123789",
   "jobCodeRef": "3",
   "clkInAuthEmpNum": 12345,
   "clkOutAuthEmpNum": 12345,
   "jcNum": 123,
   "rvcNum": 1,
   "shftNum": 1,
   "clkInLcl": "2024-05-31T10:00:00",
   "clkInUTC": "2024-05-31T10:00:00",
   "clkInStatus": 84,
   "clkOutLcl": "2024-05-31T14:30:00",
   "clkOutUTC": "2024-05-31T14:30:00",
   "clkOutStatus": 84,
   "payRt": 100.0,
   "regHrs": 3.54,
   "regPay": 354.0,
   "ovt1Hrs": 1.0,
   "ovt1Pay": 1.5,
   "ovt2Hrs": 2.0,
   "ovt2Pay": 2.5,
   "ovt3Hrs": 3.0,
   "ovt3Pay": 3.5,
   "ovt4Hrs": 4.0,
   "ovt4Pay": 4.5,
   "premHrs": 4.0,
   "premPay": 4.5,
   "shftType": 1,
   "grossRcpts": 1234.56,
   "chrgRcpts": 1234.56,
   "chrgTips": 1234.56,
   "drctTips": 1234.56,
   "indirTips": 1234.56,
   "svcTips": 1234.56,
   "tipsPd": 1234.56,
   "adjustments": [{
    "adjId": 123456789,
    "adjUTC": "2024-05-31T14:30:00",
    "mgrName": "J Doe",
    "prevJcNum": 1,
    "prevRVCNum": 1,
    "prevClkInLcl": "2024-05-31T10:00:00",
    "prevClkInUTC": "2024-05-31T10:00:00",
    "prevClkOutLcl": "2024-05-31T10:00:00",
    "prevClkOutUTC": "2024-05-31T10:00:00",
    "prevDrctTips": 1234.56,
    "prevIndirTipsPd": 1234.56,
    "rsn": "Clocked out late"
    }]
   }]
  }]
 }

Back to Top