The following example shows how to get the latest business date for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H \"Authorization: Bearer\" -H \"Content-Type:application/json\" -d {\"locRef\":\"1234\"} https://baseurl/bi/v1/orgidentifier/getLatestBusinessDate
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
The following example shows the contents of the response body in JSON format:
{\n \"curUTC\": \"2019-07-20T17:59:59\",\n \"locRef\": \"1234\",\n \"latestBusDt\": \"2019-07-20\"\n \"softwareVersion\": \"20.1.8.1\",\n}The following example shows how to get the location dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H \"Authorization: Bearer\" -H \"Content-Type:application/json\" -d {\"locRef\":\"1234\"} https://baseurl/bi/v1/orgidentifier/getLocationDimensions
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
The following example shows the contents of the response body in JSON format:
{\n \"locations\":[{\n \"locRef\": \"1234\",\n \"name\": \"McLean VA\",\n \"openDt\": \"2010-07-20\",\n \"active\": true,\n \"srcName\": \"Simphony\",\n \"srcVer\": \"18.2\",\n \"tz\": \"America/Denver\",\n \"curr\": \"USD\",\n \"addrLn1\": \"7031 Columbia Gateway Dr\",\n \"addrLn2\": \"Floor 3\",\n \"addrLn3\": \"Columbia, MD 21046\",\n \"postalCode\": \"21046\",\n \"phone\": \"4432856000\",\n \"phoneCountryCode\": \"1\",\n \"countryCode\": \"US\",\n \"countryName\": \"United States\",\n \"regionCode\": \"MD\",\n \"regionName\": \"Maryland\"\n \"workstations\":[{\n \"wsNum\":1,\n \"wsName\": \"register 1\"\n }]\n }]\n}The following example shows how to get the revenue center dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H \"Authorization: Bearer\" -H \"Content-Type:application/json\" -d {\"locRef\":\"1234\"} https://baseurl/bi/v1/orgidentifier/getRevenueCenterDimensions
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"revenueCenters\":[{\n \"num\":152,\n \"name\": \"Bar\",\n \"mstrNumNum\":152,\n \"mstrNameName\": \"Bar\",\n \"addrLn1\": \"7031 Columbia Gateway Dr\",\n \"addrLn2\": \"Floor 3\",\n \"addrLn3\": \"Columbia, MD 21046\",\n \"postalCode\": \"21046\",\n \"phone\": \"4432856000\",\n \"phoneCountryCode\": \"1\",\n \"countryCode\": \"US\",\n \"countryName\": \"United States\",\n \"regionCode\": \"MD\",\n \"regionName\": \"Maryland\",\n \"catGrpHierName1\": \"Category Hierarchy 1\",\n \"catGrpName1\": \"Category Group 1\",\n \"catGrpHierName2\": \"Category Hierarchy 2\",\n \"catGrpName2\": \"Category Group 2\",\n \"catGrpHierName3\": \"Category Hierarchy 3\",\n \"catGrpName3\": \"Category Group 3\",\n \"catGrpHierName4\": \"Category Hierarchy 4\",\n \"catGrpName4\": \"Category Group 4\"\n }]\n}The following example shows how to get the discount dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H \"Authorization: Bearer\" -H \"Content-Type:application/json\" -d {\"locRef\":\"1234\"} https://baseurl/bi/v1/orgidentifier/getDiscountDimensions
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"discounts\":[{\n \"num\": 15253,\n \"name: \"BOGO\",\n \"mstrNum\": 15253,\n \"mstrName\": \"BOGO\",\n \"catGrpHierName1\": \"Category Hierarchy 1\",\n \"catGrpName1\": \"Category Group 1\",\n \"catGrpHierName2\": \"Category Hierarchy 2\",\n \"catGrpName2\": \"Category Group 2\",\n \"catGrpHierName3\": \"Category Hierarchy 3\",\n \"catGrpName3\": \"Category Group 3\",\n \"catGrpHierName4\": \"Category Hierarchy 4\",\n \"catGrpName4\": \"Category Group 4\",\n \"posPercent\": 10.25,\n \"rptGrpNum\": 1,\n \"rptGrpName\": \"Manager Comps\",\n \"extRef1\": \"567abc\",\n \"extRef2\": \"789def01\"\n }]\n}The following example shows how to get the service charge dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H \"Authorization: Bearer\" -H \"Content-Type:application/json\" -d {\"locRef\":\"1234\"} https://baseurl/bi/v1/orgidentifier/getServiceChargeDimensions
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"serviceCharges\":[{\n \"num\": 15253,\n \"name\": \"Charge Tip\",\n \"mstrNum\": 15253,\n \"mstrName\": \"Charge Tip\",\n \"catGrpHierName1\": \"Category Hierarchy 1\",\n \"catGrpName1\": \"Category Group 1\",\n \"catGrpHierName2\": \"Category Hierarchy 2\",\n \"catGrpName2\": \"Category Group 2\",\n \"catGrpHierName3\": \"Category Hierarchy 3\",\n \"catGrpName3\": \"Category Group 3\",\n \"catGrpHierName4\": \"Category Hierarchy 4\",\n \"catGrpName4\": \"Category Group 4\",\n \"posPercent\": 10.25,\n \"revFlag\": true,\n \"chrgTipsFlag\": true,\n \"category\": \"category\"\n \"extRef1\": \"567abc\",\n \"extRef2\": \"789def01\"\n }]\n}The following example shows how to get the tender media dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H \"Authorization: Bearer\" -H \"Content-Type:application/json\" -d {\"locRef\":\"1234\"} https://baseurl/bi/v1/orgidentifier/getTenderMediaDimensions
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"tenderMedias\":[{\n \"num\":15253,\n \"name\": \"Cash\",\n \"mstrNum\":15253,\n \"mstrName\": \"Cash\",\n \"catGrpHierName1\": \"Category Hierarchy 1\",\n \"catGrpName1\": \"Category Group 1\",\n \"catGrpHierName2\": \"Category Hierarchy 2\",\n \"catGrpName2\": \"Category Group 2\",\n \"catGrpHierName3\": \"Category Hierarchy 3\",\n \"catGrpName3\": \"Category Group 3\",\n \"catGrpHierName4\": \"Category Hierarchy 4\",\n \"catGrpName4\": \"Category Group 4\",\n \"type\": 1,\n \"subType\": 1,\n \"cat\": 2,\n \"autoClsdTnd\": true,\n \"extRef1\": \"567abc\",\n \"extRef2\": \"789def01\"\n }]\n}The following example shows how to get the order type dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H \"Authorization: Bearer\" -H \"Content-Type:application/json\" -d {\"locRef\":\"1234\"} https://baseurl/bi/v1/orgidentifier/getOrderTypeDimensions
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"orderTypes\":[{\n \"num\": 15253,\n \"name\": \"App\",\n \"mstrNum\":15253,\n \"mstrName\": \"App\",\n \"catGrpHierName1\": \"Category Hierarchy 1\",\n \"catGrpName1\": \"Category Group 1\",\n \"catGrpHierName2\": \"Category Hierarchy 2\",\n \"catGrpName2\": \"Category Group 2\",\n \"catGrpHierName3\": \"Category Hierarchy 3\",\n \"catGrpName3\": \"Category Group 3\",\n \"catGrpHierName4\": \"Category Hierarchy 4\",\n \"catGrpName4\": \"Category Group 4\"\n }]\n}The following example shows how to get the order type dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H \"Authorization: Bearer\" -H \"Content-Type:application/json\" -d {\"locRef\":\"1234\"} https://baseurl/bi/v1/orgidentifier/getOrderChannelDimensions
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"orderChannels\":[{\n \"num\": 2,\n \"name\": \"Online Order\",\n \"mstrNum\":2,\n \"mstrName\": \"Online Order\"\n }]\n}The following example shows how to get the tax dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H \"Authorization: Bearer\" -H \"Content-Type:application/json\" -d {\"locRef\":\"1234\"} https://baseurl/bi/v1/orgidentifier/getTaxDimensions
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"taxes\":[{\n \"num\": 1,\n \"name\": \"City Tax\",\n \"mstrNum\":1,\n \"mstrName\": \"City Tax\",\n \"catGrpHierName1\": \"Category Hierarchy 1\",\n \"catGrpName1\": \"Category Group 1\",\n \"catGrpHierName2\": \"Category Hierarchy 2\",\n \"catGrpName2\": \"Category Group 2\",\n \"catGrpHierName3\": \"Category Hierarchy 3\",\n \"catGrpName3\": \"Category Group 3\",\n \"catGrpHierName4\": \"Category Hierarchy 4\",\n \"catGrpName4\": \"Category Group 4\",\n \"type\": 1,\n \"taxRate\": 10.25,\n \"effFrDt\": \"2018-10-18\",\n \"effToDt\": \"2019-07-29\" \n }]\n}The following example shows how to get the job code dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H \"Authorization: Bearer\" -H \"Content-Type:application/json\" -d {\"locRef\":\"1234\"} https://baseurl/bi/v1/orgidentifier/getJobCodeDimensions
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"jobCodes\":[{\n \"num\": 101,\n \"name\": \"Cashier\",\n \"mstrNum\": 101,\n \"mstrName\": \"Cashier\",\n \"lbrCatNum\": 101,\n \"lbrCatName\": \"Staff\",\n \"lbrCatMstrNum\": 101,\n \"lbrCatMstrName\": \"Staff\"\n }]\n}The following example shows how to get the cash management item dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H \"Authorization: Bearer\" -H \"Content-Type:application/json\" -d {\"locRef\":\"1234\"} https://baseurl/bi/v1/orgidentifier/getCashManagementItemDimensions
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"cashMgmtItems\":[{\n \"num\": 19,\n \"name\": \"Cash\",\n \"mstrNum\": 19,\n \"mstrName\": \"Cash\",\n \"catGrpHierName1\": \"Category Hierarchy 1\",\n \"catGrpName1\": \"Category Group 1\",\n \"catGrpHierName2\": \"Category Hierarchy 2\",\n \"catGrpName2\": \"Category Group 2\",\n \"catGrpHierName3\": \"Category Hierarchy 3\",\n \"catGrpName3\": \"Category Group 3\",\n \"catGrpHierName4\": \"Category Hierarchy 4\",\n \"catGrpName4\": \"Category Group 4\",\n \"type\": 1,\n \"recordNum\": 123\n }]\n}The following example shows how to get the reason code dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H \"Authorization: Bearer\" -H \"Content-Type:application/json\" -d {\"locRef\":\"1234\"} https://baseurl/bi/v1/orgidentifier/getReasonCodeDimensions
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"reasonCodes\":[{\n \"mstrPosRef\": 123,\n \"mstrNum\": 152,\n \"mstrName\": \"Manager Adjust\",\n \"name\": \"Manager Adjust\",\n \"num\": 152,\n \"posRef\": 123,\n \"type\": 27\n }]\n}The following example shows how to get the cashier dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H \"Authorization: Bearer\" -H \"Content-Type:application/json\" -d {\"locRef\":\"1234\"} https://baseurl/bi/v1/orgidentifier/getCashierDimensions
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"cashiers\":[{\n \"num\": 19,\n \"name\": \"Cash\",\n \"mstrNum\": 19,\n \"mstrName\": \"Cash\"\n }]\n}The following example shows how to get the menu item dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H \"Authorization: Bearer\" -H \"Content-Type:application/json\" -d {\"locRef\":\"1234\"} https://baseurl/bi/v1/orgidentifier/getMenuItemDimensions
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234,\n \"menuItems\":[{\n \"num\": 15253,\n \"name: \"Hamburger\",\n \"catGrpHierName1\": \"Menu Item Category Hierarchy 1\",\n \"catGrpName1\": \"Menu Item Category Group 1\",\n \"catGrpHierName2\": \"Menu Item Category Hierarchy 2\",\n \"catGrpName2\": \"Menu Item Category Group 2\",\n \"catGrpHierName3\": \"Menu Item Category Hierarchy 3\",\n \"catGrpName3\": \"Menu Item Category Group 3\",\n \"catGrpHierName4\": \"Menu Item Category Hierarchy 4\",\n \"catGrpName4\": \"Menu Item Category Group 4\",\n \"majGrpNum\": 49469,\n \"majGrpName\": \"Food\",\n \"famGrpNum\": 261486,\n \"famGrpName\": \"Sides\",\n \"majGrpMstrNum\": 49469,\n \"majGrpMstrName\": \"Food\",\n \"mgCatGrpHierName1\": \"Major Group Category Hierarchy 1\",\n \"mgCatGrpName1\": \"Major Group Category Group 1\",\n \"mgCatGrpHierName2\": \"Major Group Category Hierarchy 2\",\n \"mgCatGrpName2\": \"Major Group Category Group 2\",\n \"mgCatGrpHierName3\": \"Major Group Category Hierarchy 3\",\n \"mgCatGrpName3\": \"Major Group Category Group 3\",\n \"mgCatGrpHierName4\": \"Major Group Category Hierarchy 4\",\n \"mgCatGrpName4\": \"Major Group Category Group 4\",\n \"famGrpMstrNum\": 261486,\n \"famGrpMstrName\": \"Sides\",\n \"fgCatGrpHierName1\": \"Family Group Category Hierarchy 1\",\n \"fgCatGrpName1\": \"Family Group Category Group 1\",\n \"fgCatGrpHierName2\": \"Family Group Category Hierarchy 2\",\n \"fgCatGrpName2\": \"Family Group Category Group 2\",\n \"fgCatGrpHierName3\": \"Family Group Category Hierarchy 3\",\n \"fgCatGrpName3\": \"Family Group Category Group 3\",\n \"fgCatGrpHierName4\": \"Family Group Category Hierarchy 4\",\n \"fgCatGrpName4\": \"Family Group Category Group 4\",\n \"doNotIncludeInSales\": false,\n \"category\": \"Gift Card\",\n \"revFlag\": true\n \"extRef1\": \"567abc\",\n \"extRef2\": \"789def01\"\n }]\n}The following example shows how to get the menu item dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H \"Authorization: Bearer\" -H \"Content-Type:application/json\" -d {\"locRef\":\"1234\"} https://baseurl/bi/v1/orgidentifier/getMenuItemPrices
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"menuItemPrices\":[{\n \"num\": 15253,\n \"rvcNum\": 421,\n \"prcLvlNum\": 3,\n \"prcLvlName\": \"level\",\n \"price\": 1234.56,\n \"cost\": 1234.56,\n \"effFrDt\": \"2018-10-18\",\n \"effToDt\": \"2019-07-29\"\n \"extRef1\": \"567abc\",\n \"extRef2\": \"789def01\"\n }]\n}The following example shows how to view all the Employee Dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H \"Authorization: Bearer\" -H \"Content-Type:application/json\" -d {\"locRef\":\"1234\"} https://baseurl/bi/v1/orgidentifier/getEmployeeDimensions
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef:\"1234\",\n \"employees\":[{\n \"num\": 1372,\n \"uuId\": 145326,\n \"employeeId\": 145326,\n \"fName\": \"Adam\",\n \"lName\": \"Smith\",\n \"externalPayrollID\": 145326,\n \"payrollId\": 2327895,\n \"homeLocRef\": \"1234\"\n \"className\": \"Shift Manager\",\n \"classNum\": 123,\n \"classMstrName\": \"Shift Manager\",\n \"classMstrNum\": 123\n }]\n}Gets Payment settlement records for the given settlement date and location. This API only returns data for customers using Oracle MICROS Payment Cloud Service.
The following example shows how to get the payment account holder details 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 https://baseurl/bi/v1/orgidentifier/getPaymentSettlements
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
The following example shows the contents of the response body in JSON format:
{\n \"stlmtDt\": \"2021-07-03\",\n \"locRef: \"1234\",\n \"accounts\":[{\n \"acctCode\": \"8516212653197782\",\n \"revenueCenters\":[{\n \"rvcNum\": 123,\n \"businessDates\":[{\n \"busDt\": \"2021-07-01\",\n \"settlements\":[{\n \"merchAcctRef\": \"Oracle_Merchant\",\n \"pspRef\": \"8836251672789792\",\n \"merchRef\": \"999-991720391116\",\n \"modPspRef\": \"8036251672851715\",\n \"pmntMethod\": \"Visa\",\n \"pmntMethodVar\": \"visacommercialcredit\",\n \"createdUTC\": \"2021-07-01T12:10:00\",\n \"journalType\": \"Settled\",\n \"currStatusFlag\": 1,\n \"grossCur\": \"USD\",\n \"grossDebit\": 123.45,\n \"grossCredit\": 123.45,\n \"cardPrsntRate\": 0.12,\n \"cardPrsntFee\": 0.05,\n \"cardNotPrsntRate\": 0.15,\n \"cardNotPrsntFee\": 0.05,\n \"chgbkFee\": 15,\n \"batchNum\": 123,\n \"rrn\": \"abcdef123456789\",\n \"isReferenced\": 1,\n \"cardBin\": \"123456****9876\",\n \"pymtID\": \"123456\",\n \"pymtDtlID\": \"123456\"\n }]\n }]\n }]\n }]\n}Gets payment transaction records for the given business date and location. This API only returns data for customers using Oracle MICROS Payment Cloud Service.
The following example shows how to get the payment account holder details 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 https://baseurl/bi/v1/orgidentifier/getPaymentTransactions
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
The following example shows the contents of the response body in JSON format:
{\n \"busDt\": \"2020-10-20\",\n \"locRef: \"1234\",\n \"curUTC: \"122020-10-20T12:10:0034\",\n \"accounts\":[{\n \"acctCode\": \"8516212653197782\",\n \"revenueCenters\":[{\n \"rvcNum\": 123,\n \"transactions\":[{\n \"pspRef\": \"8836251672789792\",\n \"checkNum\": 1234,\n \"guestCheckID\": 123654,\n \"guestCheckLineItemId\": 123,\n \"transAmt\": 2.5,\n \"tipAmt\": 2,\n \"transUTC\": \"2020-10-20T12:10:00\",\n \"transLcl\": \"2020-10-20T15:10:00\",\n \"pmntType\": \"PAY\",\n \"tmedNum\": \"1234\",\n \"seqNum\": \"210217292426\",\n \"wsNum\": 12345,\n \"empNum\": 54321,\n \"terminalID\": \"01234567\",\n \"entryMode\": 16,\n \"authCode\": \"654abc\",\n \"cardAlias\": \"1234567\",\n \"offlineFlag\": 0,\n \"raPostUTC\": \"2020-10-20T12:12:00\",\n \"payPostUTC\": \"2020-10-20T12:12:00\",\n \"rrn\": \"abcdef123456789\",\n \"modPspRef\": \"8036251672851715\"\n \"pymtID\": \"123456\",\n \"pymtDtlID\": \"123456\",\n \"curStatus\": \"\",\n \"cancelAmt\": \"123456\",\n \"configStoreId\": \"123\",\n \"cardPresentFlag\": 1\n }]\n }]\n }]\n}Gets payment transaction records for the given booking date and location. This API only returns data for customers using Oracle MICROS Payment Cloud Service.
The following example shows how to get the payment account holder details 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 https://baseurl/bi/v1/orgidentifier/getPaymentPayouts
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
The following example shows the contents of the response body in JSON format:
{\n \"bookingDt\": \"2020-10-20\",\n \"locRef: \"1234\",\n \"accounts\":[{\n \"acctCode\": 8516212653197782,\n \"revenueCenters\":[{\n \"rvcNum\": 123,\n \"businessDates\":[{\n \"busDt\": \"2020-10-20\",\n \"payouts\":[{\n \"pspRef\": 2342435436,\n \"payoutDetails\":[{\n \"merchAcctRef\": \"Oracle_Merchant\",\n \"merchRef\": \"999-991720391116\",\n \"modPspRef\": \"8036251672851715\",\n \"payoutCur\": \"USD\",\n \"recordType\": \"Payout\",\n \"pspTransDateTime\": \"2020-10-20T12:10:00\",\n \"posTransDateTime\": \"2020-10-20T12:10:00\",\n \"payoutType\": \"TRANSANDFEE\",\n \"payoutPspRef\": \"8836251672789792\",\n \"payoutAmt\": 1.23,\n \"pymtID\": \"123456\",\n \"pymtDtlID\": \"123456\",\n \"transPayoutPspRef\": \"123456\",\n \"feePayoutPspRef\": \"123456\",\n \"oracleFees\": \"123\"\n }]\n }]\n }]\n }]\n }]\n}Gets a summary of payment batch payouts for the specified account and payout date.
The following example shows how to get the payments account details 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 {\"payoutDt\":\"2024-12-24\", \"acctCode\":8516212653197782} https://baseurl/bi/v1/orgidentifier/getPaymentPayoutSummary
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
The following example shows the contents of the response body in JSON format:
{\n \"payoutDt\": \"122024-12-2434\",\n \"acctCode\": \"8516212653197782\",\n \"payouts\":[{\n \"payoutPspRef\": \"8836251672789792\",\n \"payoutUTC\": \"2014-12-24T11:00:00\",\n \"payoutCurr\": \"USD\",\n \"payoutAmt\": 1234.56,\n \"wthhldAmt\": 1.23\n }]\n}Gets payment transaction records for the given record date and location. This API only returns data for customers using Oracle MICROS Payment Cloud Service.
The following example shows how to get the payment account holder details 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 https://baseurl/bi/v1/getPaymentChargebacks
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
The following example shows the contents of the response body in JSON format:
{\n \"recordDt\": \"2020-10-20\",\n \"locRef\": \"1234\",\n \"accounts\":[{\n \"acctCode\": \"8516212653197782\",\n \"revenueCenters\":[{\n \"rvcNum\": 123,\n \"chargebacks\":[{\n \"recordType\": \"REQUESTFORINFORMATION\",\n \"disputePspRef\": \"12345678\",\n \"pmntType\": \"PAY\",\n \"checkNum\": 1234,\n \"guestCheckID\": 123654,\n \"guestCheckLineItemId\": 123,\n \"disputeUTC\": \"2020-10-20T12:10:00\",\n \"transAmt\": 2.5,\n \"disputeCur\": \"USD\",\n \"disputeAmt\": 2.5,\n \"currStatus\": \"true\",\n \"chgbkSchemeCode\": \"Visa\",\n \"chgbkRsnCode\": \"12.6\",\n \"disputeRsn\": \"Duplicate Processing/Paid by Other Means\",\n \"pspRef\": \"8836251672789792\",\n \"busDt\": \"2020-10-20\",\n \"autodefense\": \"false\",\n \"disputeEndUTC\": \"2020-10-20T12:12:00\",\n \"modPspRef\": \"8036251672851715\",\n \"pymtID\": \"123456\",\n \"pymtDtlID\": \"123456\"\n }]\n }]\n }]\n}The following example shows how to view Control Daily totals for a specified location & business date 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\":123,\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getControlDailyTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2019-07-20\",\n \"eodStatus\": 1,\n \"lastUpdatedUTC\": \"2020-10-20T16:20:45\",\n \"lastUpdatedLcl\": \"2020-10-20T16:20:45\",\n \"firstTransUTC\": \"2019-07-20T13:02:00\",\n \"firstTransLcl\": \"2019-07-20T09:02:00\",\n \"lastTransUTC\": \"2019-07-20T22:01:26\",\n \"lastTransLcl\": \"2019-07-20T18:01:26\",\n \"revenueCenters\":[{\n \"rvcNum\": 123,\n \"numClsdChks\": 399,\n \"clsdChkTtl\": 14657.34,\n \"numOpnChksAtEOD\": 3,\n \"opnChkTtlAtEOD\": 50.99,\n \"numNonSlsTrans\": 19\n }]\n}The following example shows how to view all the operational daily totals by Job Codes for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getJobCodeDailyTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\":1372,\n \"jobCodes\":[{\n \"jcNum\": 12345,\n \"regHrs\": 123.45,\n \"regPay\": 1234.56,\n \"ovtHrs\": 123.45,\n \"ovtPay\": 1234.56.\n \"ovt2Hrs\": 123.45,\n \"ovt2Pay\": 1234.56,\n \"ovt3Hrs\": 123.45,\n \"ovt3Pay\": 1234.56,\n \"ovt4Hrs\": 123.45,\n \"ovt4Pay\": 1234.56\n }]\n }]\n}The following example shows how to view all the operational daily totals by employees for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getEmployeeDailyTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"employees\" [{\n \"empNum\": 12345,\n \"netSlsTtl\": 1234.56,\n \"itmDscTtl\": 1234.56,\n \"subDscTtl\": 1234.56,\n \"svcTtl\": 1234.56,\n \"nonRevSvcTtl\": 1234.56,\n \"rtrnCnt\": 123,\n \"rtrnTtl\": 1234.56,\n \"credTtl\": 1234.56,\n \"rndTtl\": 123.45,\n \"chngInGrndTtl\": 1234.56,\n \"tblTurnCnt\":123,\n \"dineTimeInMins\": 34,\n \"chkCnt\": 123,\n \"gstCnt\": 123,\n \"vdTtl\": 1234.56,\n \"vdCnt\": 123,\n \"errCorTtl\": 1234.56,\n \"errCorCnt\": 123,\n \"mngrVdTtl\": 1234.56,\n \"mngrVdCnt\": 123,\n \"transCnclTtl\": 123.45,\n \"transCnclCnt\": 123,\n \"carryoverTtl\": 123.45,\n \"carryoverCnt\": 123,\n \"chkOpnTtl\": 1234.56,\n \"chkOpnCnt\": 123,\n \"chkClsdTtl\": 1234.56,\n \"chkClsdCnt\": 123,\n \"chkXferInTtl\": 1234.56,\n \"chkXferInCnt\": 123,\n \"chkXferOutTtl\": 1234.56,\n \"chkXferOutCnt\": 123,\n \"chkClsdCnt\": 123,\n \"noSlsCnt\": 123,\n \"grossRcptsTtl\": 1234.56,\n \"chrgRcptsTtl\": 1234.56,\n \"chrgTipsTtl\": 1234.56,\n \"indirTipsPdTtl\": 1234.56,\n \"tipsDclrdTtl\": 1234.56,\n \"tipsPdTtl\":1234.56,\n \"tipTtl\": 1234.56,\n \"taxTtl\": 1234.56,\n \"tipsOutTtl\": 123.45\n }]\n }]\n}The following example shows how to view all the operational daily totals for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getOperationsDailyTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234,\n \"busDt\": \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\": 123,\n \"netSlsTtl\": 1234.56,\n \"itmDscTtl\": 1234.56,\n \"subDscTtl\": 1234.56,\n \"svcTtl\": 1234.56,\n \"nonRevSvcTtl\": 1234.56,\n \"rtrnCnt\": 123,\n \"rtrnTtl\": 1234.56,\n \"credTtl\": 1234.56,\n \"rndTtl\": 123.45,\n \"chngInGrndTtl\": 1234.56,\n \"nonTxblSlsTtl\": 1234.56,\n \"txblSlsTtl\": 1234.56,\n \"taxExmptSlsTtl\": 1234.56,\n \"taxCollTtl\": 1234.56,\n \"slsFcst\": 1234.56,\n \"prepCostTtl\": 1234.56,\n \"numTbl\": 10,\n \"tblTurnCnt\": 101,\n \"chkCnt\": 123,\n \"waitPtyCnt\": 123,\n \"waitTimeInMins\": 12\n \"gstCnt\": 123,\n \"dineTimeInMins\": 34,\n \"parkCarCnt\": 123,\n \"drvThruTimeInMins\": 12,\n \"vdTtl\": 1234.56,\n \"vdCnt\": 123,\n \"errCorTtl\": 1234.56,\n \"errCorCnt\": 123,\n \"mngrVdTtl\": 1234.56,\n \"mngrVdCnt\": 123,\n \"transCnclTtl\": 123.45,\n \"transCnclCnt\": 123,\n \"carryoverTtl\": 123.45,\n \"carryoverCnt\": 123,\n \"chkOpnTtl\": 1234.56,\n \"chkOpenCount\": 123,\n \"chkXferInTtl\": 1234.56,\n \"chkXferInCnt\": 123,\n \"chkXferOutTtl\": 1234.56,\n \"chkXferOutCnt\": 123,\n \"chkClsdTtl\": 1234.56,\n \"chkClsdCnt\": 123,\n \"overShortTtl\": 1234.56,\n \"noSlsCnt\": 123,\n \"trnChkTtl\": 134.56,\n \"trnChkCnt\": 12\n }]\n}The following example shows how to view all the menu item daily totals for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getMenuItemDailyTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt: \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"menuItems\":[{\n \"miNum\": 12345,\n \"prcLvlNum\": 1,\n \"ocNum\": 2,\n \"otNum\": 12345,\n \"slsTtl\": 1234.56,\n \"slsCnt\": 123,\n \"rtnCnt\": 123,\n \"dscTtl\": 1234.56,\n \"vol\": 1234.56,\n \"prepCost\": 1234.56,\n \"vatTtl\": 1234.567890,\n \"dscVatTtl\": 1234.567890,\n \"inclTaxTtl\": 14.45,\n \"forgivenInclTaxTtl\": 12.34\n }]\n }]\n}Get the Combo Item Daily Totals for a specified location and business date.
The following example shows how to view all the combo item daily totals for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getComboItemDailyTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2020-10-20\",\n \"revenueCenters\":{[\n \"rvcNum\": \"1234\",\n \"comboItems\":{[\n \"comboMiNum\": 124,\n \"componentMiNum\": 124,\n \"origMiNum\": 124,\n \"ocNum\": 2,\n \"otNum\": 12,\n \"slsCnt\": 1,\n \"slsTtl\": 12.34,\n \"dscTtl\": -2.3,\n \"vatTtl\": 1.21346,\n \"dscVatTtl\": 0.312345,\n \"components\":{[\n \"componentMiNum\": 235,\n \"origMiNum\": 235,\n \"ocNum\": 2,\n \"otNum\": 12,\n \"slsCnt\": 1,\n \"slsTtl\": 1.34,\n \"dscTtl\": -0.3,\n \"vatTtl\": 0.121346,\n \"dscVatTtl\": 0.0312345\n ]}\n ]}\n ]}\n}The following example shows how to view all the discount daily totals for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getDiscountDailyTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"discounts\":[{\n \"dscNum\": 12345,\n \"ttl\": 1234.56,\n \"cnt\": 123\n }]\n }]\n}The following example shows how to view all the service charge daily totals for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getServiceChargeDailyTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"serviceCharges\":[{\n \"svcNum\": 12345,\n \"ttl\": 1234.56,\n \"cnt\": 123\n }]\n }]\n}The following example shows how to view all the tender media daily totals for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getTenderMediaDailyTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"tenderMedias\":[{\n \"tmedNum\": 12345,\n \"ttl\": 1234.56,\n \"cnt\": 123\n }]\n }]\n}The following example shows how to view all the tax daily totals for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getTaxDailyTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"nonTxblSlsTtl\": 1024.42,\n \"taxes\":[{\n \"taxNum\": 12345,\n \"txblSlsTtl\": 1234.56,\n \"taxCollTtl\": 123.45\n \"taxExmptSlsTtl\": 123.45\n }]\n }]\n}The following example shows how to view all the order type daily totals for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getOrderTypeDailyTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"orderTypes\": [{\n \"ocNum\": 2,\n \"otNum\": 12345,\n \"netSlsTtl\": 1234.56,\n \"dscTtl\": 1234.56,\n \"svcTtl\": 1234.56,\n \"nonRevSvcTtl\": 1234.56,\n \"taxColTtl\": 1234.56,\n \"taxCredTtl\": 1234.56,\n \"prepCost\": 1234.56,\n \"rtrnCnt\": 123,\n \"rtrnTtl\": 1234.56,\n \"chkCnt\": 123, \n \"gstCnt\": 123,\n \"tblTurnCnt\": 123,\n \"dineTimeInMins\": 34,\n \"parkCarCnt\": 123,\n \"vdTtl\": 1234.56,\n \"vdCnt\": 123,\n \"errCorTtl\": 1234.56,\n \"errCorCnt\": 123,\n \"mngrVdTtl\": 1234.56,\n \"mngrVdCnt\": 123,\n \"transCnclTtl\": 123.45,\n \"transCnclCnt\": 1,\n \"chkOpnCnt\": 1234,\n \"chkClsdCnt\": 1234,\n \"sosTime1\": 1234,\n \"sosTime2\": 1234,\n \"sosTime3\": 1234,\n \"sosTime4\": 1234\n }]\n }]\n}The following example shows how to view all the order type daily totals for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getOrderChannelDailyTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"orderChannels\": [{\n \"ocNum\": 2,\n \"otNum\": 12345,\n \"netSlsTtl\": 1234.56,\n \"dscTtl\": 1234.56,\n \"svcTtl\": 1234.56,\n \"nonRevSvcTtl\": 1234.56,\n \"taxColTtl\": 1234.56,\n \"taxCredTtl\": 1234.56,\n \"prepCost\": 1234.56,\n \"rtrnCnt\": 123,\n \"rtrnTtl\": 1234.56,\n \"chkCnt\": 123, \n \"gstCnt\": 123,\n \"tblTurnCnt\": 123,\n \"dineTimeInMins\": 34,\n \"parkCarCnt\": 123,\n \"vdTtl\": 1234.56,\n \"vdCnt\": 123,\n \"errCorTtl\": 1234.56,\n \"errCorCnt\": 123,\n \"mngrVdTtl\": 1234.56,\n \"mngrVdCnt\": 123,\n \"transCnclTtl\": 123.45,\n \"transCnclCnt\": 1,\n \"chkOpnCnt\": 1234,\n \"chkClsdCnt\": 1234,\n \"sosTime1\": 1234,\n \"sosTime2\": 1234,\n \"sosTime3\": 1234,\n \"sosTime4\": 1234\n }]\n }]\n}Get the operations quarter hour totals for a specified location and business date.
The following example shows how to view all the operational quarter hour totals for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getOperationsQuarterHourTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234,\n \"busDt\": \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\": 123,\n \"quarterHours\":[{\n \"qtrHrNum\": 67,\n \"busHrNum\": 16,\n \"dpName\": \"All Day\",\n \"netSlsTtl\": 1234.56,\n \"itmDscTtl\": 1234.56,\n \"subDscTtl\": 1234.56,\n \"svcTtl\": 1234.56,\n \"nonRevSvcTtl\": 1234.56,\n \"rtrnCnt\": 123,\n \"rtrnTtl\": 1234.56,\n \"credTtl\": 1234.56,\n \"chngInGrndTtl\": 1234.56,\n \"nonTxblSlsTtl\": 1234.56,\n \"txblSlsTtl\": 1234.56,\n \"taxExmptSlsTtl\": 1234.56,\n \"taxCollTtl\": 1234.56,\n \"prepCostTtl\": 1234.56,\n \"tblTurnCnt\": 101,\n \"chkCnt\": 123,\n \"waitPtyCnt\": 123,\n \"waitTimeInMins\": 12\n \"gstCnt\": 123,\n \"dineTimeInMins\": 34,\n \"drvThruTimeInMins\": 12,\n \"vdTtl\": 1234.56,\n \"vdCnt\": 123,\n \"errCorTtl\": 1234.56,\n \"errCorCnt\": 123,\n \"mngrVdTtl\": 1234.56,\n \"mngrVdCnt\": 123,\n \"transCnclTtl\": 123.45,\n \"transCnclCnt\": 123,\n \"carryoverTtl\": 123.45,\n \"carryoverCnt\": 123,\n \"chkOpnTtl\": 1234.56,\n \"chkOpenCount\": 123,\n \"chkXferInTtl\": 1234.56,\n \"chkXferInCnt\": 123,\n \"chkXferOutTtl\": 1234.56,\n \"chkXferOutCnt\": 123,\n \"chkClsdTtl\": 1234.56,\n \"chkClsdCnt\": 123,\n \"overShortTtl\": 1234.56,\n \"noSlsCnt\": 123,\n \"trnChkTtl\": 134.56,\n \"trnChkCnt\": 12\n }]\n }]\n}Get the menu item quarter hour totals for a specified location and business date.
The following example shows how to view all the menu item quarter hour totals for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getMenuItemQuarterHourTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt: \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"quarterHours\": [{\n \"qtrHrNum\": 67,\n \"busHrNum\": 16,\n \"dpName\": \"All Day\",\n \"menuItems\":[{\n \"miNum\": 12345,\n \"prcLvlNum\": 1,\n \"ocNum\": 2,\n \"otNum\": 12345,\n \"slsTtl\": 1234.56,\n \"slsCnt\": 123,\n \"rtnCnt\": 123,\n \"dscTtl\": 1234.56,\n \"vol\": 1234.56,\n \"prepCost\": 1234.56,\n \"vatTtl\": 1234.567890,\n \"dscVatTtl\": 1234.567890,\n \"inclTaxTtl\": 14.45,\n \"forgivenInclTaxTtl\": 12.34\n }]\n }]\n }]\n}Get the combo item quarter hour totals for a specified location and business date.
The following example shows how to view all the combo item quarter hour totals for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getComboItemQuarterHourTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2020-10-20\",\n \"revenueCenters\":{[\n \"rvcNum\": \"1234\",\n \"quarterHours\": [{\n \"qtrHrNum\": 67,\n \"busHrNum\": 16,\n \"dpName\": \"All Day\",\n \"comboItems\":{[\n \"comboMiNum\": 124,\n \"componentMiNum\": 124,\n \"origMiNum\": 124,\n \"ocNum\": 2,\n \"otNum\": 12,\n \"slsCnt\": 1,\n \"slsTtl\": 12.34,\n \"dscTtl\": -2.3,\n \"vatTtl\": 1.21346,\n \"dscVatTtl\": 0.312345,\n \"components\":{[\n \"componentMiNum\": 235,\n \"origMiNum\": 235,\n \"ocNum\": 2,\n \"otNum\": 12,\n \"slsCnt\": 1,\n \"slsTtl\": 1.34,\n \"dscTtl\": -0.3,\n \"vatTtl\": 0.121346,\n \"dscVatTtl\": 0.0312345\n ]}\n ]}\n ]}\n ]}\n}Get the discount quarter hour totals for a specified location and business date.
The following example shows how to view all the discount quarter hour totals for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getDiscountQuarterHourTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"quarterHours\":[{\n \"qtrHrNum\": 67,\n \"busHrNum\": 16,\n \"dpName\": \"All Day\",\n \"discounts\":[{\n \"dscNum\": 12345,\n \"ttl\": 1234.56,\n \"cnt\": 123\n }]\n }]\n }]\n}Get the service charge quarter hour totals for a specified location and business date.
The following example shows how to view all the service charge quarter hour totals for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getServiceChargeQuarterHourTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"quarterHours\":[{\n \"qtrHrNum\": 67,\n \"busHrNum\": 16,\n \"dpName\": \"All Day\",\n \"serviceCharges\":[{\n \"svcNum\": 12345,\n \"ttl\": 1234.56,\n \"cnt\": 123\n }]\n }]\n }]\n}Get the tender media quarter hour totals for a specified location and business date.
The following example shows how to view all the tender media quarter hour totals for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getTenderMediaQuarterHourTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"quarterHours\":[{\n \"qtrHrNum\": 67,\n \"busHrNum\": 16,\n \"dpName\": \"All Day\",\n \"tenderMedias\":[{\n \"tmedNum\": 12345,\n \"ttl\": 1234.56,\n \"cnt\": 123\n }]\n }]\n }]\n}Get the order type quarter hour totals for a specified location and business date.
The following example shows how to view all the order type quarter hour totals for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getOrderTypeQuarterHourTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"quarterHours\":[{\n \"qtrHrNum\": 67,\n \"busHrNum\": 16,\n \"dpName\": \"All Day\",\n \"orderTypes\":[{\n \"ocNum\": 2,\n \"otNum\": 12345,\n \"netSlsTtl\": 1234.56,\n \"dscTtl\": 1234.56,\n \"svcTtl\": 1234.56,\n \"nonRevSvcTtl\": 1234.56,\n \"taxColTtl\": 1234.56,\n \"prepCost\": 1234.56,\n \"rtrnCnt\": 123,\n \"rtrnTtl\": 1234.56,\n \"chkCnt\": 123, \n \"gstCnt\": 123,\n \"tblTurnCnt\": 123,\n \"dineTimeInMins\": 34,\n \"vdTtl\": 1234.56,\n \"vdCnt\": 123,\n \"errCorTtl\": 1234.56,\n \"errCorCnt\": 123,\n \"mngrVdTtl\": 1234.56,\n \"mngrVdCnt\": 123,\n \"transCnclTtl\": 123.45,\n \"transCnclCnt\": 1,\n \"chkOpnCnt\": 1234,\n \"chkClsdCnt\": 1234\n }]\n }]\n }]\n}Get the job code quarter hour totals for a specified location and business date.
The following example shows how to view all the operational quarter hour totals by Job Codes for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getJobCodeQuarterHourTotals
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\":1372,\n \"quarterHours\":[{\n \"qtrHrNum\": 67,\n \"busHrNum\": 16,\n \"dpName\": \"All Day\",\n \"jobCodes\":[{\n \"jcNum\": 12345,\n \"regHrs\": 123.45,\n \"regPay\": 1234.56,\n \"ovtHrs\": 123.45,\n \"ovtPay\": 1234.56\n }]\n }]\n }]\n}The following example shows how to view the Kitchen performance for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getKDSDetails
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
The following example shows the contents of the response body in JSON format:
{\n \"curUTC\": \"2019-07-20T17:59:59\",\n \"locRef\": \"1234\",\n \"busDt\": \"2020-07-20\",\n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"orders\":[{\n \"guestCheckId\": 137243,\n \"stationName\": \"Station 1\",\n \"startTime\": \"2019-07-20T15:59:59\",\n \"startTimeUTC\": \"2019-07-20T14:59:59\",\n \"startTimeLcl\": \"2019-07-20T10:59:59\",\n \"serviceRoundNum\": 1,\n \"prepTimeInSecs\": 1234,\n \"isAppetizerFlag\": false,\n \"menuItemCount\": 5,\n \"recallCount\": 1,\n \"highPriorityFlag\": true,\n \"subOrders\":[{\n \"subOrderId\": 123,\n \"miDefSeq\": 1,\n \"miNum\": 123,\n \"postTimeUTC\": \"2019-07-20T14:59:59\",\n \"postTimeLcl\": \"2019-07-20T10:59:59\",\n \"actualPrepTimeInSecs\": 123,\n \"miPrepTimeInSecs\": 123,\n \"miMod\": \"Menu Item Modifier\"\n }]\n }]\n }]\n}The following example shows how to view Fiscal Invoice Data for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getFiscalInvoiceData
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2019-07-19\", \n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"invoiceData\":[{\n \"wsNum\": 23,\n \"fcrInvNum\": \"INV01\",\n \"customerDataNum\": \"CUST123\",\n \"opnBusDt\": \"2019-07-19\",\n \"checkNum\": 414798,\n \"guestCheckId\": 123,\n \"invoiceType\": 1,\n \"invoiceStatus\": 1,\n \"fcrBusinessDt\": \"2019-07-19\",\n \"subTotal1\": 1234.56,\n \"subTotal2\": 1234.56,\n \"subTotal3\": 1234.56,\n \"subTotal4\": 1234.56,\n \"subTotal5\": 1234.56,\n \"subTotal6\": 1234.56,\n \"subTotal7\": 1234.56,\n \"subTotal8\": 1234.56,\n \"subTotal9\": 1234.56,\n \"subTotal10\": 1234.56,\n \"subTotal11\": 1234.56,\n \"subTotal12\": 1234.56,\n \"subTotal13\": 1234.56,\n \"subTotal14\": 1234.56,\n \"taxTotal1\": 1234.56,\n \"taxTotal2\": 1234.56,\n \"taxTotal3\": 1234.56,\n \"taxTotal4\": 1234.56,\n \"taxTotal5\": 1234.56,\n \"taxTotal6\": 1234.56,\n \"taxTotal7\": 1234.56,\n \"taxTotal8\": 1234.56,\n \"taxTotal9\": 1234.56,\n \"taxTotal10\": 1234.56,\n \"taxTotal11\": 1234.56,\n \"taxTotal12\": 1234.56,\n \"taxTotal13\": 1234.56,\n \"taxTotal14\": 1234.56,\n \"taxTotal15\": 1234.56,\n \"taxTotal16\": 1234.56,\n \"invDataInfo1\": \"Inv Info\",\n \"invDataInfo2\": \"Inv Info\",\n \"invDataInfo3\": \"Inv Info\",\n \"invDataInfo4\": \"Inv Info\",\n \"invDataInfo5\": \"Inv Info\",\n \"invDataInfo6\": \"Inv Info\",\n \"invDataInfo7\": \"Inv Info\",\n \"invDataInfo8\": \"Inv Info\",\n \"invDataInfo9\": \"Inv Info\",\n \"invDataInfo10\": \"Inv Info\",\n \"invDataInfo11\": \"Inv Info\",\n \"invDataInfo12\": \"Inv Info\",\n \"invDataInfo13\": \"Inv Info\",\n \"invDataInfo14\": \"Inv Info\",\n \"invDataInfo15\": \"Inv Info\",\n \"invDataInfo16\": \"Inv Info\",\n \"fcrIdentifier\": 987,\n \"storeIdentifier\": 654,\n \"deviceIdentifier\": \"ID01\",\n \"documentType\": \"D01\",\n \"dataType\": \"T01\",\n \"sysDocIdentifier\": 1234.56,\n \"fiscalKey\": \"KEY01\",\n \"json\": \"[{Country / Transaction specific fiscal data}]\",\n \"extraDate1\": \"2019-07-01T13:00:00\",\n \"extraDate2\": \"2019-07-01T13:00:00\",\n \"extraDate3\": \"2019-07-01T13:00:00\",\n \"extraDate4\": \"2019-07-01T13:00:00\",\n \"extraDate5\": \"2019-07-01T13:00:00\"\n }]\n}]\n}The following example shows how to view Fiscal Total Data for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getFiscalTotalData
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2019-07-19\", \n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"totalData\":[{\n \"wsNum\": 23,\n \"fcrBusDt\": \"2019-07-19\",\n \"fcrNum1\": \"Num1\",\n \"fcrNum2\": \"Num2\",\n \"fcrInfo1\": \"Info\",\n \"fcrInfo2\": \"Info\",\n \"fcrInfo3\": \"Info\",\n \"fcrInfo4\": \"Info\",\n \"fcrInfo5\": \"Info\",\n \"fcrInfo6\": \"Info\",\n \"fcrInfo7\": \"Info\",\n \"fcrInfo8\": \"Info\",\n \"fcrInfo9\": \"Info\",\n \"fcrInfo10\": \"Info\",\n \"fcrInfo11\": \"Info\",\n \"fcrInfo12\": \"Info\",\n \"fcrInfo13\": \"Info\",\n \"fcrInfo14\": \"Info\",\n \"fcrInfo15\": \"Info\",\n \"fcrInfo16\": \"Info\"\n \"json\": \"[{Country / Transaction specific fiscal data}]\",\n }]\n }]\n}The following example shows how to view Fiscal Invoice Control Data for a specified location & business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getFiscalInvoiceControlData
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2019-07-20\", \n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"invoiceControlData\":[{\n \"wsNum\": 23,\n \"invoiceType\": 1,\n \"series\": \"S01\",\n \"startInvNum\": 1,\n \"endInvNum\": 99999999,\n \"status\": 0,\n \"currInvNum\": 8877,\n \"lockedBy\": 0,\n \"resolutionDt\": \"2019-07-01\",\n \"invcontrolInfo1\": \"Control Info\",\n \"invcontrolInfo2\": \"Control Info\",\n \"invcontrolInfo3\": \"Control Info\",\n \"invcontrolInfo4\": \"Control Info\",\n \"invcontrolInfo5\": \"Control Info\",\n \"invcontrolInfo6\": \"Control Info\",\n \"invcontrolInfo7\": \"Control Info\",\n \"invcontrolInfo8\": \"Control Info\",\n \"invcontrolInfo9\": \"Control Info\",\n \"invcontrolInfo10\": \"Control Info\",\n \"invcontrolInfo11\": \"Control Info\",\n \"invcontrolInfo12\": \"Control Info\"\n \"invcontrolInfo12\": \"Control Info\"\n \"json\": \"[{Country / Transaction specific fiscal data}]\",\n }]\n }]\n}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
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
The following example shows the contents of the response body in JSON format:
{\n \"curUTC\": \"2020-10-20T16:42:42\",\n \"locRef\" : \"SAC\",\n \"guestChecks\": [{\n \"guestCheckId\": 829084,\n \"chkNum\": 9735,\n \"chkName\": \"Check\",\n \"opnBusDt\": \"2020-10-20\",\n \"opnUTC\": \"2020-10-20T15:41:54\",\n \"opnLcl\": \"2020-10-20T11:41:54\",\n \"clsdBusDt\": \"2020-10-20\",\n \"clsdUTC\": \"2020-10-20T16:20:44\",\n \"clsdLcl\": \"2020-10-20T12:20:44\",\n \"reopnClsdChkClsdBusDt\": \"2020-10-20\",\n \"reopnClsdChkClsdUTC\": \"2020-10-20T16:20:44\",\n \"reopnClsdChkClsdLcl\": \"2020-10-20T12:20:44\",\n \"lastUpdatedUTC\": \"2020-10-20T16:20:45\",\n \"lastUpdatedLcl\": \"2020-10-20T12:20:45\",\n \"lastTransUTC\": \"2020-10-20T12:20:45\",\n \"lastTransLcl\": \"2020-10-20T12:20:45\",\n \"clsdFlag\": true,\n \"cancelFlag\": false,\n \"gstCnt\": 2,\n \"subTtl\": 16.66,\n \"autoSvcTtl\": 0.00,\n \"svcChgTtl\": 3.5,\n \"nonTxblSlsTtl\": 123.45,\n \"taxExmpSlsTtl\": 0.00,\n \"taxCollTtl\": 0.83,\n \"chkTtl\": 20.99,\n \"dscTtl\": -5,\n \"payTtl\": 15.00,\n \"tipTotal\": 3.5,\n \"balDueTtl\": 0.99,\n \"rndTtl\": 21.00,\n \"reopnFrmChk\": 9736,\n \"reopnToChk\": 9738,\n \"spltFrmChk\": 9735,\n \"rvcNum\": 1,\n \"ocNum\": 2,\n \"otNum\": 12,\n \"tblNum\": 1,\n \"tblName\": \"5\",\n \"empNum\": 258,\n \"chkInfo\": \"Check Info\",\n \"chkRef\": \"Check Reference\",\n \"xferStatus\": \"X\",\n \"xferToChkNum\": 8,\n \"autoFireUTC\": \"2020-10-20T12:20:45\",\n \"autoFireLcl\": \"2020-10-20T12:20:45\",\n \"numSrvcRd\": 2,\n \"vdTtl\": 12.34,\n \"mgrVdTtl\": 12.34,\n \"returnTtl\": 12.34,\n \"errorCorrectTtl\": 12.34,\n \"reopnClsdChkFlag\": false,\n \"reopnClsdChkOpnLcl\": \"2020-10-20T12:19:44\",\n \"reopnClsdChkOpnUTC\": \"2020-10-20T12:19:44\",\n \"reopnClsdChkOpnBusDt\": \"2020-10-20\",\n \"numChkPrntd\": 1,\n \"splitOut\": 1,\n \"addedIn\": 1,\n \"inclTaxExmpTtl\": 1.82,\n \"autoClsdFlag\": true,\n \"taxes\": [{\n \"taxNum\": 1,\n \"txblSlsTtl\": 12.34,\n \"taxCollTtl\": 0.83,\n \"taxRate\": 19,\n \"taxType\": 3,\n \"taxExmptTtl\": 12.34\n }],\n \"detailLines\": [{\n \"guestCheckLineItemId\": 9433187,\n \"lineNum\": 1,\n \"dtlId\": 17,\n \"parDtlId\": 0,\n \"detailUTC\": \"2020-10-20T15:42:08\",\n \"detailLcl\": \"2020-10-20T11:42:08\",\n \"busDt\": \"2020-10-20\",\n \"lastUpdatedUTC\": \"2020-10-20T12:20:45\",\n \"lastUpdatedLcl\": \"2020-10-20T12:20:45\",\n \"rvcNum\": 152,\n \"prepCost\": 0.481,\n \"weight\": 1.23,\n \"vdFlag\": false,\n \"errCorFlag\": false,\n \"wsNum\": 6,\n \"refInfo1\": \"reference info 1\",\n \"refInfo2\": \"reference info 2\",\n \"dspTtl\": 2.09,\n \"dspQty\": 1,\n \"aggTtl\": 2.09,\n \"aggQty\": 1,\n \"doNotShowFlag\": false,\n \"chkEmpNum\": 69405,\n \"transEmpNum\": 69405,\n \"mgrEmpNum\": null,\n \"rsnCodeNum\": null,\n \"svcRndNum\": 1,\n \"cashierNum\": null,\n \"dtlOcNum\": 2,\n \"dtlOtNum\": 123,\n \"seatNum\": 1,\n \"numerator\": 1,\n \"denominator\": 3,\n \"menuItem\": {\n \"miNum\": 3401,\n \"comboMealSeq\": 1,\n \"comboSideSeq\": 1,\n \"comboGrpNum\": 101,\n \"modFlag\": false,\n \"modPrfx\": 1,\n \"inclTax\": 0,\n \"returnFlag\": false,\n \"activeTaxes\": {1},\n \"prcLvl\": 1\n }\n },\n {\n \"guestCheckLineItemId\": 9433353,\n \"lineNum\": 21,\n \"dtlId\": 37,\n \"parDtlId\": 20,\n \"detailUTC\": \"2020-10-20T16:06:06\",\n \"detailLcl\": \"2020-10-20T12:06:06\",\n \"busDt\": \"2020-10-20\",\n \"rvcNum\": 152,\n \"prepCost\": 0,\n \"vdFlag\": false,\n \"errCorFlag\": false,\n \"wsNum\": 5,\n \"refInfo1\": \"SV012003621910405\",\n \"refInfo2\": null,\n \"dspTtl\": -2.19,\n \"dspQty\": 1,\n \"aggTtl\": -2.19,\n \"aggQty\": 0,\n \"doNotShowFlag\": true,\n \"chkEmpNum\": 69405,\n \"chkEmpId\": 123435,\n \"transEmpId\": 123435,\n \"mgrEmpId\": 123435,\n \"transEmpNum\": 69405,\n \"mgrEmpNum\": null,\n \"rsnCodeNum\": null,\n \"svcRndNum\": 4,\n \"cashierNum\": null,\n \"dtlOtNum\": 123,\n \"seatNum\": 1,\n \"numerator\": 1,\n \"denominator\": 3,\n \"discount\": {\n \"dscNum\": 210,\n \"dscMiNum\": 1509,\n \"mealEmpNum\": null,\n \"vatTaxTtl\": 0,\n \"inclTax\": 123.456789,\n \"activeTaxes\": \"1,2,5\"\n }\n },\n {\n \"guestCheckLineItemId\": 9433400,\n \"lineNum\": 3,\n \"dtlId\": 0,\n \"parDtlId\": 0,\n \"detailUTC\": \"2020-10-20T16:20:45\",\n \"detailLcl\": \"2020-10-20T12:20:45\",\n \"busDt\": \"2020-10-20\",\n \"rvcNum\": 152,\n \"prepCost\": 0,\n \"vdFlag\": false,\n \"errCorFlag\": false,\n \"wsNum\": 5,\n \"refInfo1\": null,\n \"refInfo2\": null,\n \"dspTtl\": 3.5,\n \"dspQty\": 1,\n \"aggTtl\": 3.5,\n \"aggQty\": 1,\n \"doNotShowFlag\": false,\n \"chkEmpNum\": 69405,\n \"transEmpNum\": 69405,\n \"mgrEmpNum\": null,\n \"rsnCodeNum\": null,\n \"svcRndNum\": 6,\n \"cashierNum\": null,\n \"dtlOtNum\": 123,\n \"seatNum\": 1,\n \"numerator\": 1,\n \"denominator\": 3,\n \"serviceCharge\": {\n \"svcChgNum\": 101,\n \"inclTax\": 123.456789,\n \"activeTaxes\": \"1,2,5\"\n }\n },\n {\n \"guestCheckLineItemId\": 9433401,\n \"lineNum\": 4,\n \"dtlId\": 0,\n \"parDtlId\": 0,\n \"detailUTC\": \"2020-10-20T16:20:45\",\n \"detailLcl\": \"2020-10-20T12:20:45\",\n \"busDt\": \"2020-10-20\",\n \"rvcNum\": 152,\n \"prepCost\": 0,\n \"vdFlag\": false,\n \"errCorFlag\": false,\n \"wsNum\": 5,\n \"refInfo1\": \"XXXXXXXXXXX6008\",\n \"refInfo2\": null,\n \"dspTtl\": 3.5,\n \"dspQty\": 1,\n \"aggTtl\": 3.5,\n \"aggQty\": 1,\n \"doNotShowFlag\": true,\n \"chkEmpNum\": 69405,\n \"transEmpNum\": 69405,\n \"mgrEmpNum\": null,\n \"rsnCodeNum\": null,\n \"svcRndNum\": 6,\n \"cashierNum\": null,\n \"dtlOtNum\": 123,\n \"seatNum\": 1,\n \"numerator\": 1,\n \"denominator\": 3,\n \"tenderMedia\": {\n \"tmedNum\": 503,\n \"mealEmpNum\": 258\n }\n },\n {\n \"guestCheckLineItemId\": 9433402,\n \"lineNum\": 39,\n \"dtlId\": 55,\n \"parDtlId\": 0,\n \"detailUTC\": \"2011-01-17T16:20:45\",\n \"detailLcl\": \"2011-01-17T12:20:45\",\n \"busDt\": \"2011-01-17\",\n \"rvcNum\": 152,\n \"prepCost\": 0,\n \"vdFlag\": false,\n \"errCorFlag\": false,\n \"wsNum\": 5,\n \"refInfo1\": \"XXXXXXXXXXX6008\",\n \"refInfo2\": null,\n \"dspTtl\": 0,\n \"dspQty\": 0,\n \"aggTtl\": 20.99,\n \"aggQty\": 0,\n \"doNotShowFlag\": false,\n \"chkEmpNum\": 69405,\n \"transEmpNum\": 69405,\n \"mgrEmpNum\": null,\n \"rsnCodeNum\": null,\n \"svcRndNum\": 6,\n \"cashierNum\": null,\n \"dtlOtNum\": 123,\n \"seatNum\": 1,\n \"numerator\": 1,\n \"denominator\": 3,\n \"other\": {\n \"detailType\": 6,\n \"detailNum\": 53415\n }\n },\n {\n \"guestCheckLineItemId\": 9433409,\n \"lineNum\": 40,\n \"dtlId\": 56,\n \"parDtlId\": 0,\n \"detailUTC\": \"2011-01-17T16:20:45\",\n \"detailLcl\": \"2011-01-17T12:20:45\",\n \"busDt\": \"2011-01-17\",\n \"rvcNum\": 152,\n \"prepCost\": 0,\n \"vdFlag\": false,\n \"errCorFlag\": false,\n \"wsNum\": 5,\n \"refInfo1\": \"XXXXXXXXXXX6008\",\n \"refInfo2\": null,\n \"dspTtl\": 0,\n \"dspQty\": 0,\n \"aggTtl\": 20.99,\n \"aggQty\": 0,\n \"doNotShowFlag\": false,\n \"chkEmpNum\": 69405,\n \"transEmpNum\": 69405,\n \"mgrEmpNum\": null,\n \"rsnCodeNum\": null,\n \"svcRndNum\": 6,\n \"cashierNum\": null,\n \"dtlOtNum\": 123,\n \"seatNum\": 1,\n \"numerator\": 1,\n \"denominator\": 3,\n \"errorCorrect\": {\n \"type\": 1,\n \"objectNum\": 123\n }\n }]\n }]\n}The following example shows how to get the point of sale journal log details for a specified location and business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getPOSJournalLogDetails
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2020-10-20\",\n \"revenueCenters\" [{\n \"rvcNum\": 1372,\n \"logDetails\":[{\n \"guestCheckId\": 123,\n \"type\": 1,\n \"transId\": 1,\n \"transUTC\": \"2019-10-20T15:59:59\",\n \"transLcl\": \"2019-10-20T11:59:59\",\n \"journalTxt\": \"Journal Text\", \n \"wsNum\": 123,\n \"empNum\": 1234\n }]\n }]\n}The following example shows how to get the non-sales transaction details for a specified location and 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\",\"busDt\":\"2020-10-20\",\"transSinceUTC\":\"2020-10-20T16:00:00\"} https://baseurl/bi/v1/orgidentifier/getNonSalesTransactions
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
The following example shows the contents of the response body in JSON format:
{\n \"curUTC\": \"2020-10-20T17:59:59\",\n \"locRef\": \"1234\",\n \"busDt\": \"2019-10-20\", \n \"nonSalesTransactions\": [{\n \"transUTC\": \"2020-10-20T16:16:10\",\n \"transLcl\": \"2020-10-20T12:16:10\",\n \"transType\": 4,\n \"tmedNum\": 3691,\n \"chkNum\": 414798,\n \"empNum\": 6128,\n \"wsNum\": 354,\n \"value\": 1234.56,\n \"refInfo\": \"This is an example\",\n \"rsnCodeNum\": 2632,\n \"guestCheckId\": 1234,\n \"rvcNum\": 123\n }]\n}The following example shows how to get the point of sale waste details for a specified location and business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getPOSWasteDetails
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
The following example shows the contents of the response body in JSON format:
{\n \"curUTC\": \"2020-10-20T16:42:42\",\n \"locRef\": \"1234\",\n \"busDt\": \"2020-07-20\",\n \"revenueCenters\": [{\n \"rvcNum\": 1372,\n \"menuItems\": [{\n \"miNum\": 123,\n \"rsnCodeNum\": 12,\n \"empNum\": 123,\n \"qty\": 2.23,\n \"weight\": 1.15,\n \"amt\": 12.56,\n \"cost\": 10.32,\n \"prcLvl\": 1,\n \"transUTC\": \"2019-07-20T15:59:59\",\n \"transLcl\": \"2019-07-20T11:59:59\"\n }]\n }]\n}The following example shows how to get the guest check extensibility details for a specified location and business date 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\",\"opnBusDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getGuestCheckExtensibilityDetails
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef: \"1234\",\n \"opnBusDt\": \"2020-07-20\",\n \"revenueCenters\": [{\n \"rvcNum\": 1372,\n \"guestChecks\": [{\n \"guestCheckId\": 124354,\n \"extAppId\": 123,\n \"extDataName\": \"Extensibility Data\",\n \"strData\": \"Extension string\",\n \"dspName\": \"Name\"\n }]\n }]\n}The following example shows how to get the guest check extensibility details for a specified location and business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getGuestCheckLineItemExtDetails
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef: \"1234\",\n \"busDt\": \"2020-10-20\",\n \"revenueCenters\": [{\n \"rvcNum\": 1372,\n \"detailLines\": [{\n \"guestCheckId\": 124354,\n \"guestCheckLineItemIdId\": 134567,\n \"extAppId\": 123,\n \"extDataName\": \"Extensibility Data\",\n \"strData\": \"Extension string\",\n \"dspName\": \"Name\"\n }]\n }]\n}The API gets credit card payment transaction records for the given business date and location. This API returns data for customer who are using the Simphony Payment Interface (SPI). It does not return data for customers of Oracle MICROS Payment Cloud Service.
The following example shows how to get the payment detail for a specified location and 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\",\"busDt\":\"2020-10-20\",\"changedSinceUTC\":\"2020-10-20T13:00:00\"} https://baseurl/bi/v1/orgidentifier/getSPIPaymentDetails
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
The following example shows the contents of the response body in JSON format:
{\n \"busDt\": \"2020-10-20\",\n \"locRef: \"1234\",\n \"curUTC\": \"2020-10-20T14:00:00\",\n \"revenueCenters\":[{\n \"rvcNum\": 123,\n \"transactions\":[{\n \"pspRef\": \"VNV7FG58XCGMMM52\",\n \"chkNum\": 7,\n \"guestCheckID\": 124563,\n \"guestCheckLineItemId\": 123,\n \"amt\": 123.45,\n \"tip\": 123.45,\n \"transUTC\": \"2019-07-20T13:58:58\",\n \"transLcl\": \"2019-07-20T07:58:58\",\n \"pmntType\": \"PAY\",\n \"tmedNum\": 15253,\n \"seqNum\": \"670086133130\",\n \"wsNum\": 1,\n \"empNum\": 12345,\n \"terminalID\": \"P400Plus-804139629\",\n \"entryMode\": 1,\n \"authCode\": \"03587B\",\n \"cardAlias\": \"76349057583904834AB\",\n \"offlineFlag\": \"true\",\n \"rrn\": \"SH5JZZ2GSM2J8HH2\",\n \"cardPresentType\": 1,\n \"transCurrency\": 826,\n \"posClientVer\": \"19.6.1.0.28\",\n \"cardPresentFlag\": \"true\"\n }]\n }]\n}Gets the payment account holder details. This API only returns data for customers using Oracle MICROS Payment Cloud Service.
The following example shows how to get the payment account holder details 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 https://baseurl/bi/v1/orgidentifier/getPaymentAccountHolderDimensions
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
The following example shows the contents of the response body in JSON format:
{\n \"accountHolders\":[{\n \"acctHldrCode\": \"123456789\",\n \"acctHldrName\": \"Customer 1\",\n \"stlmtCur\": \"USD\",\n \"acctHldrStatus\": 2,\n \"verification\": 1,\n \"busEmail\": \"abc@corporate.com\",\n \"phoneNum\": \"9876543210\",\n \"webAddr\": \"www.abc.com\",\n \"streetNum\": \"12345\",\n \"streetName\": \"Boulevard Avenue\",\n \"city\": \"Atlanta\",\n \"state\": \"GA\",\n \"zip\": \"12345\",\n \"countryCode\": \"US\",\n \"createdDt\": \"2021-04-12\"\n }]\n}Gets the payments account details. This API only returns data for customers using Oracle MICROS Payment Cloud Service.
The following example shows how to get the payments account details 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\"} https://baseurl/bi/v1/orgidentifier/getPaymentAccountDimensions
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"accounts\":[{\n \"acctHldrCode\": \"123456789\",\n \"acctCode\": \"8516212653197782\",\n \"acctName\": \"Account 1\",\n \"createdDt\": \"2021-05-17\",\n \"acctStatus\": 1,\n \"ccStmtName\": \"Account 1\"\n }]\n}The following example shows how to view all Cash Management details for a specified location and business date 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\",\"busDt\":\"2020-10-20\"} https://baseurl/bi/v1/orgidentifier/getCashManagementDetails
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
The following example shows the contents of the response body in JSON format:
{\n \"locRef\": \"1234\",\n \"busDt\": \"2020-10-20\",\n \"revenueCenters\":[{\n \"rvcNum\": 1372,\n \"cmDetails\":[{\n \"cmItemNum\": 1372,\n \"receptacleType\": 1,\n \"receptacleName\": \"Safe\",\n \"receptacleNum\": 123,\n \"startAmt\": 123.45,\n \"transAmt\": 123.45,\n \"overShortAmt\": 123.45,\n \"depAmt\": 1234.56\n \"transUTC\": \"2020-10-20T15:59:59\",\n \"transLcl\": \"2020-10-20T11:59:59\",\n \"transEmpNum\":1234,\n \"refInfo\": \"Manually Entered Text\",\n \"transType\": 1,\n \"rsnCodeNum\": 123,\n \"wsNum\": 123,\n \"notes\": \"Notes\",\n \"othrAmt\": 123.45,\n \"guestCheckId\": 345667,\n \"tmedNum\": 1234,\n \"balanceAmt\": 55.55,\n \"actBusDate\": \"2020-10-20\",\n \"sessionNum\": 12345,\n \"targetReceptacleNum\": 12345,\n \"targetSessionNum\": 12345\n }]\n }]\n}The API is first available in version 20.2
The following example shows how to view time card and related sales information for a specified employee in a given location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H \"Authorization: Bearer\" -H \"Content-Type:application/json\" -d {\"busDt\":\"2020-10-20\",\"locRef\":\"1234\"} https://baseurl/bi/v1/orgidentifier/getTimeCardDetails
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
The following example shows the contents of the response body in JSON format:
{\n \"curUTC\": \"2024-05-31T17:59:59\",\n \"locRef\": \"1234\",\n \"businessDates\": [{\n \"busDt\": \"2024-05-31\",\n \"timeCardDetails\": [{\n \"tcId\": 15253,\n \"lastUpdatedUTC\": \"2024-05-31T10:00:00\",\n \"addedUTC\": \"2024-05-31T10:00:00\",\n \"empNum\": 1234,\n \"payrollID\": \"12345\",\n \"extPayrollID\": \"123789\",\n \"jobCodeRef\": \"3\",\n \"clkInAuthEmpNum\": 12345,\n \"clkOutAuthEmpNum\": 12345,\n \"jcNum\": 123,\n \"rvcNum\": 1,\n \"shftNum\": 1,\n \"clkInLcl\": \"2024-05-31T10:00:00\",\n \"clkInUTC\": \"2024-05-31T10:00:00\",\n \"clkInStatus\": 84,\n \"clkOutLcl\": \"2024-05-31T14:30:00\",\n \"clkOutUTC\": \"2024-05-31T14:30:00\",\n \"clkOutStatus\": 84,\n \"payRt\": 100.0,\n \"regHrs\": 3.54,\n \"regPay\": 354.0,\n \"ovt1Hrs\": 1.0,\n \"ovt1Pay\": 1.5,\n \"ovt2Hrs\": 2.0,\n \"ovt2Pay\": 2.5,\n \"ovt3Hrs\": 3.0,\n \"ovt3Pay\": 3.5,\n \"ovt4Hrs\": 4.0,\n \"ovt4Pay\": 4.5,\n \"premHrs\": 4.0,\n \"premPay\": 4.5,\n \"shftType\": 1,\n \"grossRcpts\": 1234.56,\n \"chrgRcpts\": 1234.56,\n \"chrgTips\": 1234.56,\n \"drctTips\": 1234.56,\n \"indirTips\": 1234.56,\n \"svcTips\": 1234.56,\n \"tipsPd\": 1234.56,\n \"adjustments\": [{\n \"adjId\": 123456789,\n \"adjUTC\": \"2024-05-31T14:30:00\",\n \"mgrName\": \"J Doe\",\n \"prevJcNum\": 1,\n \"prevRVCNum\": 1,\n \"prevClkInLcl\": \"2024-05-31T10:00:00\",\n \"prevClkInUTC\": \"2024-05-31T10:00:00\",\n \"prevClkOutLcl\": \"2024-05-31T10:00:00\",\n \"prevClkOutUTC\": \"2024-05-31T10:00:00\",\n \"prevDrctTips\": 1234.56,\n \"prevIndirTipsPd\": 1234.56,\n \"rsn\": \"Clocked out late\"\n }]\n }]\n }]\n }First Available Version: 20.1.8.3
", "title":"Software Version", "maxLength":99 } }, "required":[ "curUTC", "locRef", "latestBusDt", "softwareVersion" ] }, "workStation":{ "description":"The response body contains information about a workstation for the specified location.", "properties":{ "wsNum":{ "type":"integer", "description":"Workstation number", "title":"Workstation Number", "maxLength":16 }, "wsName":{ "type":"string", "description":"Workstation Name. This attribute will not be returned in the response if value is null", "title":"Workstation Name", "maxLength":99 } }, "required":[ "wsNum", "wsName" ] }, "location":{ "description":"The response body contains information about a specified location.", "properties":{ "name":{ "type":"string", "description":"Name of the location", "title":"Name", "maxLength":99 }, "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "openDt":{ "type":"string", "description":"The date this location was opened", "title":"Open Date", "format":"date" }, "active":{ "type":"boolean", "description":"Flag indicating if this location is active or not", "title":"Active" }, "srcName":{ "type":"string", "description":"The name of the POS system associated with this location", "title":"Source Name", "maxLength":99 }, "srcVer":{ "type":"string", "description":"The POS version associated with this location", "title":"Source Version", "maxLength":99 }, "tz":{ "type":"string", "description":"Time zone configured at the location", "title":"Time Zone", "maxLength":99 }, "curr":{ "type":"string", "description":"Abbreviation of the currency configured at the location. This attribute will not be returned in the response if value is null", "title":"Currency", "maxLength":3 }, "addrLn1":{ "type":"string", "description":"Address Line 1. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Address Line 1", "maxLength":250 }, "addrLn2":{ "type":"string", "description":"Address Line 2. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Address Line 2", "maxLength":250 }, "addrLn3":{ "type":"string", "description":"Address Line 3. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Address Line 3", "maxLength":250 }, "postalCode":{ "type":"string", "description":"ZIP or Postalcode. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"ZIP or Postalcode", "maxLength":20 }, "phone":{ "type":"string", "description":"Telephone number. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Telephone number", "maxLength":20 }, "phoneCountryCode":{ "type":"string", "description":"Telephone country code. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Telephone country code", "maxLength":2 }, "countryCode":{ "type":"string", "description":"Two character country code as defined in ISO 3166-2 standard. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Two character country code", "maxLength":2 }, "countryName":{ "type":"string", "description":"Country name as defined in ISO 3166-2 standard. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Country name", "maxLength":50 }, "regionCode":{ "type":"string", "description":"Region code as defined in ISO 3166-2 standard for subdivisions. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Region code", "maxLength":6 }, "regionName":{ "type":"string", "description":"Region name as defined in ISO 3166-2 standard for subdivisions. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Region name", "maxLength":40 }, "workstations":{ "type":"array", "description":"An array of workstations. This attribute will not be returned in the response if there are no workstations associated", "title":"Workstations", "items":{ "$ref":"#/definitions/workStation" } } }, "required":[ "name", "locRef", "openDt", "active", "srcName", "srcVer", "workstations", "tz", "curr" ] }, "locationDimensions":{ "properties":{ "locations":{ "type":"array", "description":"An array of Location Dimensions", "items":{ "$ref":"#/definitions/location" } } }, "required":[ "locations" ] }, "revenueCenter":{ "description":"The response body contains information about the revenue center for the specified location.", "properties":{ "num":{ "type":"integer", "description":"Revenue Center number", "title":"Number", "maxLength":16 }, "name":{ "type":"string", "description":"Revenue Center Name", "title":"Name", "maxLength":99 }, "mstrNum":{ "type":"integer", "description":"The master Revenue Center number", "title":"Master Number", "maxLength":16 }, "mstrName":{ "type":"string", "description":"The master Revenue Center name", "title":"Master Name", "maxLength":99 }, "catGrpHierName1":{ "type":"string", "description":"Category Group Hierarchy #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #1 assigned to the master item", "maxLength":40 }, "catGrpName1":{ "type":"string", "description":"Category Group #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #1 assigned to the master item", "maxLength":20 }, "catGrpHierName2":{ "type":"string", "description":"Category Group Hierarchy #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #2 assigned to the master item", "maxLength":40 }, "catGrpName2":{ "type":"string", "description":"Category Group #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #2 assigned to the master item", "maxLength":20 }, "catGrpHierName3":{ "type":"string", "description":"Category Group Hierarchy #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #3 assigned to the master item", "maxLength":40 }, "catGrpName3":{ "type":"string", "description":"Category Group #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #3 assigned to the master item", "maxLength":20 }, "catGrpHierName4":{ "type":"string", "description":"Category Group Hierarchy #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #4 assigned to the master item", "maxLength":40 }, "catGrpName4":{ "type":"string", "description":"Category Group #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #4 assigned to the master item", "maxLength":20 }, "addrLn1":{ "type":"string", "description":"Address Line 1. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Address Line 1", "maxLength":250 }, "addrLn2":{ "type":"string", "description":"Address Line 2. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Address Line 2", "maxLength":250 }, "addrLn3":{ "type":"string", "description":"Address Line 3. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Address Line 3", "maxLength":250 }, "postalCode":{ "type":"string", "description":"ZIP or Postalcode. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"ZIP or Postalcode", "maxLength":20 }, "phone":{ "type":"string", "description":"Telephone number. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Telephone number", "maxLength":20 }, "phoneCountryCode":{ "type":"string", "description":"Telephone country code. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Telephone country code", "maxLength":2 }, "countryCode":{ "type":"string", "description":"Two character country code as defined in ISO 3166-2 standard. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Two character country code", "maxLength":2 }, "countryName":{ "type":"string", "description":"Country name as defined in ISO 3166-2 standard. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Country name", "maxLength":50 }, "regionCode":{ "type":"string", "description":"Region code as defined in ISO 3166-2 standard for subdivisions. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Region code", "maxLength":6 }, "regionName":{ "type":"string", "description":"Region name as defined in ISO 3166-2 standard for subdivisions. This attribute is optional and will not be returned in the response by default.First available version 20.1.16
", "title":"Region name", "maxLength":40 } }, "required":[ "num", "name", "catGrpHierName1", "catGrpName1", "catGrpHierName2", "catGrpName2", "catGrpHierName3", "catGrpName3", "catGrpHierName4", "catGrpName4" ] }, "revenueCenterDimensions":{ "description":"The response body contains information about the revenue center dimensions for the specified locatio", "properties":{ "locRef":{ "type":"string", "title":"Location Reference", "description":"The location reference, this may be a store number or name depending on the organization", "maxLength":99 }, "revenueCenters":{ "type":"array", "description":"An array of revenue center dimensions", "items":{ "$ref":"#/definitions/revenueCenter" } } }, "required":[ "locRef", "revenueCenters" ] }, "discount":{ "description":"The response body contains information about the discount for the specified location.", "properties":{ "num":{ "type":"integer", "description":"Discount number", "title":"Number", "maxLength":16 }, "name":{ "type":"string", "description":"Discount Name", "title":"Name", "maxLength":99 }, "mstrNum":{ "type":"integer", "description":"The master discount number", "title":"Master Number", "maxLength":16 }, "mstrName":{ "type":"string", "description":"The master discount name", "title":"Master Name", "maxLength":99 }, "posPercent":{ "type":"number", "description":"POS Percentage of discount", "title":"POS Percentage" }, "catGrpHierName1":{ "type":"string", "description":"Category Group Hierarchy #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #1 assigned to the master item", "maxLength":40 }, "catGrpName1":{ "type":"string", "description":"Category Group #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #1 assigned to the master item", "maxLength":20 }, "catGrpHierName2":{ "type":"string", "description":"Category Group Hierarchy #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #2 assigned to the master item", "maxLength":40 }, "catGrpName2":{ "type":"string", "description":"Category Group #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #2 assigned to the master item", "maxLength":20 }, "catGrpHierName3":{ "type":"string", "description":"Category Group Hierarchy #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #3 assigned to the master item", "maxLength":40 }, "catGrpName3":{ "type":"string", "description":"Category Group #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #3 assigned to the master item", "maxLength":20 }, "catGrpHierName4":{ "type":"string", "description":"Category Group Hierarchy #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #4 assigned to the master item", "maxLength":40 }, "catGrpName4":{ "type":"string", "description":"Category Group #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #4 assigned to the master item", "maxLength":20 }, "rptGrpNum":{ "type":"integer", "description":"Discount report group number as defined in Simphony EMC. First available version 20.1.17", "title":"Report Group Number" }, "rptGrpName":{ "type":"string", "description":"Discount report group name as defined in Simphony EMC. First available version 20.1.17", "title":"Report Group Name", "maxLength":128 }, "extRef1":{ "type":"string", "description":"External reference 1 that corresponds to an identifier in a third party system. This attribute is optional. This attribute will not be returned in the response if value is null.First Available Version 20.2
", "title":"External reference 1 that corresponds to an identifier in a third party system", "maxLength":32 }, "extRef2":{ "type":"string", "description":"External reference 2 that corresponds to an identifier in a third party system. This attribute is Optional optional. This attribute will not be returned in the response if value is null.First Available Version 20.2
", "title":"External reference 2 that corresponds to an identifier in a third party system", "maxLength":32 } }, "required":[ "num", "name", "posPercent", "catGrpHierName1", "catGrpName1", "catGrpHierName2", "catGrpName2", "catGrpHierName3", "catGrpName3", "catGrpHierName4", "catGrpName4", "rptGrpNum", "rptGrpName" ] }, "discountDimensions":{ "description":"The response body contains information about the discount dimensions for the specified locatio", "properties":{ "locRef":{ "type":"string", "title":"Location Reference", "description":"The location reference, this may be a store number or name depending on the organization", "maxLength":99 }, "discounts":{ "type":"array", "description":"An array of discount dimensions", "items":{ "$ref":"#/definitions/discount" } } }, "required":[ "locRef", "discounts" ] }, "serviceCharge":{ "description":"The response body contains information about the service charge for the specified location.", "properties":{ "num":{ "type":"integer", "description":"Service charge number", "title":"Number", "maxLength":16 }, "name":{ "type":"string", "description":"Service charge name", "title":"Name", "maxLength":99 }, "mstrNum":{ "type":"integer", "description":"The master Service charge number", "title":"Master Number", "maxLength":16 }, "mstrName":{ "type":"string", "description":"The master Service charge name", "title":"Master Name", "maxLength":99 }, "posPercent":{ "type":"number", "description":"Percentage of the service charge", "title":"POS Percentage" }, "revFlag":{ "type":"boolean", "description":"A flag indicating if the service charge is revenue or non-revenue service charge. This attribute will not be returned in the response if value is true or null", "title":"Revenue Flag" }, "chrgTipsFlag":{ "type":"boolean", "description":"A flag indicating if the service charged is a charged tip. This attribute will not be returned in the response if value is false or null", "title":"Charged Tip Flag" }, "category":{ "type":"string", "description":"The category of the service charge. This attribute will not be returned in the response if value is null", "title":"Category", "maxLength":99 }, "catGrpHierName1":{ "type":"string", "description":"Category Group Hierarchy #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #1 assigned to the master item", "maxLength":40 }, "catGrpName1":{ "type":"string", "description":"Category Group #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #1 assigned to the master item", "maxLength":20 }, "catGrpHierName2":{ "type":"string", "description":"Category Group Hierarchy #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #2 assigned to the master item", "maxLength":40 }, "catGrpName2":{ "type":"string", "description":"Category Group #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #2 assigned to the master item", "maxLength":20 }, "catGrpHierName3":{ "type":"string", "description":"Category Group Hierarchy #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #3 assigned to the master item", "maxLength":40 }, "catGrpName3":{ "type":"string", "description":"Category Group #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #3 assigned to the master item", "maxLength":20 }, "catGrpHierName4":{ "type":"string", "description":"Category Group Hierarchy #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #4 assigned to the master item", "maxLength":40 }, "catGrpName4":{ "type":"string", "description":"Category Group #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #4 assigned to the master item", "maxLength":20 }, "extRef1":{ "type":"string", "description":"External reference 1 that corresponds to an identifier in a third party system. This attribute is optional. This attribute will not be returned in the response if value is null.First Available Version 20.2
", "title":"External reference 1 that corresponds to an identifier in a third party system", "maxLength":32 }, "extRef2":{ "type":"string", "description":"External reference 2 that corresponds to an identifier in a third party system. This attribute is Optional optional. This attribute will not be returned in the response if value is null.First Available Version 20.2
", "title":"External reference 2 that corresponds to an identifier in a third party system", "maxLength":32 } }, "required":[ "num", "name", "posPercent", "revFlag", "chrgTipsFlag", "category", "catGrpHierName1", "catGrpName1", "catGrpHierName2", "catGrpName2", "catGrpHierName3", "catGrpName3", "catGrpHierName4", "catGrpName4" ] }, "serviceChargeDimensions":{ "description":"The response body contains information about the service charge dimensions for the specified locatio", "properties":{ "locRef":{ "type":"string", "title":"Location Reference", "description":"The location reference, this may be a store number or name depending on the organization", "maxLength":99 }, "serviceCharges":{ "type":"array", "description":"An array of service charge dimensions", "items":{ "$ref":"#/definitions/serviceCharge" } } }, "required":[ "locRef", "serviceCharges" ] }, "tenderMedia":{ "description":"The response body contains information about the tender media for the specified location.", "properties":{ "num":{ "type":"integer", "description":"Tender media number", "title":"Number", "maxLength":16 }, "name":{ "type":"string", "description":"Tender media Name", "title":"Name", "maxLength":99 }, "mstrNum":{ "type":"integer", "description":"The master tender media number", "title":"Master Number", "maxLength":16 }, "mstrName":{ "type":"string", "description":"The master tender media name", "title":"Master Name", "maxLength":99 }, "type":{ "type":"integer", "description":"The Tender Media Type as defined in the POS and the tender media master.First Available Version 20.3
", "title":"Sub type", "maxLength":3 }, "cat":{ "type":"number", "description":"The category assigned to the master item of this tender media.First Available Version 20.3
", "title":"Category", "maxLength":3 }, "catGrpHierName1":{ "type":"string", "description":"Category Group Hierarchy #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #1 assigned to the master item", "maxLength":40 }, "catGrpName1":{ "type":"string", "description":"Category Group #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #1 assigned to the master item", "maxLength":20 }, "catGrpHierName2":{ "type":"string", "description":"Category Group Hierarchy #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #2 assigned to the master item", "maxLength":40 }, "catGrpName2":{ "type":"string", "description":"Category Group #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #2 assigned to the master item", "maxLength":20 }, "catGrpHierName3":{ "type":"string", "description":"Category Group Hierarchy #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #3 assigned to the master item", "maxLength":40 }, "catGrpName3":{ "type":"string", "description":"Category Group #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #3 assigned to the master item", "maxLength":20 }, "catGrpHierName4":{ "type":"string", "description":"Category Group Hierarchy #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #4 assigned to the master item", "maxLength":40 }, "catGrpName4":{ "type":"string", "description":"Category Group #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #4 assigned to the master item", "maxLength":20 }, "autoClsdTnd":{ "type":"boolean", "description":"Flag indicating if this tender is used to auto close checks after 7 days. This field i 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.
", "title":"Flag indicating if this tender is used to auto close checks after 7 days" }, "extRef1":{ "type":"string", "description":"External reference 1 that corresponds to an identifier in a third party system. This attribute is optional. This attribute will not be returned in the response if value is null.First Available Version 20.2
", "title":"External reference 1 that corresponds to an identifier in a third party system", "maxLength":32 }, "extRef2":{ "type":"string", "description":"External reference 2 that corresponds to an identifier in a third party system. This attribute is Optional optional. This attribute will not be returned in the response if value is null.First Available Version 20.2
", "title":"External reference 2 that corresponds to an identifier in a third party system", "maxLength":32 } }, "required":[ "num", "name", "type", "catGrpHierName1", "catGrpName1", "catGrpHierName2", "catGrpName2", "catGrpHierName3", "catGrpName3", "catGrpHierName4", "catGrpName4" ] }, "tenderMediaDimensions":{ "description":"The response body contains information about the tender media dimensions for the specified locatio", "properties":{ "locRef":{ "type":"string", "title":"Location Reference", "description":"The location reference, this may be a store number or name depending on the organization", "maxLength":99 }, "tenderMedias":{ "type":"array", "description":"An array of tender media dimensions", "title":"Tender Medias", "items":{ "$ref":"#/definitions/tenderMedia" } } }, "required":[ "locRef", "tenderMedias" ] }, "orderType":{ "description":"The response body contains information about the order type for the specified location.", "properties":{ "num":{ "type":"integer", "description":"Order type number", "title":"Number", "maxLength":16 }, "name":{ "type":"string", "description":"Order type Name", "title":"Name", "maxLength":99 }, "mstrNum":{ "type":"integer", "description":"The master Order type number", "title":"Master Number", "maxLength":16 }, "mstrName":{ "type":"string", "description":"The master Order type name", "title":"Master Name", "maxLength":99 }, "catGrpHierName1":{ "type":"string", "description":"Category Group Hierarchy #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #1 assigned to the master item", "maxLength":40 }, "catGrpName1":{ "type":"string", "description":"Category Group #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #1 assigned to the master item", "maxLength":20 }, "catGrpHierName2":{ "type":"string", "description":"Category Group Hierarchy #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #2 assigned to the master item", "maxLength":40 }, "catGrpName2":{ "type":"string", "description":"Category Group #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #2 assigned to the master item", "maxLength":20 }, "catGrpHierName3":{ "type":"string", "description":"Category Group Hierarchy #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #3 assigned to the master item", "maxLength":40 }, "catGrpName3":{ "type":"string", "description":"Category Group #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #3 assigned to the master item", "maxLength":20 }, "catGrpHierName4":{ "type":"string", "description":"Category Group Hierarchy #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #4 assigned to the master item", "maxLength":40 }, "catGrpName4":{ "type":"string", "description":"Category Group #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #4 assigned to the master item", "maxLength":20 } }, "required":[ "num", "name", "catGrpHierName1", "catGrpName1", "catGrpHierName2", "catGrpName2", "catGrpHierName3", "catGrpName3", "catGrpHierName4", "catGrpName4" ] }, "orderChannel":{ "description":"The response body contains information about the order channel for the specified location.", "properties":{ "num":{ "type":"integer", "description":"Order Channel number.First available version 20.1.15
", "title":"Number", "maxLength":16 }, "name":{ "type":"string", "description":"Order Channel name.First available version 20.1.15
", "title":"Name", "maxLength":99 }, "mstrNum":{ "type":"integer", "description":"The master order channel number.First available version 20.1.15
", "title":"Master Number", "maxLength":16 }, "mstrName":{ "type":"string", "description":"The master order channel name.First available version 20.1.15
", "title":"Master Name", "maxLength":99 } }, "required":[ "num", "name" ] }, "orderTypeDimensions":{ "description":"The response body contains information about the order type dimensions for the specified locatio", "properties":{ "locRef":{ "type":"string", "title":"Location Reference", "description":"The location reference, this may be a store number or name depending on the organization", "maxLength":99 }, "orderTypes":{ "type":"array", "description":"An array of order type dimensions", "title":"Order Types", "items":{ "$ref":"#/definitions/orderType" } } }, "required":[ "locRef", "orderTypes" ] }, "orderChannelDimensions":{ "description":"The response body contains information about the order channel dimensions for the specified locatio", "properties":{ "locRef":{ "type":"string", "title":"Location Reference", "description":"The location reference, this may be a store number or name depending on the organization", "maxLength":99 }, "orderChannels":{ "type":"array", "description":"An array of order channels dimensions.First available version 20.1.15
", "title":"Order Channels", "items":{ "$ref":"#/definitions/orderChannel" } } }, "required":[ "locRef", "orderChannels" ] }, "tax":{ "description":"The response body contains information about the tax for the specified location.", "properties":{ "num":{ "type":"integer", "description":"Tax number", "title":"Number", "maxLength":16 }, "name":{ "type":"string", "description":"Tax Name", "title":"Name", "maxLength":99 }, "mstrNum":{ "type":"integer", "description":"The master tax number", "title":"Master Number", "maxLength":16 }, "mstrName":{ "type":"string", "description":"The master tax name", "title":"Master Name", "maxLength":99 }, "type":{ "type":"integer", "description":"Type of Tax.The following are the different tax types that could be returned:Type: 6: First available version 20.1.16, dependent on Simphony 19.7 or later
", "title":"Type" }, "taxRate":{ "type":"number", "description":"Rate of the tax. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Rate" }, "effFrDt":{ "type":"string", "description":"The tax's effective from date. This object will not be present if there is no effective from date. This attribute will not be returned in the response if value is null", "title":"Effective From Date", "format":"date-time" }, "effToDt":{ "type":"string", "description":"The tax's effective to date. This object will not be present if there is no effective to date. This attribute will not be returned in the response if value is null", "title":"Effective To Date", "format":"date-time" }, "catGrpHierName1":{ "type":"string", "description":"Category Group Hierarchy #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #1 assigned to the master item", "maxLength":40 }, "catGrpName1":{ "type":"string", "description":"Category Group #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #1 assigned to the master item", "maxLength":20 }, "catGrpHierName2":{ "type":"string", "description":"Category Group Hierarchy #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #2 assigned to the master item", "maxLength":40 }, "catGrpName2":{ "type":"string", "description":"Category Group #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #2 assigned to the master item", "maxLength":20 }, "catGrpHierName3":{ "type":"string", "description":"Category Group Hierarchy #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #3 assigned to the master item", "maxLength":40 }, "catGrpName3":{ "type":"string", "description":"Category Group #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #3 assigned to the master item", "maxLength":20 }, "catGrpHierName4":{ "type":"string", "description":"Category Group Hierarchy #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #4 assigned to the master item", "maxLength":40 }, "catGrpName4":{ "type":"string", "description":"Category Group #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #4 assigned to the master item", "maxLength":20 } }, "required":[ "num", "name", "type", "taxRate", "effFrDt", "effToDt", "catGrpHierName1", "catGrpName1", "catGrpHierName2", "catGrpName2", "catGrpHierName3", "catGrpName3", "catGrpHierName4", "catGrpName4" ] }, "taxDimensions":{ "description":"The response body contains information about the tax dimensions for the specified location", "properties":{ "locRef":{ "type":"string", "title":"Location Reference", "description":"The location reference, this may be a store number or name depending on the organization", "maxLength":99 }, "taxes":{ "type":"array", "description":"An array of tax dimensions", "title":"Taxes", "items":{ "$ref":"#/definitions/tax" } } }, "required":[ "locRef", "taxes" ] }, "jobCode":{ "description":"The response body contains information about the job code for the specified location.", "properties":{ "num":{ "type":"integer", "description":"Job code number", "title":"Number", "maxLength":16 }, "name":{ "type":"string", "description":"Job code Name", "title":"Name", "maxLength":99 }, "mstrNum":{ "type":"integer", "description":"The master job code number", "title":"Master Number", "maxLength":16 }, "mstrName":{ "type":"string", "description":"The master job code name", "title":"Master Name", "maxLength":99 }, "lbrCatNum":{ "type":"integer", "description":"Labor category number. This attribute will not be returned in the response if value is null", "title":"Labor Category Number", "maxLength":16 }, "lbrCatName":{ "type":"string", "description":"Labor category name. This attribute will not be returned in the response if value is null", "title":"Labor Category Name", "maxLength":99 }, "lbrCatMstrNum":{ "type":"integer", "description":"The master labor category number", "title":"Labor Category Master Number", "maxLength":16 }, "lbrCatMstrName":{ "type":"string", "description":"The master labor category name", "title":"Labor Category Master Name", "maxLength":99 } }, "required":[ "num", "name", "lbrCatNum", "lbrCatName" ] }, "jobCodeDimensions":{ "description":"The response body contains information about the job code dimensions for the specified locatio", "properties":{ "locRef":{ "type":"string", "title":"Location Reference", "description":"The location reference, this may be a store number or name depending on the organization", "maxLength":99 }, "jobCodes":{ "type":"array", "description":"An array of job code dimensions", "title":"Job Codes", "items":{ "$ref":"#/definitions/jobCode" } } }, "required":[ "locRef", "jobCodes" ] }, "reasonCode":{ "description":"The response body contains information about the reason code for the specified location.", "properties":{ "num":{ "type":"integer", "description":"Reason code number. A unique identifier of the reason code, but not the reason code object number as defined in Simphony EMC.", "title":"Reason Code Number", "maxLength":16 }, "name":{ "type":"string", "description":"Reason code name", "title":"Name", "maxLength":99 }, "mstrNum":{ "type":"integer", "title":"Master Number", "description":"Reason code master number. A unique identifier of th reason code master, but not the reason code master object number.", "maxLength":16 }, "mstrName":{ "type":"string", "description":"The master reason code name", "title":"Master Name", "maxLength":99 }, "posRef":{ "type":"integer", "description":"Reason code object number as defined in Simphony EMC. Different types of reason codes can share the same object number.First available version 20.3
", "title":"Reason code object number", "maxLength":16 }, "mstrPosRef":{ "type":"integer", "description":"Reason code master item object number as defined in Simphony EMC. This attribute is optional and is not returned by default, regardless of whether it is null or not.First available version 20.3
", "title":"Reason code master item object number", "maxLength":16 }, "type":{ "type":"integer", "description":"The type of reason code.First available version 20.3
", "title":"The type of reason code", "maxLength":16 } }, "required":[ "num", "name", "posRef", "type" ] }, "reasonCodeDimensions":{ "description":"The response body contains information about the reason code dimensions for the specified locatio", "properties":{ "locRef":{ "type":"string", "title":"Location Reference", "description":"The location reference, this may be a store number or name depending on the organization", "maxLength":99 }, "reasonCodes":{ "type":"array", "description":"An array of reason code dimensions", "title":"Reason Codes", "items":{ "$ref":"#/definitions/reasonCode" } } }, "required":[ "locRef", "reasonCodes" ] }, "cashMgmtItem":{ "description":"The response body contains information about the cash management item for the specified location.", "properties":{ "num":{ "type":"integer", "description":"cash management item number", "title":"Number", "maxLength":16 }, "name":{ "type":"string", "description":"cash management item Name", "title":"Name", "maxLength":99 }, "mstrNum":{ "type":"integer", "description":"The master cash management item number", "title":"Master Number", "maxLength":16 }, "mstrName":{ "type":"string", "description":"The master cash management item name", "title":"Master Name", "maxLength":99 }, "type":{ "type":"integer", "description":"Cash management item Type", "title":"Type" }, "recordNum":{ "type":"integer", "description":"The unique number of the cash management item record. This attribute will not be returned in the response if value is null", "title":"Record Number", "maxLength":16 }, "catGrpHierName1":{ "type":"string", "description":"Category Group Hierarchy #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #1 assigned to the master item", "maxLength":40 }, "catGrpName1":{ "type":"string", "description":"Category Group #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #1 assigned to the master item", "maxLength":20 }, "catGrpHierName2":{ "type":"string", "description":"Category Group Hierarchy #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #2 assigned to the master item", "maxLength":40 }, "catGrpName2":{ "type":"string", "description":"Category Group #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #2 assigned to the master item", "maxLength":20 }, "catGrpHierName3":{ "type":"string", "description":"Category Group Hierarchy #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #3 assigned to the master item", "maxLength":40 }, "catGrpName3":{ "type":"string", "description":"Category Group #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #3 assigned to the master item", "maxLength":20 }, "catGrpHierName4":{ "type":"string", "description":"Category Group Hierarchy #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #4 assigned to the master item", "maxLength":40 }, "catGrpName4":{ "type":"string", "description":"Category Group #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #4 assigned to the master item", "maxLength":20 } }, "required":[ "num", "name", "type", "recordNum", "catGrpHierName1", "catGrpName1", "catGrpHierName2", "catGrpName2", "catGrpHierName3", "catGrpName3", "catGrpHierName4", "catGrpName4" ] }, "cashMgmtItemDimensions":{ "description":"The response body contains information about the cash management item dimensions for the specified location", "properties":{ "locRef":{ "type":"string", "title":"Location Reference", "description":"The location reference, this may be a store number or name depending on the organization", "maxLength":99 }, "cashMgmtItems":{ "type":"array", "description":"An array of cash management item dimensions", "title":"Cash Management Items", "items":{ "$ref":"#/definitions/cashMgmtItem" } } }, "required":[ "locRef", "cashMgmtItems" ] }, "cashier":{ "description":"The response body contains information about the cashier for the specified location.", "properties":{ "num":{ "type":"integer", "description":"Cashier number", "title":"Number", "maxLength":16 }, "name":{ "type":"string", "description":"Cashier Name", "title":"Name", "maxLength":99 }, "mstrNum":{ "type":"integer", "description":"The master cashier number", "title":"Master Number", "maxLength":16 }, "mstrName":{ "type":"string", "description":"The master cashier name", "title":"Master Name", "maxLength":99 } }, "required":[ "num", "name" ] }, "cashierDimensions":{ "description":"The response body contains information about the cashier dimensions for the specified locatio", "properties":{ "locRef":{ "type":"string", "title":"Location Reference", "description":"The location reference, this may be a store number or name depending on the organization", "maxLength":99 }, "cashiers":{ "type":"array", "description":"An array of cashier dimensions", "title":"Cashiers", "items":{ "$ref":"#/definitions/cashier" } } }, "required":[ "locRef", "cashiers" ] }, "menuItem":{ "description":"The response body contains information about the menu item for the specified location.", "properties":{ "num":{ "type":"integer", "description":"Menu item number", "title":"Number", "maxLength":16 }, "name":{ "type":"string", "description":"Menu item name", "title":"Name", "maxLength":99 }, "mstrNum":{ "type":"integer", "description":"The master menu item number", "title":"Master Number", "maxLength":16 }, "mstrName":{ "type":"string", "description":"The master menu item name", "title":"Master Name", "maxLength":99 }, "name2":{ "type":"string", "description":"Menu Item Name 2. This attribute will not be returned in the response if value is null", "title":"Name 2", "maxLength":99 }, "name2MstrNum":{ "type":"integer", "description":"The master menu item number of menu item name2", "title":"Name 2 Master Number", "maxLength":16 }, "name2MstrName":{ "type":"string", "description":"The master menu item name of menu item name2", "title":"Name 2 Master Name", "maxLength":99 }, "majGrpNum":{ "type":"integer", "description":"The number of this menu item's major group", "title":"Major Group Number", "maxLength":16 }, "majGrpName":{ "type":"string", "description":"The name of this menu item's major group", "title":"Major Group Name", "maxLength":99 }, "famGrpNum":{ "type":"integer", "description":"The number of this menu item's family group", "title":"Family Group Number", "maxLength":16 }, "famGrpName":{ "type":"string", "description":"The name of this menu item's family group", "title":"Family Group Name", "maxLength":99 }, "majGrpMstrNum":{ "type":"integer", "description":"The number of this menu item's major group master", "title":"Major Group Master Number", "maxLength":16 }, "majGrpMstrName":{ "type":"string", "description":"The name of this menu item's major group master", "title":"Major Group Master Name", "maxLength":99 }, "famGrpMstrNum":{ "type":"integer", "description":"The number of this menu item's family group master", "title":"Family Group Master Number", "maxLength":16 }, "famGrpMstrName":{ "type":"string", "description":"The name of this menu item's family group master", "title":"Faily Group Master Name", "maxLength":99 }, "doNotIncludeInSales":{ "type":"boolean", "description":"Identifies if the menu item is not to be included in sales. This attribute will not be returned in the response if value is false or null", "title":"Do Not Include In Sales" }, "category":{ "type":"string", "description":"The category of the menu item. This attribute will not be returned in the response if value is null", "title":"Category", "maxLength":99 }, "revFlag":{ "type":"boolean", "description":"A flag indicating if the Menu Item is revenue or non-revenue Menu Item. This attribute will not be returned in the response if value is true or null", "title":"Revenue Flag" }, "catGrpHierName1":{ "type":"string", "description":"Category Group Hierarchy #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #1 assigned to the master item", "maxLength":40 }, "catGrpName1":{ "type":"string", "description":"Category Group #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #1 assigned to the master item", "maxLength":20 }, "catGrpHierName2":{ "type":"string", "description":"Category Group Hierarchy #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #2 assigned to the master item", "maxLength":40 }, "catGrpName2":{ "type":"string", "description":"Category Group #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #2 assigned to the master item", "maxLength":20 }, "catGrpHierName3":{ "type":"string", "description":"Category Group Hierarchy #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #3 assigned to the master item", "maxLength":40 }, "catGrpName3":{ "type":"string", "description":"Category Group #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #3 assigned to the master item", "maxLength":20 }, "catGrpHierName4":{ "type":"string", "description":"Category Group Hierarchy #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #4 assigned to the master item", "maxLength":40 }, "catGrpName4":{ "type":"string", "description":"Category Group #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #4 assigned to the master item", "maxLength":20 }, "mgCatGrpHierName1":{ "type":"string", "description":"Category Group Hierarchy #1 assigned to the major group master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #1 assigned to the major group master item", "maxLength":40 }, "mgCatGrpName1":{ "type":"string", "description":"Category Group #1 assigned to the major group master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #1 assigned to the major group master item", "maxLength":20 }, "mgCatGrpHierName2":{ "type":"string", "description":"Category Group Hierarchy #2 assigned to the major group master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #2 assigned to the major group master item", "maxLength":40 }, "mgCatGrpName2":{ "type":"string", "description":"Category Group #2 assigned to the major group master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #2 assigned to the major group master item", "maxLength":20 }, "mgCatGrpHierName3":{ "type":"string", "description":"Category Group Hierarchy #3 assigned to the major group master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #3 assigned to the major group master item", "maxLength":40 }, "mgCatGrpName3":{ "type":"string", "description":"Category Group #3 assigned to the major group master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #3 assigned to the major group master item", "maxLength":20 }, "mgCatGrpHierName4":{ "type":"string", "description":"Category Group Hierarchy #4 assigned to the major group master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #4 assigned to the major group master item", "maxLength":40 }, "mgCatGrpName4":{ "type":"string", "description":"Category Group #4 assigned to the major group master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #4 assigned to the major group master item", "maxLength":20 }, "fgCatGrpHierName1":{ "type":"string", "description":"Category Group Hierarchy #1 assigned to the family group master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #1 assigned to the family group master item", "maxLength":40 }, "fgCatGrpName1":{ "type":"string", "description":"Category Group #1 assigned to the family group master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #1 assigned to the family group master item", "maxLength":20 }, "fgCatGrpHierName2":{ "type":"string", "description":"Category Group Hierarchy #2 assigned to the family group master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #2 assigned to the family group master item", "maxLength":40 }, "fgCatGrpName2":{ "type":"string", "description":"Category Group #2 assigned to the family group master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #2 assigned to the family group master item", "maxLength":20 }, "fgCatGrpHierName3":{ "type":"string", "description":"Category Group Hierarchy #3 assigned to the family group master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #3 assigned to the family group master item", "maxLength":40 }, "fgCatGrpName3":{ "type":"string", "description":"Category Group #3 assigned to the family group master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #3 assigned to the family group master item", "maxLength":20 }, "fgCatGrpHierName4":{ "type":"string", "description":"Category Group Hierarchy #4 assigned to the family group master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group Hierarchy #4 assigned to the family group master item", "maxLength":40 }, "fgCatGrpName4":{ "type":"string", "description":"Category Group #4 assigned to the family group master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
", "title":"Category Group #4 assigned to the family group master item", "maxLength":20 }, "extRef1":{ "type":"string", "description":"External reference 1 that corresponds to an identifier in a third party system. This attribute is optional. This attribute will not be returned in the response if value is null.First Available Version 20.2
", "title":"External reference 1 that corresponds to an identifier in a third party system", "maxLength":32 }, "extRef2":{ "type":"string", "description":"External reference 2 that corresponds to an identifier in a third party system. This attribute is Optional optional. This attribute will not be returned in the response if value is null.First Available Version 20.2
", "title":"External reference 2 that corresponds to an identifier in a third party system", "maxLength":32 } }, "required":[ "num", "name", "majGrpNum", "majGrpName", "famGrpNum", "famGrpName", "name2", "doNotIncludeInSales", "category", "revFlag", "catGrpHierName1", "catGrpName1", "catGrpHierName2", "catGrpName2", "catGrpHierName3", "catGrpName3", "catGrpHierName4", "catGrpName4", "mgCatGrpHierName1", "mgCatGrpName1", "mgCatGrpHierName2", "mgCatGrpName2", "mgCatGrpHierName3", "mgCatGrpName3", "mgCatGrpHierName4", "mgCatGrpName4", "fgCatGrpHierName1", "fgCatGrpName1", "fgCatGrpHierName2", "fgCatGrpName2", "fgCatGrpHierName3", "fgCatGrpName3", "fgCatGrpHierName4", "fgCatGrpName4" ] }, "menuItemDimensions":{ "description":"The response body contains information about the menu item dimensions for the specified location", "properties":{ "locRef":{ "type":"string", "title":"Location Reference", "description":"The location reference, this may be a store number or name depending on the organization", "maxLength":99 }, "menuItems":{ "type":"array", "description":"An array of menu item dimensions", "title":"Menu Items", "items":{ "$ref":"#/definitions/menuItem" } } }, "required":[ "locRef", "menuItems" ] }, "menuItemPrice":{ "description":"The response body contains information about the menu item price for the specified location.", "properties":{ "num":{ "type":"integer", "description":"Menu item number", "title":"Number", "maxLength":16 }, "rvcNum":{ "type":"integer", "description":"The revenue center number", "title":"Revenue Center Number", "maxLength":10 }, "prcLvlNum":{ "type":"integer", "description":"The price level number of the menu item price", "title":"Price level Number", "maxLength":16 }, "prcLvlName":{ "type":"string", "description":"The price level name of the menu item price. This attribute will not be returned in the response if value is null", "title":"Price Level Name", "maxLength":99 }, "price":{ "type":"number", "description":"The menu item's price", "title":"Price" }, "cost":{ "type":"number", "description":"The menu item's cost. This attribute will not be returned in the response if value is 0 or null", "title":"Cost" }, "effFrDt":{ "type":"string", "description":"The price's effective from date. This object will not be present if there is no effective from date.", "format":"date-time" }, "effToDt":{ "type":"string", "description":"The prices effective to date. This object will not be present if there is no effective to date. This attribute will not be returned in the response if value is null", "format":"date-time" }, "extRef1":{ "type":"string", "description":"External reference 1 that corresponds to an identifier in a third party system. This attribute is optional. This attribute will not be returned in the response if value is null.First Available Version 20.2
", "title":"External reference 1 that corresponds to an identifier in a third party system", "maxLength":32 }, "extRef2":{ "type":"string", "description":"External reference 2 that corresponds to an identifier in a third party system. This attribute is Optional optional. This attribute will not be returned in the response if value is null.First Available Version 20.2
", "title":"External reference 2 that corresponds to an identifier in a third party system", "maxLength":32 } }, "required":[ "num", "rvcNum", "prcLvlNum", "price", "effFrDt", "prcLvlName", "cost", "effToDt" ] }, "menuItemPriceDimensions":{ "description":"The response body contains information about the menu item prices for the specified locatio", "properties":{ "locRef":{ "type":"string", "title":"Location Reference", "description":"The location reference, this may be a store number or name depending on the organization", "maxLength":99 }, "menuItemPrices":{ "type":"array", "description":"An array of menu item prices", "title":"Menu Items", "items":{ "$ref":"#/definitions/menuItemPrice" } } }, "required":[ "locRef", "menuItemPrices" ] }, "employee":{ "description":"The response body contains employee information about a specified location.", "properties":{ "num":{ "type":"integer", "description":"Unique identifier of the employee.", "title":"Employee Number", "maxLength":10 }, "uuid":{ "type":"integer", "description":"Unique identifier for employee for data privacy. This attribute will not be returned in the response if value is null", "title":"UUID", "maxLength":16 }, "employeeId":{ "type":"integer", "description":"Alternative unique identifier of the employee.", "title":"Employee ID", "maxLength":19 }, "fName":{ "type":"string", "description":"The first name of the employee", "title":"Employee First Name", "maxLength":99 }, "lName":{ "type":"string", "description":"The last name of the employee", "title":"Employee Last Name", "maxLength":99 }, "payrollId":{ "type":"integer", "description":"The employee's payroll identifier", "title":"Employee Payroll ID", "maxLength":16 }, "externalPayrollID":{ "type":"integer", "description":"External payroll id for the employee.First Available Version: 20.1.10
", "title":"External Payroll ID", "maxLength":16 }, "homeLocRef":{ "type":"string", "description":"The employee's home location reference", "title":"Employee Home Location Reference", "maxLength":99 }, "className":{ "type":"string", "description":"Default employee class name assigned to the employee. It does not change with other employee classes assigned to job codes for this employee.First Available Version: 20.1.12
", "title":"Employee Class Name", "maxLength":99 }, "classNum":{ "type":"integer", "description":"Default Employee Class Number. It does not change with other employee classes assigned to job codes for this employee.First Available Version: 20.1.12
", "title":"Employee Class Number", "maxLength":16 }, "classMstrName":{ "type":"string", "description":"Default Employee Class Master Name. It does not change with other employee classes assigned to job codes for this employee.First Available Version: 20.1.12
", "title":"Employee Class Master Name", "maxLength":99 }, "classMstrNum":{ "type":"integer", "description":"Default Employee Class Master Number. It does not change with other employee classes assigned to job codes for this employee.First Available Version: 20.1.12
", "title":"Employee Class Master Number", "maxLength":16 } }, "required":[ "num", "employeeId", "fName", "lName", "payrollId", "homeLocRef", "uuid" ] }, "employeeDimensions":{ "description":"The response body contains employee information about a specified location.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization" }, "employees":{ "type":"array", "description":"An array of employees for a given location", "items":{ "$ref":"#/definitions/employee" } } }, "required":[ "locRef", "employees" ] }, "locDimRequestPayload":{ "description":"Request payload for location dimensions", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference" }, "searchCriteria":{ "type":"string", "description":"Search criteria to filter results based on field value", "title":"Search Criteria" }, "include":{ "type":"string", "description":"List of objects to include in response", "title":"Include" }, "applicationName":{ "type":"string", "description":"The name of the application which is accessing the API.First Available Version: 20.1.10
", "title":"Application Name", "maxLength":128 } } }, "locRequestPayload":{ "description":"Request payload with location reference", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference" }, "searchCriteria":{ "type":"string", "description":"Search criteria to filter results based on field value", "title":"Search Criteria" }, "include":{ "type":"string", "description":"List of objects to include in response", "title":"Include" }, "applicationName":{ "type":"string", "description":"The name of the application which is accessing the API.First Available Version: 20.1.10
", "title":"Application Name", "maxLength":128 } }, "required":[ "locRef" ] }, "mnprRequestPayload":{ "description":"Request payload for menu item prices", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference" }, "searchCriteria":{ "type":"string", "description":"Search criteria to filter results based on field value", "title":"Search Criteria" }, "include":{ "type":"string", "description":"List of objects to include in response", "title":"Include" }, "effFrDt":{ "type":"string", "description":"Gets prices with an \"effective from\" date on or after the specified date. The prices returned can have any \"effective to\" date (none, in the past, or in the future). When used with the effToDt parameter, the API will return prices that were effective in the range between the \"effective from\" and \"effective to\" dates (inclusive). The parameter is limited to the last 3 years from the current business date.", "title":"Effective From Date", "format":"date" }, "effToDt":{ "type":"string", "description":"Gets prices with an \"effective to\" date on or prior to the specified date. When used with the effFrDt parameter, the API will return prices that were effective in the range between the \"effective from\" and \"effective to\" dates (inclusive). The parameter is limited to the last 3 years from the current business date.", "title":"Effective To Date", "format":"date" }, "applicationName":{ "type":"string", "description":"The name of the application which is accessing the API.First Available Version: 20.1.10
", "title":"Application Name", "maxLength":128 } }, "required":[ "locRef" ] }, "exceptionDetailType":{ "description":"Exception details", "properties":{ "o:errorCode":{ "type":"integer", "description":"Oracle error code", "title":"Oracle Error Code" }, "detail":{ "type":"string", "description":"The description of the error", "title":"Error Description" }, "status":{ "type":"integer", "description":"HTTP Response Code", "title":"Status" }, "type":{ "type":"string", "description":"The description of the type of HTTP error", "title":"Type" }, "title":{ "type":"string", "description":"High level description of the error", "title":"Title" } }, "required":[ "o:errorCode", "type", "title" ] }, "paymentSettlementsDimensions":{ "description":"The response body contains information about the payment settlement details.", "properties":{ "stlmtDt":{ "type":"string", "description":"The settlement date associated with the payment settlement details", "title":"Payment settlement date", "format":"date" }, "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location reference", "maxLength":99 }, "accounts":{ "type":"array", "description":"An array of accounts", "items":{ "$ref":"#/definitions/paymentSettlementsAccounts" } } }, "required":[ "stlmtDt", "locRef", "accounts" ] }, "paymentSettlementsAccounts":{ "description":"The response body contains information about the account holder.", "properties":{ "acctCode":{ "type":"string", "description":"Account code", "title":"Account code", "maxLength":50 }, "revenueCenters":{ "type":"array", "description":"An array of revenue centers", "items":{ "$ref":"#/definitions/paymentSettlementsRevenueCenters" } } }, "required":[ "acctCode", "revenueCenters" ] }, "paymentSettlementsRevenueCenters":{ "description":"The response body contains information about the account holder.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue center number", "title":"Revenue center number", "maxLength":10 }, "businessDates":{ "type":"array", "description":"An array of business dates", "items":{ "$ref":"#/definitions/paymentSettlementsBusinessDates" } } }, "required":[ "rvcNum", "businessDates" ] }, "paymentSettlementsBusinessDates":{ "description":"The response body contains information about the account holder.", "properties":{ "busDt":{ "type":"string", "description":"Business Date associated with the settlement", "title":"Business date associated with the settlement", "format":"date" }, "settlements":{ "type":"array", "description":"An array of settlement transactions", "items":{ "$ref":"#/definitions/paymentSettlementsSettlements" } } }, "required":[ "busDt", "settlements" ] }, "paymentSettlementsSettlements":{ "description":"The response body contains information about the account holder.", "properties":{ "merchAcctRef":{ "type":"string", "description":"The name of the merchant account", "title":"The name of the merchant account", "maxLength":255 }, "pspRef":{ "type":"string", "description":"Reference identifying the transaction, issued by Payment Service Provider (PSP)", "title":"Reference identifying the transaction, issued by Payment Service Provider (PSP)", "maxLength":64 }, "merchRef":{ "type":"string", "description":"Merchant reference for the transaction.", "title":"Merchant reference for the transaction", "maxLength":80 }, "modPspRef":{ "type":"string", "description":"For records of Journal Type Settled, Refunded, Chargeback, this is the modification PSP reference, a unique ID that identifies the modification request.", "title":"Modification PSP reference", "maxLength":80 }, "pmntMethod":{ "type":"string", "description":"Method of payment", "title":"Method of payment", "maxLength":30 }, "pmntMethodVar":{ "type":"string", "description":"Variant of the method of payment", "title":"Variant of the method of payment", "maxLength":50 }, "createdUTC":{ "type":"string", "description":"The UTC date and time when the transaction was created", "title":"The UTC date and time when the transaction was created", "format":"date" }, "journalType":{ "type":"string", "description":"Journal type of the transaction. Possible values are: SETTLED, REFUNDED, CHARGEBACK, CHARGEBACKREVERSED, SECONDCHARGEBACK, FUNDTRANSFER", "title":"Journal type of the transaction", "maxLength":50 }, "currStatusFlag":{ "type":"integer", "description":"Flag indicating if this is the current status of the transaction settlement. Always NULL if journalType = \"FUNDTRANSFER\"", "title":"Current status of the transaction settlement" }, "grossCur":{ "type":"string", "description":"Currency of the transaction. Always NULL if journalType = \"FUNDTRANSFER\"", "title":"Currency of the transaction", "maxLength":3 }, "grossDebit":{ "type":"number", "description":"Gross debit of the transaction. Always NULL if journalType = \"FUNDTRANSFER\"", "title":"Gross debit of the transaction" }, "grossCredit":{ "type":"number", "description":"Gross credit of the transaction. Always NULL if journalType = \"FUNDTRANSFER\"", "title":"Gross credit of the transaction" }, "cardPrsntRate":{ "type":"number", "description":"Card present rate of the transaction", "title":"Card present rate of the transaction" }, "cardPrsntFee":{ "type":"number", "description":"Card present fee of the transaction", "title":"Card present fee of the transaction" }, "cardNotPrsntRate":{ "type":"number", "description":"Card not present rate of the transaction", "title":"Card not present rate of the transaction" }, "cardNotPrsntFee":{ "type":"number", "description":"Card not present fee of the transaction", "title":"Card not present fee of the transaction" }, "chgbkFee":{ "type":"number", "description":"Chargeback fee of the transaction. Always NULL if journalType = \"FUNDTRANSFER\"", "title":"Chargeback fee of the transaction" }, "batchNum":{ "type":"number", "description":"Number of the batch in which the transaction was settled. Always NULL if journalType = \"FUNDTRANSFER\"", "title":"Number of the batch in which the transaction was settled" }, "rrn":{ "type":"string", "description":"Reference retrieval number issued by payment service provider", "title":"Reference retrieval number", "maxLength":64 }, "isReferenced":{ "type":"integer", "description":"A flag to signify whether the transaction is referenced. Always NULL if journalType = \"FUNDTRANSFER\"", "title":"A flag to signify whether the transaction is referenced" }, "cardBin":{ "type":"string", "description":"Masked credit card number. Always NULL if journalType = \"FUNDTRANSFER\"", "title":"Masked credit card number", "maxLength":20 }, "pymtID":{ "type":"string", "description":"Unique identifier for a payment transaction. Use this ID to link the payment POS transaction to subsequent settlement and payout transactions.First available version 20.2
\n", "title":"Payment unique identifier", "maxLength":80 }, "pymtDtlID":{ "type":"string", "description":"Unique identifier for each status a payment transaction flows through during processing. Use this ID to link the payment POS transaction to subsequent settlement and payout transactions.First available version 20.2
\n", "title":"Payment status unique identifier", "maxLength":80 } }, "required":[ "merchAcctRef", "pspRef", "merchRef", "modPspRef", "pmntMethod", "pmntMethodVar", "createdUTC", "journalType", "currStatusFlag", "cardPrsntRate", "cardPrsntFee", "cardNotPrsntRate", "cardNotPrsntFee", "rrn", "pymtID", "pymtDtlID" ] }, "paymentTransactionsDimensions":{ "description":"The response body contains information about the payment transactions.", "properties":{ "busDt":{ "type":"string", "description":"The business date associated with the transactions", "title":"Business date", "format":"date" }, "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location reference", "maxLength":99 }, "curUTC":{ "type":"string", "description":"The current UTC date and time when the request is made", "title":"The current UTC date and time", "format":"date-time" }, "accounts":{ "type":"array", "description":"An array of accounts", "items":{ "$ref":"#/definitions/paymentTransactionsAccounts" } } }, "required":[ "busDt", "locRef", "curUTC", "accounts" ] }, "paymentTransactionsAccounts":{ "description":"The response body contains information about the payment transactions.", "properties":{ "acctCode":{ "type":"string", "description":"Unique code of the account", "title":"Account code", "maxLength":50 }, "revenueCenters":{ "type":"array", "description":"An array of revenue centers", "items":{ "$ref":"#/definitions/paymentTransactionsRevenueCenters" } } }, "required":[ "acctCode", "revenueCenters" ] }, "paymentTransactionsRevenueCenters":{ "description":"The response body contains information about the account holder.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue center number", "title":"Revenue center number", "maxLength":10 }, "transactions":{ "type":"array", "description":"An array of transactions", "items":{ "$ref":"#/definitions/paymentTransactionsTransactions" } } }, "required":[ "rvcNum", "transactions" ] }, "paymentTransactionsTransactions":{ "description":"The response body contains information about the account holder.", "properties":{ "pspRef":{ "type":"string", "description":"Reference identifying the transaction, issued by Payment Service Provider (PSP)", "title":"Reference identifying the transaction", "maxLength":64 }, "checkNum":{ "type":"integer", "description":"Check number", "title":"Check number", "maxLength":10 }, "guestCheckID":{ "type":"integer", "description":"Unique odentifier of the guest check", "title":"Unique identifier of the guest check", "maxLength":16 }, "guestCheckLineItemId":{ "type":"integer", "description":"Unique identifier of the guest check line item", "title":"Guest check line item", "maxLength":16 }, "transAmt":{ "type":"number", "description":"Total authorized transaction amount of the payment", "title":"Payment amount" }, "tipAmt":{ "type":"number", "description":"Tip amount of the transaction", "title":"Tip amount of the transactiont" }, "transUTC":{ "type":"string", "description":"The transaction UTC date and time", "title":"The transaction UTC date and time", "format":"date-time" }, "transLcl":{ "type":"string", "description":"The transaction local store date and time", "title":"The transaction local store date and time", "format":"date-time" }, "pmntType":{ "type":"boolean", "description":"Type of the payment. Possible values: PAY, VOID, CANCEL, REFUND, ADJUSTMENT", "title":"Type of the payment", "maxLength":30 }, "tmedNum":{ "type":"string", "description":"Tender media number, can be used to lookup from getTenderMediaDimensions", "title":"Tender media number", "maxLength":16 }, "seqNum":{ "type":"string", "description":"Unique transaction identifier issued by Simphony Payment Interface (SPI)", "title":"Unique transaction identifier", "maxLength":12 }, "wsNum":{ "type":"integer", "description":"Workstation number, can be used to lookup from getLocationDimensions", "title":"Workstation number", "maxLength":16 }, "empNum":{ "type":"integer", "description":"Employee number of the transaction employee, can be used to lookup from getEmployeeDimensions", "title":"Employee number", "maxLength":16 }, "terminalID":{ "type":"string", "description":"Payment terminal identifier issued by Payment Service Provider (PSP)", "title":"Payment terminal identifier issued by Payment Service Provider (PSP)", "maxLength":99 }, "entryMode":{ "type":"integer", "description":"Return a numeric representation of the entry mode of the payment transaction. Following are possible values and their description:| Entry Mode | Entry Mode Description |
|---|---|
| 0 | EMV Fallback |
| 1 | Swiping without PIN (Backwards compatibility 6.1) |
| 2 | Manual enter card number (Backwards compatibility 6.1) |
| 3 | Swiping with PIN (Backwards compatibility 6.1) |
| 4 | EMV without PIN (Backwards compatibility 6.1) |
| 5 | EMV with offline PIN (Backwards compatibility 6.1) |
| 6 | EMV with on line PIN (Backwards compatibility 6.1) |
| 7 | Proximity via Magnetic Stripe (Backwards compatibility 6.1) |
| 8 | Proximity via ICC |
| 9 | Others |
| 10 | EMV Fallback (Signature Verification) |
| 11 | Proximity via Magnetic Stripe (Signature Verification) |
| 12 | Proximity via Magnetic Stripe (No CVM) |
| 13 | Proximity via ICC (Signature Verification) |
| 14 | Proximity via ICC (PIN Verification) |
| 15 | Proximity via ICC (Customer Device Verified) |
| 16 | Proximity via ICC (No CVM) |
| 17 | Swiping without PIN (Signature Verification) |
| 18 | Swiping with PIN (PIN Verification) |
| 19 | Swiping (No CVM ) |
| 20 | Manual enter card number (Signature Verification) |
| 21 | Manual enter card number (No CVM) |
| 22 | EMV (Signature Verification) |
| 23 | EMV (PIN Verification) |
| 24 | EMV (PIN & Signature Verification) |
| 25 | EMV (No CVM) |
| 26 | E-Wallet Payment |
| 27 | Saved Card Token (No CVM) |
First available version 20.2
\n", "title":"Payment unique identifier", "maxLength":80 }, "pymtDtlID":{ "type":"string", "description":"Unique identifier for each status a payment transaction flows through during processing. Use this ID to link the payment POS transaction to subsequent settlement and payout transactions.First available version 20.2
\n", "title":"Payment status unique identifier", "maxLength":80 }, "curStatus":{ "type":"string", "description":"The current status of the payment transaction. Possible values: SUBMITTEDFORPROCESSING, RECEIVED, REFUSED, CANCELLED, SETTLED, REFUNDED, CHARGEBACK, CHARGEBACKREVERSED, SECONDCHARGEBACK. This attribute will not be returned in the response if value is 0 or null.First available version 20.2
\n", "title":"The status of payemnt transaction", "maxLength":80 }, "cancelAmt":{ "type":"string", "description":"The amount canceled. Only populated if a payment transaction is canceled. This attribute will not be returned in the response if value is 0 or null.First available version 20.2
\n", "title":"The amount canceledr", "maxLength":80 }, "configStoreId":{ "type":"string", "description":"The revenue center where the terminal was onboarded. This attribute will not be returned in the response if value is 0 or null.First available version 20.2
\n", "title":"Terminal revenue centre", "maxLength":80 } }, "required":[ "pspRef", "checkNum", "guestCheckID", "guestCheckLineItemId", "transAmt", "tipAmt", "transUTC", "transLcl", "pmntType", "tmedNum", "seqNum", "wsNum", "empNum", "terminalID", "entryMode", "cardPresentFlag", "authCode", "cardAlias", "offlineFlag", "raPostUTC", "payPostUTC", "rrn", "modPspRef", "pymtID", "pymtDtlID" ] }, "paymentPayoutsDimensions":{ "description":"The response body contains information about the payment payouts.", "properties":{ "bookingDt":{ "type":"string", "description":"The booking date associated with the payout transactions", "title":"Booking date", "format":"date" }, "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location reference", "maxLength":99 }, "accounts":{ "type":"array", "description":"An array of accounts", "items":{ "$ref":"#/definitions/paymentPayoutsAccounts" } } }, "required":[ "bookingDt", "locRef", "accounts" ] }, "paymentPayoutsAccounts":{ "description":"The response body contains information about the payment payouts accounts.", "properties":{ "acctCode":{ "type":"string", "description":"Unique code of the account", "title":"Account code", "maxLength":50 }, "revenueCenters":{ "type":"array", "description":"An array of Revenue centers", "items":{ "$ref":"#/definitions/paymentPayoutsRevenueCenters" } } }, "required":[ "acctCode", "revenueCenters" ] }, "paymentPayoutsRevenueCenters":{ "description":"The response body contains information about the payment payouts revenue centre.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue center number", "title":"Revenue center number", "maxLength":10 }, "businessDates":{ "type":"array", "description":"An array of business dates", "items":{ "$ref":"#/definitions/paymentPayoutsBusinessDates" } } }, "required":[ "rvcNum", "businessDates" ] }, "paymentPayoutsBusinessDates":{ "description":"The response body contains information about the payment payouts business dates.", "properties":{ "busDt":{ "type":"string", "description":"The business date associated with the transactions", "title":"Business date", "format":"date" }, "payouts":{ "type":"array", "description":"An array of payouts", "items":{ "$ref":"#/definitions/paymentPayoutsPayouts" } } }, "required":[ "busDt", "payouts" ] }, "paymentPayoutsPayouts":{ "description":"The response body contains information about the payment payouts.", "properties":{ "pspRef":{ "type":"string", "description":"Reference identifying the transaction, issued by Payment Service Provider (PSP)", "title":"Reference identifying the transaction, issued by Payment Service Provider (PSP)", "maxLength":64 }, "payoutDetails":{ "type":"array", "description":"An array of payout details", "items":{ "$ref":"#/definitions/paymentPayoutsPayoutDetails" } } }, "required":[ "pspRef", "payoutDetails" ] }, "paymentPayoutsPayoutDetails":{ "description":"The response body contains information about the payment payouts details.", "properties":{ "merchAcctRef":{ "type":"string", "description":"The name of the merchant account", "title":"Merchant account ", "maxLength":255 }, "payoutPspRef":{ "type":"string", "description":"Reference identifying the payout issued by Payment Service Provider (PSP)", "title":"Payout reference", "maxLength":64 }, "recordType":{ "type":"string", "description":"Record Type of the payout. Possible values: CREDITED, CREDITFAILED, DEBITED, DEBITFAILED, CHARGEBACK, CHARGEBACKREVERSED, CREDITREVERSED, SECONDCHARGEBACK, FUNDTRANSFER, PAYOUT", "title":"Record type", "maxLength":50 }, "merchRef":{ "type":"string", "description":"Merchant reference for the transaction.", "title":"Merchant reference for the transaction", "maxLength":80 }, "pspTransDateTime":{ "type":"string", "description":"PSP transaction date and time in UTC timezone associated with the payout transactions", "title":"PSP transaction date and time", "format":"date-time" }, "posTransDateTime":{ "type":"string", "description":"POS transaction business date and time associated with the payout transactions", "title":"POS transaction business date and time", "format":"date-time" }, "payoutType":{ "type":"string", "description":"Record Type of the payout. Possible values: TRANS, FEE, or TRANSANDFEE", "title":"Payout type", "maxLength":50 }, "payoutCurr":{ "type":"string", "description":"Currency of the payout transaction", "title":"Payout currency", "maxLength":3 }, "payoutAmt":{ "type":"number", "description":"Amount of the payout transaction", "title":"Payout amount" }, "modPspRef":{ "type":"string", "description":"This is the modification reference provided by the PSP, a unique ID that identifies the modification request, if applicable.", "title":"Modification reference provided by the PSP", "maxLength":80 }, "pymtID":{ "type":"string", "description":"Unique identifier for a payment transaction. Use this ID to link the payment POS transaction to subsequent settlement and payout transactions.First available version 20.2
\n", "title":"Payment unique identifier", "maxLength":80 }, "pymtDtlID":{ "type":"string", "description":"Unique identifier for each status a payment transaction flows through during processing. Use this ID to link the payment POS transaction to subsequent settlement and payout transactions.First available version 20.2
\n", "title":"Payment status unique identifier", "maxLength":80 }, "transPayoutPspRef":{ "type":"string", "description":"The transaction payout reference issues by the PSP, a unique ID that identifies the payout of the transaction amount. This attribute will not be returned in the response if value is 0 or null.First available version 20.2
\n", "title":"The PSP transaction payout reference", "maxLength":80 }, "feePayoutPspRef":{ "type":"string", "description":"The fee payout reference issues by the PSP, a unique ID that identifies the payout of the fees associated with the transactions. This attribute will not be returned in the response if value is 0 or null.First available version 20.2
\n", "title":"The PSP fee payout reference", "maxLength":80 }, "oracleFees":{ "type":"string", "description":"The amount of fees withheld for processing the payment transaction. This attribute will not be returned in the response if value is 0 or null.First available version 20.2
\n", "title":"The processing fees", "maxLength":80 } }, "required":[ "merchAcctRef", "payoutPspRef", "recordType", "merchRef", "pspTransDateTime", "posTransDateTime", "payoutType", "payoutCurr", "payoutAmt", "modPspRef", "pymtID", "pymtDtlID" ] }, "paymentPayoutSummaryDimensions":{ "description":"The response body contains information about the payment account.", "properties":{ "payoutDt":{ "type":"string", "description":"The date on which the batch payout happened", "title":"Payout date", "format":"date" }, "acctCode":{ "type":"string", "description":"Unique code of the account", "title":"Account code", "maxLength":99 }, "payouts":{ "type":"array", "description":"An array of payouts", "items":{ "$ref":"#/definitions/paymentPayoutSummaryPayouts" } } }, "required":[ "payoutDt", "acctCode", "payouts" ] }, "paymentPayoutSummaryPayouts":{ "description":"The response body contains summary of the paymet payouts.", "properties":{ "payoutPspRef":{ "type":"string", "description":"Reference identifying the payout issued by Payment Service Provider (PSP). This attribute will not be returned in the response if value is 0 or null.\n", "title":"PSP reference", "maxLength":128 }, "payoutUTC":{ "type":"string", "description":"Date and Time of the batch payout in UTC timezone. This attribute will not be returned in the response if value is 0 or null.\n", "title":"Date and Time of the batch payout", "format":"date-time" }, "payoutCurr":{ "type":"string", "description":"Currency of the payout transaction. This attribute will not be returned in the response if value is 0 or null.\n", "title":"Payout currency", "maxLength":3 }, "payoutAmt":{ "type":"string", "description":"The amount of the batch payout. This attribute will not be returned in the response if value is 0 or null.\n", "title":"The batch payout amount" }, "wthhldAmt":{ "type":"number", "description":"The amount withheld from the payout. This can happen if upcoming chargeback or refund payouts were to exceed the expected transaction payout amounts on the next payout date. This attribute will not be returned in the response if value is 0 or null.\n", "title":"The amount withheld from the payout" } }, "required":[ "payoutDt", "acctCode" ] }, "paymentChargebacksDimensions":{ "description":"The response body contains information about the payment chargebacks.", "properties":{ "recordDt":{ "type":"string", "description":"The record date associated with the chargeback transactions", "title":"Chargeback record date", "format":"date" }, "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location reference", "maxLength":99 }, "accounts":{ "type":"array", "description":"An array of accounts", "items":{ "$ref":"#/definitions/paymentChargebacksAccounts" } } }, "required":[ "recordDt", "locRef", "accounts" ] }, "paymentChargebacksAccounts":{ "description":"The response body contains information about the accounts.", "properties":{ "acctCode":{ "type":"string", "description":"Unique code of the account", "title":"Account code", "maxLength":50 }, "revenueCenters":{ "type":"array", "description":"An array of revenue centers", "items":{ "$ref":"#/definitions/paymentChargebacksRevenueCenters" } } }, "required":[ "acctCode", "revenueCenters" ] }, "paymentChargebacksRevenueCenters":{ "description":"The response body contains information about the payment chargebacks revenue centre.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue center number", "title":"Revenue center number", "maxLength":10 }, "chargebacks":{ "type":"array", "description":"An array of chargebacks", "items":{ "$ref":"#/definitions/paymentChargebackschargebacks" } } }, "required":[ "rvcNum", "chargebacks" ] }, "paymentChargebackschargebacks":{ "description":"The response body contains information about the payment chargebacks.", "properties":{ "recordType":{ "type":"string", "description":"Shows the record type. Possible values: REQUESTFORINFORMATION, NOTIFICATIONOFFRAUD, CHARGEBACK, INFORMATIONSUPPLIED, CHARGEBACKREVERSED, NOTIFICATIONOFCHARGEBACK, SECONDCHARGEBACK, ACQUIRERPREARBITRATIONUPLOADED, PREARBITRATIONWON, PREARBITRATIONLOST", "title":"Record type", "maxLength":50 }, "disputePspRef":{ "type":"string", "description":"PSP reference of the chargeback transaction", "title":"Chargeback reference", "maxLength":256 }, "pmntType":{ "type":"string", "description":"Type of the payment. Possible values: PAY, VOID, CANCEL, REFUND, ADJUSTMENT", "title":"Type of the payment", "maxLength":30 }, "checkNum":{ "type":"integer", "description":"Number of the check related to the transaction", "title":"Check number", "maxLength":10 }, "guestCheckID":{ "type":"integer", "description":"Unique identifier of the guest check", "title":"Guest check identifier", "maxLength":16 }, "guestCheckLineItemId":{ "type":"integer", "description":"Unique identifier of the guest check line item", "title":"Guest check line item identifier", "maxLength":16 }, "disputeUTC":{ "type":"string", "description":"The UTC Date and time of when the chargeback transaction was initiated", "title":"Dispute date and time", "format":"date-time" }, "transAmt":{ "type":"number", "description":"Amount of the disputed payment transaction", "title":"Transaction amount" }, "disputeCur":{ "type":"string", "description":"Currency of the transaction", "title":"Currency of the transaction", "maxLength":3 }, "disputeAmt":{ "type":"number", "description":"Amount charged-back", "title":"Amount charged-back" }, "currStatus":{ "type":"boolean", "description":"Indicates if this record is the current status of the chargeback. Downstream systems should reset the current status flag of prior records to \"false\"", "title":"Chargeback status" }, "chgbkSchemeCode":{ "type":"string", "description":"Card scheme", "title":"Card scheme", "maxLength":30 }, "chgbkRsnCode":{ "type":"string", "description":"Chargeback reason code", "title":"Chargeback reason code", "maxLength":30 }, "disputeRsn":{ "type":"string", "description":"Chargeback reason description", "title":"Chargeback reason description", "maxLength":256 }, "pspRef":{ "type":"string", "description":"Reference identifying the original transaction, issued by Payment Service Provider (PSP)", "title":"Transaction reference", "maxLength":64 }, "busDt":{ "type":"string", "description":"The business date associated with the transaction", "title":"Business date", "format":"date" }, "autodefense":{ "type":"boolean", "description":"Was the transaction autodefended by the payment service provider (PSP)", "title":"Is transaction autodefended" }, "disputeEndUTC":{ "type":"string", "description":"Date and time of day when dispute defense period ended", "title":"End of the dispute defense period", "format":"date-time" }, "modPspRef":{ "type":"string", "description":"This is the modification reference provided by the PSP, a unique ID that identifies the modification request, if applicable.", "title":"Modification reference provided by the PSP", "maxLength":80 }, "pymtID":{ "type":"string", "description":"Unique identifier for a payment transaction. Use this ID to link the payment POS transaction to subsequent settlement and payout transactions.First available version 20.2
\n", "title":"Payment unique identifier", "maxLength":80 }, "pymtDtlID":{ "type":"string", "description":"Unique identifier for each status a payment transaction flows through during processing. Use this ID to link the payment POS transaction to subsequent settlement and payout transactions.First available version 20.2
\n", "title":"Payment status unique identifier", "maxLength":80 } }, "required":[ "recordType", "disputePspRef", "pmntType", "checkNum", "guestCheckID", "guestCheckLineItemId", "disputeUTC", "transAmt", "disputeCur", "disputeAmt", "currStatus", "chgbkSchemeCode", "chgbkRsnCode", "disputeRsn", "pspRef", "busDt", "autodefense", "disputeEndUTC", "modPspRef", "pymtID", "pymtDtlID" ] }, "paymentSettlementsPayload":{ "description":"Request payload for payment settlement details", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location reference", "maxLength":99 }, "stlmtDt":{ "type":"string", "description":"The settlement date associated with the payment settlement details", "title":"Payment settlement date", "format":"date" }, "include":{ "type":"string", "description":"List of objects to include in response", "title":"Include", "maxLength":2000 }, "searchCriteria":{ "type":"string", "description":"Search criteria to filter results based on field value", "title":"Search criteria", "maxLength":2000 }, "applicationName":{ "type":"string", "description":"The name of the application which is accessing the API", "title":"Application name", "maxLength":128 } }, "required":[ "locRef", "stlmtDt" ] }, "paymentTransactionsPayload":{ "description":"Request payload for payment transaction details", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"The business date associated with the daily control totals", "title":"Business date", "format":"date" }, "changedSinceUTC":{ "type":"string", "description":"The UTC date and time of a change made in the transaction", "title":"Date and time of a change ", "format":"date-time" }, "include":{ "type":"string", "description":"List of objects to include in response", "title":"Include", "maxLength":2000 }, "searchCriteria":{ "type":"string", "description":"Search criteria to filter results based on field value", "title":"Search criteria", "maxLength":2000 }, "applicationName":{ "type":"string", "description":"The name of the application which is accessing the API", "title":"Application name", "maxLength":128 } }, "required":[ "locRef", "busDt" ] }, "paymentPayoutSummaryPayload":{ "description":"Request payload for payment payout summary details", "properties":{ "payoutDt":{ "type":"string", "description":"The date on which the batch payout happened", "title":"Payout date", "format":"date" }, "acctCode":{ "type":"string", "description":"Unique code of the account", "title":"Account code" }, "changedSinceUTC":{ "type":"string", "description":"The UTC date and time of a change made in the transaction", "title":"Date and time of a change ", "format":"date-time" }, "include":{ "type":"string", "description":"List of objects to include in response", "title":"Include", "maxLength":2000 }, "searchCriteria":{ "type":"string", "description":"Search criteria to filter results based on field value", "title":"Search criteria", "maxLength":2000 }, "applicationName":{ "type":"string", "description":"The name of the application which is accessing the API", "title":"Application name", "maxLength":128 } }, "required":[ "payoutDt", "acctCode" ] }, "paymentPayoutsPayload":{ "description":"Request payload for payment payout details", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location reference", "maxLength":99 }, "bookingDt":{ "type":"string", "description":"The booking date associated with the payout transactions", "title":"Booking date", "format":"date" }, "include":{ "type":"string", "description":"List of objects to include in response", "title":"Include", "maxLength":2000 }, "searchCriteria":{ "type":"string", "description":"Search criteria to filter results based on field value", "title":"Search criteria", "maxLength":2000 }, "applicationName":{ "type":"string", "description":"The name of the application which is accessing the API", "title":"Application name", "maxLength":128 } }, "required":[ "locRef", "bookingDt" ] }, "paymentChargebacksPayload":{ "description":"Request payload for payment chargeback details", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location reference", "maxLength":99 }, "recordDt":{ "type":"string", "description":"The record date associated with the transactions", "title":"Record date", "format":"date" }, "include":{ "type":"string", "description":"List of objects to include in response", "title":"Include", "maxLength":2000 }, "searchCriteria":{ "type":"string", "description":"Search criteria to filter results based on field value", "title":"Search criteria", "maxLength":2000 }, "applicationName":{ "type":"string", "description":"The name of the application which is accessing the API", "title":"Application name", "maxLength":128 } }, "required":[ "locRef", "recordDt" ] }, "controlDailyTotals":{ "description":"The response body contains information about the control totals for the specified business date and location.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business Date", "title":"Business Date", "format":"date" }, "eodStatus":{ "type":"integer", "description":"End of Day status. O = Open, 1 = Closed", "title":"End of Day Status" }, "lastUpdatedUTC":{ "type":"string", "description":"The date and time of the most recent transaction updates or inserts in the cloud as a UTC time.First Available Version: 20.1.12
", "title":"Last Updated Date Time UTC", "format":"date-time" }, "lastUpdatedLcl":{ "type":"string", "description":"The date and time of the most recent transaction updates or inserts in the cloud in the location's timezone.First Available Version: 20.1.12
", "title":"Last Updated Date Time Local", "format":"date-time" }, "firstTransUTC":{ "type":"string", "description":"The UTC date and time of first transaction in this business day", "title":"First Transaction UTC", "format":"date-time" }, "firstTransLcl":{ "type":"string", "description":"The date and time of first transaction in this business day in the location's timezone.First Available Version: 20.1.9.6
", "title":"First Transaction Local", "format":"date-time" }, "lastTransUTC":{ "type":"string", "description":"The UTC date and time of last transaction in this business day", "title":"Last Transaction UTC", "format":"date-time" }, "lastTransLcl":{ "type":"string", "description":"The date and time of last transaction in this business day in the location's timezone.First Available Version: 20.1.9.6
", "title":"Last Transaction Local", "format":"date-time" }, "revenueCenters":{ "type":"array", "description":"An array of Control Totals by RVC", "items":{ "$ref":"#/definitions/controlTotalsByRVC" } } }, "required":[ "locRef", "busDt", "eodStatus", "lastUpdatedUTC", "lastUpdatedLcl", "firstTransUTC", "firstTransLcl", "lastTransUTC", "lastTransLcl", "revenueCenters" ] }, "controlTotalsByRVC":{ "description":"The response body contains control totals about a revenue center for the specified location.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number", "title":"Revenue Center Number", "maxLength":10 }, "numClsdChecks":{ "type":"integer", "description":"The number of checks closed for the business date", "title":"Number of Closed Checks", "maxLength":16 }, "clsdChkTtl":{ "type":"number", "description":"The amount of all closed checks including taxes and service charges.", "title":"Closed Checks Total" }, "numOpnChksAtEOD":{ "type":"integer", "description":"The number of open checks at end of day", "title":"Number of Open Checks at End of Day", "maxLength":16 }, "opnChkTtlAtEOD":{ "type":"number", "description":"The amount of open checks at end of day including taxes, service charges, payments, etc.", "title":"Open Check total at End of Day" }, "numNonSlsTrans":{ "type":"integer", "description":"The number of non-sales transactions that occurred during this business day, including no sales and media transactions.", "title":"Number of Non Sale Transactions", "maxLength":16 } }, "required":[ "rvcNum" ] }, "opDailyTotals":{ "description":"The response body contains information about the operations daily totals for the specified business date and location.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business Date", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of operations daily totals by RVC", "items":{ "$ref":"#/definitions/opDailyTotalsByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "opDailyTotalsByRVC":{ "description":"The response body contains operations daily totals of a revenue center for the specified location and business date.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This will not be returned if there are no totals for the associated revenue center", "title":"Revenue Center Number", "maxLength":10 }, "netSlsTtl":{ "type":"number", "description":"Total of net sales for the day", "title":"Net Sales Total" }, "itmDscTtl":{ "type":"number", "description":"Total of item discounts for the day", "title":"Item Discount Total" }, "subDscTtl":{ "type":"number", "description":"Total of sub total discounts for the day", "title":"Sub Discount Total" }, "svcTtl":{ "type":"number", "description":"Total of service charges for the day", "title":"Service Charge Total" }, "nonRevSvcTtl":{ "type":"number", "description":"Non-revenue service charge, and non-revenue menu item total such as gift cards sales. This attribute will not be returned in the response if value is 0 or null", "title":"Non Revenue Service Charge Total" }, "rtnCnt":{ "type":"integer", "description":"Total number of items returned in the day. This attribute will not be returned in the response if value is 0 or null", "title":"Return Count", "maxLength":16 }, "rtnTtl":{ "type":"number", "description":"Total value of returned items for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Return Total" }, "credTtl":{ "type":"number", "description":"Total of tax credits for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Credit Total" }, "rndTtl":{ "type":"number", "description":"Total of currency roundings for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Round Total" }, "chngInGrndTtl":{ "type":"number", "description":"Change in Grand Total for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Change in Grand Total" }, "nonTxblSlsTtl":{ "type":"number", "description":"Total of non taxable sales for the day", "title":"Non Taxable Sales Total" }, "txblSlsTtl":{ "type":"number", "description":"Total of taxable sales for the day", "title":"Taxable Sales Total" }, "taxExmptSlsTtl":{ "type":"number", "description":"Total of tax exempted sales for the day", "title":"Tax Exempt Sales Total" }, "taxCollTtl":{ "type":"number", "description":"Total of tax collected for the day", "title":"Tax Collected Total" }, "slsFcst":{ "type":"number", "description":"Total of forecasted sales for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Sales Forecast" }, "prepCostTtl":{ "type":"number", "description":"Total of preparation cost for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Prepartion Cost total" }, "tblTurnCnt":{ "type":"integer", "description":"Total number of tables turns for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Table Turn Count", "maxLength":16 }, "chkCnt":{ "type":"integer", "description":"Total number of checks for the day.", "title":"Check Count", "maxLength":16 }, "waitPtyCnt":{ "type":"integer", "description":"Total number of waiting parties for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Waiting Party Count", "maxLength":16 }, "waitTimeInMins":{ "type":"number", "description":"Total wait time for the day in minutes. This attribute will not be returned in the response if value is 0 or null", "title":"Wait time in miuntes", "maxLength":16 }, "gstCnt":{ "type":"integer", "description":"Total number of guests for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Guest Count", "maxLength":16 }, "dineTimeInMins":{ "type":"number", "description":"Total dining time for the day in minutes. This attribute will not be returned in the response if value is 0 or null", "title":"Dine Time in minutes", "maxLength":16 }, "parkCarCnt":{ "type":"integer", "description":"Total number of cars parked for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Parked Car Count", "maxLength":16 }, "drvThruTimeInMins":{ "type":"number", "description":"Total drive through time for the day in minutes. This attribute will not be returned in the response if value is 0 or null", "title":"Drive through Time in minutes", "maxLength":16 }, "vdTtl":{ "type":"number", "description":"Total of items voided for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Void Total" }, "vdCnt":{ "type":"integer", "description":"Number of items voided for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Void Count", "maxLength":16 }, "errCorTtl":{ "type":"number", "description":"Total of items which were error corrected for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Error Correct Total" }, "errCorCnt":{ "type":"integer", "description":"Number of items which were error corrected for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Error Correct Count", "maxLength":16 }, "mngrVdTtl":{ "type":"number", "description":"Total items which were voided by the manager of the employee. This attribute will not be returned in the response if value is 0 or null", "title":"Manager Void Total" }, "mngrVdCnt":{ "type":"integer", "description":"Number of items which were voided by the manager of the employee. This attribute will not be returned in the response if value is 0 or null", "title":"Manager Void Count", "maxLength":16 }, "transCnclTtl":{ "type":"number", "description":"Total of transactions that were cancelled for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Transaction Cancel Total" }, "transCnclCnt":{ "type":"integer", "description":"Number of transactions that were cancelled for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Transaction Cancel Count", "maxLength":16 }, "carryoverTtl":{ "type":"number", "description":"Total of items that were carried over for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Carry Over Total" }, "carryoverCnt":{ "type":"integer", "description":"Number of items that were carried over for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Carry Over Count", "maxLength":16 }, "chkOpnTtl":{ "type":"number", "description":"Total of checks that were were rung in the day which remain in open state", "title":"Check Open Total" }, "chkOpnCnt":{ "type":"integer", "description":"Number of checks that were were rung in the day which remain in open state", "title":"Check Open Count", "maxLength":16 }, "chkClsdTtl":{ "type":"number", "description":"Total of checks that were were closed in the day", "title":"Check Closed Total" }, "chkClsdCnt":{ "type":"integer", "description":"Number of checks that were were closed in the day", "title":"Check Closed Count", "maxLength":16 }, "chkXferInTtl":{ "type":"number", "description":"Total of checks that were transferred in for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Check Transfer In Total" }, "chkXferInCnt":{ "type":"integer", "description":"Number of checks that were transferred in for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Check Transfer In Count", "maxLength":16 }, "chkXferOutTtl":{ "type":"number", "description":"Total of checks that were transferred out for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Check Transfer Out Total" }, "chkXferOutCnt":{ "type":"integer", "description":"Number of checks that were transferred out for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Check Transfer Out Count", "maxLength":16 }, "overShortTtl":{ "type":"number", "description":"Over Short Total. This attribute will not be returned in the response if value is 0 or null", "title":"Over Short Total" }, "noSalesCnt":{ "type":"integer", "description":"Number of no sale transactions for the day. This attribute will not be returned in the response if value is 0 or null", "title":"No Sale Transaction Count", "maxLength":16 }, "trnChkTtl":{ "type":"number", "description":"Total of checks that were used for training for the day. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.10First Available Version: 20.1.10First available version 20.1.14.13
", "title":"Tip track tip out amount" } }, "required":[ "empNum", "netSlsTtl", "itmDscTtl", "subDscTtl", "svcTtl", "nonRevSvcTtl", "rtnCnt", "rtnTtl", "credTtl", "rndTtl", "chngInGrndTtl", "tblTurnCnt", "dineTimeInMins", "chkCnt", "gstCnt", "vdTtl", "vdCnt", "errCorTtl", "errCorCnt", "mngrVdTtl", "mngrVdCnt", "transCnclTtl", "transCnclCnt", "carryoverTtl", "carryoverCnt", "chkOpnTtl", "chkOpnCnt", "chkClsdTtl", "chkClsdCnt", "chkXferInTtl", "chkXferInCnt", "chkXferOutTtl", "chkXferOutCnt", "noSalesCnt", "grossRcptsTtl", "chrgRcptsTtl", "chrgTipsTtl", "indirTipsPdTtl", "tipsDclrdTtl", "tipsPdTtl", "tipTtl", "taxTtl", "tipsOutTtl" ] }, "miDailyTotals":{ "description":"The response body contains information about the daily totals by menu item for the specified location and business date.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business Date", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of Menu Item Daily Totals by Revenue Centers", "items":{ "$ref":"#/definitions/miDailyTotalsByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "miDailyTotalsByRVC":{ "description":"The response body contains daily totals by menu item of a revenue center for the specified location and business date.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if menuItems is null", "title":"Revenue Center Number", "maxLength":10 }, "menuItems":{ "type":"array", "description":"An array of daily totals by menu item for a revenue center. This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/miDailyTotal" } } }, "required":[ "rvcNum", "menuItems" ] }, "miDailyTotal":{ "description":"The response body contains daily totals by menu item for a revenue center for the specified location and business date.", "properties":{ "miNum":{ "type":"integer", "description":"Menu Item Number", "title":"Menu Item Number", "maxLength":16 }, "prcLvlNum":{ "type":"integer", "description":"Unique identifier for the menu item's price level", "title":"Price Level Number", "maxLength":16 }, "ocNum":{ "type":"integer", "description":"Unique 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
", "title":"Order Channel number", "maxLength":16 }, "otNum":{ "type":"integer", "description":"Unique identfier of the order type. This attribute will not be returned in the response if value is 0 or null", "title":"Order Type Number", "maxLength":16 }, "slsTtl":{ "type":"number", "description":"Total Sales of the menu item", "title":"Sales Total" }, "slsCnt":{ "type":"integer", "description":"Total Sales Count of the menu item.", "title":"Sales Count", "maxLength":16 }, "rtnCnt":{ "type":"integer", "description":"Total Return Count of the menu item. This attribute will not be returned in the response if value is 0 or null", "title":"Return Count", "maxLength":16 }, "dscTtl":{ "type":"number", "description":"Item discount Total of the menu item. This attribute will not be returned in the response if value is 0 or null", "title":"Discount Total" }, "vol":{ "type":"number", "description":"Sales volume of the menu item. This attribute will not be returned in the response if value is 0 or null", "title":"Volume" }, "prepCost":{ "type":"number", "description":"Total Preparation cost associated with the menu item. This attribute will not be returned in the response if value is 0 or null", "title":"Prepartion Cost" }, "vatTtl":{ "type":"number", "description":"VAT total of the menu item. This attribute will not be returned in the response if value is 0 or null", "title":"VAT Total", "multipleOf":"0.0000010" }, "dscVatTtl":{ "type":"number", "description":"Discount VAT Total of the menu item. This attribute will not be returned in the response if value is 0 or null", "title":"Discount VAT Total", "multipleOf":"0.0000010" }, "inclTaxTtl":{ "type":"number", "description":"Total amount of inclusive taxes. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.10.1
", "title":"Total amount of inclusive taxes" }, "forgivenInclTaxTtl":{ "type":"number", "description":"Total amount of inclusive taxes forgiven. Applicable for Australian GST configurations. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.10.1
", "title":"Total amount of inclusive taxes forgiven." } }, "required":[ "miNum", "prcLvlNum", "slsTtl", "slsCnt", "otNum", "rtnCnt", "dscTtl", "vol", "prepCost", "vatTtl", "dscVatTtl", "inclTaxTtl", "forgivenInclTaxTtl" ] }, "cmbDailyTotals":{ "description":"The response body contains information about the daily totals by combo item for the specified location and business date.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business Date", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of Combo Item Daily Totals by Revenue Centers", "items":{ "$ref":"#/definitions/cmbDailyTotalsByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "cmbDailyTotalsByRVC":{ "description":"The response body contains daily totals by combo item of a revenue center for the specified location and business date.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if menuItems is null", "title":"Revenue Center Number", "maxLength":10 }, "comboItems":{ "type":"array", "description":"An array of daily totals by combo item for a revenue center. This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/cmbDailyTotal" } } }, "required":[ "rvcNum", "comboItems" ] }, "cmbDailyTotal":{ "description":"The response body contains daily totals by combo item for a revenue center for the specified location and business date.", "properties":{ "comboMiNum":{ "type":"integer", "description":"Menu item number of the primary combo meu item. This remains same for all the components of the combo meal.", "title":"Combo Menu Item Number", "maxLength":16 }, "componentMiNum":{ "type":"integer", "description":"Menu item number of the component of the combo meal. This attribute will not be returned in the response if value is null", "title":"Component Menu Item Number", "maxLength":16 }, "origMiNum":{ "type":"integer", "description":"Original menu item number of the combo meal component. This attribute will not be returned in the response if value is null", "title":"Original Menu Item Number", "maxLength":16 }, "otNum":{ "type":"integer", "description":"Unique identfier of the order type. This attribute will not be returned in the response if value is 0 or null", "title":"Order Type Number", "maxLength":16 }, "ocNum":{ "type":"integer", "description":"Unique 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
", "title":"Order Channel number", "maxLength":16 }, "slsTtl":{ "type":"number", "description":"Total sales of the combo item", "title":"Sales Total" }, "slsCnt":{ "type":"integer", "description":"Total count of sales of the combo item", "title":"Sales Count", "maxLength":16 }, "dscTtl":{ "type":"number", "description":"Item discount value of the combo item. This attribute will not be returned in the response if value is 0 or null", "title":"Discount Total" }, "vatTtl":{ "type":"number", "description":"VAT total with extended precision. This attribute will not be returned in the response if value is 0 or null", "title":"VAT Total", "multipleOf":"0.0000010" }, "dscVatTtl":{ "type":"number", "description":"Discount VAT Total with extended precision. This attribute will not be returned in the response if value is 0 or null", "title":"Discount VAT Total", "multipleOf":"0.0000010" }, "components":{ "type":"array", "description":"An array of daily totals of components of the combo item for a revenue center. This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/cmbCompDailyTotal" } } }, "required":[ "comboMiNum", "componentMiNum", "origMiNum", "slsTtl", "slsCnt", "otNum", "dscTtl", "vatTtl", "dscVatTtl", "components" ] }, "cmbCompDailyTotal":{ "description":"The response body contains daily totals of components of a combo item for a revenue center for the specified location and business date.", "properties":{ "componentMiNum":{ "type":"integer", "description":"Menu item number of the component of the combo meal. This attribute will not be returned in the response if value is null", "title":"Component Menu Item Number", "maxLength":16 }, "origMiNum":{ "type":"integer", "description":"Original menu item number of the combo meal component. This attribute will not be returned in the response if value is null", "title":"Original Menu Item Number", "maxLength":16 }, "otNum":{ "type":"integer", "description":"Unique identfier of the order type. This attribute will not be returned in the response if value is 0 or null", "title":"Order Type Number", "maxLength":16 }, "ocNum":{ "type":"integer", "description":"Unique 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
", "title":"Order Channel number", "maxLength":16 }, "slsTtl":{ "type":"number", "description":"Total sales of the combo item", "title":"Sales Total" }, "slsCnt":{ "type":"integer", "description":"Total count of sales of the combo item", "title":"Sales Count", "maxLength":16 }, "dscTtl":{ "type":"number", "description":"Item discount value of the combo item. This attribute will not be returned in the response if value is 0 or null", "title":"Discount Total" }, "vatTtl":{ "type":"number", "description":"VAT total with extended precision. This attribute will not be returned in the response if value is 0 or null", "title":"VAT Total", "multipleOf":"0.0000010" }, "dscVatTtl":{ "type":"number", "description":"Discount VAT Total with extended precision. This attribute will not be returned in the response if value is 0 or null", "title":"Discount VAT Total", "multipleOf":"0.0000010" } }, "required":[ "componentMiNum", "origMiNum", "slsTtl", "slsCnt", "otNum", "dscTtl", "vatTtl", "dscVatTtl" ] }, "dscDailyTotals":{ "description":"The response body contains information about the daily totals of discounts for the specified location and business date.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business Date", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of Discount Daily Totals by Revenue Centers", "items":{ "$ref":"#/definitions/dscDailyTotalsByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "dscDailyTotalsByRVC":{ "description":"The response body contains daily totals of discounts applied at a revenue center for the specified location and business date.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if discounts is null", "title":"Revenue Center Number", "maxLength":10 }, "discounts":{ "type":"array", "description":"An array of daily totals of discounts for a revenue center. This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/dscDailyTotal" } } }, "required":[ "rvcNum", "discounts" ] }, "dscDailyTotal":{ "description":"The response body contains daily totals of discounts for a revenue center for the specified location and business date.", "properties":{ "dscNum":{ "type":"integer", "description":"Unique identifier of the discount", "title":"Discount Number", "maxLength":16 }, "ttl":{ "type":"number", "description":"Total value of discount", "title":"Discount Total" }, "cnt":{ "type":"integer", "description":"Total number of times the discount was applied", "title":"Discount Count", "maxLength":16 } }, "required":[ "dscNum", "ttl", "cnt" ] }, "svcDailyTotals":{ "description":"The response body contains information about the daily totals of service charges for the specified location and business date.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business date", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of service charge daily totals by revenue centers", "items":{ "$ref":"#/definitions/svcDailyTotalsByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "svcDailyTotalsByRVC":{ "description":"The response body contains daily totals of service charges applied at a revenue center for the specified location and business date.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if serviceCharges is null", "title":"Revenue Center Number", "maxLength":10 }, "serviceCharges":{ "type":"array", "description":"An array of daily totals of service charges for a revenue center. This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/svcDailyTotal" } } }, "required":[ "rvcNum", "serviceCharges" ] }, "svcDailyTotal":{ "description":"The response body contains daily totals of service charges for a revenue center for the specified location and business date.", "properties":{ "svcNum":{ "type":"integer", "description":"Unique identifier of the service charge", "title":"Service Charge Number", "maxLength":16 }, "ttl":{ "type":"number", "description":"Total value of service charges", "title":"Service Charge Total" }, "cnt":{ "type":"integer", "description":"Total number of times the service charge was applied", "title":"Service Charge Count", "maxLength":16 } }, "required":[ "svcNum", "ttl", "cnt" ] }, "tmedDailyTotals":{ "description":"The response body contains information about the daily totals of tender media for the specified location and business date.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business date", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of tender media daily totals by revenue centers", "items":{ "$ref":"#/definitions/tmedDailyTotalsByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "tmedDailyTotalsByRVC":{ "description":"The response body contains daily totals of tender media at a revenue center for the specified location and business date.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if tenderMedias is null", "title":"Revenue Center Number", "maxLength":10 }, "tenderMedias":{ "type":"array", "description":"An array of daily totals of tender media for a revenue center/ This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/tmedDailyTotal" } } }, "required":[ "rvcNum", "tenderMedias" ] }, "tmedDailyTotal":{ "description":"The response body contains daily totals of tender media for a revenue center for the specified location and business date.", "properties":{ "tmedNum":{ "type":"integer", "description":"Unique identifier of the tender media", "title":"Tender Media Number", "maxLength":16 }, "ttl":{ "type":"number", "description":"Total value tendered via the tender media", "title":"Tender Media Total" }, "cnt":{ "type":"integer", "description":"Total number of times the tender media was used", "title":"Tender Media Count", "maxLength":16 } }, "required":[ "tmedNum", "ttl", "cnt" ] }, "taxDailyTotals":{ "description":"The response body contains information about the daily totals of taxes for the specified location and business date.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business date", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of tax daily totals by revenue centers", "items":{ "$ref":"#/definitions/taxDailyTotalsByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "taxDailyTotalsByRVC":{ "description":"The response body contains daily totals of taxes at a revenue center for the specified location and business date.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if taxes is null", "title":"Revenue Center Number", "maxLength":10 }, "nonTxblSlsTtl":{ "type":"number", "description":"Total amount of non-taxable sales. It is not associated to a specific tax rate, therefore it is outside of the taxes array.. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.10.1
", "title":"Total amount of non-taxable sales" }, "taxes":{ "type":"array", "description":"An array of daily totals of taxes for a revenue center. This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/taxDailyTotal" } } }, "required":[ "rvcNum", "nonTxblSlsTtl", "taxes" ] }, "taxDailyTotal":{ "description":"The response body contains tax daily totals for a revenue center for the specified location and business date.", "properties":{ "taxNum":{ "type":"integer", "description":"Unique identifier of the tax", "title":"Tax Number", "maxLength":16 }, "txblSlsTtl":{ "type":"number", "description":"Total value sales that were taxed under the given tax", "title":"Taxable Sales Total" }, "taxCollTtl":{ "type":"number", "description":"Total value taxes that were collected for the given tax", "title":"Tax Collected Total" }, "taxExmptSlsTtl":{ "type":"number", "description":"Total value sales that were exempted from the given tax", "title":"Tax Exempt Sales Total" } }, "required":[ "taxNum", "txblSlsTtl", "taxCollTtl", "taxExmptSlsTtl" ] }, "otDailyTotals":{ "description":"The response body contains information about the daily operational totals by order types for the specified location and business date.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business date", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of order type daily totals by revenue centers", "items":{ "$ref":"#/definitions/otDailyTotalsByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "otDailyTotalsByRVC":{ "description":"The response body contains daily operational totals by order type at a revenue center for the specified location and business date.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if orderTypes is null", "title":"Revenue Center Number", "maxLength":10 }, "orderTypes":{ "type":"array", "description":"An array of daily operational totals by order types for a revenue center. This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/otDailyTotal" } } }, "required":[ "rvcNum", "orderTypes" ] }, "otDailyTotal":{ "description":"The response body contains daily operational totals by order type for a revenue center for the specified location and business date.", "properties":{ "ocNum":{ "type":"integer", "description":"Unique 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
", "title":"Order Channel number", "maxLength":16 }, "otNum":{ "type":"integer", "description":"Order Type number", "title":"Order Type Number", "maxLength":16 }, "netSlsTtl":{ "type":"number", "description":"Total of net sales for the day", "title":"Net Sales Total" }, "dscTtl":{ "type":"number", "description":"Total of item discounts for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Item Discount Total" }, "svcTtl":{ "type":"number", "description":"Total of service charges for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Service Charge Total" }, "nonRevSvcTtl":{ "type":"number", "description":"Non-revenue service charge, and non-revenue menu item total. This attribute will not be returned in the response if value is 0 or null", "title":"Non Revenue Service Charge Total" }, "taxCollTtl":{ "type":"number", "description":"Total of tax collected for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Collected Total" }, "taxCredTtl":{ "type":"number", "description":"Tax credit totals (negative transactions with tax) for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Credited Total" }, "prepCostTtl":{ "type":"number", "description":"Total of preparation cost for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Prepartion Cost total" }, "rtnCnt":{ "type":"integer", "description":"Total number of items returned in the day. This attribute will not be returned in the response if value is 0 or null", "title":"Return Count", "maxLength":16 }, "rtnTtl":{ "type":"number", "description":"Total value of returned items for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Return Total" }, "chkCnt":{ "type":"integer", "description":"Total number of checks for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Check Count", "maxLength":16 }, "gstCnt":{ "type":"integer", "description":"Total number of guests for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Guest Count", "maxLength":16 }, "tblTurnCnt":{ "type":"integer", "description":"Total number of tables turns for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Table Turn Count", "maxLength":16 }, "dineTimeInMins":{ "type":"number", "description":"Total dining time for the day in minutes. This attribute will not be returned in the response if value is 0 or null", "title":"Dine Time in minutes", "maxLength":16 }, "parkCarCnt":{ "type":"integer", "description":"Total number of cars parked for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Parked Car Count", "maxLength":16 }, "vdTtl":{ "type":"number", "description":"Total of items voided for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Void Total" }, "vdCnt":{ "type":"integer", "description":"Number of items voided for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Void Count", "maxLength":16 }, "errCorTtl":{ "type":"number", "description":"Total of items which were error corrected for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Error Correct Total" }, "errCorCnt":{ "type":"integer", "description":"Number of items which were error corrected for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Error Correct Count", "maxLength":16 }, "mngrVdTtl":{ "type":"number", "description":"Total items which were voided by the manager of the employee. This attribute will not be returned in the response if value is 0 or null", "title":"Manager Void Total" }, "mngrVdCnt":{ "type":"integer", "description":"Number of items which were voided by the manager of the employee. This attribute will not be returned in the response if value is 0 or null", "title":"Manager Void Count", "maxLength":16 }, "transCnclTtl":{ "type":"number", "description":"Total of transactions that were cancelled for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Transaction Cancel Total" }, "transCnclCnt":{ "type":"integer", "description":"Number of transactions that were cancelled for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Transaction Cancel Count", "maxLength":16 }, "chkOpnCnt":{ "type":"integer", "description":"Number of checks that were were rung in the day which remain in open state", "title":"Check Open Count", "maxLength":16 }, "chkClsdCnt":{ "type":"integer", "description":"Number of checks that were were closed in the day", "title":"Check Closed Count", "maxLength":16 }, "sosTime1":{ "type":"integer", "description":"SOS time 1. This attribute will not be returned in the response if value is 0 or null", "title":"SOS Time 1", "maxLength":16 }, "sosTime2":{ "type":"integer", "description":"SOS time 2. This attribute will not be returned in the response if value is 0 or null", "title":"SOS Time 2", "maxLength":16 }, "sosTime3":{ "type":"integer", "description":"SOS time 3. This attribute will not be returned in the response if value is 0 or null", "title":"SOS Time 3", "maxLength":16 }, "sosTime4":{ "type":"integer", "description":"SOS time 4. This attribute will not be returned in the response if value is 0 or null", "title":"SOS Time 4", "maxLength":16 } }, "required":[ "otNum", "netSlsTtl", "chkOpnCnt", "chkClsdCnt", "dscTtl", "svcTtl", "nonRevSvcTtl", "taxCollTtl", "taxCredTtl", "prepCostTtl", "rtnCnt", "rtnTtl", "chkCnt", "gstCnt", "tblTurnCnt", "dineTimeInMins", "parkCarCnt", "vdTtl", "vdCnt", "errCorTtl", "errCorCnt", "mngrVdTtl", "mngrVdCnt", "transCnclTtl", "transCnclCnt", "sosTime1", "sosTime2", "sosTime3", "sosTime4" ] }, "ocDailyTotals":{ "description":"The response body contains information about the daily operational totals by order channels for the specified location and business date.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business date", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of order channel daily totals by revenue centers", "items":{ "$ref":"#/definitions/ocDailyTotalsByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "ocDailyTotalsByRVC":{ "description":"The response body contains daily operational totals by order channels at a revenue center for the specified location and business date.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if orderChannels is null", "title":"Revenue Center Number", "maxLength":10 }, "orderChannels":{ "type":"array", "description":"An array of daily operational totals by order channels for a revenue center. This attribute will not be returned in the response if value is null.First available version 20.1.15
", "items":{ "$ref":"#/definitions/ocDailyTotal" } } }, "required":[ "rvcNum", "orderChannels" ] }, "ocDailyTotal":{ "description":"The response body contains daily operational totals by order channel for a revenue center for the specified location and business date.", "properties":{ "ocNum":{ "type":"integer", "description":"Unique 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
", "title":"Order Channel number", "maxLength":16 }, "otNum":{ "type":"integer", "description":"Order Type number", "title":"Order Type Number", "maxLength":16 }, "netSlsTtl":{ "type":"number", "description":"Total of net sales for the day", "title":"Net Sales Total" }, "dscTtl":{ "type":"number", "description":"Total of item discounts for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Item Discount Total" }, "svcTtl":{ "type":"number", "description":"Total of service charges for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Service Charge Total" }, "nonRevSvcTtl":{ "type":"number", "description":"Non-revenue service charge, and non-revenue menu item total. This attribute will not be returned in the response if value is 0 or null", "title":"Non Revenue Service Charge Total" }, "taxCollTtl":{ "type":"number", "description":"Total of tax collected for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Collected Total" }, "taxCredTtl":{ "type":"number", "description":"Tax credit totals (negative transactions with tax) for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Credited Total" }, "prepCostTtl":{ "type":"number", "description":"Total of preparation cost for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Prepartion Cost total" }, "rtnCnt":{ "type":"integer", "description":"Total number of items returned in the day. This attribute will not be returned in the response if value is 0 or null", "title":"Return Count", "maxLength":16 }, "rtnTtl":{ "type":"number", "description":"Total value of returned items for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Return Total" }, "chkCnt":{ "type":"integer", "description":"Total number of checks for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Check Count", "maxLength":16 }, "gstCnt":{ "type":"integer", "description":"Total number of guests for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Guest Count", "maxLength":16 }, "tblTurnCnt":{ "type":"integer", "description":"Total number of tables turns for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Table Turn Count", "maxLength":16 }, "dineTimeInMins":{ "type":"number", "description":"Total dining time for the day in minutes. This attribute will not be returned in the response if value is 0 or null", "title":"Dine Time in minutes", "maxLength":16 }, "parkCarCnt":{ "type":"integer", "description":"Total number of cars parked for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Parked Car Count", "maxLength":16 }, "vdTtl":{ "type":"number", "description":"Total of items voided for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Void Total" }, "vdCnt":{ "type":"integer", "description":"Number of items voided for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Void Count", "maxLength":16 }, "errCorTtl":{ "type":"number", "description":"Total of items which were error corrected for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Error Correct Total" }, "errCorCnt":{ "type":"integer", "description":"Number of items which were error corrected for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Error Correct Count", "maxLength":16 }, "mngrVdTtl":{ "type":"number", "description":"Total items which were voided by the manager of the employee. This attribute will not be returned in the response if value is 0 or null", "title":"Manager Void Total" }, "mngrVdCnt":{ "type":"integer", "description":"Number of items which were voided by the manager of the employee. This attribute will not be returned in the response if value is 0 or null", "title":"Manager Void Count", "maxLength":16 }, "transCnclTtl":{ "type":"number", "description":"Total of transactions that were cancelled for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Transaction Cancel Total" }, "transCnclCnt":{ "type":"integer", "description":"Number of transactions that were cancelled for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Transaction Cancel Count", "maxLength":16 }, "chkOpnCnt":{ "type":"integer", "description":"Number of checks that were were rung in the day which remain in open state", "title":"Check Open Count", "maxLength":16 }, "chkClsdCnt":{ "type":"integer", "description":"Number of checks that were were closed in the day", "title":"Check Closed Count", "maxLength":16 }, "sosTime1":{ "type":"integer", "description":"SOS time 1. This attribute will not be returned in the response if value is 0 or null", "title":"SOS Time 1", "maxLength":16 }, "sosTime2":{ "type":"integer", "description":"SOS time 2. This attribute will not be returned in the response if value is 0 or null", "title":"SOS Time 2", "maxLength":16 }, "sosTime3":{ "type":"integer", "description":"SOS time 3. This attribute will not be returned in the response if value is 0 or null", "title":"SOS Time 3", "maxLength":16 }, "sosTime4":{ "type":"integer", "description":"SOS time 4. This attribute will not be returned in the response if value is 0 or null", "title":"SOS Time 4", "maxLength":16 } }, "required":[ "otNum", "netSlsTtl", "chkOpnCnt", "chkClsdCnt", "dscTtl", "svcTtl", "nonRevSvcTtl", "taxCollTtl", "taxCredTtl", "prepCostTtl", "rtnCnt", "rtnTtl", "chkCnt", "gstCnt", "tblTurnCnt", "dineTimeInMins", "parkCarCnt", "vdTtl", "vdCnt", "errCorTtl", "errCorCnt", "mngrVdTtl", "mngrVdCnt", "transCnclTtl", "transCnclCnt", "sosTime1", "sosTime2", "sosTime3", "sosTime4" ] }, "miQuarterHourTotals":{ "description":"The response body contains information about the menu item quarter hour totals for a specified location and business date.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business Date", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of Menu Item Quarter Hour Totals by Revenue Centers", "items":{ "$ref":"#/definitions/miQuarterHourTotalsByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "miQuarterHourTotalsByRVC":{ "description":"The response body contains quarter hour totals by menu item of a revenue center for the specified location and business date.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if menuItems is null", "title":"Revenue Center Number", "maxLength":10 }, "quarterHours":{ "type":"array", "description":"Array containing all quarter hours with service charge totals. The number of the 15 minute increment. Number between 1-96. This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/miQuarterHourTotalsArray" } } }, "required":[ "rvcNum", "quarterHours" ] }, "miQuarterHourTotalsArray":{ "description":"The response body contains quarter hour totals by menu item of a revenue center for the specified location and business date.", "properties":{ "qtrHrNum":{ "type":"number", "description":"The number of the 15 minute increment. Number between 1-96.", "title":"The number of the 15 minute increment" }, "busHrNum":{ "type":"number", "description":"The number of the business hour. Number between 1- 240.", "title":"The number of the business hour" }, "dpName":{ "type":"string", "description":"The name of the day part for this quarter hour.", "title":"The name of the day part for this quarter hour" }, "menuItems":{ "type":"array", "description":"An array of quarter hour totals by menu item for a revenue center. This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/miQuarterHourTotalsmenuItems" } } }, "required":[ "qtrHrNum", "busHrNum", "dpName", "menuItems" ] }, "miQuarterHourTotalsmenuItems":{ "description":"The response body contains quarter hour totals by menu item for a revenue center for the specified location and business date.", "properties":{ "miNum":{ "type":"integer", "description":"Menu Item Number", "title":"Menu Item Number", "maxLength":16 }, "prcLvlNum":{ "type":"integer", "description":"Unique identifier for the menu item's price level", "title":"Price Level Number", "maxLength":16 }, "ocNum":{ "type":"integer", "description":"Unique 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
", "title":"Order Channel number", "maxLength":16 }, "otNum":{ "type":"integer", "description":"Unique identfier of the order type. This attribute will not be returned in the response if value is 0 or null", "title":"Order Type Number", "maxLength":16 }, "slsTtl":{ "type":"number", "description":"Total Sales of the menu item", "title":"Sales Total" }, "slsCnt":{ "type":"integer", "description":"Total Sales Count of the menu item.", "title":"Sales Count", "maxLength":16 }, "rtnCnt":{ "type":"integer", "description":"Total Return Count of the menu item. This attribute will not be returned in the response if value is 0 or null", "title":"Return Count", "maxLength":16 }, "dscTtl":{ "type":"number", "description":"Item discount Total of the menu item. This attribute will not be returned in the response if value is 0 or null", "title":"Discount Total" }, "vol":{ "type":"number", "description":"Sales volume of the menu item. This attribute will not be returned in the response if value is 0 or null", "title":"Volume" }, "prepCost":{ "type":"number", "description":"Total Preparation cost associated with the menu item. This attribute will not be returned in the response if value is 0 or null", "title":"Prepartion Cost" }, "vatTtl":{ "type":"number", "description":"VAT total of the menu item. This attribute will not be returned in the response if value is 0 or null", "title":"VAT Total", "multipleOf":"0.0000010" }, "dscVatTtl":{ "type":"number", "description":"Discount VAT Total of the menu item. This attribute will not be returned in the response if value is 0 or null", "title":"Discount VAT Total", "multipleOf":"0.0000010" }, "inclTaxTtl":{ "type":"number", "description":"Total amount of inclusive taxes. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.10.1
", "title":"Total amount of inclusive taxes" }, "forgivenInclTaxTtl":{ "type":"number", "description":"Total amount of inclusive taxes forgiven. Applicable for Australian GST configurations. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.10.1
", "title":"Total amount of inclusive taxes forgiven." } }, "required":[ "miNum", "prcLvlNum", "slsTtl", "slsCnt", "otNum", "rtnCnt", "dscTtl", "vol", "prepCost", "vatTtl", "dscVatTtl", "inclTaxTtl", "forgivenInclTaxTtl" ] }, "cmbQuarterHourTotals":{ "description":"The response body contains information about the quarter hour totals by combo item for the specified location and business date.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business Date", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of combo item quarter hour totals by revenue centers", "items":{ "$ref":"#/definitions/cmbQuarterHourTotalsByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "cmbQuarterHourTotalsByRVC":{ "description":"The response body contains quarter hour totals by combo item of a revenue center for the specified location and business date.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if menuItems is null", "title":"Revenue Center Number", "maxLength":10 }, "quarterHours":{ "type":"array", "description":"Array containing all quarter hours with service charge totals. The number of the 15 minute increment. Number between 1-96 This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/cmbQuarterHourTotalsArray" } } }, "required":[ "rvcNum", "quarterHours" ] }, "cmbQuarterHourTotalsArray":{ "description":"The response body contains quarter hour totals by combo item of a revenue center for the specified location and business date.", "properties":{ "qtrHrNum":{ "type":"number", "description":"The number of the 15 minute increment. Number between 1-96.", "title":"The number of the 15 minute increment" }, "busHrNum":{ "type":"number", "description":"The number of the business hour. Number between 1- 240.", "title":"The number of the business hour" }, "dpName":{ "type":"string", "description":"The name of the day part for this quarter hour.", "title":"The name of the day part for this quarter hour" }, "comboItems":{ "type":"array", "description":"An array of quarter hour totals by combo item for a revenue center. This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/cmbQuarterHourTotalsComboItems" } } }, "required":[ "qtrHrNum", "busHrNum", "dpName", "comboItems" ] }, "cmbQuarterHourTotalsComboItems":{ "description":"The response body contains quarter hour totals by combo item for a revenue center for the specified location and business date.", "properties":{ "comboMiNum":{ "type":"integer", "description":"Menu item number of the primary combo meu item. This remains same for all the components of the combo meal.", "title":"Combo Menu Item Number", "maxLength":16 }, "componentMiNum":{ "type":"integer", "description":"Menu item number of the component of the combo meal. This attribute will not be returned in the response if value is null", "title":"Component Menu Item Number", "maxLength":16 }, "origMiNum":{ "type":"integer", "description":"Original menu item number of the combo meal component. This attribute will not be returned in the response if value is null", "title":"Original Menu Item Number", "maxLength":16 }, "otNum":{ "type":"integer", "description":"Unique identfier of the order type. This attribute will not be returned in the response if value is 0 or null", "title":"Order Type Number", "maxLength":16 }, "ocNum":{ "type":"integer", "description":"Unique 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
", "title":"Order Channel number", "maxLength":16 }, "slsTtl":{ "type":"number", "description":"Total sales of the combo item", "title":"Sales Total" }, "slsCnt":{ "type":"integer", "description":"Total count of sales of the combo item", "title":"Sales Count", "maxLength":16 }, "dscTtl":{ "type":"number", "description":"Item discount value of the combo item. This attribute will not be returned in the response if value is 0 or null", "title":"Discount Total" }, "vatTtl":{ "type":"number", "description":"VAT total with extended precision. This attribute will not be returned in the response if value is 0 or null", "title":"VAT Total", "multipleOf":"0.0000010" }, "dscVatTtl":{ "type":"number", "description":"Discount VAT Total with extended precision. This attribute will not be returned in the response if value is 0 or null", "title":"Discount VAT Total", "multipleOf":"0.0000010" }, "components":{ "type":"array", "description":"An array of daily totals of components of the combo item for a revenue center. This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/cmbCompQuaterHourTotal" } } }, "required":[ "comboMiNum", "componentMiNum", "origMiNum", "slsTtl", "slsCnt", "otNum", "dscTtl", "vatTtl", "dscVatTtl", "components" ] }, "cmbCompQuaterHourTotal":{ "description":"The response body contains quarter hour totals of components of a combo item for a revenue center for the specified location and business date.", "properties":{ "componentMiNum":{ "type":"integer", "description":"Menu item number of the component of the combo meal. This attribute will not be returned in the response if value is null", "title":"Component Menu Item Number", "maxLength":16 }, "origMiNum":{ "type":"integer", "description":"Original menu item number of the combo meal component. This attribute will not be returned in the response if value is null", "title":"Original Menu Item Number", "maxLength":16 }, "otNum":{ "type":"integer", "description":"Unique identfier of the order type. This attribute will not be returned in the response if value is 0 or null", "title":"Order Type Number", "maxLength":16 }, "ocNum":{ "type":"integer", "description":"Unique 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
", "title":"Order Channel number", "maxLength":16 }, "slsTtl":{ "type":"number", "description":"Total sales of the combo item", "title":"Sales Total" }, "slsCnt":{ "type":"integer", "description":"Total count of sales of the combo item", "title":"Sales Count", "maxLength":16 }, "dscTtl":{ "type":"number", "description":"Item discount value of the combo item. This attribute will not be returned in the response if value is 0 or null", "title":"Discount Total" }, "vatTtl":{ "type":"number", "description":"VAT total with extended precision. This attribute will not be returned in the response if value is 0 or null", "title":"VAT Total", "multipleOf":"0.0000010" }, "dscVatTtl":{ "type":"number", "description":"Discount VAT Total with extended precision. This attribute will not be returned in the response if value is 0 or null", "title":"Discount VAT Total", "multipleOf":"0.0000010" } }, "required":[ "componentMiNum", "origMiNum", "slsTtl", "slsCnt", "otNum", "dscTtl", "vatTtl", "dscVatTtl" ] }, "opQuarterHourTotals":{ "description":"The response body contains information about the quarter hour operations Totals for a specified location and business date.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business Date", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of operations quarter hour totals by RVC", "items":{ "$ref":"#/definitions/opQuarterHourTotalsByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "opQuarterHourTotalsByRVC":{ "description":"The response body contains quarter hour operations totals of a revenue center for the specified location and business date.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This will not be returned if there are no totals for the associated revenue center", "title":"Revenue Center Number", "maxLength":10 }, "quarterHours":{ "type":"array", "description":"Array containing all quarter hours with service charge totals.", "items":{ "$ref":"#/definitions/opQuarterHoursArray" } } }, "required":[ "rvcNum", "quarterHours" ] }, "opQuarterHoursArray":{ "description":"Array containing all quarter hours with service charge totals.", "properties":{ "qtrHrNum":{ "type":"number", "description":"The number of the 15 minute increment. Number between 1-96.", "title":"The number of the 15 minute increment" }, "busHrNum":{ "type":"number", "description":"The number of the business hour. Number between 1- 240.", "title":"The number of the business hour" }, "dpName":{ "type":"string", "description":"The name of the day part for this quarter hour.", "title":"The name of the day part for this quarter hour" }, "netSlsTtl":{ "type":"number", "description":"Total of net sales for the day", "title":"Net Sales Total" }, "itmDscTtl":{ "type":"number", "description":"Total of item discounts for the day", "title":"Item Discount Total" }, "subDscTtl":{ "type":"number", "description":"Total of sub total discounts for the day", "title":"Sub Discount Total" }, "svcTtl":{ "type":"number", "description":"Total of service charges for the day", "title":"Service Charge Total" }, "nonRevSvcTtl":{ "type":"number", "description":"Non-revenue service charge, and non-revenue menu item total such as gift cards sales. This attribute will not be returned in the response if value is 0 or null", "title":"Non Revenue Service Charge Total" }, "rtnCnt":{ "type":"integer", "description":"Total number of items returned in the day. This attribute will not be returned in the response if value is 0 or null", "title":"Return Count", "maxLength":16 }, "rtnTtl":{ "type":"number", "description":"Total value of returned items for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Return Total" }, "credTtl":{ "type":"number", "description":"Total of tax credits for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Credit Total" }, "rndTtl":{ "type":"number", "description":"Total of currency roundings for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Round Total" }, "chngInGrndTtl":{ "type":"number", "description":"Change in Grand Total for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Change in Grand Total" }, "nonTxblSlsTtl":{ "type":"number", "description":"Total of non taxable sales for the day", "title":"Non Taxable Sales Total" }, "txblSlsTtl":{ "type":"number", "description":"Total of taxable sales for the day", "title":"Taxable Sales Total" }, "taxExmptSlsTtl":{ "type":"number", "description":"Total of tax exempted sales for the day", "title":"Tax Exempt Sales Total" }, "taxCollTtl":{ "type":"number", "description":"Total of tax collected for the day", "title":"Tax Collected Total" }, "slsFcst":{ "type":"number", "description":"Total of forecasted sales for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Sales Forecast" }, "prepCostTtl":{ "type":"number", "description":"Total of preparation cost for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Prepartion Cost total" }, "tblTurnCnt":{ "type":"integer", "description":"Total number of tables turns for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Table Turn Count", "maxLength":16 }, "chkCnt":{ "type":"integer", "description":"Total number of checks for the day.", "title":"Check Count", "maxLength":16 }, "waitPtyCnt":{ "type":"integer", "description":"Total number of waiting parties for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Waiting Party Count", "maxLength":16 }, "waitTimeInMins":{ "type":"number", "description":"Total wait time for the day in minutes. This attribute will not be returned in the response if value is 0 or null", "title":"Wait time in miuntes", "maxLength":16 }, "gstCnt":{ "type":"integer", "description":"Total number of guests for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Guest Count", "maxLength":16 }, "dineTimeInMins":{ "type":"number", "description":"Total dining time for the day in minutes. This attribute will not be returned in the response if value is 0 or null", "title":"Dine Time in minutes", "maxLength":16 }, "parkCarCnt":{ "type":"integer", "description":"Total number of cars parked for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Parked Car Count", "maxLength":16 }, "drvThruTimeInMins":{ "type":"number", "description":"Total drive through time for the day in minutes. This attribute will not be returned in the response if value is 0 or null", "title":"Drive through Time in minutes", "maxLength":16 }, "vdTtl":{ "type":"number", "description":"Total of items voided for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Void Total" }, "vdCnt":{ "type":"integer", "description":"Number of items voided for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Void Count", "maxLength":16 }, "errCorTtl":{ "type":"number", "description":"Total of items which were error corrected for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Error Correct Total" }, "errCorCnt":{ "type":"integer", "description":"Number of items which were error corrected for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Error Correct Count", "maxLength":16 }, "mngrVdTtl":{ "type":"number", "description":"Total items which were voided by the manager of the employee. This attribute will not be returned in the response if value is 0 or null", "title":"Manager Void Total" }, "mngrVdCnt":{ "type":"integer", "description":"Number of items which were voided by the manager of the employee. This attribute will not be returned in the response if value is 0 or null", "title":"Manager Void Count", "maxLength":16 }, "transCnclTtl":{ "type":"number", "description":"Total of transactions that were cancelled for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Transaction Cancel Total" }, "transCnclCnt":{ "type":"integer", "description":"Number of transactions that were cancelled for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Transaction Cancel Count", "maxLength":16 }, "carryoverTtl":{ "type":"number", "description":"Total of items that were carried over for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Carry Over Total" }, "carryoverCnt":{ "type":"integer", "description":"Number of items that were carried over for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Carry Over Count", "maxLength":16 }, "chkOpnTtl":{ "type":"number", "description":"Total of checks that were were rung in the day which remain in open state", "title":"Check Open Total" }, "chkOpnCnt":{ "type":"integer", "description":"Number of checks that were were rung in the day which remain in open state", "title":"Check Open Count", "maxLength":16 }, "chkClsdTtl":{ "type":"number", "description":"Total of checks that were were closed in the day", "title":"Check Closed Total" }, "chkClsdCnt":{ "type":"integer", "description":"Number of checks that were were closed in the day", "title":"Check Closed Count", "maxLength":16 }, "chkXferInTtl":{ "type":"number", "description":"Total of checks that were transferred in for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Check Transfer In Total" }, "chkXferInCnt":{ "type":"integer", "description":"Number of checks that were transferred in for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Check Transfer In Count", "maxLength":16 }, "chkXferOutTtl":{ "type":"number", "description":"Total of checks that were transferred out for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Check Transfer Out Total" }, "chkXferOutCnt":{ "type":"integer", "description":"Number of checks that were transferred out for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Check Transfer Out Count", "maxLength":16 }, "overShortTtl":{ "type":"number", "description":"Over Short Total. This attribute will not be returned in the response if value is 0 or null", "title":"Over Short Total" }, "noSalesCnt":{ "type":"integer", "description":"Number of no sale transactions for the day. This attribute will not be returned in the response if value is 0 or null", "title":"No Sale Transaction Count", "maxLength":16 }, "trnChkTtl":{ "type":"number", "description":"Total of checks that were used for training for the day. This attribute will not be returned in the response if value is 0 or null.First Available Version: 20.1.10First Available Version: 20.1.10 First available version 20.1.15
", "title":"Order Channel number", "maxLength":16 }, "otNum":{ "type":"integer", "description":"Order Type number", "title":"Order Type Number", "maxLength":16 }, "netSlsTtl":{ "type":"number", "description":"Total of net sales for the day", "title":"Net Sales Total" }, "dscTtl":{ "type":"number", "description":"Total of item discounts for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Item Discount Total" }, "svcTtl":{ "type":"number", "description":"Total of service charges for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Service Charge Total" }, "nonRevSvcTtl":{ "type":"number", "description":"Non-revenue service charge, and non-revenue menu item total. This attribute will not be returned in the response if value is 0 or null", "title":"Non Revenue Service Charge Total" }, "taxCollTtl":{ "type":"number", "description":"Total of tax collected for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Collected Total" }, "prepCostTtl":{ "type":"number", "description":"Total of preparation cost for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Prepartion Cost total" }, "rtnCnt":{ "type":"integer", "description":"Total number of items returned in the day. This attribute will not be returned in the response if value is 0 or null", "title":"Return Count", "maxLength":16 }, "rtnTtl":{ "type":"number", "description":"Total value of returned items for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Return Total" }, "chkCnt":{ "type":"integer", "description":"Total number of checks for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Check Count", "maxLength":16 }, "gstCnt":{ "type":"integer", "description":"Total number of guests for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Guest Count", "maxLength":16 }, "tblTurnCnt":{ "type":"integer", "description":"Total number of tables turns for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Table Turn Count", "maxLength":16 }, "dineTimeInMins":{ "type":"number", "description":"Total dining time for the day in minutes. This attribute will not be returned in the response if value is 0 or null", "title":"Dine Time in minutes", "maxLength":16 }, "parkCarCnt":{ "type":"integer", "description":"Total number of cars parked for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Parked Car Count", "maxLength":16 }, "vdTtl":{ "type":"number", "description":"Total of items voided for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Void Total" }, "vdCnt":{ "type":"integer", "description":"Number of items voided for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Void Count", "maxLength":16 }, "errCorTtl":{ "type":"number", "description":"Total of items which were error corrected for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Error Correct Total" }, "errCorCnt":{ "type":"integer", "description":"Number of items which were error corrected for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Error Correct Count", "maxLength":16 }, "mngrVdTtl":{ "type":"number", "description":"Total items which were voided by the manager of the employee. This attribute will not be returned in the response if value is 0 or null", "title":"Manager Void Total" }, "mngrVdCnt":{ "type":"integer", "description":"Number of items which were voided by the manager of the employee. This attribute will not be returned in the response if value is 0 or null", "title":"Manager Void Count", "maxLength":16 }, "transCnclTtl":{ "type":"number", "description":"Total of transactions that were cancelled for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Transaction Cancel Total" }, "transCnclCnt":{ "type":"integer", "description":"Number of transactions that were cancelled for the day. This attribute will not be returned in the response if value is 0 or null", "title":"Transaction Cancel Count", "maxLength":16 }, "chkOpnCnt":{ "type":"integer", "description":"Number of checks that were were rung in the day which remain in open state", "title":"Check Open Count", "maxLength":16 }, "chkClsdCnt":{ "type":"integer", "description":"Number of checks that were were closed in the day", "title":"Check Closed Count", "maxLength":16 } }, "required":[ "otNum", "netSlsTtl", "chkOpnCnt", "chkClsdCnt", "dscTtl", "svcTtl", "nonRevSvcTtl", "taxCollTtl", "prepCostTtl", "rtnCnt", "rtnTtl", "chkCnt", "gstCnt", "tblTurnCnt", "dineTimeInMins", "parkCarCnt", "vdTtl", "vdCnt", "errCorTtl", "errCorCnt", "mngrVdTtl", "mngrVdCnt", "transCnclTtl", "transCnclCnt" ] }, "jcQuarterHourTotals":{ "description":"The response body contains information about the quarter hour totals by job code for the specified location.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business Date", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of Employee Quarter Hour Totals by Revenue Centers", "items":{ "$ref":"#/definitions/jcQuarterHourTotalsByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "jcQuarterHourTotalsByRVC":{ "description":"The response body contains quarter hour totals by job code of a revenue center for the specified location.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if jobCodes is null", "title":"Revenue Center Number", "maxLength":10 }, "quarterHours":{ "type":"array", "description":"Array containing all quarter hours with service chargejob code totals. This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/jcQuarterHoursTotalArray" } } }, "required":[ "rvcNum", "quarterHours" ] }, "jcQuarterHoursTotalArray":{ "description":"The response body contains quarter hour totals by job code of a revenue center for the specified location.", "properties":{ "qtrHrNum":{ "type":"number", "description":"The number of the 15 minute increment. Number between 1-96.", "title":"The number of the 15 minute increment" }, "busHrNum":{ "type":"number", "description":"The number of the business hour. Number between 1- 240.", "title":"The number of the business hour" }, "dpName":{ "type":"string", "description":"The name of the day part for this quarter hour.", "title":"The name of the day part for this quarter hour" }, "jobCodes":{ "type":"array", "description":"An array of quarter hour totals by job code for a revenue center. This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/jcQuarterHourTotalJobCodes" } } }, "required":[ "qtrHrNum", "busHrNum", "dpName", "jobCodes" ] }, "jcQuarterHourTotalJobCodes":{ "description":"The response body contains quarter hour totals by job code for a revenue center for the specified location.", "properties":{ "jcNum":{ "type":"integer", "description":"Job Code Number", "title":"Job Code Number", "maxLength":16 }, "regHrs":{ "type":"number", "description":"Number of regular hours", "title":"Regular Hours", "maxLength":16 }, "regPay":{ "type":"number", "description":"Amount of regualar Pay", "title":"Regular Pay", "maxLength":16 }, "ovtHrs":{ "type":"number", "description":"Number of overtime hours. This attribute will not be returned in the response if value is 0 or null", "title":"Overtime Hours" }, "ovtPay":{ "type":"number", "description":"Amount of overtime pay. This attribute will not be returned in the response if value is 0 or null", "title":"Overtime Pay" }, "ovt2Hrs":{ "type":"number", "description":"Number of overtime 2 hours. This attribute will not be returned in the response if value is 0 or null", "title":"Overtime 2 Hours" }, "ovt2Pay":{ "type":"number", "description":"Amount of overtime 2 pay. This attribute will not be returned in the response if value is 0 or null", "title":"Overtime 2 Pay" }, "ovt3Hrs":{ "type":"number", "description":"Number of overtime 3 hours. This attribute will not be returned in the response if value is 0 or null", "title":"Overtime 3 Hours" }, "ovt3Pay":{ "type":"number", "description":"Amount of overtime 3 pay. This attribute will not be returned in the response if value is 0 or null", "title":"Overtime 3 Pay" }, "ovt4Hrs":{ "type":"number", "description":"Number of overtime 4 hours. This attribute will not be returned in the response if value is 0 or null", "title":"Overtime 4 Hours" }, "ovt4Pay":{ "type":"number", "description":"Amount of overtime 4 pay. This attribute will not be returned in the response if value is 0 or null", "title":"Overtime 4 Pay" } }, "required":[ "jcNum", "regHrs", "regPay", "ovtHrs", "ovtPay", "ovt2Hrs", "ovt2Pay", "ovt3Hrs", "ovt3Pay", "ovt4Hrs", "ovt4Pay" ] }, "requestPayload":{ "description":"Request payload", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"The business date associated with the cash management detail", "title":"Business Date", "format":"date" }, "searchCriteria":{ "type":"string", "description":"Search criteria to filter results based on field value", "title":"Search Criteria", "maxLength":2000 }, "include":{ "type":"string", "description":"List of objects to include in response", "title":"Include", "maxLength":2000 }, "applicationName":{ "type":"string", "description":"The name of the application which is accessing the API.First Available Version: 20.1.10
", "title":"Application Name", "maxLength":128 } }, "required":[ "locRef", "busDt" ] }, "controlTotalsRequestPayload":{ "description":"Request payload for Control Daily Totals", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"If 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", "title":"Business Date", "format":"date" }, "opnBusDt":{ "type":"string", "description":"If 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.First Available Version: 20.1.10
", "title":"Business Date", "format":"date" }, "clsdBusDt":{ "type":"string", "description":"If 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.First Available Version: 20.1.10
", "title":"Business Date", "format":"date" }, "rvcNum":{ "type":"integer", "description":"Revenue center number for which the control totals are to be fetched.First Available Version: 20.1.9.7
", "title":"Revenue center number", "maxLength":10 }, "searchCriteria":{ "type":"string", "description":"Search criteria to filter results based on field value", "title":"Search Criteria", "maxLength":2000 }, "include":{ "type":"string", "description":"List of objects to include in response", "title":"Include", "maxLength":2000 }, "applicationName":{ "type":"string", "description":"The name of the application which is accessing the API.First Available Version: 20.1.10
", "title":"Application Name", "maxLength":128 } }, "required":[ "locRef", "busDt", "clsdBusDt", "opnBusDt" ] }, "kdsDetails":{ "description":"The response body contains information about the Kitchen Performance for the specified location.", "properties":{ "curUTC":{ "type":"string", "description":"Current UTC Date Time", "title":"Current UTC Date time", "format":"date-time" }, "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business Date", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of kitchen display orders", "items":{ "$ref":"#/definitions/kdsOrdersByRVC" } } }, "required":[ "curUTC", "locRef", "busDt", "revenueCenters" ] }, "kdsOrdersByRVC":{ "description":"The response body contains KDS Orders information about a revenue center for the specified location.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if orders is null", "title":"Revenue Center Number", "maxLength":10 }, "orders":{ "type":"array", "description":"An array of KDS orders for a revenue center. This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/kdsOrder" } } }, "required":[ "rvcNum", "orders" ] }, "kdsOrder":{ "description":"The response body contains KDS Order about a revenue center for the specified location.", "properties":{ "guestCheckId":{ "type":"integer", "description":"Unique ID of the Guest Check", "title":"Guest check ID", "maxLength":16 }, "stationName":{ "type":"string", "description":"Name of the station", "title":"Station Name", "maxLength":99 }, "startTime":{ "type":"string", "description":"The start time of the kitchen order. This attribute will be deprecated in future. Please use startTimeLcl instead", "title":"Start Time", "format":"date-time" }, "startTimeUTC":{ "type":"string", "description":"The UTC start time of the kitchen order.First Available Version: 20.1.9.6
", "title":"Start Time UTC", "format":"date-time" }, "startTimeLcl":{ "type":"string", "description":"The start time of the kitchen order in the location's timezone.First Available Version: 20.1.9.6
", "title":"Start Time Local", "format":"date-time" }, "serviceRoundNum":{ "type":"integer", "description":"The Service Round Number of the order", "title":"Service Round Number", "maxLength":16 }, "prepTimeInSecs":{ "type":"integer", "description":"Time taken to preapre the kitchen order in seconds", "title":"Preparation Time in Seconds", "maxLength":16 }, "isAppetizerFlag":{ "type":"boolean", "description":"A Boolean flag indicating if the order contained an appetizer item. This attribute will not be returned in the response if value is false or null", "title":"Is Appetizer Flag" }, "menuItemCount":{ "type":"integer", "description":"The number of menu items in the order", "title":"Menu item Count", "maxLength":16 }, "recallCount":{ "type":"integer", "description":"The number of menu items recalled in the order. This attribute will not be returned in the response if value is 0 or null", "title":"Recall Count", "maxLength":16 }, "highPriorityFlag":{ "type":"boolean", "description":"A flag indicating if this was rush order. This attribute will not be returned in the response if value is false or null", "title":"High Priority Flag" }, "subOrders":{ "type":"array", "description":"An array of KDS suborders for a KDS order", "items":{ "$ref":"#/definitions/kdsSubOrder" } } }, "required":[ "guestCheckId", "stationName", "startTime", "startTimeUTC", "startTimeLcl", "serviceRoundNum", "prepTimeInSecs", "menuItemCount", "subOrders", "isAppetizerFlag", "recallCount", "highPriorityFlag" ] }, "kdsSubOrder":{ "description":"The response body contains KDS Sub-Order about a revenue center for the specified location.", "properties":{ "subOrderId":{ "type":"integer", "description":"Unique identifier of the sub order", "title":"Sub Order ID", "maxLength":16 }, "miDefSeq":{ "type":"integer", "description":"Sequence of the menu item in the order", "title":"Menu Item Definition Sequence", "maxLength":16 }, "miNum":{ "type":"integer", "description":"Unique identifier of the menu item", "title":"Menu Item Number", "maxLength":16 }, "postTimeUTC":{ "type":"string", "description":"UTC time of the line item was posted in the KDS", "title":"Posting time in UTC format", "format":"date-time" }, "postTimeLcl":{ "type":"string", "description":"Date and time of the line item was posted in the KDS in the location's timezone.First Available Version: 20.1.9.6
", "title":"Posting time Local", "format":"date-time" }, "actualPrepTimeinSecs":{ "type":"integer", "description":"Actual Time taken to preapre the kitchen order in seconds", "title":"Actual Preparation Time in Seconds", "maxLength":16 }, "miPrepTimeInSecs":{ "type":"integer", "description":"SIPS menu item preparation time of the sub order", "title":"Menu Item Preparation Time in Seconds", "maxLength":16 }, "miMod":{ "type":"string", "description":"SIPS menu item preparation time of the sub order. This attribute will not be returned in the response if value is null", "title":"Menu Item Modifier", "maxLength":99 } }, "required":[ "subOrderId", "miDefSeq", "miNum", "postTimeUTC", "postTimeLcl", "actualPrepTimeinSecs", "miPrepTimeInSecs", "miMod" ] }, "kdsRequestPayload":{ "description":"Request payload", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"The business date associated with the cash management detail", "title":"Business Date", "format":"date" }, "transSinceUTC":{ "type":"string", "description":"Report all Kitchen Display System transaction activity that has occurred since this UTC date and time for the specified business date.If this object is not included, return all Kitchen Display System transaction activity for the specified business date", "format":"date-time" }, "searchCriteria":{ "type":"string", "description":"Search criteria to filter results based on field value", "title":"Search Criteria", "maxLength":2000 }, "include":{ "type":"string", "description":"List of objects to include in response", "title":"Include", "maxLength":2000 }, "applicationName":{ "type":"string", "description":"The name of the application which is accessing the API.First Available Version: 20.1.10
", "title":"Application Name", "maxLength":128 } }, "required":[ "locRef", "busDt" ] }, "fiscalInvoiceData":{ "description":"The response body contains information about the fiscal invoice for the specified location.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business Date", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of fiscal invoice data by reveneue centers", "title":"Revenue Centers", "items":{ "$ref":"#/definitions/fiscalInvoiceDataByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "fiscalInvoiceDataByRVC":{ "description":"The response body contains fiscal invoice data about a revenue center for the specified location.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if invoiceData is null", "title":"Revenue center number", "maxLength":10 }, "invoiceData":{ "type":"array", "description":"An array of fiscal invoice data for a revenue center. This attribute will not be returned in the response if value is null", "title":"Invoice Data", "items":{ "$ref":"#/definitions/fiscalInvoiceDataObj" } } }, "required":[ "rvcNum", "invoiceData" ] }, "fiscalInvoiceDataObj":{ "description":"The response body contains fiscal invoice data of a revenue center for the specified location.", "properties":{ "wsNum":{ "type":"integer", "description":"Workstation Number. This attribute will not be returned in the response if value is null", "title":"Workstation Number", "maxLength":16 }, "fcrInvNum":{ "type":"string", "description":"Country / Transaction specific value", "title":"FCR Invoice Number", "maxLength":50 }, "customerDataNum":{ "type":"string", "description":"The unque reference of customer data. This attribute will not be returned in the response if value is null.First Available Version: 20.1.10
", "title":"Customer Data Number", "maxLength":20 }, "opnBusDt":{ "type":"string", "description":"Optional business date the guest check was opened.", "title":"Open Business Date", "format":"date" }, "guestCheckId":{ "type":"integer", "description":"The unique identifier of the guest check", "title":"Guest Check ID", "maxLength":16 }, "checkNum":{ "type":"integer", "description":"Optional Check number", "title":"Check Number", "maxLength":10 }, "invoiceType":{ "type":"integer", "description":"Country / Transaction specific value", "title":"Invoice Type", "maxLength":3 }, "invoiceStatus":{ "type":"integer", "description":"Country / Transaction specific value", "title":"Invoice Status", "maxLength":3 }, "fcrBusinessDate":{ "type":"string", "description":"Device Business date, Country / Transaction specific value", "title":"FCR Business Date", "format":"date" }, "subTotal1":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Subtotal 1" }, "subTotal2":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Subtotal 2" }, "subTotal3":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Subtotal 3" }, "subTotal4":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Subtotal 4" }, "subTotal5":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Subtotal 5" }, "subTotal6":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Subtotal 6" }, "subTotal7":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Subtotal 7" }, "subTotal8":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Subtotal 8" }, "subTotal9":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Subtotal 9" }, "subTotal10":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Subtotal 10" }, "subTotal11":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Subtotal 11" }, "subTotal12":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Subtotal 12" }, "subTotal13":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Subtotal 13" }, "subTotal14":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Subtotal 14" }, "taxTotal1":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Total 1" }, "taxTotal2":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Total 2" }, "taxTotal3":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Total 3" }, "taxTotal4":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Total 4" }, "taxTotal5":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Total 5" }, "taxTotal6":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Total 6" }, "taxTotal7":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Total 7" }, "taxTotal8":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Total 8" }, "taxTotal9":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Total 9" }, "taxTotal10":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Total 10" }, "taxTotal11":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Total 11" }, "taxTotal12":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Total 12" }, "taxTotal13":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Total 13" }, "taxTotal14":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Total 14" }, "taxTotal15":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Total 15" }, "taxTotal16":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"Tax Total 16" }, "invDataInfo1":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Data Info 1", "maxLength":100 }, "invDataInfo2":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Data Info 2", "maxLength":100 }, "invDataInfo3":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Data Info 3", "maxLength":100 }, "invDataInfo4":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Data Info 4", "maxLength":100 }, "invDataInfo5":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Data Info 5", "maxLength":100 }, "invDataInfo6":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Data Info 6", "maxLength":100 }, "invDataInfo7":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Data Info 7", "maxLength":100 }, "invDataInfo8":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Data Info 8", "maxLength":100 }, "invDataInfo9":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Data Info 9", "maxLength":100 }, "invDataInfo10":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Data Info 10", "maxLength":100 }, "invDataInfo11":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Data Info 11", "maxLength":100 }, "invDataInfo12":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Data Info 12", "maxLength":100 }, "invDataInfo13":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Data Info 13", "maxLength":100 }, "invDataInfo14":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Data Info 14", "maxLength":100 }, "invDataInfo15":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Data Info 15", "maxLength":100 }, "invDataInfo16":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Data Info 16", "maxLength":100 }, "fcrIdentifier":{ "type":"integer", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Identifier", "maxLength":10 }, "storeIdentifier":{ "type":"integer", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Store Identifier", "maxLength":10 }, "deviceIdentifier":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Device Identifier", "maxLength":50 }, "documentType":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Dociment Type", "maxLength":10 }, "dataType":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Data Type", "maxLength":10 }, "sysDocIdentifier":{ "type":"number", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is 0 or null", "title":"System Document Identifier" }, "fiscalKey":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Fiscal Key", "maxLength":100 }, "json":{ "type":"object", "description":"Country / Transaction specific fiscal data represented in JSON format. This attribute will not be returned in the response if value is null.First Available Version: 20.1.12
", "title":"Country / Transaction specific fiscal data in Json" }, "extraDate1":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Extra Date 1", "format":"date-time" }, "extraDate2":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Extra Date 2", "format":"date-time" }, "extraDate3":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Extra Date 3", "format":"date-time" }, "extraDate4":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Extra Date 4", "format":"date-time" }, "extraDate5":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Extra Date 5", "format":"date-time" } }, "required":[ "fcrInvNum", "customerDataNum", "opnBusDt", "guestCheckId", "checkNum", "invoiceType", "invoiceStatus", "fcrBusinessDt", "wsNum", "subTotal1", "subTotal2", "subTotal3", "subTotal4", "subTotal5", "subTotal6", "subTotal7", "subTotal8", "subTotal9", "subTotal10", "subTotal11", "subTotal12", "subTotal13", "subTotal14", "taxTotal1", "taxTotal2", "taxTotal3", "taxTotal4", "taxTotal5", "taxTotal6", "taxTotal7", "taxTotal8", "taxTotal9", "taxTotal10", "taxTotal11", "taxTotal12", "taxTotal13", "taxTotal14", "taxTotal15", "taxTotal16", "invDataInfo1", "invDataInfo2", "invDataInfo3", "invDataInfo4", "invDataInfo5", "invDataInfo6", "invDataInfo7", "invDataInfo8", "invDataInfo9", "invDataInfo10", "invDataInfo11", "invDataInfo12", "invDataInfo13", "invDataInfo14", "invDataInfo15", "invDataInfo16", "fcrIdentifier", "storeIdentifier", "deviceIdentifier", "documentType", "dataType", "sysDocIdentifier", "fiscalKey", "extraDate1", "extraDate2", "extraDate3", "extraDate4", "extraDate5" ] }, "fiscalTotalData":{ "description":"The response body contains information about the fiscal totals for the specified location.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business Date", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of fiscal total data by reveneue centers", "title":"Revenue Centers", "items":{ "$ref":"#/definitions/fiscalTotalDataByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "fiscalTotalDataByRVC":{ "description":"The response body contains fiscal total data about a revenue center for the specified location.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if totalData is null", "title":"Revenue center number", "maxLength":10 }, "totalData":{ "type":"array", "description":"An array of fiscal total data for a revenue center. This attribute will not be returned in the response if value is null", "title":"Total Data", "items":{ "$ref":"#/definitions/fiscalTotalDataObj" } } }, "required":[ "rvcNum", "totalData" ] }, "fiscalTotalDataObj":{ "description":"The response body contains fiscal total data of a revenue center for the specified location.", "properties":{ "wsNum":{ "type":"integer", "description":"Workstation Number. This attribute will not be returned in the response if value is null", "title":"Workstation Number", "maxLength":16 }, "fcrBusDt":{ "type":"string", "description":"Device Business date, Country / Transaction specific value", "title":"FCR Business Date", "format":"date" }, "fcrNum1":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Number 1", "maxLength":100 }, "fcrNum2":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Number 2", "maxLength":100 }, "fcrInfo1":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Data Info 1", "maxLength":100 }, "fcrInfo2":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Info 2", "maxLength":100 }, "fcrInfo3":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Info 3", "maxLength":100 }, "fcrInfo4":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Info 4", "maxLength":100 }, "fcrInfo5":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Info 5", "maxLength":100 }, "fcrInfo6":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Info 6", "maxLength":100 }, "fcrInfo7":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Info 7", "maxLength":100 }, "fcrInfo8":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Info 8", "maxLength":100 }, "fcrInfo9":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Info 9", "maxLength":100 }, "fcrInfo10":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Info 10", "maxLength":100 }, "fcrInfo11":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Info 11", "maxLength":100 }, "fcrInfo12":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Info 12", "maxLength":100 }, "fcrInfo13":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Info 13", "maxLength":100 }, "fcrInfo14":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Info 14", "maxLength":100 }, "fcrInfo15":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Info 15", "maxLength":100 }, "fcrInfo16":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"FCR Info 16", "maxLength":100 }, "json":{ "type":"object", "description":"Country / Transaction specific fiscal data represented in JSON format. This attribute will not be returned in the response if value is null.First Available Version: 20.1.12
", "title":"Country / Transaction specific fiscal data in Json" } }, "required":[ "fcrBusDt", "wsNum", "fcrNum1", "fcrNum2", "fcrInfo1", "fcrInfo2", "fcrInfo3", "fcrInfo4", "fcrInfo5", "fcrInfo6", "fcrInfo7", "fcrInfo8", "fcrInfo9", "fcrInfo10", "fcrInfo11", "fcrInfo12", "fcrInfo13", "fcrInfo14", "fcrInfo15", "fcrInfo16" ] }, "fiscalControlData":{ "description":"The response body contains information about the fiscal invoice control data for the specified location.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business Date", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of fiscal invoice control data by reveneue centers", "title":"Revenue Centers", "items":{ "$ref":"#/definitions/fiscalControlDataByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "fiscalControlDataByRVC":{ "description":"The response body contains fiscal invoice control data about a revenue center for the specified location.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if invoiceControlData is null", "title":"Revenue center number", "maxLength":10 }, "invoiceControlData":{ "type":"array", "description":"An array of fiscal control data for a revenue center. This attribute will not be returned in the response if value is null", "title":"Control Data", "items":{ "$ref":"#/definitions/fiscalInvoiceControlData" } } }, "required":[ "rvcNum", "invoiceControlData" ] }, "fiscalInvoiceControlData":{ "description":"The response body contains fiscal inovice control data of a revenue center for the specified location.", "properties":{ "wsNum":{ "type":"integer", "description":"Workstation Number. This attribute will not be returned in the response if value is null", "title":"Workstation Number", "maxLength":16 }, "invoiceType":{ "type":"integer", "description":"Country / Transaction specific value of the Invoice Type", "title":"Invoice Type", "maxLength":3 }, "series":{ "type":"string", "description":"Country / Transaction specific value of the series. This attribute will not be returned in the response if value is null", "title":"Series", "maxLength":3 }, "startInvNum":{ "type":"integer", "description":"Country / Transaction specific value of the start invoice number", "title":"Start Invoice Number", "maxLength":19 }, "endInvNum":{ "type":"integer", "description":"Country / Transaction specific value of the end invoice number", "title":"End Invoice Number", "maxLength":19 }, "status":{ "type":"integer", "description":"Country / Transaction specific value of the status", "title":"Status", "maxLength":3 }, "currInvNum":{ "type":"integer", "description":"Country / Transaction specific value of the current invoice number", "title":"Current Invoice Number", "maxLength":19 }, "lockedBy":{ "type":"integer", "description":"Country / Transaction specific value of the id of the locked by", "title":"Locked By", "maxLength":5 }, "resolutionDt":{ "type":"string", "description":"Device Business date, Country / Transaction specific value of the resolution date", "title":"Resolution Date", "format":"date" }, "invcontrolInfo1":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Control Info 1", "maxLength":100 }, "invcontrolInfo2":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Control Info 2", "maxLength":100 }, "invcontrolInfo3":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Control Info 3", "maxLength":100 }, "invcontrolInfo4":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Control Info 4", "maxLength":100 }, "invcontrolInfo5":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Control Info 5", "maxLength":100 }, "invcontrolInfo6":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Control Info 6", "maxLength":100 }, "invcontrolInfo7":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Control Info 7", "maxLength":100 }, "invcontrolInfo8":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Control Info 8", "maxLength":100 }, "invcontrolInfo9":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Control Info 9", "maxLength":100 }, "invcontrolInfo10":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Control Info 10", "maxLength":100 }, "invcontrolInfo11":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Control Info 11", "maxLength":100 }, "invcontrolInfo12":{ "type":"string", "description":"Country / Transaction specific value. This attribute will not be returned in the response if value is null", "title":"Invoice Control Info 12", "maxLength":100 }, "json":{ "type":"object", "description":"Country / Transaction specific fiscal data represented in JSON format. This attribute will not be returned in the response if value is null.First Available Version: 20.1.12
", "title":"Country / Transaction specific fiscal data in Json" } }, "required":[ "invoiceType", "startInvNum", "endInvNum", "status", "currInvNum", "lockedBy", "resolutionDt", "wsNum", "series", "invcontrolInfo1", "invcontrolInfo2", "invcontrolInfo3", "invcontrolInfo4", "invcontrolInfo5", "invcontrolInfo6", "invcontrolInfo7", "invcontrolInfo8", "invcontrolInfo9", "invcontrolInfo10", "invcontrolInfo11", "invcontrolInfo12" ] }, "guestChecksResponse":{ "description":"The response body contains information about the guest checks for the specified location and business date.", "properties":{ "curUTC":{ "type":"string", "description":"The current UTC date and time when the request is made", "title":"Current Date Time in UTC", "format":"date-time" }, "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "guestChecks":{ "type":"array", "description":"An array of guest checks", "items":{ "$ref":"#/definitions/guestCheck" } } }, "required":[ "curUTC", "locRef", "guestCheck" ] }, "guestCheck":{ "description":"The response body contains information about the guest check for the specified location and business date.", "properties":{ "guestCheckId":{ "type":"integer", "description":"Unique Identifier of the guest check", "title":"Guest Check ID", "maxLength":16 }, "chkNum":{ "type":"integer", "description":"Unique identifier of the guest check associated with this transaction", "title":"Check Number", "maxLength":8 }, "chkName":{ "type":"string", "description":"Unique identifier of the guest check associated with this transaction. This attribute will not be returned in the response if value is null", "title":"Check Name", "maxLength":99 }, "opnBusDt":{ "type":"string", "description":"The business date the guest check was opened.", "title":"Open Business Date", "format":"date" }, "clsdBusDt":{ "type":"string", "description":"The 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", "title":"Closed Business Date", "format":"date" }, "opnUTC":{ "type":"string", "description":"The date and time the guest check was opened as a UTC time", "title":"Open Business Date Time UTC", "format":"date-time" }, "opnLcl":{ "type":"string", "description":"The date and time the guest check was opened in the location's timezone.First Available Version: 20.1.9.6
", "title":"Open Business Date Time Local", "format":"date-time" }, "clsdUTC":{ "type":"string", "description":"The 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.", "title":"Closed Business Date Time UTC", "format":"date-time" }, "clsdLcl":{ "type":"string", "description":"The 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
", "title":"Closed Business Date Time Local", "format":"date-time" }, "reopnClsdChkClsdBusDt":{ "type":"string", "description":"The 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.", "title":"Reopen Closed Check Closed Business Date", "format":"date" }, "reopnClsdChkClsdUTC":{ "type":"string", "description":"The 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.", "title":"Reopen Closed Check Closed Business Date Time UTC", "format":"date-time" }, "reopnClsdChkClsdLcl":{ "type":"string", "description":"The 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
", "title":"Reopen Closed Check Closed Business Date Time Local", "format":"date-time" }, "lastUpdatedUTC":{ "type":"string", "description":"The date and time the guest check was last updated in the cloud as a UTC time.First Available Version: 20.1.12
", "title":"Last Updated Date Time UTC", "format":"date-time" }, "lastUpdatedLcl":{ "type":"string", "description":"The date and time the guest check was last updated in the cloud in the location's timezone.First Available Version: 20.1.12
", "title":"Last Updated Date Time Local", "format":"date-time" }, "lastTransUTC":{ "type":"string", "description":"The date and time of the last transaction update to the guest check as a UTC time.First Available Version: 20.1.12
", "title":"Last Updated Date Time UTC", "format":"date-time" }, "lastTransLcl":{ "type":"string", "description":"The date and time of the last transaction update to the guest check in the location's timezone.First Available Version: 20.1.12
", "title":"Last Updated Date Time Local", "format":"date-time" }, "clsdFlag":{ "type":"boolean", "description":"A 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.", "title":"Closed Flag" }, "cancelFlag":{ "type":"boolean", "description":"A 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
", "title":"Cancel Flag" }, "gstCnt":{ "type":"integer", "description":"The 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.", "title":"Guest Count" }, "subTtl":{ "type":"number", "description":"The subtotal value associated with the guest check.", "title":"Sub Total" }, "rndTtl":{ "type":"number", "description":"Currency rounding total. This attribute will not be returned in the response if value is 0 or null.", "title":"Rounding Total" }, "autoSvcTtl":{ "type":"number", "description":"The 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", "title":"Auto Service Charge Total" }, "svcChgTtl":{ "type":"number", "description":"The 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", "title":"Service Charge Total" }, "nonTxblSlsTtl":{ "type":"number", "description":"Non taxable sales total for this check.", "title":"Non taxable sales total for this checkl" }, "taxExmpSlsTtl":{ "type":"number", "description":"The total of the sales that is exempted from tax. Applicable for add-on taxes only. This field is not returned by default.", "title":"Tax Exempt Sales Total" }, "taxCollTtl":{ "type":"number", "description":"The total tax collected for the guest check. This field is not returned by default.", "title":"Tax Collected Total" }, "chkTtl":{ "type":"number", "description":"The total value of this guest check without payments.", "title":"Check Total" }, "dscTtl":{ "type":"number", "description":"The total value of discounts on this guest check.", "title":"Discount Total" }, "payTtl":{ "type":"number", "description":"The total value of payments on this guest check.", "title":"Pay Total" }, "tipTotal":{ "type":"number", "description":"The tip total. This attribute will not be returned in the response if value is 0 or null", "title":"Tip Total" }, "balDueTtl":{ "type":"number", "description":"The balance due associated with this guest check, chkTtl ??? payTtl. If the check is closed, this will be 0.00.", "title":"Balance Due Total" }, "reopnFrmChk":{ "type":"integer", "description":"The 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", "title":"Reopen from Check Number", "maxLength":16 }, "reopnToChk":{ "type":"integer", "description":"The 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", "title":"Reopen to Check Number", "maxLength":16 }, "spltFrmChk":{ "type":"integer", "description":"The 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", "title":"Reopen to Check Numner", "maxLength":16 }, "rvcNum":{ "type":"integer", "description":"The number of the revenue center associated with this guest check", "title":"Revenue Center Number", "maxLength":10 }, "ocNum":{ "type":"integer", "description":"Unique 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
", "title":"Order Channel number", "maxLength":16 }, "otNum":{ "type":"integer", "description":"The number of the order type associated with this guest check.", "title":"Order Type Number", "maxLength":16 }, "tblNum":{ "type":"integer", "description":"The table number associated with the check. This attribute will not be returned in the response if value is null", "title":"Table Number", "maxLength":8 }, "tblName":{ "type":"string", "description":"The table associated with this guest check. This attribute will not be returned in the response if value is null", "title":"Table Name", "maxLength":99 }, "empNum":{ "type":"integer", "description":"The number of the employee responsible for this guest check ", "title":"Employee Number", "maxLength":16 }, "chkInfo":{ "type":"string", "description":"Information associated with the guest check. This attribute will not be returned in the response if value is null", "title":"Check Information", "maxLength":99 }, "chkRef":{ "type":"string", "description":"Reference information of the guest check. This attribute will not be returned in the response if value is null.First Available Version: 20.1.10
", "title":"Check Reference", "maxLength":99 }, "xferStatus":{ "type":"string", "description":"Transfer status of the guest checkFirst Available Version: 20.1.10
", "title":"Transfer Status", "maxLength":1 }, "xferToChkNum":{ "type":"integer", "description":"Number 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
", "title":"Transfer to Check Number", "maxLength":8 }, "autoFireUTC":{ "type":"string", "description":"The 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
", "title":"Auto fire date time of the check", "format":"date-time" }, "numSrvcRd":{ "type":"integer", "description":"Number 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
", "title":"Number of service rounds on this check" }, "vdTtl":{ "type":"number", "description":"Amount 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
", "title":"Amount of voided transactions on this check" }, "mgrVdTtl":{ "type":"number", "description":"Amount 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
", "title":"Amount of voided transactions on this check which were authorized by a manager" }, "returnTtl":{ "type":"number", "description":"Amount 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
", "title":"Amount of returned items on this check" }, "errorCorrectTtl":{ "type":"number", "description":"Amount 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
", "title":"Amount of error corrected items on this check" }, "reopnClsdChkFlag":{ "type":"boolean", "description":"Flag 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
", "title":"Flag indicating if the check was reopened after it was already closed" }, "reopnClsdChkOpnLcl":{ "type":"string", "description":"The 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
", "title":"The date and time a reopened guest check was reopened in the location's timezone", "format":"date-time" }, "reopnClsdChkOpnUTC":{ "type":"string", "description":"The 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
", "title":"The date and time a reopened guest check was reopened in UTC timezone", "format":"date-time" }, "reopnClsdChkOpnBusDt":{ "type":"string", "description":"The 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
", "title":"The business date a reopened closed guest check was opened", "format":"date" }, "numChkPrntd":{ "type":"integer", "description":"Number 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
", "title":"Number of times the check was printed" }, "splitOut":{ "type":"integer", "description":"Numeric 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
", "title":"Numeric value indicating the number of checks this check was split to" }, "addedIn":{ "type":"integer", "description":"Numeric 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
", "title":"Numeric value indicating the number of checks that were added / transferred to this check" }, "inclTaxExmpTtl":{ "type":"integer", "description":"Amount 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
", "title":"Amount of inclusive (non-VAT) taxes exempted" }, "autoClsdFlag":{ "type":"boolean", "description":"Flag 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.
", "title":"Flag indicating if the check was auto-closed after 7 days by Simphony" }, "taxes":{ "type":"array", "description":"An array of taxes that are associated with the guest check", "items":{ "$ref":"#/definitions/guestCheckTax" } }, "detailLines":{ "type":"array", "description":"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.", "items":{ "$ref":"#/definitions/guestCheckDetailLine" } } }, "required":[ "guestCheckId", "chkNum", "opnBusDt", "opnUTC", "opnLcl", "lastUpdatedUTC", "lastUpdatedLcl", "lastTransUTC", "lastTransLcl", "subTtl", "chkTtl", "dscTtl", "payTtl", "balDueTtl", "rvcNum", "otNum", "empNum", "detailLines", "chkName", "clsdBusDt", "clsdUTC", "clsdLcl", "reopnClsdChkClsdBusDt", "reopnClsdChkClsdUTC", "reopnClsdChkClsdLcl", "clsdFlag", "cancelFlag", "gstCnt", "rndTtl", "autoSvcTtl", "svcChgTtl", "tipTotal", "reopnFrmChk", "reopnToChk", "spltFrmChk", "tblNum", "tblName", "chkInfo", "chkRef", "xferStatus", "taxes", "xferToChkNum", "numSrvcRd", "vdTtl", "mgrVdTtl", "returnTtl", "errorCorrectTtl", "clsdChkEdtFlag", "reopnClsdChkFlag", "reopnClsdChkOpnLcl", "reopnClsdChkOpnUTC", "reopnClsdChkOpnBusDt", "numChkPrntd", "splitOut", "addedIn", "inclTaxExmpTtl", "nonTxblSlsTtl" ] }, "guestCheckDetailLine":{ "description":"The response body contains information about the guest check detail line for the specified guest check", "properties":{ "guestCheckLineItemId":{ "type":"integer", "description":"Unique identifier of the guest check line item", "title":"Guest Check Line Item ID", "maxLength":16 }, "lineNum":{ "type":"integer", "description":"The line number of this detail line.", "title":"Line Number", "maxLength":5 }, "dtlId":{ "type":"integer", "description":"Unique identifier of the line item", "title":"Detail ID", "maxLength":16 }, "parDtlId":{ "type":"integer", "description":"Unique identifier of the parent line item. This attribute will not be returned in the response if value is 0 or null", "title":"Parent Detail ID", "maxLength":16 }, "detailUTC":{ "type":"string", "description":"The UTC date and time this detail line was entered. ", "title":"Detail Date Time UTC", "format":"date-time" }, "detailLcl":{ "type":"string", "description":"The date and time this detail line was entered in the location's timezone.First Available Version: 20.1.9.6
", "title":"Detail Date Time Local", "format":"date-time" }, "busDt":{ "type":"string", "description":"Business Date when the line item was entered", "title":"Detail Business Date", "format":"date" }, "lastUpdatedUTC":{ "type":"string", "description":"The date and time the transaction was updated or inserted in the cloud as a UTC time.First Available Version: 20.1.12
", "title":"Last Updated Date Time UTC", "format":"date-time" }, "lastUpdatedLcl":{ "type":"string", "description":"The date and time the transaction was updated or inserted in the cloud in the location's timezone.First Available Version: 20.1.12
", "title":"Last Updated Date Time Local", "format":"date-time" }, "rvcNum":{ "type":"integer", "description":"The number of the revenue center associated with this line item.First Available Version: 20.1.16
", "title":"Revenue Center Number", "maxLength":10 }, "wsNum":{ "type":"integer", "description":"The number of the workstation where the line item was modified", "title":"Workstation Number", "maxLength":16 }, "prepCost":{ "type":"number", "description":"Preparation Cost of the line item. This attribute will not be returned in the response if value is 0 or null", "title":"Preparation Cost" }, "weight":{ "type":"number", "description":"Weight or Volume of the line item. This attribute will not be returned in the response if value is 0 or null", "title":"Weight" }, "vdFlag":{ "type":"boolean", "description":"A 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", "title":"Void Flag" }, "errCorFlag":{ "type":"boolean", "description":"A 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", "title":"Error Correct Flag" }, "refInfo1":{ "type":"string", "description":"Any manually entered text associated with this detail item. This attribute will not be returned in the response if value is null", "title":"Check Information", "maxLength":128 }, "refInfo2":{ "type":"string", "description":"Any manually entered text associated with this detail item. This attribute will not be returned in the response if value is null", "title":"Check Information", "maxLength":128 }, "dspTtl":{ "type":"number", "description":"Display total of the line item", "title":"Display Total" }, "dspQty":{ "type":"integer", "description":"Displayed quantity of the line item", "title":"Display Quantiy", "maxLength":16 }, "aggTtl":{ "type":"number", "description":"Aggregate total of the line item", "title":"Aggregate Total" }, "aggQty":{ "type":"integer", "description":"The number of the workstation where the line item was modified", "title":"Aggregate Quantity", "maxLength":16 }, "doNotShowFlag":{ "type":"boolean", "description":"A 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", "title":"DoNot Show Flag" }, "chkEmpNum":{ "type":"integer", "description":"Unique identifier of the check owner. This links to the \"num\" attribute of getEmployeeDimensions endpoint.", "title":"Check Employee Number", "maxLength":10 }, "transEmpNum":{ "type":"integer", "description":"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 (chkEmpNum = transEmpNum). This links to the \"num\" attribute of getEmployeeDimensions endpoint.", "title":"Transaction Employee Number", "maxLength":10 }, "mgrEmpNum":{ "type":"integer", "description":"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 \"num\" attribute of getEmployeeDimensions endpoint.", "title":"Manager Employee Number", "maxLength":10 }, "chkEmpId":{ "type":"integer", "description":"Alternative unique identifier of the check owner. This links to the \"employeeID\" attribute of getEmployeeDimensions endpoint.", "title":"Check Employee ID", "maxLength":19 }, "transEmpId":{ "type":"integer", "description":"Alternative 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.", "title":"Transaction Employee ID", "maxLength":19 }, "mgrEmpId":{ "type":"integer", "description":"Alternative 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.", "title":"Manager Employee ID", "maxLength":19 }, "rsnCodeNum":{ "type":"integer", "description":"Reason code number. This attribute will not be returned in the response if value is 0 or null", "title":"Reason Code Number", "maxLength":16 }, "svcRndNum":{ "type":"integer", "description":"Service Round Number", "title":"Service Round Number", "maxLength":16 }, "cashierNum":{ "type":"integer", "description":"Unique identifier of the cashier of the line item. This attribute will not be returned in the response if value is null", "title":"Cashier Number", "maxLength":16 }, "dtlOcNum":{ "type":"integer", "description":"Unique 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
", "title":"Order channel identifier", "maxLength":16 }, "dtlOtNum":{ "type":"integer", "description":"The number of the order type associated with this guest check detail. This attribute will not be returned in the response if value is null", "title":"Detail Order Type Number", "maxLength":16 }, "seatNum":{ "type":"integer", "description":"The 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
", "title":"The seat of the table that this detail line item applies to" }, "numerator":{ "type":"integer", "description":"The 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
", "title":"The numerator of a fractional count for items split across multiple checks" }, "denominator":{ "type":"integer", "description":"The 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
", "title":"The denominator of a fractional count for items split across multiple checks" }, "menuItem":{ "$ref":"#/definitions/guestCheckMenuItem" }, "discount":{ "$ref":"#/definitions/guestCheckDiscount" }, "serviceCharge":{ "$ref":"#/definitions/guestCheckServiceCharge" }, "tenderMedia":{ "$ref":"#/definitions/guestCheckTenderMedia" }, "errorCorrect":{ "$ref":"#/definitions/guestCheckErrorCorrect" }, "other":{ "$ref":"#/definitions/guestCheckOtherDetails" } }, "required":[ "guestCheckLineItemId", "lineNum", "dtlId", "parDtlId", "detailUTC", "detailLcl", "busDt", "lastUpdatedUTC", "lastUpdatedLcl", "rvcNum", "wsNum", "dspTtl", "dspQty", "aggTtl", "aggQty", "chkEmpNum", "chkEmpId", "svcRndNum", "prepCost", "weight", "vdFlag", "errCorFlag", "refInfo1", "refInfo2", "doNotShowFlag", "transEmpNum", "mgrEmpNum", "rsnCodeNum", "cashierNum", "dtlOtNum", "menuItem", "discount", "serviceCharge", "tenderMedia", "errorCorrect", "other", "seatNum", "numerator", "denominator" ] }, "guestCheckMenuItem":{ "description":"If 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", "properties":{ "miNum":{ "type":"integer", "description":"The number of the menu item", "title":"Menu Item Number", "maxLength":16 }, "comboMealSeq":{ "type":"integer", "description":"The 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
", "title":"Combo Meal Sequence Number", "maxLength":16 }, "comboSideSeq":{ "type":"integer", "description":"The 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
", "title":"Combo Side Sequence Number", "maxLength":16 }, "modFlag":{ "type":"boolean", "description":"Flag 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
", "title":"Modifier flag" }, "modPrfx":{ "type":"integer", "description":"If 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
", "title":"Modifier prefix", "maxLength":16 }, "comboGrpNum":{ "type":"integer", "description":"The 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
", "title":"Combo Group Number", "maxLength":16 }, "inclTax":{ "type":"number", "description":"The tax included in this menu item's price. This attribute will not be returned in the response if value is 0 or null", "title":"Inclusive Tax" }, "returnFlag":{ "type":"boolean", "description":"Flag indicating if this menu item is being returned. This attribute will not be returned in the response if value is false or null", "title":"Return Flag" }, "activeTaxes":{ "type":"string", "description":"Comma 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", "title":"Active Taxes" }, "prcLvl":{ "type":"integer", "description":"Price Level of the menu item", "title":"Price Level", "maxLength":16 } }, "required":[ "miNum", "comboMealSeq", "comboSideSeq", "comboGrpNum", "prcLvl", "inclTax", "returnFlag", "activeTaxes" ] }, "guestCheckDiscount":{ "description":"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", "properties":{ "dscNum":{ "type":"integer", "description":"The number associated with this discount", "title":"Discount Number", "maxLength":16 }, "dscMiNum":{ "type":"integer", "description":"The number associated with the menu item that is discounted. This attribute will not be returned in the response if value is null", "title":"Discount Menu Item Number", "maxLength":16 }, "mealEmpNum":{ "type":"integer", "description":"If this is an employee meal, the number associated with the employee. This attribute will not be returned in the response if value is null", "title":"Meal Employee Number", "maxLength":16 }, "vatTaxTtl":{ "type":"number", "description":"Total of the vat tax on the discounted item. This attribute will not be returned in the response if value is 0 or null", "title":"VAT Tax Total" }, "inclTax":{ "type":"number", "description":"Total 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
", "title":"Total of the inclusive tax on the discounted item" }, "activeTaxes":{ "type":"string", "description":"Comma 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
", "title":"Comma separated string of tax numbers that are active on the discount" } }, "required":[ "dscNum", "dscMiNum", "mealEmpNum", "vatTaxTtl", "inclTax", "activeTaxes" ] }, "guestCheckServiceCharge":{ "description":"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", "properties":{ "svcChgNum":{ "type":"integer", "description":"The number associated with this service charge", "title":"Service Charge Number", "maxLength":16 }, "inclTax":{ "type":"number", "description":"Total 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
", "title":"Total of the inclusive tax on the taxable service charge" }, "activeTaxes":{ "type":"string", "description":"Comma 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
", "title":"Comma separated string of tax numbers that are active on the service charge" } }, "required":[ "svcChgNum", "inclTax", "activeTaxes" ] }, "guestCheckTenderMedia":{ "description":"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", "properties":{ "tmedNum":{ "type":"integer", "description":"The number associated with this tender/media.", "title":"Tender Media Number", "maxLength":16 }, "mealEmpNum":{ "type":"integer", "description":"If this is an employee meal, the number associated with the employee. This attribute will not be returned in the response if value is null", "title":"Meal Employee Number", "maxLength":16 } }, "required":[ "tmedNum", "mealEmpNum" ] }, "guestCheckOtherDetails":{ "description":"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", "properties":{ "detailType":{ "type":"integer", "description":"The type of the gust check line item detail. The following are the different detail types that could be returned:First Available Version: 20.1.10
", "properties":{ "type":{ "type":"integer", "description":"The type of the detail line which is error corrected.First Available Version: 20.1.10
", "title":"Type", "maxLength":16 }, "objectNum":{ "type":"integer", "description":"Object number of the detail line that is error corrected.First Available Version: 20.1.10
", "title":"Object Number", "maxLength":16 } }, "required":[ "type", "objectNum" ] }, "guestCheckTax":{ "description":"The aggregated tax totals for a given tax associated with the guest check", "properties":{ "taxNum":{ "type":"integer", "description":"The number associated with tax.", "title":"Tax Number", "maxLength":16 }, "txblSlsTtl":{ "type":"number", "description":"The taxable sales associated with this tax number for the check.", "title":"Taxable Sales Total" }, "taxCollTtl":{ "type":"number", "description":"The total tax collected for this tax number in the check.", "title":"Tax Collected Total" }, "taxRate":{ "type":"number", "description":"The VAT Tax Rate associated with the tax number on the check.First Available Version: 20.1.10.1
", "title":"VAT Tax Rate associated with the tax number" }, "taxType":{ "type":"integer", "description":"The Tax Type associated with the tax number on the check.First Available Version: 20.1.10.1; type 6 first available version: 20.1.16
", "title":"Tax Type associated with the tax number" }, "taxExmptTtl":{ "type":"integer", "description":"Amount 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
", "title":"Amount of tax exemptions on this check" } }, "required":[ "svcNum", "taxNum", "txblSlsTtl", "taxCollTtl", "taxRate", "taxType", "taxExmptTtl" ] }, "nonSlsTransactionDetails":{ "description":"The response body contains information about the non sales transactions for the specified location and business date.", "properties":{ "curUTC":{ "type":"string", "description":"The current UTC date and time when the request is made", "title":"Current Date Time in UTC", "format":"date-time" }, "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business date or reopen closed check closed business date.", "title":"Business Date", "format":"date" }, "nonSalesTransactions":{ "type":"array", "description":"An array of non sales transactions", "title":"Non-Sales Transactions", "items":{ "$ref":"#/definitions/nonSalesTransaction" } } }, "required":[ "locRef", "busDt", "nonSalesTransactions" ] }, "nonSalesTransaction":{ "description":"The response body contains information about the non sales transactions for the specified location and business date.", "properties":{ "transUTC":{ "type":"string", "description":"The UTC date and time this transaction was entered.", "title":"Transaction Date Time in UTC", "format":"date-time" }, "transLcl":{ "type":"string", "description":"The date and time this transaction was entered in location's timezone.First Available Version: 20.1.9.6
", "title":"Transaction Date Time Local", "format":"date-time" }, "transType":{ "type":"integer", "description":"The type of the transaction. The following are the different transaction types that could be returned:First Available Version: 20.1.9.6
", "title":"Transaction Date Time Local", "format":"date-time" }, "transId":{ "type":"integer", "description":"Unique identifier of the transaction log. This attribute will not be returned in the response if value is null", "title":"Transaction ID", "maxLength":16 }, "journalTxt":{ "type":"string", "description":"Journal text of the log. This attribute will not be returned in the response if value is null", "title":"Journal text", "maxLength":99 }, "wsNum":{ "type":"integer", "description":"Unique identifier of the workstation. This attribute will not be returned in the response if value is null", "title":"Workstation Number", "maxLength":16 }, "empNum":{ "type":"integer", "description":"Unique identifier of the employee who has entered the log. This attribute will not be returned in the response if value is null", "title":"Employee Number", "maxLength":16 } }, "required":[ "guestCheckId", "type", "transUTC", "transId", "journalTxt", "wsNum", "empNum" ] }, "posWasteDetails":{ "description":"The response body contains information about the point of sale waste details for the specified location and business date.", "properties":{ "curUTC":{ "type":"string", "description":"The current UTC date and time when the request is made.First Available Version: 20.3
", "title":"The current UTC date and time", "format":"date-time" }, "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"The business date associated with the point of sale waste detail", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of point of sale waste details by reveneue centers", "items":{ "$ref":"#/definitions/posWasteDetailsByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "posWasteDetailsByRVC":{ "description":"The response body contains point of sale waste details for a revenue center", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if logDetails is null", "title":"Revenue center number", "maxLength":10 }, "menuItems":{ "type":"array", "description":"An array of point of sale waste details for a revenue center. This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/wasteDetail" } } }, "required":[ "rvcNum", "menuItems" ] }, "wasteDetail":{ "description":"The response body contains the point of sale waste details associated with a revenue center", "properties":{ "miNum":{ "type":"integer", "description":"The unique identifier of the menu item", "title":"Menu Item ID", "maxLength":16 }, "rsnCodeNum":{ "type":"integer", "description":"The unique identifier reason code.", "title":"Reason Code Number", "maxLength":16 }, "empNum":{ "type":"integer", "description":"Unique identifier of the employee who has entered the waste detail.", "title":"Employee Number", "maxLength":16 }, "cnt":{ "type":"number", "description":"Quantity of the waste. This attribute will not be returned in the response if value is null", "title":"Quantity" }, "weight":{ "type":"number", "description":"Weight of the waste. This attribute will not be returned in the response if value is null", "title":"Weight" }, "ttl":{ "type":"number", "description":"Total amount of the waste. This attribute will not be returned in the response if value is null", "title":"Amount" }, "prepCost":{ "type":"number", "description":"Preparation cost associated with the waste. This attribute will not be returned in the response if value is null", "title":"Cost" }, "prcLvl":{ "type":"integer", "description":"Price level associated with the waste.This attribute will not be returned in the response if value is null", "title":"Price Level", "maxLength":16 }, "transUTC":{ "type":"string", "description":"The date and time the point of sale waste was entered as a UTC time", "title":"Transaction Date Time in UTC", "format":"date-time" }, "transLcl":{ "type":"string", "description":"The date and time the point of sale waste was entered in the location's timezone.First Available Version: 20.1.9.6
", "title":"Transaction Date Time Local", "format":"date-time" } }, "required":[ "miNum", "rsnCodeNum", "empNum", "qty", "weight", "amt", "cost", "prcLvl", "transUTC", "transLcl" ] }, "guestCheckExtDetails":{ "description":"The response body contains information about the guest check extensiblity transactions for the specified location and business date.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "opnBusDt":{ "type":"string", "description":"The business date when the guest check was opened", "title":"Open Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of guest check extensibility details by reveneue centers", "items":{ "$ref":"#/definitions/guestCheckExtDetailsByRVC" } } }, "required":[ "locRef", "opnBusDt", "revenueCenters" ] }, "guestCheckExtDetailsByRVC":{ "description":"The response body contains guest checks extensiblity transactions associated with a revenue center.", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if guestChecks is null", "title":"Revenue center number", "maxLength":10 }, "guestChecks":{ "type":"array", "description":"An array of guest checks with extensibility data. This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/guestCheckExtDetail" } } }, "required":[ "rvcNum", "guestChecks" ] }, "guestCheckExtDetail":{ "description":"The response body contains guest check extensiblity information associated with a revenue center.", "properties":{ "guestCheckId":{ "type":"integer", "description":"The unique identifier of the guest check", "title":"Guest Check ID", "maxLength":16 }, "extAppId":{ "type":"integer", "description":"Unique identifier extension application", "title":"Extension Appllication ID", "maxLength":16 }, "extDataName":{ "type":"string", "description":"Name of the extension data. This attribute will not be returned in the response if value is null", "title":"Extension Data name", "maxLength":99 }, "strData":{ "type":"string", "description":"String data associated with the extension. This attribute will not be returned in the response if value is null", "title":"String Data", "maxLength":99 }, "dspName":{ "type":"string", "description":"Display name. This attribute will not be returned in the response if value is null", "title":"Display Name", "maxLength":99 } }, "required":[ "guestCheckId", "extAppId", "extDataName", "strData", "dspName" ] }, "guestCheckLIExtDetails":{ "description":"The response body contains information about the guest check line item extensiblity transactions for the specified location and business date.", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"The business date associated with the guest check line item extensibility detail", "title":"Business Date", "format":"date" }, "revenueCenters":{ "type":"array", "description":"An array of guest check line item extensibility details by reveneue centers", "items":{ "$ref":"#/definitions/guestCheckLIExtDetailsByRVC" } } }, "required":[ "locRef", "busDt", "revenueCenters" ] }, "guestCheckLIExtDetailsByRVC":{ "description":"The response body contains guest check line item extensiblity transactions associated with a revenue center", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number. This attribute will not be returned in the response if detailLines is null", "title":"Revenue center number", "maxLength":10 }, "detailLines":{ "type":"array", "description":"An array of guest check detail lines with extensibility data. This attribute will not be returned in the response if value is null", "items":{ "$ref":"#/definitions/guestCheckLIExtDetail" } } }, "required":[ "rvcNum", "detailLines" ] }, "guestCheckLIExtDetail":{ "description":"The response body contains guest check extensiblity information associated with a revenue center", "properties":{ "guestCheckId":{ "type":"integer", "description":"The unique identifier of the guest check", "title":"Guest Check ID", "maxLength":16 }, "guestCheckLineItemId":{ "type":"integer", "description":"The unique identifier of the guest check line item", "title":"Guest Check Line Item ID", "maxLength":16 }, "extAppId":{ "type":"integer", "description":"Unique identifier extension application. This attribute will not be returned in the response if value is null", "title":"Extension Appllication ID", "maxLength":16 }, "extDataName":{ "type":"string", "description":"Name of the extension data. This attribute will not be returned in the response if value is null", "title":"Extension Data name", "maxLength":99 }, "strData":{ "type":"string", "description":"String data associated with the extension. This attribute will not be returned in the response if value is null", "title":"String Data", "maxLength":99 }, "dspName":{ "type":"string", "description":"Display name. This attribute will not be returned in the response if value is null", "title":"Display Name", "maxLength":99 } }, "required":[ "guestCheckId", "guestCheckLineItemId", "extAppId", "extDataName", "strData", "dspName" ] }, "spiPaymentDetails":{ "description":"The response body contains information about the SPI payment details for the specified location and business date after a given date time.", "properties":{ "busDt":{ "type":"string", "description":"The business date associated with the transactions", "title":"Business Date", "format":"date" }, "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "curUTC":{ "type":"string", "description":"The current UTC date and time", "title":"Date and time in UTC", "format":"date-time" }, "revenueCenters":{ "type":"array", "description":"An array of revenue centers", "items":{ "$ref":"#/definitions/spiPaymentDetailsRVC" } } }, "required":[ "locRef", "busDt", "curUTC", "revenueCenters" ] }, "spiPaymentDetailsRVC":{ "description":"The response body contains SPI payment transactions associated with a revenue center", "properties":{ "rvcNum":{ "type":"integer", "description":"Revenue Center number", "title":"Revenue center number", "maxLength":10 }, "transactions":{ "type":"array", "description":"An array of credit card transactions in the revenue center", "items":{ "$ref":"#/definitions/spiPaymentDetail" } } }, "required":[ "rvcNum", "transactions" ] }, "spiPaymentDetail":{ "description":"The response body contains SPI payment transactions associated with a revenue center", "properties":{ "pspRef":{ "type":"string", "description":"Reference identifying the transaction, issued by Payment Service Provider (PSP)", "title":"Reference identifying the transaction", "maxLength":64 }, "chkNum":{ "type":"integer", "description":"Check Number", "title":"Check Number", "maxLength":8 }, "guestCheckID":{ "type":"integer", "description":"Unique identifier of the Guest Check", "title":"Guest Check identifier", "maxLength":16 }, "guestCheckLineItemId":{ "type":"integer", "description":"Unique identifier of the Guest Check Line item", "title":"Guest check Line item identifier", "maxLength":16 }, "amt":{ "type":"number", "description":"Transaction amount of the payment", "title":"Payemnt transaction amount" }, "tip":{ "type":"number", "description":"Tip amount of the transaction. This attribute will not be returned in the response if value if null or zero.", "title":"Tip amount" }, "transUTC":{ "type":"string", "description":"The transaction date and time in UTC timzone", "title":"The transaction date and time in UTC timzone" }, "transLcl":{ "type":"string", "description":"The transaction date and time in local store timezone", "title":"The transaction date and time in local store timezone" }, "pmntType":{ "type":"string", "description":"Type of the payment. Possible values: PAY, VOID, CANCEL, REFUND, ADJUSTMENT", "title":"Type of the payment", "maxLength":30 }, "tmedNum":{ "type":"integer", "description":"Tender media number, can be used to lookup from getTenderMediaDimensions", "title":"Tender media number", "maxLength":16 }, "seqNum":{ "type":"string", "description":"Unique transaction identifier issued by Simphony Payment Interface (SPI)", "title":"Transaction identifier", "maxLength":12 }, "wsNum":{ "type":"integer", "description":"Workstation number, can be used to lookup from getLocationDimensions", "title":"Workstation number", "maxLength":16 }, "empNum":{ "type":"integer", "description":"Employee number of the transaction employee, can be used to lookup from getEmployeeDimensions", "title":"Employee number", "maxLength":16 }, "terminalID":{ "type":"string", "description":"Payment Terminal Identifier issued by Payment Service Provider (PSP)", "title":"Payment Terminal Identifier", "maxLength":99 }, "entryMode":{ "type":"integer", "description":"Return a numeric representation of the entry mode of the payment transaction. Following are possible values and their description:| Entry Mode | Entry Mode Description |
|---|---|
| 0 | EMV Fallback |
| 1 | Swiping without PIN (Backwards compatibility 6.1) |
| 2 | Manual enter card number (Backwards compatibility 6.1) |
| 3 | Swiping with PIN (Backwards compatibility 6.1) |
| 4 | EMV without PIN (Backwards compatibility 6.1) |
| 5 | EMV with offline PIN (Backwards compatibility 6.1) |
| 6 | EMV with on line PIN (Backwards compatibility 6.1) |
| 7 | Proximity via Magnetic Stripe (Backwards compatibility 6.1) |
| 8 | Proximity via ICC |
| 9 | Others |
| 10 | EMV Fallback (Signature Verification) |
| 11 | Proximity via Magnetic Stripe (Signature Verification) |
| 12 | Proximity via Magnetic Stripe (No CVM) |
| 13 | Proximity via ICC (Signature Verification) |
| 14 | Proximity via ICC (PIN Verification) |
| 15 | Proximity via ICC (Customer Device Verified) |
| 16 | Proximity via ICC (No CVM) |
| 17 | Swiping without PIN (Signature Verification) |
| 18 | Swiping with PIN (PIN Verification) |
| 19 | Swiping (No CVM ) |
| 20 | Manual enter card number (Signature Verification) |
| 21 | Manual enter card number (No CVM) |
| 22 | EMV (Signature Verification) |
| 23 | EMV (PIN Verification) |
| 24 | EMV (PIN & Signature Verification) |
| 25 | EMV (No CVM) |
| 26 | E-Wallet Payment |
| 27 | Saved Card Token (No CVM) |
First Available Version: 20.1.10
", "title":"Business Date", "format":"date" }, "clsdGuestChecksOnly":{ "type":"boolean", "description":"Indicator whether the response includes only closed guest checks", "title":"Closed Guest Checks Only" }, "changedSinceUTC":{ "type":"string", "description":"Report 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.", "title":"Changed Since Data Time UTC", "format":"date-time" }, "rvcNum":{ "type":"integer", "description":"Revenue center number for which the checks are to be fetched.First Available Version: 20.1.9.7
", "title":"Revenue center number", "maxLength":10 }, "searchCriteria":{ "type":"string", "description":"Search criteria to filter results based on field value", "title":"Search Criteria", "maxLength":2000 }, "include":{ "type":"string", "description":"List of objects to include in response", "title":"Include", "maxLength":2000 }, "applicationName":{ "type":"string", "description":"The name of the application which is accessing the API.First Available Version: 20.1.10
", "title":"Application Name", "maxLength":128 } }, "required":[ "locRef", "opnBusDt", "clsdBusDt", "busDt" ] }, "nonSlsRequestPayload":{ "description":"Request payload for non-sales transactions", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business date associated with the non sales transaction.", "title":"Business Date", "format":"date" }, "transSinceUTC":{ "type":"string", "description":"Report all non-sales transaction activity that has occurred since this UTC date and time for the specified business date.If this object is not included, return all non-sales transaction activity for the specified business date.", "title":"Transaction Date Time in UTC", "format":"date-time" }, "searchCriteria":{ "type":"string", "description":"Search criteria to filter results based on field value", "title":"Search Criteria", "maxLength":2000 }, "include":{ "type":"string", "description":"List of objects to include in response", "title":"Include", "maxLength":2000 }, "applicationName":{ "type":"string", "description":"The name of the application which is accessing the API.First Available Version: 20.1.10
", "title":"Application Name", "maxLength":128 } }, "required":[ "locRef", "busDt" ] }, "gstChkExtRequestPayload":{ "description":"Request payload for guest check extensibility", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "opnBusDt":{ "type":"string", "description":"The date the guest check was opened / re-opened", "title":"Open Business Date", "format":"date" }, "searchCriteria":{ "type":"string", "description":"Search criteria to filter results based on field value", "title":"Search Criteria", "maxLength":2000 }, "include":{ "type":"string", "description":"List of objects to include in response", "title":"Include", "maxLength":2000 }, "applicationName":{ "type":"string", "description":"The name of the application which is accessing the API.First Available Version: 20.1.10
", "title":"Application Name", "maxLength":128 } }, "required":[ "locRef", "opnBusDt" ] }, "POSWasteDetailsrequestPayload":{ "description":"Request payload", "properties":{ "transSinceUTC":{ "type":"string", "description":"Report all POS waste transaction activity that has occurred since this UTC date and time for the specified business date. If this object is not included, return all POS Waste transactions for the specified business date.First Available Version: 20.3
", "title":"Transaction Date Time in UTC", "format":"date-time" }, "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business date of the transaction", "title":"Business Date", "format":"date" }, "searchCriteria":{ "type":"string", "description":"Search criteria to filter results based on field value", "title":"Search Criteria", "maxLength":2000 }, "include":{ "type":"string", "description":"List of objects to include in response", "title":"Include", "maxLength":2000 }, "applicationName":{ "type":"string", "description":"The name of the application which is accessing the API.First Available Version: 20.1.10
", "title":"Application Name", "maxLength":128 } }, "required":[ "locRef", "busDt" ] }, "spiPaymentDetailsrequestPayload":{ "description":"Request payload for SPI payment details", "properties":{ "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location Reference", "maxLength":99 }, "busDt":{ "type":"string", "description":"Business date of the transaction", "title":"Business Date", "format":"date" }, "changedSinceUTC":{ "type":"string", "description":"The UTC date and time of a change made in the transaction", "title":"Changed Since Data Time UTC", "format":"date-time" }, "include":{ "type":"string", "description":"List of objects to include in response", "title":"Include", "maxLength":2000 }, "searchCriteria":{ "type":"string", "description":"Search criteria to filter results based on field value", "title":"Search Criteria", "maxLength":2000 }, "applicationName":{ "type":"string", "description":"The name of the application which is accessing the API.", "title":"Application Name", "maxLength":128 } }, "required":[ "locRef", "busDt" ] }, "paymentAccountHolderDimensions":{ "description":"The response body contains information about the payment account holder.", "properties":{ "accountHolders":{ "type":"array", "description":"An array of account holder details", "items":{ "$ref":"#/definitions/accountHolders" } } }, "required":[ "accountHolders" ] }, "accountHolders":{ "description":"The response body contains information about the account holder.", "properties":{ "acctHldrCode":{ "type":"string", "description":"Unique code of the account holder", "title":"Unique code of the account holder", "maxLength":128 }, "acctHldrName":{ "type":"string", "description":"Name of the account holder", "title":"Name of the account holder", "maxLength":50 }, "stlmtCur":{ "type":"string", "description":"Currency used for settlement", "title":"Currency used for settlement", "maxLength":3 }, "acctHldrStatus":{ "type":"number", "description":"Status of the account holderFirst Available Version: 20.1.9.6
", "title":"Transaction Time in location's timezone", "format":"date-time" }, "transEmpNum":{ "type":"integer", "description":"Unique number of the employee who has made the transaction", "title":"Transaction Employee Number", "maxLength":16 }, "refInfo":{ "type":"string", "description":"Reference Information associated with the transaction. This attribute will not be returned in the response if value is null", "title":"Reference Information", "maxLength":99 }, "transType":{ "type":"integer", "description":"Type of transaction.The following are the different transaction types that could be returned:First available version 20.1.15
", "title":"Balance amount" }, "actBusDate":{ "type":"string", "description":"The actual business date of the cash management transaction. This attribute will not be returned in the response if value is nullFirst available version 20.1.16
", "title":"The actual business date", "format":"date" }, "sessionNum":{ "type":"integer", "description":"The cash management session POS reference number. This attribute will not be returned in the response if value is 0 or nullFirst available version 20.1.16
", "title":"The cash management session POS reference number" }, "targetReceptacleNum":{ "type":"integer", "description":"The target receptacle POS reference number. This attribute will not be returned in the response if value is 0 or nullFirst available version 20.1.16
", "title":"The target receptacle POS reference number" }, "targetSessionNum":{ "type":"integer", "description":"The target session POS reference number. This attribute will not be returned in the response if value is 0 or nullFirst available version 20.1.16
", "title":"The target session POS reference number" } }, "required":[ "cmItemNum", "receptacleType", "receptacleName", "receptacleNum", "startAmt", "transAmt", "transUTC", "transLcl", "transEmpNum", "transType", "overShortAmt", "depAmt", "refInfo", "rsnCodeNum", "wsNum", "notes", "othrAmt", "guestCheckId", "tmedNum", "balanceAmt", "actBusDate", "sessionNum", "targetReceptacleNum", "targetSessionNum" ] }, "timeCardDetailsResponse":{ "description":"The response body contains information about the control totals for the specified business date and location.", "properties":{ "curUTC":{ "type":"string", "description":"The current UTC date and time when the request is made. ", "title":"The current UTC date and time", "format":"date-time" }, "locRef":{ "type":"string", "description":"The location reference, this may be a store number or name depending on the organization", "title":"Location reference", "maxLength":99 }, "businessDates":{ "type":"array", "description":"An array of business dates, containing time cards for the business date defined in the busDt attribute that were inserted or updated in the cloud on the specified postedDt.", "items":{ "$ref":"#/definitions/timeCardDetailsBusinessDates" } } }, "required":[ "curUTC", "locRef", "businessDates" ] }, "timeCardDetailsBusinessDates":{ "description":"An array of business dates, containing time cards for the business date defined in the busDt attribute that were inserted or updated in the cloud on the specified postedDt.", "properties":{ "busDt":{ "type":"string", "description":"The business date for this time card", "title":"The business date", "format":"date" }, "timeCardDetails":{ "type":"array", "description":"An array of time card details", "items":{ "$ref":"#/definitions/timeCardDetails" } } }, "required":[ "busDt", "timeCardDetails" ] }, "timeCardDetails":{ "description":"An array of time card details.", "properties":{ "tcId":{ "type":"integer", "description":"Unique identifier for the time card", "title":"Time card ID", "maxLength":10 }, "lastUpdatedUTC":{ "type":"string", "description":"The date and time in UTC timezone, that the time card was last updated in the cloud. The optional PostedDt request parameter is compared to the date portion of this attribute.", "title":"Last Updated Date Time in UTC", "format":"date-time" }, "addedUTC":{ "type":"string", "description":"The date and time in UTC timezone, that the time card was initially created in the cloud.", "title":"Added date time in UTC", "format":"date-time" }, "empNum":{ "type":"integer", "description":"The object number of the employee associated to this time card. This joins to getEmployeeDimensions.", "title":"Employee object number", "maxLength":10 }, "payrollID":{ "type":"string", "description":"The payrollID of the employee, assigned by Labor Management. This attribute will not be returned in the response if value is 0 or null.", "title":"Employee payrollID", "maxLength":32 }, "extPayrollID":{ "type":"string", "description":"The external payrollID of the employee if entered and used in the enterprise. This attribute will not be returned in the response if value is 0 or null.", "title":"Employee external payrollID", "maxLength":32 }, "jobCodeRef":{ "type":"integer", "description":"Do not use. Use jcNum instead. This attribute is optional and is not returned by default, regardless of whether it is null or not.", "title":"Employee external payrollID", "maxLength":10 }, "clkInAuthEmpNum":{ "type":"integer", "description":"The object number of the employee authorizing the clock in. This joins to getEmployeeDimensions. This attribute will not be returned in the response if value is 0 or null.", "title":"Clock In authorizing employee object number", "maxLength":10 }, "clkOutAuthEmpNum":{ "type":"integer", "description":"The object number of the employee authorizing the clock out. This joins to getEmployeeDimensions. This attribute will not be returned in the response if value is 0 or null.", "title":"Clock Out authorizing employee object number", "maxLength":10 }, "jcNum":{ "type":"integer", "description":"The object number of the job code that the employee used to clock in with. This joins to getJobCodeDimensions.", "title":"Job code object number", "maxLength":10 }, "rvcNum":{ "type":"integer", "description":"The object number of the revenue center the employee clocked in. This joins to getRevenueCenterDimensions.", "title":"Revenue center object number", "maxLength":10 }, "shftNum":{ "type":"integer", "description":"The shift number. This increments on every clock in if the following recommended configuration is completed: https://docs.oracle.com/en/industries/food-beverage/back-office/20.1/rause/c_gross_sales_tips.htm#VisibilityOfGrossSalesAndTips-228C1574. This attribute will not be returned in the response if value is 0 or null.", "title":"Shift number", "maxLength":19 }, "clkInLcl":{ "type":"string", "description":"Date and time in local store timezone when the employee clocked in.", "title":"Clock in date and time", "format":"date-time" }, "clkInUTC":{ "type":"string", "description":"Date and time in UTC timezone when the employee clocked in.", "title":"Clock in date and time in UTC", "format":"date-time" }, "clkInStatus":{ "type":"integer", "description":"The clock in status.| Value | Description |
|---|---|
| 0 | None |
| 65 | Early From Break |
| 67 | Late From Break |
| 68 | Schedule Disabled |
| 69 | Early |
| 76 | Late |
| 78 | Not Scheduled |
| 82 | Revenue Center Changed |
| 84 | On Time |
| Value | Description |
|---|---|
| Null | Employee still clocked in |
| 0 | None |
| 66 | On Break |
| 68 | Schedule Disabled |
| 69 | Early |
| 76 | Late |
| 77 | Manager Clock Out |
| 78 | Not Scheduled |
| 80 | Paid Break |
| 82 | Revenue Center Changed |
| 84 | On Time |
| 85 | Auto Clock Out |
| 86 | Scheduled Clock Out |
| Value | Description |
|---|---|
| 0 | working shift |
| 1 | paid break |
| 2 | unpaid break |