POSConnect: TCP JSON API
API Version 1.0.0Introduction
The following document describes eConnect's TCP based JSON API for Point-Of-Sale (POS) data, which can be used to stream POS event data directly into POSConnect. All communication with the eConnect server is handled via standard TCP socket (either raw, or optionally TLS encrypted). After connecting and authenticating, POS events are simply encoded and sent as well-defined JSON objects — which this document describes. While it's preferable for the POS data be streamed in real-time, the API may also be used to feed delayed or archival POS data as well, assuming the requirements defined below are met.
Terms / Definitions
Event - A specific function or action occurring on a POS terminal. Events are most often initiated by an employee, but may be triggered by the terminal or POS system itself. (e.g. starting a new check, accepting a cash tender, cash drawer opening, employee signing on, etc.)
Check - A logical grouping of events that are associated, most often, with servicing a customer purchase. (a.k.a. ticket, tab, transaction, etc) Such events all share a common "check number" that links them.
Revenue Center - Denotes a logical business group where the terminal(s) are located. This could be a specific business/company, department, or some other logical grouping.
Requirements
POSConnect is designed to match POS event data to video surveillance footage to aid with loss prevention and provide analytic analysis. As such, in order for a new POS data source to be successfully integrated, there are three essential requirements:
Timekeeping - The POS system must be able to meet one of the following:
Be able to stream POS event data in real-time to the eConnect server. (preferred)
- OR -
Provide accurate (NTP synced) timestamp information for the individual POS events that's accurate to at least seconds.
Identification - The POS system must be able supply information on the specific revenue center, terminal, and employee associated with each POS event (as relevant).
Event Information - The POS system should be able to provide event data that is useful for loss prevention. This goes beyond what is typically printed on a customer receipt, to include POS events such as voids, no sales, re-printing checks, cash drawer opening/closing, etc.
Data Formatting
This API uses standard JSON formatted messages that are prepended with an ASCII "start" character (STX - ASCII 0x02) and appended with an ASCII "end" character (ETX - ASCII 0x03), to delimit each message. In pseudo-code this would look like:
[STX]{JSON Message}[ETX][STX]{JSON Message}[ETX]...
Any replies from the eConnect server will also follow this same data format.
Connecting
All communication with the eConnect server is handled via TCP socket, on one of two ports:
- TCP / 6499 - For raw, un-encrypted TCP communications
- TCPS / 6500 - For TLS encrypted TCP communications, a.k.a. TCPS (preferred)
Note: While the API offers a raw un-encrypted communication port, that should only be considered in situations where the eConnect server is local to the POS environment. eConnect cloud hosted servers/services only offer encrypted API access. As such, it's recommended to utilize the TLS encrypted port running on TCP/6500 for maximum flexibility and security.
Authentication
After establishing a TCP or TCPS connection to the eConnect server, the client must authenticate by sending a JSON formatted "authentication" object as described here. Both of the required authentication properties (pluginId and authId) are generated/supplied by eConnect and will be unique to each installation. Therefore your integration should treat these two properties as installation/usage specific configuration.
After receiving the initial authentication object, the eConnect server will respond with a JSON formatted response of either:
{ "status": "ok",
"message": "Authentication accepted" }
To confirm access, or...
{ "status": "error",
"message": "Authentication failed" }
to indicate the credentials supplied are invalid.
Data Flow & Response
After successfully authenticating, a client may immediately begin to stream JSON formatted POS event data as described by this document. The client should also maintain the TCP connection to send data as required — and avoid unnecessary connection cycling. The use of TCP keepalive packets or KeepAlive events on the connection is also recommended.
If the client adds the optional unique "responseId" property to any POS event, the server will respond with success or failure feedback after validating the event. If the "responseId" property is omitted, then the server will not supply any feedback or response. Note that all server feedback is handled asynchronously, and uniqueness of the "responseId" supplied is the responsibility of the client.
Timestamps
If a client sends POS data in real-time (recommended), then the optional "eventTime" property is not necessary. If "eventTime" is omitted, the event data is assumed to be real-time and the NTP synchronized eConnect server will timestamp each event as it arrives. As such, in the case of delayed or archival data, the "eventTime" property must be supplied and have originated from an NTP synchronized source when the event actually occurred.
Configuration Events
All POS events require unique numeric IDs to be supplied for the revenue center, terminal, and (generally) employee associated with the event. In order to provide users with more friendly display names for these entities, three "Configuration Events" are provided.
In general, clients should use these Configuration Events during "first-run" to populate initial display name data on the eConnect server. After that, the events should be used for any additions or modifications — to keep the eConnect server updated. While the eConnect server maintains and uses the last display name given for each entity, there is no penalty for re-supplying the information occasionally to make sure everything stays in sync.
Check Event Flow
Most POS event data is centered around customer transactions, where a check is typically created or recalled, associated detail events are applied, then the check is ultimately closed, voided/canceled, or saved for later recall. In order for the eConnect server to best interpret such data flow, it's recommended to first supply an originating "Check Action Event" of some kind prior to any associated "Check Detail Events" for a given check, and ultimately supply a "Check Termination Event" at some point to provide a conclusion for the check.
Thus the overall event flow for a simple check may look like:
- Check Action Event (NewCheck)
- Check Detail Event (ItemAdd)
- Check Detail Event (SubTotal)
- Check Detail Event (TaxDue)
- Check Detail Event (TotalDue)
- Check Detail Event (TenderApply)
- Check Detail Event (ChangeDue)
- Check Termination Event (CloseCheck)
You'll find descriptions of the event types within each of these categories (and others) described later in this document.
POS Event Priorities
For a successful POS integration, some event types (documented below) are required, while others are highly recommended, or nice to have. Please refer to the following document when prioritizing what event types are included in your stream:
Getting Started & Testing
To assist with development and testing of new POS data integrations using this API, eConnect has a public API testing server with a Web-based feedback interface. Once an integration is ready for final testing, eConnect will arrange for testing and certification on an actual, live eConnect server.
POS Event Types
This API currently has 71 POS event types defined within 7 categories. If the system you're integrating has additional useful events beyond what's already defined, please contact us to discuss options for inclusion.
Configuration Events
The following Configuration Events supply display name configuration information to the eConnect server:
| RevCenterName |
Provides display name information for a given revenue center. Should be supplied for all revenue centers during "first-run" to populate the eConnect server, then used for any additions or modifications to keep revenue center names on the eConnect server updated. |
| TerminalName |
Provides display name information for a given terminal. Should be supplied for all terminals during "first-run" to populate the eConnect server, then used for any additions or modifications to keep terminal names on the eConnect server updated. |
| EmployeeName |
Provide display name information for a given employee. Should be supplied for all employees during "first-run" to populate the eConnect server, then used for any additions or modifications to keep employee names on the eConnect server updated. |
Check Action Events
The following events create, modify, or perform other actions related to checks:
| NewCheck |
Indicates the creation of a new check. This event should come before any associated Check Detail Events. |
| SaveCheck |
Indicates when an active check is saved for later recall with RecallCheck. |
| RecallCheck |
Indicates when a previously saved check is recalled for additional processing. |
| SplitCheck |
Indicates when a single check is split into multiple checks. The source check is not closed, and it is recommended to subsequently move items to their appropriate check(s) using TransferItem. |
| CombineChecks |
Indicates when two or more checks are combined into a single check. The checks may be merged into a new or existing check number. Only the resultant check is left open. |
| ReleaseCheck |
Indicates that an employee has released a check, making it available for another employee to subsequently accept. |
| AcceptCheck |
Indicates when an employee accepts a previously released check. |
| TransferCheck |
Indicates when an employee transfers a check directly to another employee. |
| TransferItem |
Indicates when an item is transferred from one check to another. Recommended after SplitCheck and CombineChecks events. |
| ReopenCheck |
Indicates when a previously closed check is re-opened for additional Check Detail Events. |
| ReprintCheck |
Indicates that a check has been re-printed. |
Check Detail Events
The following events provide transaction details for a given check:
| ItemAdd |
Describes an item/product/service added to a check. |
| ItemOption |
Describes options or up-charges for a previously added item on a check. |
| ItemNote |
Indicates a manually entered special message pertaining to a previously added item. |
| ItemCancel |
Describes when an item is removed/cancelled on a check before subtotal. |
| ItemVoid |
Describes when an item is voided from a check after subtotal. |
| DiscountApply |
Describes when a discount or promotion is applied to a check. |
| DiscountCancel |
Describes when a discount or promotion is removed/cancelled on a check before subtotal. |
| DiscountVoid |
Describes when a discount or promotion is voided from a check after subtotal. |
| ReturnAdd |
Describes when a previously purchased item is returned. |
| ReturnCancel |
Describes when a return item is removed/cancelled on a check before subtotal. |
| ReturnVoid |
Describes when a return item is voided from a check after subtotal. |
| TipAdd |
Describes when a tip or gratuity is added to a check. |
| TipVoid |
Describes when a tip or gratuity is voided from a check. |
| FeeAdd |
Describes when a fee is added to a check. |
| FeeCancel |
Describes when a fee is removed/cancelled on a check before subtotal. |
| FeeVoid |
Describes when a fee is voided from a check after subtotal. |
| SubTotal |
Describes the current running total for a check. |
| TaxDue |
Describes the total amount of taxes due for a check. |
| TotalDue |
Describes the total amount due for a check, including taxes. |
| TenderApply |
Describes when a payment is tendered for a check. |
| TenderAuth |
Indicates when a tender authorization is processed. |
| TenderAdjust |
Describes when a tendered amount is adjusted, such as when a credit card tip has been added after pre-authorization. |
| TenderVoid |
Describes when a previous tender/payment is voided on a check. |
| ChangeDue |
Describes the total change due the customer after a cash tender on a check. |
| CompIssue |
Describes when a comp voucher is issued to a customer. |
| CompRedeem |
Describes when a comp voucher is redeemed by a customer. |
| CustomerDetail |
Provides associated customer information for a check. |
| RoomDetail |
Provides associated room information for a check. |
Check Termination Events
The following events conclude activity for a currently open check:
| CloseCheck |
Indicates when a check is closed. Any subsequent activity for the check should be preceded by a ReopenCheck event. |
| CancelCheck |
Indicates when a check has been canceled before payment has been tendered. |
| VoidCheck |
Indicates when a check has been voided after payment has been tendered. |
Employee Events
The following events are related to employee activity:
| ClockIn |
Indicates when an employee clocks in for their shift. |
| ClockOut |
Indicates when an employee clocks out of their shift. |
| SignIn |
Indicates when an employee signs in to a given terminal. |
| SignOut |
Indicates when an employee signs out of a given terminal. |
| EmployeeStatus |
Indicates when mid-shift employee performance information is requested. |
| EmployeeReport |
Indicates when an employee related report is requested. |
Terminal Events
The following events are related to POS terminal activity:
| NoSale |
Indicates a "no sale" event has been issued, where the cash drawer will be opened for a reason other than change due on a check. |
| CashIn |
Indicates when cash is added to the drawer for non check/transaction purposes. (e.g. for making change, re-payment for bad check, etc.) |
| CashOut |
Indicates when cash is removed from the drawer for non check/transaction purposes. (e.g. too much cash in drawer, payment for delivery, etc.) |
| DrawerOpen |
Indicates when the cash drawer has been opened. |
| DrawerClose |
Indicates when the cash drawer has been closed. |
| RevCenterChange |
Indicates when a terminal is instructed to use a different revenue center. |
| TerminalUp |
Indicates when a terminal has booted and is operational. |
| TerminalDown |
Indicates when a terminal has been shutdown. |
| DataLinkUp |
Indicates when a terminal has come online on the network. |
| DataLinkDown |
Indicates when a terminal has gone offline on the network. |
| EmployeeError |
Indicates when an error is caused by the employee operating a terminal. |
| SoftwareError |
Indicates when an unexpected software error has occurred on the terminal. |
| HardwareError |
Indicates when a hardware error has occurred on the terminal. |
System Events
The following are general POS system events:
| OverrideRequest |
Indicates a request to gain approval for a protected action. |
| OverrideResponse |
Indicates the system response to an override request for a protected action. |
| ManagerProcedure |
Indicates when a management level employee performs an administrative action. |
| ReportGenerated |
Indicates that a report has been generated. |
| EndOfDay |
Indicates the processing of end-of-day procedures. |
AuthenticateThe initial authentication message to be sent after connecting. Both of the properties required will be site / install specific and supplied by eConnect. |
Example:{
"pluginId": "9b19f91d-9122-4e72-b641-6bd8b7e1cfd6",
"authId": "b3a69ca8-bad4-4b1b-9c0f-55d053de55c8"
}
|
Required Properties:
| Property | Description | Restrictions | ||||
|---|---|---|---|---|---|---|
|
pluginId string |
The eConnect POS plugin instance ID that will be receiving the data. This ID is created during configuration of the eConnect server and will be supplied as site configuration for your system.
|
|
||||
|
authId string |
The authentication ID for this POS plugin instance. This ID is created during configuration of the eConnect server and will be supplied as site configuration for your system.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
apiVersion string |
The version of POS API to utilize. If not supplied, the latest version is assumed. Unless otherwise advised, it's best to omit this property.
|
|
KeepAliveAn optional keepalive event that can be sent periodically or during inactivity, to ensure the TCP connection remains open. |
Example:{
"eventType": "keepalive"
}
|
Required Properties:
| Property | Description | Restrictions | ||||
|---|---|---|---|---|---|---|
|
eventType string |
The type of event being sent. In this case a KeepAlive event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
RevCenterNameProvides display name information for a given revenue center. Should be supplied for all revenue centers during "first-run" to populate the eConnect server, then used for any additions or modifications to keep revenue center names on the eConnect server updated. |
Example:{
"eventType": "revcentername",
"revCenterNum": 248,
"revCenterName": "Cinnabon (C Gate)"
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a RevCenterName event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
revCenterName string |
Display name for the revCenterNum supplied.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
TerminalNameProvides display name information for a given terminal. Should be supplied for all terminals during "first-run" to populate the eConnect server, then used for any additions or modifications to keep terminal names on the eConnect server updated. |
Example:{
"eventType": "terminalname",
"terminalNum": 1132,
"terminalName": "Rental Returns"
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a TerminalName event.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
terminalName string |
Display name for the terminalNum supplied.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
EmployeeNameProvide display name information for a given employee. Should be supplied for all employees during "first-run" to populate the eConnect server, then used for any additions or modifications to keep employee names on the eConnect server updated. |
Example:{
"eventType": "employeename",
"employeeNum": 634277,
"employeeName": "Amanda Wolf"
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an EmployeeName event.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
employeeName string |
Display name for the employeeNum supplied.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
NewCheckIndicates the creation of a new check. This event should come before any associated Check Detail Events. |
Example:{
"eventType": "newcheck",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a NewCheck event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
SaveCheckIndicates when an active check is saved for later recall with RecallCheck. |
Example:{
"eventType": "savecheck",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a SaveCheck event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
RecallCheckIndicates when a previously saved check is recalled for additional processing. |
Example:{
"eventType": "recallcheck",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a RecallCheck event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
SplitCheckIndicates when a single check is split into multiple checks. The source check is not closed, and it is recommended to subsequently move items to their appropriate check(s) using TransferItem. |
Example:{
"eventType": "splitcheck",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"sourceCheckNum": 237712,
"splitCheckNums": [
237712,
237713
]
}
|
Required Properties:
| Property | Description | Restrictions | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a SplitCheck event.
|
|
||||||||||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||||||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||||||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||||||||||
|
sourceCheckNum integer |
Positive integer ID identifying the source check/transaction number that is being split.
|
|
||||||||||||||
|
splitCheckNums array |
An array of new check number(s) that items will be transferred into from the source check.
|
|
||||||||||||||
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
CombineChecksIndicates when two or more checks are combined into a single check. The checks may be merged into a new or existing check number. Only the resultant check is left open. |
Example:{
"eventType": "combinechecks",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"sourceCheckNums": [
237712,
39233
],
"combinedCheckNum": 237712
}
|
Required Properties:
| Property | Description | Restrictions | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a CombineChecks event.
|
|
||||||||||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||||||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||||||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||||||||||
|
sourceCheckNums array |
An array of source check number(s) that items will be transferred from.
|
|
||||||||||||||
|
combinedCheckNum integer |
Positive integer ID identifying the check/transaction number that items will be transferred to.
|
|
||||||||||||||
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
ReleaseCheckIndicates that an employee has released a check, making it available for another employee to subsequently accept. |
Example:{
"eventType": "releasecheck",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a ReleaseCheck event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
releaseReason string |
Optional reason for the employee releasing the check.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
AcceptCheckIndicates when an employee accepts a previously released check. |
Example:{
"eventType": "acceptcheck",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a AcceptCheck event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
TransferCheckIndicates when an employee transfers a check directly to another employee. |
Example:{
"eventType": "transfercheck",
"revCenterNum": 248,
"terminalNum": 1132,
"checkNum": 237712,
"fromEmployee": 634277,
"toEmployee": 342244
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an TransferCheck event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
fromEmployee integer |
Positive integer ID that uniquely identifies the employee that the check is being transferred from.
|
|
||||||
|
toEmployee integer |
Positive integer ID that uniquely identifies the employee that the check is being transferred to.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
transferReason string |
Optional reason for the employee transferring the check.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
TransferItemIndicates when an item is transferred from one check to another. Recommended after SplitCheck and CombineChecks events. |
Example:{
"eventType": "transferitem",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"fromCheckNum": 237712,
"toCheckNum": 453553,
"itemId": "049000608779",
"itemName": "Classic Coke 12oz",
"qty": 2,
"amount": 11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an TransferItem event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
fromCheckNum integer |
Positive integer ID identifying the check/transaction number this event is transferring the item from.
|
|
||||||
|
toCheckNum integer |
Positive integer ID identifying the check/transaction number this event is transferring the item to.
|
|
||||||
|
itemId string |
Unique ID identifying the item associated with this event. (e.g. POS product ID (preferred), UPC code, etc)
|
|
||||||
|
itemName string |
The display name used for the item associated with this event.
|
|
||||||
|
qty integer |
Positive integer quantity of the item involved with this event.
|
|
||||||
|
amount number |
Total positive monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
qtyUnit string |
Quantity unit of measure used in conjunction with the quantity of the item involved with this event.
|
|
||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
ReopenCheckIndicates when a previously closed check is re-opened for additional Check Detail Events. |
Example:{
"eventType": "reopencheck",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a ReopenCheck event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
ReprintCheckIndicates that a check has been re-printed. |
Example:{
"eventType": "reprintcheck",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an ReprintCheck event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
ItemAddDescribes an item/product/service added to a check. |
Example:{
"eventType": "itemadd",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"itemId": "049000608779",
"itemName": "Classic Coke 12oz",
"qty": 2,
"amount": 11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a ItemAdd event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
itemId string |
Unique ID identifying the item associated with this event. (e.g. POS product ID (preferred), UPC code, etc)
|
|
||||||
|
itemName string |
The display name used for the item associated with this event.
|
|
||||||
|
qty integer |
Positive integer quantity of the item involved with this event.
|
|
||||||
|
amount number |
Total positive monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
qtyUnit string |
Quantity unit of measure used in conjunction with the quantity of the item involved with this event.
|
|
||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
ItemOptionDescribes options or up-charges for a previously added item on a check. |
Example:{
"eventType": "itemoption",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"optionName": "No Cheese"
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a ItemOption event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
optionName string |
The display name for the option supplied.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
optionId string |
Unique ID identifying the option supplied with this event. (e.g. System option ID (preferred), etc)
|
|
||||||||
|
itemId string |
Unique ID identifying the previously added item associated with this event. (e.g. POS product ID (preferred), UPC code, etc)
|
|
||||||||
|
qty integer |
Integer quantity of the item involved with this event.
|
|
||||||||
|
qtyUnit string |
Quantity unit of measure used in conjunction with the quantity of the item involved with this event.
|
|
||||||||
|
amount number |
Total monetary amount associated with this event.
|
|
||||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
ItemNoteIndicates a manually entered special message pertaining to a previously added item. |
Example:{
"eventType": "itemnote",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"note": "Bacon extra crisp"
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an ItemNote event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
note string |
The manually entered special message pertaining to a previously added item.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
itemId string |
Unique ID identifying the previously added item associated with this event. (e.g. System product ID (preferred), UPC code, etc)
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
ItemCancelDescribes when an item is removed/cancelled on a check before subtotal. |
Example:{
"eventType": "itemcancel",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"itemId": "049000608779",
"itemName": "Classic Coke 12oz",
"qty": -2,
"amount": -11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a ItemCancel event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
itemId string |
Unique ID identifying the item associated with this event. (e.g. POS product ID (preferred), UPC code, etc)
|
|
||||||
|
itemName string |
The display name used for the item associated with this event.
|
|
||||||
|
qty integer |
Negative integer quantity of the item involved with this event.
|
|
||||||
|
amount number |
Total negative monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
qtyUnit string |
Quantity unit of measure used in conjunction with the quantity of the item involved with this event.
|
|
||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
ItemVoidDescribes when an item is voided from a check after subtotal. |
Example:{
"eventType": "itemvoid",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"itemId": "049000608779",
"itemName": "Classic Coke 12oz",
"qty": -2,
"amount": -11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a ItemVoid event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
itemId string |
Unique ID identifying the item associated with this event. (e.g. POS product ID (preferred), UPC code, etc)
|
|
||||||
|
itemName string |
The display name used for the item associated with this event.
|
|
||||||
|
qty integer |
Negative integer quantity of the item involved with this event.
|
|
||||||
|
amount number |
Total negative monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
qtyUnit string |
Quantity unit of measure used in conjunction with the quantity of the item involved with this event.
|
|
||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
DiscountApplyDescribes when a discount or promotion is applied to a check. |
Example:{
"eventType": "discountapply",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"discountName": "Senior Discount",
"amount": -11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a DiscountApply event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
discountName string |
The display name used for the discount associated with this event.
|
|
||||||
|
amount number |
Total negative monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
discountId string |
Unique ID identifying the discount associated with this event.
|
|
||||||||
|
qty integer |
Positive integer quantity of the discount involved with this event.
|
|
||||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
DiscountCancelDescribes when a discount or promotion is removed/cancelled on a check before subtotal. |
Example:{
"eventType": "discountcancel",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"discountName": "Senior Discount",
"amount": 11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a DiscountCancel event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
discountName string |
The display name used for the discount associated with this event.
|
|
||||||
|
amount number |
Total positive monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
discountId string |
Unique ID identifying the discount associated with this event.
|
|
||||||||
|
qty integer |
Negative integer quantity of the discount involved with this event.
|
|
||||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
DiscountVoidDescribes when a discount or promotion is voided from a check after subtotal. |
Example:{
"eventType": "discountvoid",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"discountName": "Senior Discount",
"amount": 11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a DiscountVoid event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
discountName string |
The display name used for the discount associated with this event.
|
|
||||||
|
amount number |
Total positive monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
discountId string |
Unique ID identifying the discount associated with this event.
|
|
||||||||
|
qty integer |
Negative integer quantity of the discount involved with this event.
|
|
||||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
ReturnAddDescribes when a previously purchased item is returned. |
Example:{
"eventType": "returnadd",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"itemId": "049000608779",
"itemName": "Classic Coke 12oz",
"qty": -2,
"amount": -11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a ReturnAdd event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
itemId string |
Unique ID identifying the item associated with this event. (e.g. POS product ID (preferred), UPC code, etc)
|
|
||||||
|
itemName string |
The display name used for the item associated with this event.
|
|
||||||
|
qty integer |
Negative integer quantity of the item involved with this event.
|
|
||||||
|
amount number |
Total negative monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
qtyUnit string |
Quantity unit of measure used in conjunction with the quantity of the item involved with this event.
|
|
||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
ReturnCancelDescribes when a return item is removed/cancelled on a check before subtotal. |
Example:{
"eventType": "returncancel",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"itemId": "049000608779",
"itemName": "Classic Coke 12oz",
"qty": 2,
"amount": 11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a ReturnCancel event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
itemId string |
Unique ID identifying the item associated with this event. (e.g. POS product ID (preferred), UPC code, etc)
|
|
||||||
|
itemName string |
The display name used for the item associated with this event.
|
|
||||||
|
qty integer |
Positive integer quantity of the item involved with this event.
|
|
||||||
|
amount number |
Total positive monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
qtyUnit string |
Quantity unit of measure used in conjunction with the quantity of the item involved with this event.
|
|
||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
ReturnVoidDescribes when a return item is voided from a check after subtotal. |
Example:{
"eventType": "returnvoid",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"itemId": "049000608779",
"itemName": "Classic Coke 12oz",
"qty": 2,
"amount": 11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a returnVoid event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
itemId string |
Unique ID identifying the item associated with this event. (e.g. POS product ID (preferred), UPC code, etc)
|
|
||||||
|
itemName string |
The display name used for the item associated with this event.
|
|
||||||
|
qty integer |
Positive integer quantity of the item involved with this event.
|
|
||||||
|
amount number |
Total positive monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
qtyUnit string |
Quantity unit of measure used in conjunction with the quantity of the item involved with this event.
|
|
||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
TipAddDescribes when a tip or gratuity is added to a check. |
Example:{
"eventType": "tipadd",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"amount": 11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a TipAdd event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
amount number |
Total positive monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
autoTipDesc string |
Optional description for automatic / required gratuities.
|
|
||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
TipVoidDescribes when a tip or gratuity is voided from a check. |
Example:{
"eventType": "tipvoid",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"amount": -11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a TipVoid event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
amount number |
Total negative monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
autoTipDesc string |
Optional description for automatic / required gratuities.
|
|
||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
FeeAddDescribes when a fee is added to a check. |
Example:{
"eventType": "feeadd",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"feeName": "Dining surcharge",
"amount": 11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a FeeAdd event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
feeName string |
The display name used for the fee associated with this event.
|
|
||||||
|
amount number |
Total positive monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
feeId string |
Unique ID identifying the fee associated with this event.
|
|
||||||||
|
qty integer |
Positive integer quantity of the fee involved with this event.
|
|
||||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
FeeCancelDescribes when a fee is removed/cancelled on a check before subtotal. |
Example:{
"eventType": "feecancel",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"feeName": "Dining surcharge",
"amount": -11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a FeeCancel event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
feeName string |
The display name used for the fee associated with this event.
|
|
||||||
|
amount number |
Total negative monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
feeId string |
Unique ID identifying the fee associated with this event.
|
|
||||||||
|
qty integer |
Negative integer quantity of the fee involved with this event.
|
|
||||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
FeeVoidDescribes when a fee is voided from a check after subtotal. |
Example:{
"eventType": "feevoid",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"feeName": "Dining surcharge",
"amount": -11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a FeeVoid event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
feeName string |
The display name used for the fee associated with this event.
|
|
||||||
|
amount number |
Total negative monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
feeId string |
Unique ID identifying the fee associated with this event.
|
|
||||||||
|
qty integer |
Negative integer quantity of the fee involved with this event.
|
|
||||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
SubTotalDescribes the current running total for a check. |
Example:{
"eventType": "subtotal",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"amount": 11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a SubTotal event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
amount number |
Total monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
TaxDueDescribes the total amount of taxes due for a check. |
Example:{
"eventType": "taxdue",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"taxName": "NV Sales Tax",
"amount": 11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a TaxDue event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
taxName string |
The display name used for the tax associated with this event.
|
|
||||||
|
amount number |
Total monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
taxId string |
Unique ID identifying the tax associated with this event.
|
|
||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
TotalDueDescribes the total amount due for a check, including taxes. |
Example:{
"eventType": "totaldue",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"amount": 11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a TotalDue event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
amount number |
Total monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
TenderApplyDescribes when a payment is tendered for a check. |
Example:{
"eventType": "tenderapply",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"tenderTypeNum": 3,
"tenderTypeName": "Visa",
"amount": 11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a TenderApply event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
tenderTypeNum integer |
Positive integer ID that uniquely identifies the tender type.
|
|
||||||
|
tenderTypeName string |
The display name used for the tender type associated with this event.
|
|
||||||
|
amount number |
Total monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
tenderInfo string |
Additional information related to the tender.
|
|
||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
TenderAuthIndicates when a tender authorization is processed. |
Example:{
"eventType": "tenderauth",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"tenderTypeNum": 3,
"tenderTypeName": "Visa",
"authTypeName": "Authorize.net"
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an TenderAuth event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
tenderTypeNum integer |
Positive integer ID that uniquely identifies the tender type.
|
|
||||||
|
tenderTypeName string |
The display name used for the tender type associated with this event.
|
|
||||||
|
authTypeName string |
The display name used for the tender authorization type associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
authCode string |
Unique ID resulting from the authorization request.
|
|
||||||
|
amount number |
Total monetary amount associated with this event.
|
|
||||||
|
tenderInfo string |
Additional information related to the tender.
|
|
||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
TenderAdjustDescribes when a tendered amount is adjusted, such as when a credit card tip has been added after pre-authorization. |
Example:{
"eventType": "tenderadjust",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"tenderTypeNum": 3,
"tenderTypeName": "Visa",
"amount": 11.95,
"amountAdjusted": 11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a TenderAdjust event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
tenderTypeNum integer |
Positive integer ID that uniquely identifies the tender type.
|
|
||||||
|
tenderTypeName string |
The display name used for the tender type associated with this event.
|
|
||||||
|
amount number |
The new total amount tendered after adjustment.
|
|
||||||
|
amountAdjusted number |
Monetary difference the tender amount was adjusted by.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
tenderInfo string |
Additional information related to the tender.
|
|
||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
TenderVoidDescribes when a previous tender/payment is voided on a check. |
Example:{
"eventType": "tendervoid",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"tenderTypeNum": 3,
"tenderTypeName": "Visa",
"amount": 11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a TenderVoid event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
tenderTypeNum integer |
Positive integer ID that uniquely identifies the tender type.
|
|
||||||
|
tenderTypeName string |
The display name used for the tender type associated with this event.
|
|
||||||
|
amount number |
Total monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
tenderInfo string |
Additional information related to the tender.
|
|
||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
ChangeDueDescribes the total change due the customer after a cash tender on a check. |
Example:{
"eventType": "changedue",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"amount": 11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a ChangeDue event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
amount number |
Total positive monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
CompIssueDescribes when a comp voucher is issued to a customer. |
Example:{
"eventType": "compissue",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"compName": "Player comp"
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a CompIssue event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
compName string |
The display name used for the comp type associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
trackingId string |
Unique ID identifying the comp voucher associated with this event.
|
|
||||||||
|
custInfo string |
Information related to the customer who was issued the comp.
|
|
||||||||
|
amount number |
Total positive monetary amount associated with this event.
|
|
||||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
CompRedeemDescribes when a comp voucher is redeemed by a customer. |
Example:{
"eventType": "compredeem",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"compName": "Player comp"
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a CompRedeem event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
compName string |
The display name used for the comp type associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
trackingId string |
Unique ID identifying the comp voucher associated with this event.
|
|
||||||||
|
custInfo string |
Information related to the customer who was issued the comp.
|
|
||||||||
|
amount number |
Total positive monetary amount associated with this event.
|
|
||||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
CustomerDetailProvides associated customer information for a check. |
Example:{
"eventType": "customerdetail",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"custInfo": "Doe, John"
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a CustomerDetail event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
custInfo string |
Information related to the customer account.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
custId string |
Unique ID identifying the customer account.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
RoomDetailProvides associated room information for a check. |
Example:{
"eventType": "roomdetail",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712,
"roomId": "835"
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a RoomDetail event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
roomId string |
Unique ID identifying the room.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
CloseCheckIndicates when a check is closed. Any subsequent activity for the check should be preceded by a ReopenCheck event. |
Example:{
"eventType": "closecheck",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a CloseCheck event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
CancelCheckIndicates when a check has been canceled before payment has been tendered. |
Example:{
"eventType": "cancelcheck",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an CancelCheck event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
VoidCheckIndicates when a check has been voided after payment has been tendered. |
Example:{
"eventType": "voidcheck",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"checkNum": 237712
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case a VoidCheck event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
ClockInIndicates when an employee clocks in for their shift. |
Example:{
"eventType": "clockin",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an ClockIn event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
ClockOutIndicates when an employee clocks out of their shift. |
Example:{
"eventType": "clockout",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an ClockOut event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
SignInIndicates when an employee signs in to a given terminal. |
Example:{
"eventType": "signin",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an SignIn event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
SignOutIndicates when an employee signs out of a given terminal. |
Example:{
"eventType": "signout",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an SignOut event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
EmployeeStatusIndicates when mid-shift employee performance information is requested. |
Example:{
"eventType": "employeestatus",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an EmployeeStatus event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
authEmployeeNum integer |
Positive integer uniquely identifying the employee who ran this status request.
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
EmployeeReportIndicates when an employee related report is requested. |
Example:{
"eventType": "employeereport",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an EmployeeReport event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
reportName string |
The display name used for the employee report associated with this event.
|
|
||||||||
|
authEmployeeNum integer |
Positive integer uniquely identifying the employee who ran this report event.
|
|
||||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
NoSaleIndicates a "no sale" event has been issued, where the cash drawer will be opened for a reason other than change due on a check. |
Example:{
"eventType": "nosale",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an NoSale event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
CashInIndicates when cash is added to the drawer for non check/transaction purposes. (e.g. for making change, re-payment for bad check, etc.) |
Example:{
"eventType": "cashin",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"amount": 11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an CashIn event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
amount number |
Total positive monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
purposeDesc string |
A description of the purpose for this CashIn event.
|
|
||||||
|
purposeId string |
Unique ID identifying the purpose for this CashIn event.
|
|
||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
CashOutIndicates when cash is removed from the drawer for non check/transaction purposes. (e.g. too much cash in drawer, payment for delivery, etc.) |
Example:{
"eventType": "cashout",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"amount": -11.95
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an CashOut event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
amount number |
Total negative monetary amount associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
purposeDesc string |
A description of the purpose for this event.
|
|
||||||
|
purposeId string |
Unique ID identifying the purpose for this event.
|
|
||||||
|
currency string |
ISO 4217 currency abbreviation identifying the currency involved with this event.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
DrawerOpenIndicates when the cash drawer has been opened. |
Example:{
"eventType": "draweropen",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an DrawerOpen event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
DrawerCloseIndicates when the cash drawer has been closed. |
Example:{
"eventType": "drawerclose",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an DrawerClose event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
RevCenterChangeIndicates when a terminal is instructed to use a different revenue center. |
Example:{
"eventType": "revcenterchange",
"prevRevCenter": 248,
"newRevCenter": 434,
"terminalNum": 1132,
"employeeNum": 634277
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an RevCenterChange event.
|
|
||||||
|
prevRevCenter integer |
Positive integer ID that uniquely identifies the previous revenue center the terminal was using.
|
|
||||||
|
newRevCenter integer |
Positive integer ID that uniquely identifies the new revenue center the terminal switched to.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
TerminalUpIndicates when a terminal has booted and is operational. |
Example:{
"eventType": "terminalup",
"revCenterNum": 248,
"terminalNum": 1132
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an TerminalUp event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
TerminalDownIndicates when a terminal has been shutdown. |
Example:{
"eventType": "terminaldown",
"revCenterNum": 248,
"terminalNum": 1132
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an TerminalDown event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
DataLinkUpIndicates when a terminal has come online on the network. |
Example:{
"eventType": "datalinkup",
"revCenterNum": 248,
"terminalNum": 1132
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an DataLinkUp event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
DataLinkDownIndicates when a terminal has gone offline on the network. |
Example:{
"eventType": "datalinkdown",
"revCenterNum": 248,
"terminalNum": 1132
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an DataLinkDown event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
EmployeeErrorIndicates when an error is caused by the employee operating a terminal. |
Example:{
"eventType": "employeeerror",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"errorMessage": "SKU not found"
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an EmployeeError event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
errorMessage string |
The error message text associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
errorId string |
Unique ID identifying the error associated with this event.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
SoftwareErrorIndicates when an unexpected software error has occurred on the terminal. |
Example:{
"eventType": "softwareerror",
"revCenterNum": 248,
"terminalNum": 1132,
"errorMessage": "Internal Error: Out of Memory"
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an SoftwareError event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
errorMessage string |
Error message text.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
errorId string |
Unique ID identifying the error associated with this event.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
HardwareErrorIndicates when a hardware error has occurred on the terminal. |
Example:{
"eventType": "hardwareerror",
"revCenterNum": 248,
"terminalNum": 1132,
"errorMessage": "Drive Error"
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an HardwareError event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
errorMessage string |
Error message text.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
errorId string |
Unique ID identifying the error associated with this event.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
OverrideRequestIndicates a request to gain approval for a protected action. |
Example:{
"eventType": "overriderequest",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"authEmployeeNum": 938234
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an OverrideRequest event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
authEmployeeNum integer |
Positive integer uniquely identifying the employee who authorized this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
overrideDesc string |
Text that describes the override requested.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
OverrideResponseIndicates the system response to an override request for a protected action. |
Example:{
"eventType": "overrideresponse",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"response": "accepted"
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an OverrideResponse event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
response string |
The result of the override request made.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
responseMessage string |
Additional text pertaining to the override result.
|
|
||||||
|
authEmployeeNum integer |
Positive integer uniquely identifying the employee who authorized this event.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
ManagerProcedureIndicates when a management level employee performs an administrative action. |
Example:{
"eventType": "managerprocedure",
"revCenterNum": 248,
"terminalNum": 1132,
"employeeNum": 634277,
"procedureDesc": "Pay-Out/In"
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an ManagerProcedure event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
procedureDesc string |
A description of the administrative procedure associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
procedureId string |
Unique ID identifying the administrative procedure associated with this event.
|
|
||||||
|
checkNum integer |
Positive integer ID identifying the check/transaction number this event is associated with. Check numbers are assumed to be unique per revenue center within 24 hours.
|
|
||||||
|
tableNum integer |
Positive integer ID that uniquely identifies the dining table that this event is related to.
|
|
||||||
|
groupNum integer |
Positive integer ID that uniquely identifies the customer group at a given dining table. (e.g. Separate checks)
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
ReportGeneratedIndicates that a report has been generated. |
Example:{
"eventType": "reportgenerated",
"reportName": "Pay-Out/In"
}
|
Required Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an ReportGenerated event.
|
|
||||||
|
reportName string |
The display name used for the report associated with this event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
reportId string |
Unique ID identifying the report associated with this event.
|
|
||||||
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|
EndOfDayIndicates the processing of end-of-day procedures. |
Example:{
"eventType": "endofday"
}
|
Required Properties:
| Property | Description | Restrictions | ||||
|---|---|---|---|---|---|---|
|
eventType string |
The type of POS event being sent. In this case an EndOfDay event.
|
|
Optional Properties:
| Property | Description | Restrictions | ||||||
|---|---|---|---|---|---|---|---|---|
|
revCenterNum integer |
Positive integer ID that uniquely identifies the revenue center associated.
|
|
||||||
|
terminalNum integer |
Positive integer ID that uniquely identifies the terminal associated.
|
|
||||||
|
employeeNum integer |
Positive integer ID that uniquely identifies the employee associated.
|
|
||||||
|
eventTime string |
RFC 3339 formatted date/time stamp when this event took place -- accurate to at least seconds. (UTC preferred)
|
|
||||||
|
responseId string |
Optional, unique response id for the event being sent. If supplied, the eConnect server will provide a JSON response confirming success or failure after reception.
|
|