2TouchPOS DataKey Data API V2
2TouchPOS DataKey Data API V2
2013 Xenios LLC 82 Saint Paul Street Rochester, NY 14604 Phone 585.325.5242 • Fax 585.325.6989
Table of Contents About this Document .................................................................................................................................... 3 What is DataKey? .......................................................................................................................................... 4 API Details ..................................................................................................................................................... 5 Service Endpoint ....................................................................................................................................... 5 Method Credentials .............................................................................................................................. 5 Method Results ..................................................................................................................................... 5 Example Use .............................................................................................................................................. 6 Ticket Methods ......................................................................................................................................... 7 GetMetaData ........................................................................................................................................ 7 Get Menu Item Usage ........................................................................................................................... 7 Get Modifier Usage............................................................................................................................... 8 Get Ticket Details .................................................................................................................................. 9 Time Clock Methods ............................................................................................................................... 18 GetAdjustedTimeClockData ................................................................................................................ 18 GetRawTimeClockData ....................................................................................................................... 19
2
About this Document This document was written for 2TouchPOS version 3.03.5500 and version 2 of the DataKey API.
3
What is DataKey? DataKey is a web service enabling you to retrieve your 2TouchPOS historical data.
2TouchPOS
Cloud Storage
Your Application
Version 1 provides ticket detail data and inventory summary data. A ticket is comprised of menu items, modifiers, payments, gift card increases and gift certificate increases. Inventory summary data reports the total number of menu items and modifiers sold and their quantity used. Version 2 adds time clock data.
4
API Details Service Endpoint The DataKey Browser download service is available at: http://DataKey.2TPos.com/2TouchPOS/DataKey/V2/DownloadService/DownloadService.svc
Method Credentials All service methods take your Application Id, the Site Id and Auth Code as credentials. Requests with an invalid Application Id, Site Id, or Auth Code combination will be rejected. The result will indicate the failure in the status and the status reason will be ‘Invalid application id/ site Id / authorization code’.
Method Results All service methods return results of the request. Check the result Status to ensure the operation succeeded. If the operation failed, the reason will be in the result’s Reason field.
5
Example Use Here is a C#.Net example of calling the DownloadService and retrieving MetaData. Line 8 shows creating a DownloadServiceClient. Line 9 shows calling the GetMetaDataAsync method which asynchronously retrieves the ResultOfTicketMetadata results. Line 11 shows checking the result Status before continuing Lines 12-17 show doing something with the result Data if the operation was a success Line 21 shows doing something with the error message when the operation failed.
1 public async Task RefreshData_Executed() 2 { 3 Executing = true; 4 ErrorMessage = string.Empty; 5 6 try 7 { 8 DownloadServiceClient client = new DownloadServiceClient(); 9 ResultOfTicketMetadata result = await client.GetMetaDataAsync(appId, CredentialsVM.SiteId, CredentialsVM.AuthCode); 10 11 if (result.Status == Status.Success) 12 { 13 TicketMetadata ticketMetaData = result.Data; 14 15 16 17 18 19
20 21 22 23 24 25 26 27 21 22 23 }
this.EarliestBusinessDate = ticketMetaData.EarliestBusinessDate; this.LatestBusinessDate = ticketMetaData.LatestBusinessDate; this.EarliestClosedOnDate = ticketMetaData.EarliestClosedOnDate; this.LatestClosedOnDate = ticketMetaData.LatestClosedOnDate; } else
{ ErrorMessage = result.Reason; } } catch (Exception ex) { ErrorMessage = ex.Message; } Executing = false;
6
Ticket Methods GetMetaData GetMetaData returns summary information about your data. Specifically, it returns the earliest business date, latest business date, earliest ticket closed on date, and latest ticket closed on date. This method should be used to ensure data is available before calling other methods. Parameters Name applicationId siteId authCode
Type Guid Guid Guid
Returns ResultOfTicketMetaData: Name Status Reason Location Data
Type Enum String String Ticket Meta Data
Notes Success = 0, Failure = 1 The reason for a failure The Site Id
TicketMetaData: Name Earliest Business Date Earliest Closed On Date Latest Business Date Latest Closed On Date
Type Notes Date Time Date only Date Time Date Time Date only Date Time
Get Menu Item Usage Get Menu Item Usage returns summary data about the menu items used during the provided time period. Parameters Name Type applicationId Guid siteId Guid authCode Guid From Date Date Time To Date Date Time From Date and to Date are filters on ticket business dates. They are inclusive. Returns ResultOfMenuItemUsageSummary: Name Status Reason
Type Enum String
Notes Success = 0, Failure = 1 The reason for a failure 7
Location String The SiteId Data Menu Item Usage Summary Menu Item Usage Summary: Name Details Net Sales Tax Total
Type Menu Item Usage[] Decimal Decimal Decimal
Menu Item Usage: Name ERN Inventory Usage Name Quantity Sales Amount
Type string double string double Decimal
Get Modifier Usage Get Modifier Usage returns summary data about the modifiers used during the provided time period. Parameters Name Type siteId Guid applicationId Guid authCode Guid From Date Date Time To Date Date Time From Date and to Date are filters on ticket business dates. They are inclusive. Returns Result Of Array Of Modifier Group Usage Summary: Name Status Reason Location Data
Type Enum String String Modifier Group Usage Summary[]
Notes Success = 0, Failure = 1 The reason for a failure The SiteId
Modifier Group Usage Summary: Name ERN Modifiers Name
Type string Modifier Usage[] string
8
Quantity
double
Modifier Usage: Name ERN Inventory Usage Name Price Level Price Level ERN Quantity
Type string double string String String double
Get Ticket Details GetTicketDetails returns complete data about tickets. Parameters Name applicationId siteId authCode Business Date
Type Guid Guid Guid Date Time
Returns Result Of Array Of Ticket DTO: Name Status Reason Location Data
Data type Enum String String Ticket DTO[]
Description Success = 0, Failure = 1 The reason for a failure The Site Id
Ticket DTO: A Ticket Header contains summary data for a ticket as well as Menu Items, Payments, Gift Card Increases, and Gift Certificate Increases. Field Datatype Max Nullable Description Length Id Unique N Unique Id of this record Identifier Amount Due Decimal Y The total amount due from the customer Annual Int N The number of Z's since the beginning of the year. The ZCount format is YYYYdddd where YYYY is the year and dddd is the number of Zs processed this year. APIVersion Float N The DataKey version used to upload the ticket. Auto Tab String 25 Y The Id of the employee that owns the ticket when this is an Employee Id AutoTab ticket Auto Tab String 36 Y The ERN of the employee that owns the ticket when this is Employee an AutoTab ticket ERN Auto Gratuity Decimal Y The amount of the Auto Gratuity tip kept by the House establishment.
9
Amount Auto Gratuity Decimal Total Amount
Y
Business Date Closed On Cost Created On
N N Y N
Date Date Time Float Date Time
Employee Id String
25
N
Employee ERN Future Payment Gift Card Increases
36
Y
Gift Certificate Increases Guest Count
Gross Sale Amount Menu Items
String Float
Y
Gift Card Increas DTO[] Gift Certificate Increas DTO[] Int
Y
Decimal
Y
Menu Item DTO[] Decimal
Y
Net Sale Amount Order Origin String
Payments
The Payment amount taken on an a Future Order prior to completing the order.
Y
Y
3
Payment DTO[] Decimal
Promo Amount Station Name String
The amount of tip from the check as determined by the Auto Gratuity Percent and the Sub-Total, Total, Discounted SubTotal or Discounted Total depending on the system settings. The business date of this ticket. The Date and Time the ticket was closed. The total cost of menu items and modifiers The Date and Time the ticket was created. Note that due to split checks and item transfers, the ticket header could be created after a line item. The employeeId of the employee that owns the ticket. This could be the employee that opened the ticket or closed the ticket based on your settings. The owner could have been transferred to another employee. The ERN of the employee that owns the ticket.
The number of people on a ticket when usinig table management. Guest count is not necessarily required are can be null. The total gross sale amount
Y
The total of the ticket line items without taxes.
Y
Where the order started. A value of NULL means the order was started at a POS Station. A value of 'W' means the order started from 2TouchPOS' Online Ordering module.
Y Y
The total of the promo amounts
25
N
Station ERN String Tab Name String
36 25
Y Y
Table Name
25
Y
The name of the station where the ticket was closed. When the ticket was completed by a driver drop, StationName is the delivery station's name. The ERN of the station where the ticket was closed. The name given to the tab. A null value indicates a transaction that wasn't placed on a table or tab and 2TouchPOS is set to not require names. The name of the tab is provided when the ticket is associated with a table. The name of the table for this ticket. The value will be null
String
10
Tax1Amount Tax1ERN Tax1Name Tax2Amount Tax2ERN Tax2Name Tax3Amount Tax3ERN Tax3Name Ticket Number
Decimal String String Decimal String String Decimal String String String
Ticket Type
String
36 25 20
Y Y Y Y Y Y Y Y Y N
12
N
36 25 36 25
when not affiliated with a table. The amount of Tax from Tax 1 The ERN of Tax 1 The name of Tax 1 The amount of Tax from Tax 2 The ERN of Tax 2 The name of Tax 2 The amount of Tax from Tax 3 The ERN of Tax 3 The name of Tax 3 A 2TouchPOS generated identifier for the ticket. The format is YYYYMMDDhhmmTTTXXXXX where YYYY is the year, MM is the month, DD is the day, hh is the hour in 24-hour format, mm is the minute, TTT is the terminal number, XXXX is the sequential ticket number for that day. Indicates the type of transaction. The valid values are Transaction, Comp, Spill.
Menu Item DTO: Column Id Ticket Id Amount Due
Data type Max Length Unique Identifier Unique Identifier Decimal
Nullable Description N
Primary Key
N
Foreign Key to the Ticket
Y
Annual ZCount Int
Y
Auto Coupon Amount Business Date Cash Discount Surcharge Cost Course Name Course ERN Created On Department Name Department ERN Discount Amount Discount ERN Discount Employee Id Discount
Decimal
Y
Date Time Bit
Y Y
Float String 20 String 36 Date Time String 25
Y Y Y N N
NetSaleAmount plus taxes. This is the amount the customer pays. Z report identifier. The number of Z's since the beginning of the year. The format is YYYYdddd where YYYY is the year and dddd is the number of Zs processed this year. The amount deducted from an automatically applied coupon The business date of this ticket item. Indicates that the item had a surcharge applied to it because it was not paid for in cash. The cost of the item as entered into 2TouchPOS. The name of the course this item was served in. The ERN of the course this item was served in. The date and time this item was rung onto the ticket. The name of the department the item is in.
String
Y
The ERN of the department the item is in.
Y
The amount the item was discounted by The ERN of the discount applied to this item. The name of the employee receiving the employee discount applied to the item. The ERN of the employee receiving the employee
36
Decimal String String
36 50
Y Y
String
36
Y
11
Employee ERN Discount Name String Employee Id String Employee ERN String ERN String Gross Sale Decimal Amount Inventory Usage Float Name String Net Sale Decimal Amount Order Type String Order Type String ERN Original Ticket String Number PLU String Price Level String Name Price Level String ERN Promo Amount Decimal Quantity Sold Float Refund Flag Bit Reward Points Float Earned Reward Points Float Redeem Reward Card String Number Reporting String Category Name Reporting String Category ERN Seat Number Int Sort Order Int Station Name String Station ERN String Taxable Amount Decimal Tax1Amount Decimal Tax1Name String Tax1ERN String Tax2Amount Decimal Tax2Name String Tax2ERN String Tax3Amount Decimal Tax3Name String Tax3ERN String
50
Y N Y
discount applied to the item. The name of the discount applied to this item. The employee Id of the employee that rang in this item. The ERN of the employee that rang in this item. The ERN of the item. The Price per item * quantity. This before discounts and taxes. The quantity * the inventory factor The name of the item. Gross Sale Amount after discounts but before taxes.
15 36
Y Y
The name of the order type. The ERN of the order type.
20
Y
The ticket number this menu item was original rung on.
14 25
Y Y
The price look up of the item. The name of the price level the menu item was sold at.
36
Y
The ERN of the price level the menu item was sold at.
Y Y N Y
Promotional Amount Redeemed to purchase this item. The quantity of the item sold. Indicates if this line item represents a return. The number of rewards points earned
Y
25 25 36 36
Y N Y Y Y
9
Y
25
N
The number of rewards points redeemed to purchase this item. The Reward Card Number points were added to or subtracted from. The name of the category this item is reported in.
36
Y
The name of the category this item is reported in.
Y N
The seat number ordering the item. The sort order of the menu items and modifiers entered on the ticket. The name of the station where the item was rung. The ERN of the station where the item was rung. The value that taxes were calculated on. The amount of Tax from Tax 1 The name of Tax 1 The ERN of Tax 1 The amount of Tax from Tax 2 The name of Tax 2 The ERN of Tax 2 The amount of Tax from Tax 3 The name of Tax 3 The ERN of Tax 3
25 36
25 36 25 36 25 36
N Y Y Y Y Y Y Y Y Y Y Y
12
ModifiersDTO: Column
Data type
Max Length
Id
Nullable Description
Unique Identifier Menu Item Id Unique Identifier Parent Modifier Id Unique Identifier Amount Due Decimal
N
Primary Key
N
Foreign Key to the Menu Item
Y
Auto Coupon Amount Cash Discount Surcharge Cost
Decimal
Y
Bit
Y
Float
Y
Course Name Course ERN Created On Discount Amount Discount ERN Discount Employee Id Discount Employee ERN Discount Name Employee Id
String String Date Time Decimal String String
20 36
36 50
Y Y N Y Y Y
String
36
Y
String String
25 25
Y N
Employee ERN Gross Sale Amount Inventory Usage Modifier Group Modifier Group ERN Modifier Option Modifier Option ERN Modifiers
String Decimal
36
Y Y
Float String String
25 36
N Y Y
The modifier that this modifier modified. If NULL, this modifier modifies the Menu Item directly. Net Sale Amount plus taxes. This is the amount the customer pays. The amount deducted from an automatically applied coupon. Indicates that the item had a surcharge applied to it because it was not paid for in cash. The cost of this modifier. Cost is defined as the per unit cost *quantity * inventory factors. The name of the course this item was served in. The ERN of the course this item was served in. The date and time this item was rung onto the ticket. The amount the item was discounted by The ERN of the department the item is in. The name of the employee receiving the employee discount applied to the item. The ERN of the employee receiving the employee discount applied to the item. The name of the discount applied to this modifier. The employee Id of the employee that rang in this item. The ERN of the employee that rang in this item. The Price per item * quantity. This before discounts and taxes. The quantity * the inventory factor The Name of the modifier group the modifier is in. The ERN of the modifier group the modifier is in
String String
50 36
Y Y
The Name of the modifier option. The ERN of the modifier option.
Y
Modifier DTO[] Net Sale Amount Decimal
Y Y
Original Ticket String Number PLU String Price Level Name String
20
Y
14 25
Y Y
Price Level ERN
36
Y
String
The Gross Sale Amount less discounts but before taxes The ticket number this menu item was original rung on. The price look up of the item. The name of the price level the menu item was sold at. The ERN of the price level the menu item was sold
13
String
25
N
at. Promotional amount redeemed to purchase this item. The quantity of the item sold. True if this modifier is being refunded. The number of reward points earned in purchasing this modifier. The number of rewards points used to purchase this modifier. The name of the reporting category for this modifier.
String
36
Y
The ERN of the reporting category for this modifier.
String String Int
30 36 4
Y Y N
String String Decimal Decimal String String Decimal String String Decimal String String String
25 36
25 36 25
N Y Y Y Y Y Y Y Y Y Y Y N
Then name of the segment this item is divided into. Then ERN of the segment this item is divided into. The sort order of the menu items and modifiers entered on the ticket. The name of the station where the item was rung. The ERN of the station where the item was rung. The value that taxes were calculated on. The amount of Tax from Tax 1 The name of Tax 1 The ERN of Tax 1 The amount of Tax from Tax 2 The name of Tax 2 The ERN of Tax 2 The amount of Tax from Tax 3 The name of Tax 3 The ERN of Tax 3 The unique name of this modifier
String
36
Y
The ERN of the unique modifier
Promo Amount Quantity Sold Refund Flag Reward Points Earned Reward Points Redeem Reporting Category Name Reporting Category ERN Segment Name Segment ERN Sort Order
Decimal Float Bit Float
Y Y N Y
Float
Y
Station Name Station ERN Taxable Amount Tax1Amount Tax1Name Tax1ERN Tax2Amount Tax2Name Tax2ERN Tax3Amount Tax3Name Tax3ERN Unique Modifier Name Unique Modifier ERN
25 36 25 36
Gift Card Increase DTO: Column Id Ticket Id Amount Due Annual Z Count
Data type Max Length Unique Identifier Unique Identifier Decimal
Nullable Description
Int
Y
Business Date Date Created On Date Time Discount Decimal
N
Primary Key
N
The ID of the ticket this Gift Card Increase is associated with Net Sale Amount plus taxes. This is the amount the customer pays. Z report identifier. The number of Z's since the beginning of the year. The format is YYYYdddd where YYYY is the year and dddd is the number of Zs processed this year. The business date of this ticket item. The date and time this item was rung onto the ticket. The amount the item was discounted by
N
Y N Y
14
Amount Discount ERN String Discount Name String Employee Id String Employee String ERN Gift Increase Decimal Amount Order Type String Order Type String ERN Original Ticket String Number Quantity Sold Float Reward Points Float Earned Reward Points Float Redeem Reward Card String Number Seat Number Int Sort Order Int
36 25 25 36
Y Y N Y
The ERN of the discount applied to this item. The name of the discount applied to this item. The employee Id of the employee that rang in this item. The ERN of the employee that rang in this item.
Y
The amount the gift card was increased by
15 36
N Y
The name of the order type. The ERN of the order type.
20
Y
The ticket number this menu item was original rung on.
Y Y
The quantity of the item sold. The number of rewards points earned
Y
The number of rewards points used to purchase this modifier. The Reward Card Number points were added to or subtracted from. The seat number ordering the item. The sort order of the menu items and modifiers entered on the ticket. The name of the station where the item was rung. The ERN of the station where the item was rung.
9
Y Y N
Station Name String StationERN String
25 36
N Y
Gift Certificate Increases: Column
Data type Max Length Id Unique Identifier Ticket Id Unique Identifier Amount Due Decimal
Nullable Description
Annual Z Count
Y
N
Primary Key
N
Y N Y
The ID of the ticket this Gift Certificate Increase is associated with Net Sale Amount plus taxes. This is the amount the customer pays. Z report identifier. The number of Z's since the beginning of the year. The format is YYYYdddd where YYYY is the year and dddd is the number of Zs processed this year. The business date of this ticket item. The date and time this item was rung onto the ticket. The amount the item was discounted by
36
Y
The ERN of the discount applied to this item.
25
Y
The name of the discount applied to this item.
25 36
N Y
The employee Id of the employee that rang in this item. The ERN of the employee that rang in this item.
Y
The amount the gift certificate was increased by
Int
Business Date Date Created On Date Time Discount Decimal Amount Discount String ERN Discount String Name Employee Id String Employee String ERN Gift Increase Decimal
N
15
Amount Order Type String Order Type String ERN Original String Ticket Number Quantity Sold Float Reward Float Points Earned Reward Float Points Redeem Reward Card String Number Seat Number Int Sort Order Int Station Name String Station ERN String
15 36
N Y
The name of the order type. The ERN of the order type.
20
Y
The ticket number this menu item was original rung on.
Y Y
The quantity of the item sold. The number of rewards points earned
Y
The number of rewards points used to purchase this modifier.
Y
The Reward Card Number points were added to or subtracted from. The seat number ordering the item. The sort order of the menu items and modifiers entered on the ticket. The name of the station where the item was rung. The ERN of the station where the item was rung.
9
Y N 25 36
N Y
Payment DTO: Records a payment where a payment is cash, credit card, or coupon. Rewards and Loyalty purchases are recorded against the menu item. Column Data type Max Nullable Description Length Id Unique N Primary Key Identifier Ticket Id Unique N Foreign Key to the Ticket Identifier Annual Z Count Int Y The number of Z's since the beginning of the year. The format is YYYYdddd where YYYY is the year and dddd is the number of Zs processed this year. Business Date Date Time N The business date of the payment. CreditCardNumberLast4Digits String 4 Y Last 4 digits of the credit card Card Type String 20 Y AMEX, DISCOVER, MASTERCARD, DINERS, VISA Change Given Decimal Y Change Kept Decimal Y Coupon Name String 20 Y Name of the coupon Coupon ERN String 36 Y ERN of the coupon used in this transaction Coupon Percent Float Y The percent reduction in cost due to the coupon Coupon Type String 50 Y The type of coupon used Employee Name String 25 N The employee Id of the employee that rang in this item. Employee ERN String 36 Y The ERN of the employee that rang in this item. Foreign Amount Decimal Y The amount paid in foreign currency 16
Incentive Card Number
String
9
Payment Taken On Payment Type Payment Name Payment ERN Station Name
Date Time Int String 50 String 36 String 25
N N N Y N
Station ERN
String
Y
Tip Amount
Decimal
Y
Tip House Amount Total Amount
Decimal Decimal
Y Y
36
Y
The card number used to make a loyalty/reward card payment Date and time that the payment was taken Type of payment Name of the payment type The name of the station where the payment was taken. The ERN of the station where the payment was taken. The amount of tip including the amount the house keeps from the tip. Amount the house keeps from the tip. The total amount paid including the tip amount
17
Time Clock Methods Time clock data is not locked after any amount of time. That is, an adjustment to a time clock entry can be made at any time in the future. Therefore, who clocked in when and how long they worked could change at any time. Note that a clock out is required before the data for the individual interaction to be uploaded.
GetAdjustedTimeClockData GetAdjustedTimeClockData returns adjusted time clock entries whose clock out time is after the from date and before the to date at the time of the request. Parameters Name applicationId siteId authCode fromDate toDate
Type Notes Guid Guid Guid DateTime This is filtering on the Clock Out time. DateTime This is filtering on the Clock Out time.
Returns ResultOfArrayOfTimeClockState: Name Status Reason RequestedOn Location Data
Type Enum String DateTime String TimeClockState[]
Notes Success = 0, Failure = 1 The reason for a failure The date and time of the request The Site Id An array of the TimeClockData
TimeClockState: Name AutoGratuityTips ClockInTime ClockOutTime CreditCardTips CustomerAccountTips DeclaredCashTips EmployeeERN EmployeeFirstName EmployeeLastName Id JobTypeERN JobTypeName PayRate Sales
Type Decimal Date Time Date Time Decimal Decimal Decimal String String String Guid String String Decimal Decimal
Notes The amount of tips collected via Auto Gratuity The date and time of the clock in The date and time of the clock out The amount of tips from credit card transactions The amount of tips from payments to customer accounts The amount of cash tips declared The ERN of the employee. The employee’s first name. The employee’s last name. Unique Id for this record The ERN assigned to the job type. The name of the job type The payrate for this clock in/out The amount of sales generated for this clock in/out
18
GetRawTimeClockData GetRawTimeClockData returns the raw data for time clock interactions. The way the DataKey captures time clock data is through a sequence of TimeClockStates. The first state is normally created when the user clocks in. This state is also used to capture the clock out time so long as no adjustments are made. Each new state represents the best data at that moment. What Triggers and Adjustment?
Adjusting any of the following creates an adjustment record.
Clock in time Clock out time Job type Pay Rate Cash Tips Credit card Tips Account tips Auto Gratuity tips Sales total
Creating a clock in entry creates an adjustment record. Deleting a clock entry also creates an adjustment record. How is the Data Related
In every scenario, a TimeClockEntry is created. The TimeClockEntry ties all of the details together. In the majority of cases, you will have a TimeClockEntry and an associated TimeClockState. If adjustments have been performed, they will be related to the TimeClockEntry and point to new TimeClockStates. TimeClockAdjustments are ordered. When processing adjustments, it is important to process them in order.
19
Special Cases
If the user clocks in, then the TimeClockEntry will have a TimeClockState. If the manager clocks in an employee then the TimeClockEntry’s TimeClockState will be null. The manager clock in will be captured as an adjustment. The adjustments state represents the clock in. If the TimeClockEntry is deleted, the last TimeClockAdjustment’s TimeClockState will be null. Parameters Name applicationId siteId authCode fromDate toDate
Type Guid Guid Guid DateTime DateTime
Returns ResultOfRawTimeClockData: Name
Type
Notes
20
Status Reason RequestedOn Location Data
Enum String DateTime String RawTimeClockData
Success = 0, Failure = 1 The reason for a failure The date and time of the request The Site Id An array of the TimeClockData
RawTimeClockData: Name Type Notes Adjustments TimeClockAdjustment[] The array of adjustments Entries TimeClockEntry[] The array of time clock entries TimeClockAdjustment: Name Type AdjustmentOrdering Int AdjustmentTime AdjustorERN AdjustorFirstName AdjustorLastName Id TimeClockEntryId TimeClockState
Notes An integer indicating the order in which this adjustment occurred DateTime The date and time the adjustment occurred String The ERN of the employee that made the adjustment String The first name of the employee that made the adjustment String The last name of the employee that made the Guid Unique Id for this record Guid The id of the time clock entry being adjusted TimeClockState The resulting state from this adjustment. See TimeClockState in GetAdjustedTimeClockData
TimeClockEntry: Name Id TimeClockState TimeClockStateId
Type Guid TimeClockState Guid
Notes The id of the time clock entry The time clock state created on clock in. The id of the time clock state created on clock in.
21
2013 Xenios LLC 82 Saint Paul Street Rochester, NY 14604 Phone 585.325.5242 • Fax 585.325.6989
Table of Contents About this Document .................................................................................................................................... 3 What is DataKey? .......................................................................................................................................... 4 API Details ..................................................................................................................................................... 5 Service Endpoint ....................................................................................................................................... 5 Method Credentials .............................................................................................................................. 5 Method Results ..................................................................................................................................... 5 Example Use .............................................................................................................................................. 6 Ticket Methods ......................................................................................................................................... 7 GetMetaData ........................................................................................................................................ 7 Get Menu Item Usage ........................................................................................................................... 7 Get Modifier Usage............................................................................................................................... 8 Get Ticket Details .................................................................................................................................. 9 Time Clock Methods ............................................................................................................................... 18 GetAdjustedTimeClockData ................................................................................................................ 18 GetRawTimeClockData ....................................................................................................................... 19
2
About this Document This document was written for 2TouchPOS version 3.03.5500 and version 2 of the DataKey API.
3
What is DataKey? DataKey is a web service enabling you to retrieve your 2TouchPOS historical data.
2TouchPOS
Cloud Storage
Your Application
Version 1 provides ticket detail data and inventory summary data. A ticket is comprised of menu items, modifiers, payments, gift card increases and gift certificate increases. Inventory summary data reports the total number of menu items and modifiers sold and their quantity used. Version 2 adds time clock data.
4
API Details Service Endpoint The DataKey Browser download service is available at: http://DataKey.2TPos.com/2TouchPOS/DataKey/V2/DownloadService/DownloadService.svc
Method Credentials All service methods take your Application Id, the Site Id and Auth Code as credentials. Requests with an invalid Application Id, Site Id, or Auth Code combination will be rejected. The result will indicate the failure in the status and the status reason will be ‘Invalid application id/ site Id / authorization code’.
Method Results All service methods return results of the request. Check the result Status to ensure the operation succeeded. If the operation failed, the reason will be in the result’s Reason field.
5
Example Use Here is a C#.Net example of calling the DownloadService and retrieving MetaData. Line 8 shows creating a DownloadServiceClient. Line 9 shows calling the GetMetaDataAsync method which asynchronously retrieves the ResultOfTicketMetadata results. Line 11 shows checking the result Status before continuing Lines 12-17 show doing something with the result Data if the operation was a success Line 21 shows doing something with the error message when the operation failed.
1 public async Task RefreshData_Executed() 2 { 3 Executing = true; 4 ErrorMessage = string.Empty; 5 6 try 7 { 8 DownloadServiceClient client = new DownloadServiceClient(); 9 ResultOfTicketMetadata result = await client.GetMetaDataAsync(appId, CredentialsVM.SiteId, CredentialsVM.AuthCode); 10 11 if (result.Status == Status.Success) 12 { 13 TicketMetadata ticketMetaData = result.Data; 14 15 16 17 18 19
20 21 22 23 24 25 26 27 21 22 23 }
this.EarliestBusinessDate = ticketMetaData.EarliestBusinessDate; this.LatestBusinessDate = ticketMetaData.LatestBusinessDate; this.EarliestClosedOnDate = ticketMetaData.EarliestClosedOnDate; this.LatestClosedOnDate = ticketMetaData.LatestClosedOnDate; } else
{ ErrorMessage = result.Reason; } } catch (Exception ex) { ErrorMessage = ex.Message; } Executing = false;
6
Ticket Methods GetMetaData GetMetaData returns summary information about your data. Specifically, it returns the earliest business date, latest business date, earliest ticket closed on date, and latest ticket closed on date. This method should be used to ensure data is available before calling other methods. Parameters Name applicationId siteId authCode
Type Guid Guid Guid
Returns ResultOfTicketMetaData: Name Status Reason Location Data
Type Enum String String Ticket Meta Data
Notes Success = 0, Failure = 1 The reason for a failure The Site Id
TicketMetaData: Name Earliest Business Date Earliest Closed On Date Latest Business Date Latest Closed On Date
Type Notes Date Time Date only Date Time Date Time Date only Date Time
Get Menu Item Usage Get Menu Item Usage returns summary data about the menu items used during the provided time period. Parameters Name Type applicationId Guid siteId Guid authCode Guid From Date Date Time To Date Date Time From Date and to Date are filters on ticket business dates. They are inclusive. Returns ResultOfMenuItemUsageSummary: Name Status Reason
Type Enum String
Notes Success = 0, Failure = 1 The reason for a failure 7
Location String The SiteId Data Menu Item Usage Summary Menu Item Usage Summary: Name Details Net Sales Tax Total
Type Menu Item Usage[] Decimal Decimal Decimal
Menu Item Usage: Name ERN Inventory Usage Name Quantity Sales Amount
Type string double string double Decimal
Get Modifier Usage Get Modifier Usage returns summary data about the modifiers used during the provided time period. Parameters Name Type siteId Guid applicationId Guid authCode Guid From Date Date Time To Date Date Time From Date and to Date are filters on ticket business dates. They are inclusive. Returns Result Of Array Of Modifier Group Usage Summary: Name Status Reason Location Data
Type Enum String String Modifier Group Usage Summary[]
Notes Success = 0, Failure = 1 The reason for a failure The SiteId
Modifier Group Usage Summary: Name ERN Modifiers Name
Type string Modifier Usage[] string
8
Quantity
double
Modifier Usage: Name ERN Inventory Usage Name Price Level Price Level ERN Quantity
Type string double string String String double
Get Ticket Details GetTicketDetails returns complete data about tickets. Parameters Name applicationId siteId authCode Business Date
Type Guid Guid Guid Date Time
Returns Result Of Array Of Ticket DTO: Name Status Reason Location Data
Data type Enum String String Ticket DTO[]
Description Success = 0, Failure = 1 The reason for a failure The Site Id
Ticket DTO: A Ticket Header contains summary data for a ticket as well as Menu Items, Payments, Gift Card Increases, and Gift Certificate Increases. Field Datatype Max Nullable Description Length Id Unique N Unique Id of this record Identifier Amount Due Decimal Y The total amount due from the customer Annual Int N The number of Z's since the beginning of the year. The ZCount format is YYYYdddd where YYYY is the year and dddd is the number of Zs processed this year. APIVersion Float N The DataKey version used to upload the ticket. Auto Tab String 25 Y The Id of the employee that owns the ticket when this is an Employee Id AutoTab ticket Auto Tab String 36 Y The ERN of the employee that owns the ticket when this is Employee an AutoTab ticket ERN Auto Gratuity Decimal Y The amount of the Auto Gratuity tip kept by the House establishment.
9
Amount Auto Gratuity Decimal Total Amount
Y
Business Date Closed On Cost Created On
N N Y N
Date Date Time Float Date Time
Employee Id String
25
N
Employee ERN Future Payment Gift Card Increases
36
Y
Gift Certificate Increases Guest Count
Gross Sale Amount Menu Items
String Float
Y
Gift Card Increas DTO[] Gift Certificate Increas DTO[] Int
Y
Decimal
Y
Menu Item DTO[] Decimal
Y
Net Sale Amount Order Origin String
Payments
The Payment amount taken on an a Future Order prior to completing the order.
Y
Y
3
Payment DTO[] Decimal
Promo Amount Station Name String
The amount of tip from the check as determined by the Auto Gratuity Percent and the Sub-Total, Total, Discounted SubTotal or Discounted Total depending on the system settings. The business date of this ticket. The Date and Time the ticket was closed. The total cost of menu items and modifiers The Date and Time the ticket was created. Note that due to split checks and item transfers, the ticket header could be created after a line item. The employeeId of the employee that owns the ticket. This could be the employee that opened the ticket or closed the ticket based on your settings. The owner could have been transferred to another employee. The ERN of the employee that owns the ticket.
The number of people on a ticket when usinig table management. Guest count is not necessarily required are can be null. The total gross sale amount
Y
The total of the ticket line items without taxes.
Y
Where the order started. A value of NULL means the order was started at a POS Station. A value of 'W' means the order started from 2TouchPOS' Online Ordering module.
Y Y
The total of the promo amounts
25
N
Station ERN String Tab Name String
36 25
Y Y
Table Name
25
Y
The name of the station where the ticket was closed. When the ticket was completed by a driver drop, StationName is the delivery station's name. The ERN of the station where the ticket was closed. The name given to the tab. A null value indicates a transaction that wasn't placed on a table or tab and 2TouchPOS is set to not require names. The name of the tab is provided when the ticket is associated with a table. The name of the table for this ticket. The value will be null
String
10
Tax1Amount Tax1ERN Tax1Name Tax2Amount Tax2ERN Tax2Name Tax3Amount Tax3ERN Tax3Name Ticket Number
Decimal String String Decimal String String Decimal String String String
Ticket Type
String
36 25 20
Y Y Y Y Y Y Y Y Y N
12
N
36 25 36 25
when not affiliated with a table. The amount of Tax from Tax 1 The ERN of Tax 1 The name of Tax 1 The amount of Tax from Tax 2 The ERN of Tax 2 The name of Tax 2 The amount of Tax from Tax 3 The ERN of Tax 3 The name of Tax 3 A 2TouchPOS generated identifier for the ticket. The format is YYYYMMDDhhmmTTTXXXXX where YYYY is the year, MM is the month, DD is the day, hh is the hour in 24-hour format, mm is the minute, TTT is the terminal number, XXXX is the sequential ticket number for that day. Indicates the type of transaction. The valid values are Transaction, Comp, Spill.
Menu Item DTO: Column Id Ticket Id Amount Due
Data type Max Length Unique Identifier Unique Identifier Decimal
Nullable Description N
Primary Key
N
Foreign Key to the Ticket
Y
Annual ZCount Int
Y
Auto Coupon Amount Business Date Cash Discount Surcharge Cost Course Name Course ERN Created On Department Name Department ERN Discount Amount Discount ERN Discount Employee Id Discount
Decimal
Y
Date Time Bit
Y Y
Float String 20 String 36 Date Time String 25
Y Y Y N N
NetSaleAmount plus taxes. This is the amount the customer pays. Z report identifier. The number of Z's since the beginning of the year. The format is YYYYdddd where YYYY is the year and dddd is the number of Zs processed this year. The amount deducted from an automatically applied coupon The business date of this ticket item. Indicates that the item had a surcharge applied to it because it was not paid for in cash. The cost of the item as entered into 2TouchPOS. The name of the course this item was served in. The ERN of the course this item was served in. The date and time this item was rung onto the ticket. The name of the department the item is in.
String
Y
The ERN of the department the item is in.
Y
The amount the item was discounted by The ERN of the discount applied to this item. The name of the employee receiving the employee discount applied to the item. The ERN of the employee receiving the employee
36
Decimal String String
36 50
Y Y
String
36
Y
11
Employee ERN Discount Name String Employee Id String Employee ERN String ERN String Gross Sale Decimal Amount Inventory Usage Float Name String Net Sale Decimal Amount Order Type String Order Type String ERN Original Ticket String Number PLU String Price Level String Name Price Level String ERN Promo Amount Decimal Quantity Sold Float Refund Flag Bit Reward Points Float Earned Reward Points Float Redeem Reward Card String Number Reporting String Category Name Reporting String Category ERN Seat Number Int Sort Order Int Station Name String Station ERN String Taxable Amount Decimal Tax1Amount Decimal Tax1Name String Tax1ERN String Tax2Amount Decimal Tax2Name String Tax2ERN String Tax3Amount Decimal Tax3Name String Tax3ERN String
50
Y N Y
discount applied to the item. The name of the discount applied to this item. The employee Id of the employee that rang in this item. The ERN of the employee that rang in this item. The ERN of the item. The Price per item * quantity. This before discounts and taxes. The quantity * the inventory factor The name of the item. Gross Sale Amount after discounts but before taxes.
15 36
Y Y
The name of the order type. The ERN of the order type.
20
Y
The ticket number this menu item was original rung on.
14 25
Y Y
The price look up of the item. The name of the price level the menu item was sold at.
36
Y
The ERN of the price level the menu item was sold at.
Y Y N Y
Promotional Amount Redeemed to purchase this item. The quantity of the item sold. Indicates if this line item represents a return. The number of rewards points earned
Y
25 25 36 36
Y N Y Y Y
9
Y
25
N
The number of rewards points redeemed to purchase this item. The Reward Card Number points were added to or subtracted from. The name of the category this item is reported in.
36
Y
The name of the category this item is reported in.
Y N
The seat number ordering the item. The sort order of the menu items and modifiers entered on the ticket. The name of the station where the item was rung. The ERN of the station where the item was rung. The value that taxes were calculated on. The amount of Tax from Tax 1 The name of Tax 1 The ERN of Tax 1 The amount of Tax from Tax 2 The name of Tax 2 The ERN of Tax 2 The amount of Tax from Tax 3 The name of Tax 3 The ERN of Tax 3
25 36
25 36 25 36 25 36
N Y Y Y Y Y Y Y Y Y Y Y
12
ModifiersDTO: Column
Data type
Max Length
Id
Nullable Description
Unique Identifier Menu Item Id Unique Identifier Parent Modifier Id Unique Identifier Amount Due Decimal
N
Primary Key
N
Foreign Key to the Menu Item
Y
Auto Coupon Amount Cash Discount Surcharge Cost
Decimal
Y
Bit
Y
Float
Y
Course Name Course ERN Created On Discount Amount Discount ERN Discount Employee Id Discount Employee ERN Discount Name Employee Id
String String Date Time Decimal String String
20 36
36 50
Y Y N Y Y Y
String
36
Y
String String
25 25
Y N
Employee ERN Gross Sale Amount Inventory Usage Modifier Group Modifier Group ERN Modifier Option Modifier Option ERN Modifiers
String Decimal
36
Y Y
Float String String
25 36
N Y Y
The modifier that this modifier modified. If NULL, this modifier modifies the Menu Item directly. Net Sale Amount plus taxes. This is the amount the customer pays. The amount deducted from an automatically applied coupon. Indicates that the item had a surcharge applied to it because it was not paid for in cash. The cost of this modifier. Cost is defined as the per unit cost *quantity * inventory factors. The name of the course this item was served in. The ERN of the course this item was served in. The date and time this item was rung onto the ticket. The amount the item was discounted by The ERN of the department the item is in. The name of the employee receiving the employee discount applied to the item. The ERN of the employee receiving the employee discount applied to the item. The name of the discount applied to this modifier. The employee Id of the employee that rang in this item. The ERN of the employee that rang in this item. The Price per item * quantity. This before discounts and taxes. The quantity * the inventory factor The Name of the modifier group the modifier is in. The ERN of the modifier group the modifier is in
String String
50 36
Y Y
The Name of the modifier option. The ERN of the modifier option.
Y
Modifier DTO[] Net Sale Amount Decimal
Y Y
Original Ticket String Number PLU String Price Level Name String
20
Y
14 25
Y Y
Price Level ERN
36
Y
String
The Gross Sale Amount less discounts but before taxes The ticket number this menu item was original rung on. The price look up of the item. The name of the price level the menu item was sold at. The ERN of the price level the menu item was sold
13
String
25
N
at. Promotional amount redeemed to purchase this item. The quantity of the item sold. True if this modifier is being refunded. The number of reward points earned in purchasing this modifier. The number of rewards points used to purchase this modifier. The name of the reporting category for this modifier.
String
36
Y
The ERN of the reporting category for this modifier.
String String Int
30 36 4
Y Y N
String String Decimal Decimal String String Decimal String String Decimal String String String
25 36
25 36 25
N Y Y Y Y Y Y Y Y Y Y Y N
Then name of the segment this item is divided into. Then ERN of the segment this item is divided into. The sort order of the menu items and modifiers entered on the ticket. The name of the station where the item was rung. The ERN of the station where the item was rung. The value that taxes were calculated on. The amount of Tax from Tax 1 The name of Tax 1 The ERN of Tax 1 The amount of Tax from Tax 2 The name of Tax 2 The ERN of Tax 2 The amount of Tax from Tax 3 The name of Tax 3 The ERN of Tax 3 The unique name of this modifier
String
36
Y
The ERN of the unique modifier
Promo Amount Quantity Sold Refund Flag Reward Points Earned Reward Points Redeem Reporting Category Name Reporting Category ERN Segment Name Segment ERN Sort Order
Decimal Float Bit Float
Y Y N Y
Float
Y
Station Name Station ERN Taxable Amount Tax1Amount Tax1Name Tax1ERN Tax2Amount Tax2Name Tax2ERN Tax3Amount Tax3Name Tax3ERN Unique Modifier Name Unique Modifier ERN
25 36 25 36
Gift Card Increase DTO: Column Id Ticket Id Amount Due Annual Z Count
Data type Max Length Unique Identifier Unique Identifier Decimal
Nullable Description
Int
Y
Business Date Date Created On Date Time Discount Decimal
N
Primary Key
N
The ID of the ticket this Gift Card Increase is associated with Net Sale Amount plus taxes. This is the amount the customer pays. Z report identifier. The number of Z's since the beginning of the year. The format is YYYYdddd where YYYY is the year and dddd is the number of Zs processed this year. The business date of this ticket item. The date and time this item was rung onto the ticket. The amount the item was discounted by
N
Y N Y
14
Amount Discount ERN String Discount Name String Employee Id String Employee String ERN Gift Increase Decimal Amount Order Type String Order Type String ERN Original Ticket String Number Quantity Sold Float Reward Points Float Earned Reward Points Float Redeem Reward Card String Number Seat Number Int Sort Order Int
36 25 25 36
Y Y N Y
The ERN of the discount applied to this item. The name of the discount applied to this item. The employee Id of the employee that rang in this item. The ERN of the employee that rang in this item.
Y
The amount the gift card was increased by
15 36
N Y
The name of the order type. The ERN of the order type.
20
Y
The ticket number this menu item was original rung on.
Y Y
The quantity of the item sold. The number of rewards points earned
Y
The number of rewards points used to purchase this modifier. The Reward Card Number points were added to or subtracted from. The seat number ordering the item. The sort order of the menu items and modifiers entered on the ticket. The name of the station where the item was rung. The ERN of the station where the item was rung.
9
Y Y N
Station Name String StationERN String
25 36
N Y
Gift Certificate Increases: Column
Data type Max Length Id Unique Identifier Ticket Id Unique Identifier Amount Due Decimal
Nullable Description
Annual Z Count
Y
N
Primary Key
N
Y N Y
The ID of the ticket this Gift Certificate Increase is associated with Net Sale Amount plus taxes. This is the amount the customer pays. Z report identifier. The number of Z's since the beginning of the year. The format is YYYYdddd where YYYY is the year and dddd is the number of Zs processed this year. The business date of this ticket item. The date and time this item was rung onto the ticket. The amount the item was discounted by
36
Y
The ERN of the discount applied to this item.
25
Y
The name of the discount applied to this item.
25 36
N Y
The employee Id of the employee that rang in this item. The ERN of the employee that rang in this item.
Y
The amount the gift certificate was increased by
Int
Business Date Date Created On Date Time Discount Decimal Amount Discount String ERN Discount String Name Employee Id String Employee String ERN Gift Increase Decimal
N
15
Amount Order Type String Order Type String ERN Original String Ticket Number Quantity Sold Float Reward Float Points Earned Reward Float Points Redeem Reward Card String Number Seat Number Int Sort Order Int Station Name String Station ERN String
15 36
N Y
The name of the order type. The ERN of the order type.
20
Y
The ticket number this menu item was original rung on.
Y Y
The quantity of the item sold. The number of rewards points earned
Y
The number of rewards points used to purchase this modifier.
Y
The Reward Card Number points were added to or subtracted from. The seat number ordering the item. The sort order of the menu items and modifiers entered on the ticket. The name of the station where the item was rung. The ERN of the station where the item was rung.
9
Y N 25 36
N Y
Payment DTO: Records a payment where a payment is cash, credit card, or coupon. Rewards and Loyalty purchases are recorded against the menu item. Column Data type Max Nullable Description Length Id Unique N Primary Key Identifier Ticket Id Unique N Foreign Key to the Ticket Identifier Annual Z Count Int Y The number of Z's since the beginning of the year. The format is YYYYdddd where YYYY is the year and dddd is the number of Zs processed this year. Business Date Date Time N The business date of the payment. CreditCardNumberLast4Digits String 4 Y Last 4 digits of the credit card Card Type String 20 Y AMEX, DISCOVER, MASTERCARD, DINERS, VISA Change Given Decimal Y Change Kept Decimal Y Coupon Name String 20 Y Name of the coupon Coupon ERN String 36 Y ERN of the coupon used in this transaction Coupon Percent Float Y The percent reduction in cost due to the coupon Coupon Type String 50 Y The type of coupon used Employee Name String 25 N The employee Id of the employee that rang in this item. Employee ERN String 36 Y The ERN of the employee that rang in this item. Foreign Amount Decimal Y The amount paid in foreign currency 16
Incentive Card Number
String
9
Payment Taken On Payment Type Payment Name Payment ERN Station Name
Date Time Int String 50 String 36 String 25
N N N Y N
Station ERN
String
Y
Tip Amount
Decimal
Y
Tip House Amount Total Amount
Decimal Decimal
Y Y
36
Y
The card number used to make a loyalty/reward card payment Date and time that the payment was taken Type of payment Name of the payment type The name of the station where the payment was taken. The ERN of the station where the payment was taken. The amount of tip including the amount the house keeps from the tip. Amount the house keeps from the tip. The total amount paid including the tip amount
17
Time Clock Methods Time clock data is not locked after any amount of time. That is, an adjustment to a time clock entry can be made at any time in the future. Therefore, who clocked in when and how long they worked could change at any time. Note that a clock out is required before the data for the individual interaction to be uploaded.
GetAdjustedTimeClockData GetAdjustedTimeClockData returns adjusted time clock entries whose clock out time is after the from date and before the to date at the time of the request. Parameters Name applicationId siteId authCode fromDate toDate
Type Notes Guid Guid Guid DateTime This is filtering on the Clock Out time. DateTime This is filtering on the Clock Out time.
Returns ResultOfArrayOfTimeClockState: Name Status Reason RequestedOn Location Data
Type Enum String DateTime String TimeClockState[]
Notes Success = 0, Failure = 1 The reason for a failure The date and time of the request The Site Id An array of the TimeClockData
TimeClockState: Name AutoGratuityTips ClockInTime ClockOutTime CreditCardTips CustomerAccountTips DeclaredCashTips EmployeeERN EmployeeFirstName EmployeeLastName Id JobTypeERN JobTypeName PayRate Sales
Type Decimal Date Time Date Time Decimal Decimal Decimal String String String Guid String String Decimal Decimal
Notes The amount of tips collected via Auto Gratuity The date and time of the clock in The date and time of the clock out The amount of tips from credit card transactions The amount of tips from payments to customer accounts The amount of cash tips declared The ERN of the employee. The employee’s first name. The employee’s last name. Unique Id for this record The ERN assigned to the job type. The name of the job type The payrate for this clock in/out The amount of sales generated for this clock in/out
18
GetRawTimeClockData GetRawTimeClockData returns the raw data for time clock interactions. The way the DataKey captures time clock data is through a sequence of TimeClockStates. The first state is normally created when the user clocks in. This state is also used to capture the clock out time so long as no adjustments are made. Each new state represents the best data at that moment. What Triggers and Adjustment?
Adjusting any of the following creates an adjustment record.
Clock in time Clock out time Job type Pay Rate Cash Tips Credit card Tips Account tips Auto Gratuity tips Sales total
Creating a clock in entry creates an adjustment record. Deleting a clock entry also creates an adjustment record. How is the Data Related
In every scenario, a TimeClockEntry is created. The TimeClockEntry ties all of the details together. In the majority of cases, you will have a TimeClockEntry and an associated TimeClockState. If adjustments have been performed, they will be related to the TimeClockEntry and point to new TimeClockStates. TimeClockAdjustments are ordered. When processing adjustments, it is important to process them in order.
19
Special Cases
If the user clocks in, then the TimeClockEntry will have a TimeClockState. If the manager clocks in an employee then the TimeClockEntry’s TimeClockState will be null. The manager clock in will be captured as an adjustment. The adjustments state represents the clock in. If the TimeClockEntry is deleted, the last TimeClockAdjustment’s TimeClockState will be null. Parameters Name applicationId siteId authCode fromDate toDate
Type Guid Guid Guid DateTime DateTime
Returns ResultOfRawTimeClockData: Name
Type
Notes
20
Status Reason RequestedOn Location Data
Enum String DateTime String RawTimeClockData
Success = 0, Failure = 1 The reason for a failure The date and time of the request The Site Id An array of the TimeClockData
RawTimeClockData: Name Type Notes Adjustments TimeClockAdjustment[] The array of adjustments Entries TimeClockEntry[] The array of time clock entries TimeClockAdjustment: Name Type AdjustmentOrdering Int AdjustmentTime AdjustorERN AdjustorFirstName AdjustorLastName Id TimeClockEntryId TimeClockState
Notes An integer indicating the order in which this adjustment occurred DateTime The date and time the adjustment occurred String The ERN of the employee that made the adjustment String The first name of the employee that made the adjustment String The last name of the employee that made the Guid Unique Id for this record Guid The id of the time clock entry being adjusted TimeClockState The resulting state from this adjustment. See TimeClockState in GetAdjustedTimeClockData
TimeClockEntry: Name Id TimeClockState TimeClockStateId
Type Guid TimeClockState Guid
Notes The id of the time clock entry The time clock state created on clock in. The id of the time clock state created on clock in.
21
