Get guest checks
post
/bi/v1/{orgIdentifier}/getGuestChecks
Gets all guest checks for a specified location that were opened on a specified business date or for a specified business date and also after a specified calendar date and time. If the guest check is reopened, it will be included if the reopen closed check business date falls into the specified business or if it was closed after the specified calendar date and time. In order to get the closed guest checks, use the search criteria on the clsdGuestChecksOnly attribute. At least one of the opnbusDt or cldBusDt need to be provided in the guest checks API request.
Request
Path Parameters
-
orgIdentifier(required): string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : gstChkRequestPayload
Type:
objectRequest payload for guest checks
Show Source
-
applicationName:
string
Title:
Application NameMaximum Length:128The name of the application which is accessing the API.First Available Version: 20.1.10
-
busDt(required):
string(date)
Title:
Business DateIf present, the API will return the superset of all guest checks where Open Business Date or Closed Business Date match to the supplied date. This parameter cannot be present if clsdBusDt or opnbusDt are present.First Available Version: 20.1.10
-
changedSinceUTC:
string(date-time)
Title:
Changed Since Data Time UTCReport all guest check activity that has occurred since this UTC date and time for the specified business date.If this object is not included, return all guest check activity for the specified business date. -
clsdBusDt(required):
string(date)
Title:
Closed Business DateIf present, the API will return all guest checks which were closed or reopen closed on the supplied business date. This parameter cannot be present if opnBusDt or busDt are present -
clsdGuestChecksOnly:
boolean
Title:
Closed Guest Checks OnlyIndicator whether the response includes only closed guest checks -
include:
string
Title:
IncludeMaximum Length:2000List of objects to include in response -
locRef(required):
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
opnBusDt(required):
string(date)
Title:
Open Business DateIf present, the API will return the guest checks which were opened or reopened on the supplied business date. This parameter cannot be present if clsdBusDt or busDt are present -
rvcNum:
integer
Title:
Revenue center numberMaximum Length:10Revenue center number for which the checks are to be fetched.First Available Version: 20.1.9.7
-
searchCriteria:
string
Title:
Search CriteriaMaximum Length:2000Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : guestChecksResponse
Type:
objectThe response body contains information about the guest checks for the specified location and business date.
Show Source
-
curUTC(required):
string(date-time)
Title:
Current Date Time in UTCThe current UTC date and time when the request is made -
guestChecks:
array guestChecks
An array of guest checks
-
locRef(required):
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization
Nested Schema : guestChecks
Type:
arrayAn array of guest checks
Show Source
-
Array of:
object guestCheck
The response body contains information about the guest check for the specified location and business date.
Nested Schema : guestCheck
Type:
objectThe response body contains information about the guest check for the specified location and business date.
Show Source
-
addedIn(required):
integer
Title:
Numeric value indicating the number of checks that were added / transferred to this checkNumeric value indicating the number of checks that were added / transferred to this check. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.16
-
autoClsdFlag:
boolean
Title:
Flag indicating if the check was auto-closed after 7 days by SimphonyFlag indicating if the check was auto-closed after 7 days by Simphony. This field is dependent on feature availability in Simphony. This is optional. This attribute will not be returned in the response if value is false.First available version 20.2.
-
autoFireUTC:
string(date-time)
Title:
Auto fire date time of the checkThe date and time the guest check was or is going to be auto fired as a UTC time. This attribute will not be returned in the response if value is null.First Available Version: 20.1.12
-
autoSvcTtl(required):
number
Title:
Auto Service Charge TotalThe autogratuity or auto service charge total associated with the check. This is optional. The detail also appears in as a service charge line item. This attribute will not be returned in the response if value is 0 or null -
balDueTtl(required):
number
Title:
Balance Due TotalThe balance due associated with this guest check, chkTtl ??? payTtl. If the check is closed, this will be 0.00. -
cancelFlag(required):
boolean
Title:
Cancel FlagA flag indicating if the guest check is cancelled. If the check is not cancelled, this object is not present. This attribute will not be returned in the response if value is false or null.First Available Version: 20.1.8.2
-
chkInfo(required):
string
Title:
Check InformationMaximum Length:99Information associated with the guest check. This attribute will not be returned in the response if value is null -
chkName(required):
string
Title:
Check NameMaximum Length:99Unique identifier of the guest check associated with this transaction. This attribute will not be returned in the response if value is null -
chkNum(required):
integer
Title:
Check NumberMaximum Length:8Unique identifier of the guest check associated with this transaction -
chkRef(required):
string
Title:
Check ReferenceMaximum Length:99Reference information of the guest check. This attribute will not be returned in the response if value is null.First Available Version: 20.1.10
-
chkTtl(required):
number
Title:
Check TotalThe total value of this guest check without payments. -
clsdBusDt(required):
string(date)
Title:
Closed Business DateThe business date the guest check was closed. If the check is open, this object is not present. This attribute will not be returned in the response if value is null -
clsdFlag(required):
boolean
Title:
Closed FlagA flag indicating if the guest check is closed. If the check is open, this object is not present. This attribute will not be returned in the response if value is false or null. -
clsdLcl(required):
string(date-time)
Title:
Closed Business Date Time LocalThe date and time the guest check was closed in the location's timezone. If the check is open, this object is not present. This attribute will not be returned in the response if value is null.First Available Version: 20.1.9.6
-
clsdUTC(required):
string(date-time)
Title:
Closed Business Date Time UTCThe date and time the guest check was closed as a UTC time. If the check is open, this object is not present. This attribute will not be returned in the response if value is null. -
detailLines(required):
array detailLines
Array of guest check detail line JSON objects. Each detail line contains information about a specific menu item, discount, service charge or tender/media. Detail lines are presented in sequence.
-
dscTtl(required):
number
Title:
Discount TotalThe total value of discounts on this guest check. -
empNum(required):
integer
Title:
Employee NumberMaximum Length:16The number of the employee responsible for this guest check -
errorCorrectTtl(required):
number
Title:
Amount of error corrected items on this checkAmount of error corrected items on this check. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.16
-
gstCnt(required):
integer
Title:
Guest CountThe guest count associated with thus guest check. This is optional. This attribute will not be returned in the response if value is 0 or null. -
guestCheckId(required):
integer
Title:
Guest Check IDMaximum Length:16Unique Identifier of the guest check -
inclTaxExmpTtl(required):
integer
Title:
Amount of inclusive (non-VAT) taxes exemptedAmount of inclusive (non-VAT) taxes exempted. Requires POS client version to be 19.8 or higher. This attribute will not be returned in the response if value is 0 or null.First available version 20.1.18
-
lastTransLcl(required):
string(date-time)
Title:
Last Updated Date Time LocalThe date and time of the last transaction update to the guest check in the location's timezone.First Available Version: 20.1.12
-
lastTransUTC(required):
string(date-time)
Title:
Last Updated Date Time UTCThe date and time of the last transaction update to the guest check as a UTC time.First Available Version: 20.1.12
-
lastUpdatedLcl(required):
string(date-time)
Title:
Last Updated Date Time LocalThe date and time the guest check was last updated in the cloud in the location's timezone.First Available Version: 20.1.12
-
lastUpdatedUTC(required):
string(date-time)
Title:
Last Updated Date Time UTCThe date and time the guest check was last updated in the cloud as a UTC time.First Available Version: 20.1.12
-
mgrVdTtl(required):
number
Title:
Amount of voided transactions on this check which were authorized by a managerAmount of voided transactions on this check which were authorized by a manager. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.16
-
nonTxblSlsTtl(required):
number
Title:
Non taxable sales total for this checklNon taxable sales total for this check. -
numChkPrntd(required):
integer
Title:
Number of times the check was printedNumber of times the check was printed. If a closed check was printed again at a later time this attribute will increase and the last updated date and time of the check will be updated. The check will be returned again when using the changedSinceUTC request parameter. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.16
-
numSrvcRd(required):
integer
Title:
Number of service rounds on this checkNumber of service rounds on this check. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.16
-
ocNum:
integer
Title:
Order Channel numberMaximum Length:16Unique identifier of the order channel. This attribute will not be returned in the response if value is 0 or null.First available version 20.1.15
-
opnBusDt(required):
string(date)
Title:
Open Business DateThe business date the guest check was opened. -
opnLcl(required):
string(date-time)
Title:
Open Business Date Time LocalThe date and time the guest check was opened in the location's timezone.First Available Version: 20.1.9.6
-
opnUTC(required):
string(date-time)
Title:
Open Business Date Time UTCThe date and time the guest check was opened as a UTC time -
otNum(required):
integer
Title:
Order Type NumberMaximum Length:16The number of the order type associated with this guest check. -
payTtl(required):
number
Title:
Pay TotalThe total value of payments on this guest check. -
reopnClsdChkClsdBusDt(required):
string(date)
Title:
Reopen Closed Check Closed Business DateThe business date a reopened closed guest check was closed. If the check was not reopened, the object is not present. This attribute will not be returned in the response if value is null. -
reopnClsdChkClsdLcl(required):
string(date-time)
Title:
Reopen Closed Check Closed Business Date Time LocalThe date and time a reopened guest check was closed in the location's timezone. If the check was not reopened, this object is not present. This attribute will not be returned in the response if value is null.First Available Version: 20.1.9.6
-
reopnClsdChkClsdUTC(required):
string(date-time)
Title:
Reopen Closed Check Closed Business Date Time UTCThe date and time a reopened guest check was closed as a UTC time. If the check was not reopened, this object is not present. This attribute will not be returned in the response if value is null. -
reopnClsdChkFlag(required):
boolean
Title:
Flag indicating if the check was reopened after it was already closedFlag indicating if the check was reopened after it was already closed. This attribute will not be returned in the response if value is false.First Available Version: 20.1.16
-
reopnClsdChkOpnBusDt(required):
string(date)
Title:
The business date a reopened closed guest check was openedThe business date a reopened closed guest check was opened. If the check was not reopened, the object is not present. This attribute will not be returned in the response if value is null.First Available Version: 20.1.16
-
reopnClsdChkOpnLcl(required):
string(date-time)
Title:
The date and time a reopened guest check was reopened in the location's timezoneThe date and time a reopened guest check was reopened in the location's timezone. If the check was not reopened, the object is not present. This attribute will not be returned in the response if value is null.First Available Version: 20.1.16
-
reopnClsdChkOpnUTC(required):
string(date-time)
Title:
The date and time a reopened guest check was reopened in UTC timezoneThe date and time a reopened guest check was reopened in UTC timezone. If the check was not reopened, the object is not present.This attribute will not be returned in the response if value is null.First Available Version: 20.1.16
-
reopnFrmChk(required):
integer
Title:
Reopen from Check NumberMaximum Length:16The unique identifier of the check from which the current check was reopened. This attribute will not be returned in the response if value is null -
reopnToChk(required):
integer
Title:
Reopen to Check NumberMaximum Length:16The unique identifier of the check to which the current check was reopened. This attribute will not be returned in the response if value is null -
returnTtl(required):
number
Title:
Amount of returned items on this checkAmount of returned items on this check. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.16
-
rndTtl(required):
number
Title:
Rounding TotalCurrency rounding total. This attribute will not be returned in the response if value is 0 or null. -
rvcNum(required):
integer
Title:
Revenue Center NumberMaximum Length:10The number of the revenue center associated with this guest check -
splitOut(required):
integer
Title:
Numeric value indicating the number of checks this check was split toNumeric value indicating the number of checks this check was split to. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.16
-
spltFrmChk(required):
integer
Title:
Reopen to Check NumnerMaximum Length:16The unique identifier of the check from which the current check was split. This attribute will not be returned in the response if value is null -
subTtl(required):
number
Title:
Sub TotalThe subtotal value associated with the guest check. -
svcChgTtl(required):
number
Title:
Service Charge TotalThe service charge (executing auto services charge) associated with this guest check. This attribute will not be returned in the response if value is 0 or null -
taxCollTtl:
number
Title:
Tax Collected TotalThe total tax collected for the guest check. This field is not returned by default. -
taxes(required):
array taxes
An array of taxes that are associated with the guest check
-
taxExmpSlsTtl:
number
Title:
Tax Exempt Sales TotalThe total of the sales that is exempted from tax. Applicable for add-on taxes only. This field is not returned by default. -
tblName(required):
string
Title:
Table NameMaximum Length:99The table associated with this guest check. This attribute will not be returned in the response if value is null -
tblNum(required):
integer
Title:
Table NumberMaximum Length:8The table number associated with the check. This attribute will not be returned in the response if value is null -
tipTotal(required):
number
Title:
Tip TotalThe tip total. This attribute will not be returned in the response if value is 0 or null -
vdTtl(required):
number
Title:
Amount of voided transactions on this checkAmount of voided transactions on this check. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.16
-
xferStatus(required):
string
Title:
Transfer StatusMaximum Length:1Transfer status of the guest check
X - Transfer
A - Add. This attribute will not be returned in the response if value is null.First Available Version: 20.1.10
-
xferToChkNum(required):
integer
Title:
Transfer to Check NumberMaximum Length:8Number of the check to which the check is transferred. This attribute will not be returned in the response if value is null.First Available Version: 20.1.10
Nested Schema : detailLines
Type:
arrayArray of guest check detail line JSON objects. Each detail line contains information about a specific menu item, discount, service charge or tender/media. Detail lines are presented in sequence.
Show Source
-
Array of:
object guestCheckDetailLine
The response body contains information about the guest check detail line for the specified guest check
Nested Schema : taxes
Type:
arrayAn array of taxes that are associated with the guest check
Show Source
-
Array of:
object guestCheckTax
The aggregated tax totals for a given tax associated with the guest check
Nested Schema : guestCheckDetailLine
Type:
objectThe response body contains information about the guest check detail line for the specified guest check
Show Source
-
aggQty(required):
integer
Title:
Aggregate QuantityMaximum Length:16The number of the workstation where the line item was modified -
aggTtl(required):
number
Title:
Aggregate TotalAggregate total of the line item -
busDt(required):
string(date)
Title:
Detail Business DateBusiness Date when the line item was entered -
cashierNum(required):
integer
Title:
Cashier NumberMaximum Length:16Unique identifier of the cashier of the line item. This attribute will not be returned in the response if value is null -
chkEmpId(required):
integer
Title:
Check Employee IDMaximum Length:19Alternative unique identifier of the check owner. This links to the "employeeID" attribute of getEmployeeDimensions endpoint. -
chkEmpNum(required):
integer
Title:
Check Employee NumberMaximum Length:10Unique identifier of the check owner. This links to the "num" attribute of getEmployeeDimensions endpoint. -
denominator(required):
integer
Title:
The denominator of a fractional count for items split across multiple checksThe denominator of a fractional count for items split across multiple checks. Use together with the numerator attribute. If a menu item is split between 3 checks, the numerator is set to 1, the denominator is set to 3, together describing a fractional count of 1/3 of the menu item on each check.. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.16
-
detailLcl(required):
string(date-time)
Title:
Detail Date Time LocalThe date and time this detail line was entered in the location's timezone.First Available Version: 20.1.9.6
-
detailUTC(required):
string(date-time)
Title:
Detail Date Time UTCThe UTC date and time this detail line was entered. -
discount(required):
object guestCheckDiscount
If this detail line is a discount, a discount JSON object will be present. This attribute will not be returned in the response if detail type is not a discount
-
doNotShowFlag(required):
boolean
Title:
DoNot Show FlagA flag indicating if the line item is not shown on the check. This attribute will not be returned in the response if value is false or null -
dspQty(required):
integer
Title:
Display QuantiyMaximum Length:16Displayed quantity of the line item -
dspTtl(required):
number
Title:
Display TotalDisplay total of the line item -
dtlId(required):
integer
Title:
Detail IDMaximum Length:16Unique identifier of the line item -
dtlOcNum:
integer
Title:
Order channel identifierMaximum Length:16Unique identifier of the order channel associated with this guest check detail. This attribute will not be returned in the response if value is 0 or null.First available version 20.1.15
-
dtlOtNum(required):
integer
Title:
Detail Order Type NumberMaximum Length:16The number of the order type associated with this guest check detail. This attribute will not be returned in the response if value is null -
errCorFlag(required):
boolean
Title:
Error Correct FlagA flag indicating if this detail item is an error correct. This attribute will not be returned in the response if value is false or null -
errorCorrect(required):
object guestCheckErrorCorrect
If this detail line is a error correct, a errorCorrect JSON object will be present. This attribute will not be returned in the response if detail type is not a error correct.
First Available Version: 20.1.10
-
guestCheckLineItemId(required):
integer
Title:
Guest Check Line Item IDMaximum Length:16Unique identifier of the guest check line item -
lastUpdatedLcl(required):
string(date-time)
Title:
Last Updated Date Time LocalThe date and time the transaction was updated or inserted in the cloud in the location's timezone.First Available Version: 20.1.12
-
lastUpdatedUTC(required):
string(date-time)
Title:
Last Updated Date Time UTCThe date and time the transaction was updated or inserted in the cloud as a UTC time.First Available Version: 20.1.12
-
lineNum(required):
integer
Title:
Line NumberMaximum Length:5The line number of this detail line. - menuItem(required): object guestCheckMenuItem
-
mgrEmpId:
integer
Title:
Manager Employee IDMaximum Length:19Alternative unique identifier of the manager approving the transaction. This attribute will not be returned in the response if value is NULL. This links to the "employeeID" attribute of getEmployeeDimensions endpoint. -
mgrEmpNum(required):
integer
Title:
Manager Employee NumberMaximum Length:10Unique identifier of the manager approving the transaction. This attribute will not be returned in the response if value is NULL. This links to the "num" attribute of getEmployeeDimensions endpoint. -
numerator(required):
integer
Title:
The numerator of a fractional count for items split across multiple checksThe numerator of a fractional count for items split across multiple checks. Use together with the denominator attribute. If a menu item is split between 3 checks, the numerator is set to 1, the denominator is set to 3, together describing a fractional count of 1/3 of the menu item on each check. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.16
-
other(required):
object guestCheckOtherDetails
If this detail line is any other type like reference, transfer, error correct, a other JSON object will be present. This attribute will not be returned in the response if detail type is a menu item, discount, service charge or tender media
-
parDtlId(required):
integer
Title:
Parent Detail IDMaximum Length:16Unique identifier of the parent line item. This attribute will not be returned in the response if value is 0 or null -
prepCost(required):
number
Title:
Preparation CostPreparation Cost of the line item. This attribute will not be returned in the response if value is 0 or null -
refInfo1(required):
string
Title:
Check InformationMaximum Length:128Any manually entered text associated with this detail item. This attribute will not be returned in the response if value is null -
refInfo2(required):
string
Title:
Check InformationMaximum Length:128Any manually entered text associated with this detail item. This attribute will not be returned in the response if value is null -
rsnCodeNum(required):
integer
Title:
Reason Code NumberMaximum Length:16Reason code number. This attribute will not be returned in the response if value is 0 or null -
rvcNum(required):
integer
Title:
Revenue Center NumberMaximum Length:10The number of the revenue center associated with this line item.First Available Version: 20.1.16
-
seatNum(required):
integer
Title:
The seat of the table that this detail line item applies toThe seat of the table that this detail line item applies to. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.16
-
serviceCharge(required):
object guestCheckServiceCharge
If this detail line is a service charge, a service charge JSON object will be present.Note autogratuity also appears here. This attribute will not be returned in the response if detail type is not a service charge
-
svcRndNum(required):
integer
Title:
Service Round NumberMaximum Length:16Service Round Number -
tenderMedia(required):
object guestCheckTenderMedia
If this detail line is a tender/media, a tender/media JSON object will be present. This attribute will not be returned in the response if detail type is not a tender media
-
transEmpId:
integer
Title:
Transaction Employee IDMaximum Length:19Alternative unique identifier of the transaction employee. This attribute will not be returned in the response if the transaction employee is the same as the check owner (chkEmpId = transEmpId). This links to the "employeeID" attribute of getEmployeeDimensions endpoint. -
transEmpNum(required):
integer
Title:
Transaction Employee NumberMaximum Length:10Unique identifier of the transaction employee. This attribute will not be returned in the response if the transaction employee is the same as the check owner (chkEmpNum = transEmpNum). This links to the "num" attribute of getEmployeeDimensions endpoint. -
vdFlag(required):
boolean
Title:
Void FlagA flag indicating if this detail item is a voided item. This attribute will not be returned in the response if value is false or null -
weight(required):
number
Title:
WeightWeight or Volume of the line item. This attribute will not be returned in the response if value is 0 or null -
wsNum(required):
integer
Title:
Workstation NumberMaximum Length:16The number of the workstation where the line item was modified
Nested Schema : guestCheckDiscount
Type:
objectIf this detail line is a discount, a discount JSON object will be present. This attribute will not be returned in the response if detail type is not a discount
Show Source
-
activeTaxes(required):
string
Title:
Comma separated string of tax numbers that are active on the discountComma separated string of tax numbers that are active on the discount. This attribute will not be returned in the response if value is null.First Available Version: 20.1.10.1
-
dscMiNum(required):
integer
Title:
Discount Menu Item NumberMaximum Length:16The number associated with the menu item that is discounted. This attribute will not be returned in the response if value is null -
dscNum(required):
integer
Title:
Discount NumberMaximum Length:16The number associated with this discount -
inclTax(required):
number
Title:
Total of the inclusive tax on the discounted itemTotal of the inclusive tax on the discounted item. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.10.1
-
mealEmpNum(required):
integer
Title:
Meal Employee NumberMaximum Length:16If this is an employee meal, the number associated with the employee. This attribute will not be returned in the response if value is null -
vatTaxTtl(required):
number
Title:
VAT Tax TotalTotal of the vat tax on the discounted item. This attribute will not be returned in the response if value is 0 or null
Nested Schema : guestCheckErrorCorrect
Type:
objectIf this detail line is a error correct, a errorCorrect JSON object will be present. This attribute will not be returned in the response if detail type is not a error correct.
Show Source
First Available Version: 20.1.10
-
objectNum(required):
integer
Title:
Object NumberMaximum Length:16Object number of the detail line that is error corrected.First Available Version: 20.1.10
-
type(required):
integer
Title:
TypeMaximum Length:16The type of the detail line which is error corrected.
1 - Menu Item
2 - Service ChargeFirst Available Version: 20.1.10
Nested Schema : guestCheckMenuItem
Type:
objectIf this detail line is a menu item, a menu item JSON object will be present. This attribute will not be returned in the response if detail type is not a menu item
Show Source
-
activeTaxes(required):
string
Title:
Active TaxesComma separated string of tax numbers that are active on the menu item. This attribute will not be returned in the response if value is null -
comboGrpNum(required):
integer
Title:
Combo Group NumberMaximum Length:16The number of the combo group associated with the menu item. This attribute will not be returned in the response if value is null.First Available Version: 20.1.8.3
-
comboMealSeq(required):
integer
Title:
Combo Meal Sequence NumberMaximum Length:16The sequence number of the combo meal. This attribute will not be returned in the response if value is null.First Available Version: 20.1.8.3
-
comboSideSeq(required):
integer
Title:
Combo Side Sequence NumberMaximum Length:16The sequence number of the combo side item. This attribute will not be returned in the response if value is null.First Available Version: 20.1.8.3
-
inclTax(required):
number
Title:
Inclusive TaxThe tax included in this menu item's price. This attribute will not be returned in the response if value is 0 or null -
miNum(required):
integer
Title:
Menu Item NumberMaximum Length:16The number of the menu item -
modFlag:
boolean
Title:
Modifier flagFlag specifying whether the line item is a modifier or not. This attribute will not be returned in the response if value is false or null.Requires Simphony 19.6
-
modPrfx:
integer
Title:
Modifier prefixMaximum Length:16If this item is a modifier, this is the modifier prefix. Possible values: 1 = DESCRIPTOR, 2 = NO, 3 = ADD, 4 = SUB, 5 = PLAIN, 6 = RESET. This attribute will not be returned in the response if value is 0 or null.Requires Simphony 19.6
-
prcLvl(required):
integer
Title:
Price LevelMaximum Length:16Price Level of the menu item -
returnFlag(required):
boolean
Title:
Return FlagFlag indicating if this menu item is being returned. This attribute will not be returned in the response if value is false or null
Nested Schema : guestCheckOtherDetails
Type:
objectIf this detail line is any other type like reference, transfer, error correct, a other JSON object will be present. This attribute will not be returned in the response if detail type is a menu item, discount, service charge or tender media
Show Source
-
detailNum(required):
integer
Title:
Detail NumberMaximum Length:16The number associated with the other detail. This attribute will not be returned in the response if value is null -
detailType(required):
integer
Title:
Detail TypeMaximum Length:16The type of the gust check line item detail. The following are the different detail types that could be returned:
5 - Reference
6 - Reference
7 - Transfer
11 - CreditAuth
12 - CreditVoucher
Nested Schema : guestCheckServiceCharge
Type:
objectIf this detail line is a service charge, a service charge JSON object will be present.Note autogratuity also appears here. This attribute will not be returned in the response if detail type is not a service charge
Show Source
-
activeTaxes(required):
string
Title:
Comma separated string of tax numbers that are active on the service chargeComma separated string of tax numbers that are active on the service charge. This attribute will not be returned in the response if value is null.First Available Version: 20.1.10.1
-
inclTax(required):
number
Title:
Total of the inclusive tax on the taxable service chargeTotal of the inclusive tax on the taxable service charge. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.10.1
-
svcChgNum(required):
integer
Title:
Service Charge NumberMaximum Length:16The number associated with this service charge
Nested Schema : guestCheckTenderMedia
Type:
objectIf this detail line is a tender/media, a tender/media JSON object will be present. This attribute will not be returned in the response if detail type is not a tender media
Show Source
-
mealEmpNum(required):
integer
Title:
Meal Employee NumberMaximum Length:16If this is an employee meal, the number associated with the employee. This attribute will not be returned in the response if value is null -
tmedNum(required):
integer
Title:
Tender Media NumberMaximum Length:16The number associated with this tender/media.
Nested Schema : guestCheckTax
Type:
objectThe aggregated tax totals for a given tax associated with the guest check
Show Source
-
taxCollTtl(required):
number
Title:
Tax Collected TotalThe total tax collected for this tax number in the check. -
taxExmptTtl(required):
integer
Title:
Amount of tax exemptions on this checkAmount of tax exemptions on this check. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.16
-
taxNum(required):
integer
Title:
Tax NumberMaximum Length:16The number associated with tax. -
taxRate(required):
number
Title:
VAT Tax Rate associated with the tax numberThe VAT Tax Rate associated with the tax number on the check.First Available Version: 20.1.10.1
-
taxType(required):
integer
Title:
Tax Type associated with the tax numberThe Tax Type associated with the tax number on the check.
Possible values:
1 = Breakpoint add-on
2 = Add-on percentage
3 = Inclusive
4 = Surcharge
5 = Open
6 = Add on, Excludes Start AmountFirst Available Version: 20.1.10.1; type 6 first available version: 20.1.16
-
txblSlsTtl(required):
number
Title:
Taxable Sales TotalThe taxable sales associated with this tax number for the check.
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Examples
The following example shows how to get the guest checks for a specified location and closed business date after a given date time by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H "Authorization: Bearer" -H "Content-Type:application/json" -d {"locRef":"1234","rvcNum": 1, "clsdBusDt":"2020-10-20", "changedSinceUTC":"2020-10-20T16:00:00"} https://baseurl/bi/v1/orgidentifier/getGuestChecks
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Date: Tue, 20 Oct 2020 21:24:33 GMT Transfer-Encoding: chunked Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"curUTC": "2020-10-20T16:42:42",
"locRef" : "SAC",
"guestChecks": [{
"guestCheckId": 829084,
"chkNum": 9735,
"chkName": "Check",
"opnBusDt": "2020-10-20",
"opnUTC": "2020-10-20T15:41:54",
"opnLcl": "2020-10-20T11:41:54",
"clsdBusDt": "2020-10-20",
"clsdUTC": "2020-10-20T16:20:44",
"clsdLcl": "2020-10-20T12:20:44",
"reopnClsdChkClsdBusDt": "2020-10-20",
"reopnClsdChkClsdUTC": "2020-10-20T16:20:44",
"reopnClsdChkClsdLcl": "2020-10-20T12:20:44",
"lastUpdatedUTC": "2020-10-20T16:20:45",
"lastUpdatedLcl": "2020-10-20T12:20:45",
"lastTransUTC": "2020-10-20T12:20:45",
"lastTransLcl": "2020-10-20T12:20:45",
"clsdFlag": true,
"cancelFlag": false,
"gstCnt": 2,
"subTtl": 16.66,
"autoSvcTtl": 0.00,
"svcChgTtl": 3.5,
"nonTxblSlsTtl": 123.45,
"taxExmpSlsTtl": 0.00,
"taxCollTtl": 0.83,
"chkTtl": 20.99,
"dscTtl": -5,
"payTtl": 15.00,
"tipTotal": 3.5,
"balDueTtl": 0.99,
"rndTtl": 21.00,
"reopnFrmChk": 9736,
"reopnToChk": 9738,
"spltFrmChk": 9735,
"rvcNum": 1,
"ocNum": 2,
"otNum": 12,
"tblNum": 1,
"tblName": "5",
"empNum": 258,
"chkInfo": "Check Info",
"chkRef": "Check Reference",
"xferStatus": "X",
"xferToChkNum": 8,
"autoFireUTC": "2020-10-20T12:20:45",
"autoFireLcl": "2020-10-20T12:20:45",
"numSrvcRd": 2,
"vdTtl": 12.34,
"mgrVdTtl": 12.34,
"returnTtl": 12.34,
"errorCorrectTtl": 12.34,
"reopnClsdChkFlag": false,
"reopnClsdChkOpnLcl": "2020-10-20T12:19:44",
"reopnClsdChkOpnUTC": "2020-10-20T12:19:44",
"reopnClsdChkOpnBusDt": "2020-10-20",
"numChkPrntd": 1,
"splitOut": 1,
"addedIn": 1,
"inclTaxExmpTtl": 1.82,
"autoClsdFlag": true,
"taxes": [{
"taxNum": 1,
"txblSlsTtl": 12.34,
"taxCollTtl": 0.83,
"taxRate": 19,
"taxType": 3,
"taxExmptTtl": 12.34
}],
"detailLines": [{
"guestCheckLineItemId": 9433187,
"lineNum": 1,
"dtlId": 17,
"parDtlId": 0,
"detailUTC": "2020-10-20T15:42:08",
"detailLcl": "2020-10-20T11:42:08",
"busDt": "2020-10-20",
"lastUpdatedUTC": "2020-10-20T12:20:45",
"lastUpdatedLcl": "2020-10-20T12:20:45",
"rvcNum": 152,
"prepCost": 0.481,
"weight": 1.23,
"vdFlag": false,
"errCorFlag": false,
"wsNum": 6,
"refInfo1": "reference info 1",
"refInfo2": "reference info 2",
"dspTtl": 2.09,
"dspQty": 1,
"aggTtl": 2.09,
"aggQty": 1,
"doNotShowFlag": false,
"chkEmpNum": 69405,
"transEmpNum": 69405,
"mgrEmpNum": null,
"rsnCodeNum": null,
"svcRndNum": 1,
"cashierNum": null,
"dtlOcNum": 2,
"dtlOtNum": 123,
"seatNum": 1,
"numerator": 1,
"denominator": 3,
"menuItem": {
"miNum": 3401,
"comboMealSeq": 1,
"comboSideSeq": 1,
"comboGrpNum": 101,
"modFlag": false,
"modPrfx": 1,
"inclTax": 0,
"returnFlag": false,
"activeTaxes": {1},
"prcLvl": 1
}
},
{
"guestCheckLineItemId": 9433353,
"lineNum": 21,
"dtlId": 37,
"parDtlId": 20,
"detailUTC": "2020-10-20T16:06:06",
"detailLcl": "2020-10-20T12:06:06",
"busDt": "2020-10-20",
"rvcNum": 152,
"prepCost": 0,
"vdFlag": false,
"errCorFlag": false,
"wsNum": 5,
"refInfo1": "SV012003621910405",
"refInfo2": null,
"dspTtl": -2.19,
"dspQty": 1,
"aggTtl": -2.19,
"aggQty": 0,
"doNotShowFlag": true,
"chkEmpNum": 69405,
"chkEmpId": 123435,
"transEmpId": 123435,
"mgrEmpId": 123435,
"transEmpNum": 69405,
"mgrEmpNum": null,
"rsnCodeNum": null,
"svcRndNum": 4,
"cashierNum": null,
"dtlOtNum": 123,
"seatNum": 1,
"numerator": 1,
"denominator": 3,
"discount": {
"dscNum": 210,
"dscMiNum": 1509,
"mealEmpNum": null,
"vatTaxTtl": 0,
"inclTax": 123.456789,
"activeTaxes": "1,2,5"
}
},
{
"guestCheckLineItemId": 9433400,
"lineNum": 3,
"dtlId": 0,
"parDtlId": 0,
"detailUTC": "2020-10-20T16:20:45",
"detailLcl": "2020-10-20T12:20:45",
"busDt": "2020-10-20",
"rvcNum": 152,
"prepCost": 0,
"vdFlag": false,
"errCorFlag": false,
"wsNum": 5,
"refInfo1": null,
"refInfo2": null,
"dspTtl": 3.5,
"dspQty": 1,
"aggTtl": 3.5,
"aggQty": 1,
"doNotShowFlag": false,
"chkEmpNum": 69405,
"transEmpNum": 69405,
"mgrEmpNum": null,
"rsnCodeNum": null,
"svcRndNum": 6,
"cashierNum": null,
"dtlOtNum": 123,
"seatNum": 1,
"numerator": 1,
"denominator": 3,
"serviceCharge": {
"svcChgNum": 101,
"inclTax": 123.456789,
"activeTaxes": "1,2,5"
}
},
{
"guestCheckLineItemId": 9433401,
"lineNum": 4,
"dtlId": 0,
"parDtlId": 0,
"detailUTC": "2020-10-20T16:20:45",
"detailLcl": "2020-10-20T12:20:45",
"busDt": "2020-10-20",
"rvcNum": 152,
"prepCost": 0,
"vdFlag": false,
"errCorFlag": false,
"wsNum": 5,
"refInfo1": "XXXXXXXXXXX6008",
"refInfo2": null,
"dspTtl": 3.5,
"dspQty": 1,
"aggTtl": 3.5,
"aggQty": 1,
"doNotShowFlag": true,
"chkEmpNum": 69405,
"transEmpNum": 69405,
"mgrEmpNum": null,
"rsnCodeNum": null,
"svcRndNum": 6,
"cashierNum": null,
"dtlOtNum": 123,
"seatNum": 1,
"numerator": 1,
"denominator": 3,
"tenderMedia": {
"tmedNum": 503,
"mealEmpNum": 258
}
},
{
"guestCheckLineItemId": 9433402,
"lineNum": 39,
"dtlId": 55,
"parDtlId": 0,
"detailUTC": "2011-01-17T16:20:45",
"detailLcl": "2011-01-17T12:20:45",
"busDt": "2011-01-17",
"rvcNum": 152,
"prepCost": 0,
"vdFlag": false,
"errCorFlag": false,
"wsNum": 5,
"refInfo1": "XXXXXXXXXXX6008",
"refInfo2": null,
"dspTtl": 0,
"dspQty": 0,
"aggTtl": 20.99,
"aggQty": 0,
"doNotShowFlag": false,
"chkEmpNum": 69405,
"transEmpNum": 69405,
"mgrEmpNum": null,
"rsnCodeNum": null,
"svcRndNum": 6,
"cashierNum": null,
"dtlOtNum": 123,
"seatNum": 1,
"numerator": 1,
"denominator": 3,
"other": {
"detailType": 6,
"detailNum": 53415
}
},
{
"guestCheckLineItemId": 9433409,
"lineNum": 40,
"dtlId": 56,
"parDtlId": 0,
"detailUTC": "2011-01-17T16:20:45",
"detailLcl": "2011-01-17T12:20:45",
"busDt": "2011-01-17",
"rvcNum": 152,
"prepCost": 0,
"vdFlag": false,
"errCorFlag": false,
"wsNum": 5,
"refInfo1": "XXXXXXXXXXX6008",
"refInfo2": null,
"dspTtl": 0,
"dspQty": 0,
"aggTtl": 20.99,
"aggQty": 0,
"doNotShowFlag": false,
"chkEmpNum": 69405,
"transEmpNum": 69405,
"mgrEmpNum": null,
"rsnCodeNum": null,
"svcRndNum": 6,
"cashierNum": null,
"dtlOtNum": 123,
"seatNum": 1,
"numerator": 1,
"denominator": 3,
"errorCorrect": {
"type": 1,
"objectNum": 123
}
}]
}]
}