Xstorepos 210 SG

Oracle® Retail Xstore Suite
Services Guide
Release 21.0
F48816-01
January 2022
Oracle® Retail Xstore Suite, Services Guide, Release 21.0
F48816-01
Copyright © 2022, Oracle and/or its affiliates. All rights reserved.
Primary Author: Gerlinde Rust
This software and related documentation are provided under a license agreement containing
restrictions on use and disclosure and are protected by intellectual property laws. Except as
expressly permitted in your license agreement or allowed by law, you may not use, copy,
reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or
display any part, in any form, or by any means. Reverse engineering, disassembly, or
decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be
error-free. If you find any errors, please report them to us in writing.
If this software or related documentation is delivered to the U.S. Government or anyone licensing
it on behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated
software, any programs installed on the hardware, and/or documentation, delivered to U.S.
Government end users are “commercial computer software” pursuant to the applicable Federal
Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication,
disclosure, modification, and adaptation of the programs, including any operating system,
integrated software, any programs installed on the hardware, and/or documentation, shall be
subject to license terms and license restrictions applicable to the programs. No other rights are
granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management
applications. It is not developed or intended for use in any inherently dangerous applications,
including applications that may create a risk of personal injury. If you use this software or
hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe,
backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its
affiliates disclaim any liability for any damages caused by use of this software or hardware in
dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be
trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC
trademarks are used under license and are trademarks or registered trademarks of SPARC
International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or
registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open
Group.
This software or hardware and documentation may provide access to or information on content,
products, and services from third parties. Oracle Corporation and its affiliates are not responsible
for and expressly disclaim all warranties of any kind with respect to third-party content, products,
and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle
Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to
your access to or use of third-party content, products, or services, except as set forth in an
applicable agreement between you and Oracle.
Value-Added Reseller (VAR) Language
Oracle Retail VAR Applications
The following restrictions and provisions only apply to the programs referred to in this section
and licensed to you. You acknowledge that the programs may contain third party software (VAR
applications) licensed to Oracle. Depending upon your product and its version number, the VAR
applications may include:
(i) the MicroStrategy Components developed and licensed by MicroStrategy Services Corporation
(MicroStrategy) of McLean, Virginia to Oracle and imbedded in the MicroStrategy for Oracle
Retail Data Warehouse and MicroStrategy for Oracle Retail Planning & Optimization applications.
(ii) the Wavelink component developed and licensed by Wavelink Corporation (Wavelink) of
Kirkland, Washington, to Oracle and imbedded in Oracle Retail Mobile Store Inventory
Management.
(iii) the software component known as Access Via™ licensed by Access Via of Seattle, Washington,
and imbedded in Oracle Retail Signs and Oracle Retail Labels and Tags.
(iv) the software component known as Adobe Flex™ licensed by Adobe Systems Incorporated of
San Jose, California, and imbedded in Oracle Retail Promotion Planning & Optimization
application.
You acknowledge and confirm that Oracle grants you use of only the object code of the VAR
Applications. Oracle will not deliver source code to the VAR Applications to you.
Notwithstanding any other term or condition of the agreement and this ordering document, you
shall not cause or permit alteration of any VAR Applications. For purposes of this section,
"alteration" refers to all alterations, translations, upgrades, enhancements, customizations or
modifications of all or any portion of the VAR Applications including all reconfigurations,
reassembly or reverse assembly, re-engineering or reverse engineering and recompilations or
reverse compilations of the VAR Applications or any derivatives of the VAR Applications. You
acknowledge that it shall be a breach of the agreement to utilize the relationship, and/or
confidential information of the VAR Applications for purposes of competitive discovery.
The VAR Applications contain trade secrets of Oracle and Oracle's licensors and Customer shall
not attempt, cause, or permit the alteration, decompilation, reverse engineering, disassembly or
other reduction of the VAR Applications to a human perceivable form. Oracle reserves the right to
replace, with functional equivalent software, any of the VAR Applications in future releases of the
applicable program.
Contents
1 Send Us Your Comments..............................................................1-28
1 Preface............................................................................................1-29
Audience...................................................................................................................... 1-29
Documentation Accessibility .................................................................................. 1-29
Access to Oracle Support.................................................................................... 1-29
Related Documents .................................................................................................. 1-29
Customer Support...................................................................................................... 1-29
Review Patch Documentation ................................................................................. 1-29
Oracle Retail Documentation on the Oracle Help Center (docs.oracle.com). 1-30
Conventions ................................................................................................................ 1-30
1 Introduction......................................................................................1-1
About This Chapter..................................................................................................... 1-1
Examples........................................................................................................................ 1-2
methodExample..................................................................................................... 1-2
classExample .......................................................................................................... 1-2
subClass .................................................................................................................. 1-3
Simple Data Types................................................................................................. 1-3
Common Data Types................................................................................................... 1-4
codeValueObject .................................................................................................... 1-4
serviceContext........................................................................................................ 1-4
serviceResponse ..................................................................................................... 1-4
statusServiceResponse .......................................................................................... 1-5
About this Manual....................................................................................................... 1-5
2 Address ............................................................................................2-1
Overview ....................................................................................................................... 2-1
Methods ......................................................................................................................... 2-2
decodePostalCode ................................................................................................. 2-2
getAvailableCountries .......................................................................................... 2-2
translatePostalCode............................................................................................... 2-3
validateAddress ..................................................................................................... 2-3
Classes............................................................................................................................ 2-4
address .................................................................................................................... 2-4
addressValidationResponse................................................................................. 2-4
country .................................................................................................................... 2-5
countryListResponse............................................................................................. 2-5
postalCodeResponse ............................................................................................. 2-5
serviceContext........................................................................................................ 2-5
postalCodeListResponse....................................................................................... 2-6
4
3 Clienteling ........................................................................................3-1
Overview ....................................................................................................................... 3-1
Methods ......................................................................................................................... 3-2
addCustomerNote ................................................................................................. 3-2
getAppointmentStatuses ...................................................................................... 3-2
getAssociateAppointments .................................................................................. 3-3
getAssociateTasks.................................................................................................. 3-3
getAssociatesAssignments ................................................................................... 3-4
getClientelingConfig ............................................................................................. 3-4
getCustomerAppointments ................................................................................. 3-4
getCustomerNotes................................................................................................. 3-5
getCustomerPrefrences......................................................................................... 3-5
getCustomerRSVPForEvent................................................................................. 3-6
getCustomerRSVPs ............................................................................................... 3-6
getStoreEvents........................................................................................................ 3-6
getSuggestSellingItems......................................................................................... 3-7
markContactCustomer.......................................................................................... 3-7
saveAssociateTask ................................................................................................. 3-8
saveAssociateTest .................................................................................................. 3-8
saveAssociatesAssignment .................................................................................. 3-9
saveCustomerAppointment................................................................................. 3-9
saveCustomerRSVP............................................................................................. 3-10
searchCustomersByAssociate ............................................................................ 3-10
Classes.......................................................................................................................... 3-11
appointmentStatusResponse.............................................................................. 3-11
associateAppointmentsResponse...................................................................... 3-11
associateAssignment ........................................................................................... 3-11
associateAssignmentResponse .......................................................................... 3-11
associateRole ........................................................................................................ 3-12
associateTask ........................................................................................................ 3-12
associateTaskResponse ....................................................................................... 3-12
associateTasksResponse ..................................................................................... 3-13
clientelCustomerSearchResponse ..................................................................... 3-13
clientelingConfig.................................................................................................. 3-13
codeValueObject .................................................................................................. 3-14
codesLookupResponse ....................................................................................... 3-14
commissionedAssociate...................................................................................... 3-14
customer................................................................................................................ 3-14
customerAppointmentResponse....................................................................... 3-14
customerNote ....................................................................................................... 3-15
customerNotesResponse .................................................................................... 3-15
customerRSVPResponse..................................................................................... 3-15
customerSearchResponse ................................................................................... 3-15
dailyAssociateTask.............................................................................................. 3-15
5
item ........................................................................................................................ 3-16
itemSearchResponse............................................................................................ 3-16
storeEvent ............................................................................................................. 3-16
storeEventLookupResponse .............................................................................. 3-16
storeEventRSVP ................................................................................................... 3-16
weeklyAssociateTask .......................................................................................... 3-17
serviceContext...................................................................................................... 3-17
serviceResponse ................................................................................................... 3-17
startupConfiguration .......................................................................................... 3-17
statusServiceResponse ........................................................................................ 3-17
4 Configuration ...................................................................................4-1
Overview ....................................................................................................................... 4-1
Methods ......................................................................................................................... 4-2
checkFirmwareUpdate.......................................................................................... 4-2
checkForEncryptionKeyUpdate .......................................................................... 4-2
getSystemStartupConfig....................................................................................... 4-3
Classes............................................................................................................................ 4-3
encryptionKeyUpdateResponse.......................................................................... 4-3
checkForFirmwareUpdateResponse................................................................... 4-4
operationConfig ..................................................................................................... 4-4
serviceContext........................................................................................................ 4-4
startupConfiguration ............................................................................................ 4-4
systemConfig.......................................................................................................... 4-5
5 Customer ..........................................................................................5-1
Overview ....................................................................................................................... 5-1
Methods ......................................................................................................................... 5-2
addNewCustomer ................................................................................................. 5-2
getCustomerByParty ............................................................................................. 5-2
getCustomerHistory.............................................................................................. 5-2
saveCustomerChanges ......................................................................................... 5-3
searchCustomers.................................................................................................... 5-3
Classes............................................................................................................................ 5-4
awardCoupon ........................................................................................................ 5-4
commercialAccount............................................................................................... 5-4
customer.................................................................................................................. 5-4
customerEmail ....................................................................................................... 5-5
customerGroup ...................................................................................................... 5-6
customerHistoryItem ............................................................................................ 5-6
customerHistoryResult ......................................................................................... 5-7
customerLookupResponse ................................................................................... 5-7
customerLoyaltyAccount ..................................................................................... 5-7
6
customerLoyaltyCard ........................................................................................... 5-8
customerParty ........................................................................................................ 5-8
customerSearchResponse ................................................................................... 5-10
customerTelephone ............................................................................................. 5-10
partyProperty ....................................................................................................... 5-10
serviceContext...................................................................................................... 5-10
taxExemption ....................................................................................................... 5-11
6 Discount ...........................................................................................6-1
Overview ....................................................................................................................... 6-1
Methods ......................................................................................................................... 6-2
getCouponDiscount .............................................................................................. 6-2
getDiscountsByApplicationMethod ................................................................... 6-2
Classes............................................................................................................................ 6-3
coupon..................................................................................................................... 6-3
couponLookupResponse ...................................................................................... 6-3
discount................................................................................................................... 6-3
discountLookupResponse .................................................................................... 6-4
serviceContext........................................................................................................ 6-4
7 Employee..........................................................................................7-1
Overview ....................................................................................................................... 7-1
Methods ......................................................................................................................... 7-2
addMessage ............................................................................................................ 7-2
authenticate ............................................................................................................ 7-2
authorize ................................................................................................................. 7-3
changePassword .................................................................................................... 7-3
deleteMessage ........................................................................................................ 7-4
getCommissionedAssociates ............................................................................... 7-4
updateMessage ...................................................................................................... 7-4
validateEmp ........................................................................................................... 7-5
Classes............................................................................................................................ 7-5
commissionedAssociate........................................................................................ 7-5
employee................................................................................................................. 7-6
employeeAuthResponse....................................................................................... 7-6
employeeMessage.................................................................................................. 7-6
employeeMsgResponse ........................................................................................ 7-7
retrieveCommAsscResponse ............................................................................... 7-7
serviceContext........................................................................................................ 7-7
userAuthorizeResponse........................................................................................ 7-7
validateEmployeeResponse ................................................................................. 7-7
7
8 House Account ................................................................................8-1
Overview ....................................................................................................................... 8-1
Methods ......................................................................................................................... 8-2
createAccount......................................................................................................... 8-2
retrieveById ............................................................................................................ 8-2
searchByAccountName ........................................................................................ 8-2
searchByCustomerNamePhone........................................................................... 8-3
updateAccount....................................................................................................... 8-3
Classes............................................................................................................................ 8-4
adaptedHouseAccountSearchResult .................................................................. 8-4
chargeAccountUser ............................................................................................... 8-4
consumerChargeAccount..................................................................................... 8-5
customerParty ........................................................................................................ 8-5
houseAccountRetrieveResponse ......................................................................... 8-5
houseAccountSearchResponse ............................................................................ 8-6
serviceContext........................................................................................................ 8-6
9 Input ..................................................................................................9-1
Overview ....................................................................................................................... 9-1
Methods ......................................................................................................................... 9-2
translateInput ......................................................................................................... 9-2
Classes............................................................................................................................ 9-2
inputEvent .............................................................................................................. 9-2
inputResponse........................................................................................................ 9-2
serviceContext........................................................................................................ 9-3
10 Inventory.........................................................................................10-1
Overview ..................................................................................................................... 10-1
Methods ....................................................................................................................... 10-2
getOnHandStockLedger ..................................................................................... 10-2
getStockLedger..................................................................................................... 10-2
Classes.......................................................................................................................... 10-3
stockLedger .......................................................................................................... 10-3
serviceContext...................................................................................................... 10-3
11 Inventory Adjustment....................................................................11-1
Overview ..................................................................................................................... 11-1
Methods ....................................................................................................................... 11-2
addLine ................................................................................................................. 11-2
8
cancelInvAdjustment .......................................................................................... 11-3
changeLineLocBucket ......................................................................................... 11-3
changeLineQty ..................................................................................................... 11-4
changeLineReason............................................................................................... 11-4
getInventoryAdjustmentConfig ........................................................................ 11-5
initializeInvAdjustment...................................................................................... 11-5
saveInvAdjustment ............................................................................................. 11-5
saveItmTransfer ................................................................................................... 11-6
validateLine .......................................................................................................... 11-6
voidLine ................................................................................................................ 11-6
Classes.......................................................................................................................... 11-7
adjustmentLineItem ............................................................................................ 11-7
inputEvent ............................................................................................................ 11-7
invAdjustmentConfiguration ............................................................................ 11-8
invAdjustmentResponse..................................................................................... 11-8
inventoryBucket................................................................................................... 11-8
inventoryDocumentResponse ........................................................................... 11-8
inventoryLocation ............................................................................................... 11-8
inventoryResponse .............................................................................................. 11-8
item ........................................................................................................................ 11-9
reasonCode ........................................................................................................... 11-9
reasonCodePromptProperties ........................................................................... 11-9
serviceContext...................................................................................................... 11-9
startupConfiguration .......................................................................................... 11-9
validateDocumentLineItemResponse............................................................... 11-9
12 Inventory Count .............................................................................12-1

Overview ..................................................................................................................... 12-1
Methods ....................................................................................................................... 12-2
addInventoryCountLineItem............................................................................. 12-2
cancelCurrentInventoryCountSession.............................................................. 12-3
cancelInventoryCountDocument ...................................................................... 12-3
changeInventoryCountLineItemQty ................................................................ 12-3
completeInventoryCount ................................................................................... 12-4
createNewInventoryCountDoc ......................................................................... 12-4
getInventoryCountConfig .................................................................................. 12-5
getInventoryCountDocument............................................................................ 12-5
getInventoryCountSheetsForCycle ................................................................... 12-6
getInventoryCountSummaryForCycle............................................................. 12-6
getVarianceReport ............................................................................................... 12-7
initiateInventoryCount ....................................................................................... 12-7
saveInventoryCount............................................................................................ 12-8
searchInventoryCountDocuments .................................................................... 12-8
9
submitInventoryCount ....................................................................................... 12-8
Classes.......................................................................................................................... 12-9
codeValueObject .................................................................................................. 12-9
inventoryBucket................................................................................................... 12-9
inventoryCountConfiguration........................................................................... 12-9
inventoryCountCycle........................................................................................ 12-10
inventoryCountCycleSummary ...................................................................... 12-10
inventoryCountDocSearchResponse .............................................................. 12-10
inventoryCountDocument ............................................................................... 12-11
inventoryCountDocumentResponse .............................................................. 12-11
inventoryCountElement ................................................................................... 12-12
inventoryCountLineItem.................................................................................. 12-12
inventoryCountSheet ........................................................................................ 12-13
inventoryCountSheetsForCycleResponse...................................................... 12-13
inventoryCountSummaryForCycleResponse................................................ 12-13
inventoryCountVarianceReportResponse ..................................................... 12-14
inventoryDocType............................................................................................. 12-14
inventoryResponse ............................................................................................ 12-14
item ...................................................................................................................... 12-14
serviceContext.................................................................................................... 12-14
serviceResponse ................................................................................................. 12-14
statusServiceResponse ...................................................................................... 12-14
13 Item .................................................................................................13-1
Overview ..................................................................................................................... 13-1
Methods ....................................................................................................................... 13-2
checkProductAvailability ................................................................................... 13-2
getCatalog............................................................................................................. 13-2
getCatalogList ...................................................................................................... 13-3
getCurrentItemPrices .......................................................................................... 13-3
getGiftCardItems ................................................................................................. 13-3
getItemById .......................................................................................................... 13-4
getItemBySaleType.............................................................................................. 13-4
getItemDeals......................................................................................................... 13-4
getItemNotOnFileItems ...................................................................................... 13-5
getItemPriceHistory ............................................................................................ 13-5
getItemVariations ................................................................................................ 13-6
getItemsByDimensions ....................................................................................... 13-6
getItemsForCategory........................................................................................... 13-7
getNonPhysicalItems .......................................................................................... 13-7
getProductCategories.......................................................................................... 13-7
getSimilarItems .................................................................................................... 13-8
getSingleItemDealPrice....................................................................................... 13-8
getVoucherItemForActivity ............................................................................... 13-9
10
printItemLabel ..................................................................................................... 13-9
searchCatalogForItem ....................................................................................... 13-10
searchItemsByDescription................................................................................ 13-10
searchItemsByIdOrDescription ....................................................................... 13-10
Classes........................................................................................................................ 13-11
catalog ................................................................................................................. 13-11
catalogListResponse .......................................................................................... 13-11
catalogPage......................................................................................................... 13-12
catalogPageItem................................................................................................. 13-12
catalogPageResponse ........................................................................................ 13-12
catalogResponse................................................................................................. 13-12
inventoryLocatorResponse .............................................................................. 13-13
item ...................................................................................................................... 13-13
itemDeal .............................................................................................................. 13-14
itemDealListResponse....................................................................................... 13-15
itemDimension................................................................................................... 13-15
itemDimensionValue ........................................................................................ 13-15
itemLookupResponse ....................................................................................... 13-15
itemPrice ............................................................................................................. 13-16
itemPriceHistory................................................................................................ 13-16
itemPriceHistoryResponse ............................................................................... 13-16
itemPricesResponse........................................................................................... 13-17
itemPromptProperty ......................................................................................... 13-17
itemProperty....................................................................................................... 13-17
itemSearchResponse.......................................................................................... 13-17
productCategoriesResponse ............................................................................ 13-18
productCategory................................................................................................ 13-18
retailLocation...................................................................................................... 13-18
retailLocationStockLevel .................................................................................. 13-18
serviceContext.................................................................................................... 13-18
14 Logging...........................................................................................14-1
Overview ..................................................................................................................... 14-1
Methods ....................................................................................................................... 14-2
logEvent ................................................................................................................ 14-2
logList.................................................................................................................... 14-2
Classes.......................................................................................................................... 14-2
logEntry................................................................................................................. 14-2
loggingResponse.................................................................................................. 14-3
serviceContext...................................................................................................... 14-3
11
15 Order ...............................................................................................15-1
Overview ..................................................................................................................... 15-1
Methods ....................................................................................................................... 15-2
cancelOrder .......................................................................................................... 15-2
submitOrder ......................................................................................................... 15-2
Classes.......................................................................................................................... 15-2
orderDelivery ....................................................................................................... 15-2
orderEntity............................................................................................................ 15-3
orderInfo ............................................................................................................... 15-4
orderLocation ....................................................................................................... 15-4
orderLocationsResponse .................................................................................... 15-5
orderPickup .......................................................................................................... 15-5
orderPickupTransactionDetail........................................................................... 15-5
orderPickupTransactionDetails......................................................................... 15-5
orderResponse...................................................................................................... 15-5
orderRetailPickup................................................................................................ 15-6
orderShipTransactionDetail ............................................................................... 15-6
orderShipTransactionDetails ............................................................................. 15-6
orderSoldTo.......................................................................................................... 15-7
orderTax................................................................................................................ 15-7
orderTaxes ............................................................................................................ 15-7
orderTender.......................................................................................................... 15-7
orderTenders ........................................................................................................ 15-7
orderTransactionDetail ....................................................................................... 15-8
orderUpdate ......................................................................................................... 15-8
serviceContext...................................................................................................... 15-8
16 Ping .................................................................................................16-1
Overview ..................................................................................................................... 16-1
Methods ....................................................................................................................... 16-2
pingServer............................................................................................................. 16-2
Classes.......................................................................................................................... 16-2
pingResponse ....................................................................................................... 16-2
serviceContext...................................................................................................... 16-2
17 Printing ...........................................................................................17-1
Overview ..................................................................................................................... 17-1
Methods ....................................................................................................................... 17-2
getAvailablePrinters............................................................................................ 17-2
printTestReceipt................................................................................................... 17-2
12
Classes.......................................................................................................................... 17-2
printer.................................................................................................................... 17-2
printerResponse ................................................................................................... 17-3
serviceContext...................................................................................................... 17-3
18 Reason Code..................................................................................18-1
Overview ..................................................................................................................... 18-1
Methods ....................................................................................................................... 18-2
getReasonCodesByType ..................................................................................... 18-2
Classes.......................................................................................................................... 18-2
reasonCodeLookupResponse ............................................................................ 18-2
reasonCode ........................................................................................................... 18-2
reasonCodePromptProperties ........................................................................... 18-3
serviceContext...................................................................................................... 18-3
19 Receiving........................................................................................19-1
Overview ..................................................................................................................... 19-1
Methods ....................................................................................................................... 19-2
addLine ................................................................................................................. 19-2
addToExpress....................................................................................................... 19-2
cancelDocumentChanges ................................................................................... 19-3
cancelExpress ....................................................................................................... 19-3
changeLineQty ..................................................................................................... 19-4
createNewDocument .......................................................................................... 19-4
getCarton .............................................................................................................. 19-5
getDocument ........................................................................................................ 19-5
getReceiveFromLocations .................................................................................. 19-5
getReceivingConfig ............................................................................................. 19-6
receiveCartonInFull............................................................................................. 19-6
receiveInFull......................................................................................................... 19-7
saveDocument...................................................................................................... 19-7
saveExpress .......................................................................................................... 19-7
searchDocuments................................................................................................. 19-8
updatePONumber ............................................................................................... 19-8
validateControlNumber ..................................................................................... 19-9
validateId .............................................................................................................. 19-9
validateLine .......................................................................................................... 19-9
validateOrAddCarton....................................................................................... 19-10
voidFromExpress............................................................................................... 19-10
voidLine .............................................................................................................. 19-11
Classes........................................................................................................................ 19-11
cartonLineItem ................................................................................................... 19-11
13
documentLineItem ............................................................................................ 19-12
documentSearchResultResponse .................................................................... 19-13
expressLineItem................................................................................................. 19-13
expressReceivingResponse............................................................................... 19-13
inventoryCartonResponse................................................................................ 19-13
inventoryDestination ........................................................................................ 19-14
inventoryDestinationResponse ....................................................................... 19-14
inventoryDocument .......................................................................................... 19-14
inventoryDocumentResponse ......................................................................... 19-15
inventoryResponse ............................................................................................ 19-15
item ...................................................................................................................... 19-15
receivingConfiguration..................................................................................... 19-16
serviceContext.................................................................................................... 19-16
shipperOption .................................................................................................... 19-16
startupConfiguration ........................................................................................ 19-16
validateInvIdResponse ..................................................................................... 19-16
validateDocumentLineItemResponse............................................................. 19-16
20 Register ..........................................................................................20-1
Overview ..................................................................................................................... 20-1
Methods ....................................................................................................................... 20-2
closeRegister......................................................................................................... 20-2
getRegisterStoreStatus ........................................................................................ 20-2
openRegister......................................................................................................... 20-2
validateRegisterOpen.......................................................................................... 20-3
Classes.......................................................................................................................... 20-3
registerStoreStatusResponse .............................................................................. 20-3
serviceContext...................................................................................................... 20-3
21 Retail Location ...............................................................................21-1

Overview ..................................................................................................................... 21-1
Methods ....................................................................................................................... 21-2
closeStore .............................................................................................................. 21-2
getRetailLocation ................................................................................................. 21-2
getRetailLocationWithId .................................................................................... 21-2
locateSendSaleStores ........................................................................................... 21-3
locateStores ........................................................................................................... 21-3
openStore .............................................................................................................. 21-4
validateStoreClosed ............................................................................................ 21-4
validateStoreOpen ............................................................................................... 21-4
Classes.......................................................................................................................... 21-5
14
retailLocation........................................................................................................ 21-5
retailLocationLookupResponse......................................................................... 21-6
retailLocationSearchResponse ........................................................................... 21-6
serviceContext...................................................................................................... 21-6
validationResponse ............................................................................................. 21-6
22 Shipping .........................................................................................22-1
Overview ..................................................................................................................... 22-1
Methods ....................................................................................................................... 22-2
addDocumentComment ..................................................................................... 22-2
addLine ................................................................................................................. 22-2
cancelDocumentChanges ................................................................................... 22-3
changeLineQty ..................................................................................................... 22-3
createNewDocument .......................................................................................... 22-4
getCarton .............................................................................................................. 22-4
getDocument ........................................................................................................ 22-5
getShipToLocations ............................................................................................. 22-5
getShippingConfig .............................................................................................. 22-6
getShippingMethods........................................................................................... 22-6
saveDocument...................................................................................................... 22-6
searchDocuments................................................................................................. 22-7
updatePONumber ............................................................................................... 22-7
validateLine .......................................................................................................... 22-8
validateOrAddCarton......................................................................................... 22-8
voidLine ................................................................................................................ 22-9
Classes.......................................................................................................................... 22-9
cartonLineItem ..................................................................................................... 22-9
documentSearchResultResponse ...................................................................... 22-9
inventoryCartonResponse.................................................................................. 22-9
inventoryDestinationResponse ......................................................................... 22-9
inventoryDocument ............................................................................................ 22-9
inventoryDocumentResponse ........................................................................... 22-9
inventoryResponse .............................................................................................. 22-9
orderShippingMethodResponse ..................................................................... 22-10
serviceContext.................................................................................................... 22-10
shippingBundleResponse................................................................................. 22-10
shippingConfiguration ..................................................................................... 22-10
shippingMethod ................................................................................................ 22-10
validateDocumentLineItemResponse............................................................. 22-11
15
23 Tax...................................................................................................23-1
Overview ..................................................................................................................... 23-1
Methods ....................................................................................................................... 23-2
getTaxLocations ................................................................................................... 23-2
Classes.......................................................................................................................... 23-2
serviceContext...................................................................................................... 23-2
taxLocation ........................................................................................................... 23-2
taxLocationLookupResponse............................................................................. 23-3
24 Timeclock .......................................................................................24-1
Overview ..................................................................................................................... 24-1
Methods ....................................................................................................................... 24-2
employeeChangeWorkCode.............................................................................. 24-2
employeeClockIn ................................................................................................. 24-2
employeeClockOut.............................................................................................. 24-3
employeeTimeclockHistory ............................................................................... 24-3
validateEmployeeChangeWorkCode ............................................................... 24-4
validateEmployeeClockIn .................................................................................. 24-5
validateEmployeeClockInWithoutAuth .......................................................... 24-5
validateEmployeeClockOut ............................................................................... 24-6
validateEmployeeIsClockedIn........................................................................... 24-6
Classes.......................................................................................................................... 24-7
dailyTimeClockEntries ....................................................................................... 24-7
employee............................................................................................................... 24-7
employeeAuthResponse..................................................................................... 24-7
employeeMessage................................................................................................ 24-7
employeeTimeClockEntriesResponse .............................................................. 24-7
serviceContext...................................................................................................... 24-8
timeClockEntry .................................................................................................... 24-8
timeClockResponse ............................................................................................. 24-8
validateTimeClockResponse.............................................................................. 24-8
workCode ............................................................................................................. 24-9
25 Transaction ....................................................................................25-1
Overview ..................................................................................................................... 25-1
Methods ....................................................................................................................... 25-2
addCouponLineItem........................................................................................... 25-2
addCreditDebitTenderLineItem........................................................................ 25-3
addCustomerToRetailTrans............................................................................... 25-4
addLocalCurrencyTenderLineItem .................................................................. 25-5
16
addSaleLineItem .................................................................................................. 25-5
addVoucherSaleLineItem ................................................................................... 25-6
addVoucherTenderLineItem.............................................................................. 25-7
applyLineItemTaxExemption ............................................................................ 25-8
authorizeVoucherSale......................................................................................... 25-9
cancelRetailTransaction .................................................................................... 25-10
changeLineItemCommissionedAssociate ...................................................... 25-10
changeLineItemPrice......................................................................................... 25-11
changeLineItemQty........................................................................................... 25-12
changeLineItemTax ........................................................................................... 25-12
changeLineItemTaxLocation............................................................................ 25-13
changeTransactionCommissionedAssociate ................................................. 25-14
changeTransactionTax ...................................................................................... 25-14
changeTransactionTaxLocation....................................................................... 25-15
commitRetailTransaction.................................................................................. 25-16
convertSaleItemToSendSale............................................................................. 25-16
convertSendSaleItemToSale............................................................................. 25-17
createNewRetailTransaction ............................................................................ 25-17
createOrderSale.................................................................................................. 25-18
discountGroupLineItems ................................................................................. 25-18
discountLineItem............................................................................................... 25-19
discountTransaction .......................................................................................... 25-20
finalizeRetailTransaction .................................................................................. 25-21
generateRetailTransactionDocuments............................................................ 25-21
getBounceBackCoupon..................................................................................... 25-22
getEligibleGiftReceiptItems ............................................................................. 25-22
getPosConfig ...................................................................................................... 25-23
getSuspendedTransactions .............................................................................. 25-23
getTransPromptProperties ............................................................................... 25-23
isBounceBackCouponInRange......................................................................... 25-24
issueRedeemBounceBackCoupon ................................................................... 25-24
joinLoyaltyProgram .......................................................................................... 25-25
lookupTrans ....................................................................................................... 25-26
lookupTransByBarcode .................................................................................... 25-26
postVoidTransaction ......................................................................................... 25-27
redeemLoyaltyAward....................................................................................... 25-27
refreshTransaction ............................................................................................. 25-28
regenerateTransactionDocuments .................................................................. 25-28
removeCustomerFromRetailTrans ................................................................. 25-29
resumeTransaction ............................................................................................ 25-29
saveSendSaleAddress ....................................................................................... 25-30
searchTrans......................................................................................................... 25-30
searchTransByCustomerAndItem................................................................... 25-31
selectLoyaltyCard.............................................................................................. 25-32
setTaxExemptionAccount ................................................................................ 25-32
17
setTransProperties ............................................................................................. 25-33
suspendRetailTransaction ................................................................................ 25-33
updateSendSaleItems........................................................................................ 25-34
validateCommissionedAssociates................................................................... 25-34
validateCreditCardTender ............................................................................... 25-35
validateGroupDiscount .................................................................................... 25-35
validateLineItemChangePrice ......................................................................... 25-36
validateLineItemChangeQty............................................................................ 25-36
validateLineItemDiscount................................................................................ 25-37
validateLineItemVoid ....................................................................................... 25-37
validateTenderLineItemVoid........................................................................... 25-38
validateTransactionDiscount ........................................................................... 25-38
validateVoucherSale.......................................................................................... 25-39
validateVoucherTender .................................................................................... 25-40
voidLineItem ...................................................................................................... 25-40
voidLineItemDiscount ...................................................................................... 25-41
voidTenderLineItem ......................................................................................... 25-41
voidTransactionDiscount ................................................................................. 25-42
Classes........................................................................................................................ 25-42
authResponse ..................................................................................................... 25-42
awardCoupon .................................................................................................... 25-43
bounceBackCoupon .......................................................................................... 25-44
bounceBackCouponResponse.......................................................................... 25-44
codeValueObject ................................................................................................ 25-44
commissionedAssociate.................................................................................... 25-45
customerLoyaltyCard ....................................................................................... 25-45
giftReceiptEligibilityResponse......................................................................... 25-45
item ...................................................................................................................... 25-46
itemPromptProperty ......................................................................................... 25-46
orderSaleAccount .............................................................................................. 25-46
orderSaleTransResponse .................................................................................. 25-46
posConfiguration............................................................................................... 25-47
posTrans.............................................................................................................. 25-47
posTransDiscountLine...................................................................................... 25-48
posTransSaleLine............................................................................................... 25-49
posTransSaleLineProperties............................................................................. 25-50
posTenderLine ................................................................................................... 25-50
reasonCodePromptProperties ......................................................................... 25-51
resumeTransResponse ...................................................................................... 25-51
sendSaleAccount................................................................................................ 25-52
sendSaleAccountResponse............................................................................... 25-53
sendSaleTransResponse.................................................................................... 25-53
serviceContext.................................................................................................... 25-53
sourceStoreInfo .................................................................................................. 25-53
18
suspendedTrans................................................................................................. 25-54
suspendedTransResultResponse..................................................................... 25-54
taxExemption ..................................................................................................... 25-54
tender................................................................................................................... 25-55
tenderMoreInfo.................................................................................................. 25-55
tenderMoreInfoField ......................................................................................... 25-55
tenderMoreInputField ...................................................................................... 25-55
trackSet................................................................................................................ 25-55
transPromptProperty ........................................................................................ 25-55
transPromptPropertyResponse ....................................................................... 25-56
transactionHistoryResult.................................................................................. 25-56
transactionListResponse ................................................................................... 25-56
validateSaleVoucherResponse......................................................................... 25-57
validationResponse ........................................................................................... 25-57
26 ReSTful Web Services...................................................................26-1

Overview ..................................................................................................................... 26-1
Resources..................................................................................................................... 26-1
GetByQueryResource.......................................................................................... 26-1
Method GET .................................................................................................. 26-1
ReST URI........................................................................................................ 26-1
Input Parameters .......................................................................................... 26-1
Method POST................................................................................................ 26-2
ReST URI........................................................................................................ 26-2
Parameters ..................................................................................................... 26-2
Construct URL - GetByIdResource ............................................................ 26-2
GetByIDResource................................................................................................. 26-3
ReST URI........................................................................................................ 26-3
Response ........................................................................................................ 26-3
Construct Query XML - GetByQueryResource........................................ 26-4
ReST Xservices Lookup ...................................................................................... 26-5
27 Xstore Office Services...................................................................27-1

Overview ..................................................................................................................... 27-1
RTLog Endpoints ....................................................................................................... 27-1
Endpoint - RTLog Mapping Config.................................................................. 27-1
URI.................................................................................................................. 27-1
HTTP Protocol .............................................................................................. 27-1
PUT.......................................................................................................... 27-1
Body ........................................................................................................ 27-2
RTLogConfigMapping.xml file content............................................. 27-2
Returns.................................................................................................... 27-2
19
GET.......................................................................................................... 27-2
Returns.................................................................................................... 27-2
DELETE .................................................................................................. 27-2
Returns.................................................................................................... 27-2
Type of Web Service..................................................................................... 27-2
Security Protocol/Grant Type (if OAuth).................................................. 27-2
Client .............................................................................................................. 27-2
Server.............................................................................................................. 27-2
Endpoint - RTLog Format Config ..................................................................... 27-3
URI.................................................................................................................. 27-3
HTTP Protocol .............................................................................................. 27-3
PUT.......................................................................................................... 27-3
Body ........................................................................................................ 27-3
RTLogConfigFormat.xml file content ................................................ 27-3
Returns.................................................................................................... 27-3
GET.......................................................................................................... 27-3
Returns.................................................................................................... 27-3
DELETE .................................................................................................. 27-3
Returns.................................................................................................... 27-3
Client .............................................................................................................. 27-4
Server.............................................................................................................. 27-4
Endpoint - Published RTLogs............................................................................ 27-4
URI.................................................................................................................. 27-4
HTTP Protocol .............................................................................................. 27-4
GET.......................................................................................................... 27-4
Response................................................................................................. 27-4
Client .............................................................................................................. 27-4
Server.............................................................................................................. 27-4
Endpoint - Generate RTLog from PosLog ....................................................... 27-5
URI.................................................................................................................. 27-5
HTTP Protocol .............................................................................................. 27-5
POST........................................................................................................ 27-5
Parameters.............................................................................................. 27-5
Client .............................................................................................................. 27-5
Server.............................................................................................................. 27-5
Endpoint - healthcheck (Cloud Only)............................................................... 27-5
URI.................................................................................................................. 27-5
HTTP Protocol .............................................................................................. 27-5
GET.......................................................................................................... 27-5
Returns.................................................................................................... 27-5
Oracle Retail Xstore Suite Services Guide 1-20

Client .............................................................................................................. 27-6
Server.............................................................................................................. 27-6
Xcenter Endpoints...................................................................................................... 27-6
Endpoint - Broadcaster REST Service........................................................ 27-6
URI........................................................................................................... 27-6
HTTP Protocol ....................................................................................... 27-6
GET................................................................................................... 27-6
Parameters:...................................................................................... 27-7
Returns............................................................................................. 27-7
Type of Web Service ............................................................................. 27-7
Security Protocol/Grant Type (if OAuth) .......................................... 27-7
Client ....................................................................................................... 27-7
Server ...................................................................................................... 27-7
Endpoint - Updates ............................................................................................. 27-7
URI.................................................................................................................. 27-7
HTTP Protocol .............................................................................................. 27-7
GET.......................................................................................................... 27-7
Parameters.............................................................................................. 27-8
Returns.................................................................................................... 27-8
Client .............................................................................................................. 27-8
Server.............................................................................................................. 27-8
Endpoint - EventLog ........................................................................................... 27-8
URI.................................................................................................................. 27-8
HTTP Protocol .............................................................................................. 27-8
POS .......................................................................................................... 27-8
Client .............................................................................................................. 27-8
Server.............................................................................................................. 27-9
Endpoint - File...................................................................................................... 27-9
URI.................................................................................................................. 27-9
HTTP Protocol .............................................................................................. 27-9
GET.......................................................................................................... 27-9
Headers................................................................................................... 27-9
Path Parameters..................................................................................... 27-9
Returns.................................................................................................. 27-10
PUT........................................................................................................ 27-10
Headers................................................................................................. 27-10
Path Parameters................................................................................... 27-10
Returns.................................................................................................. 27-11
DELETE ................................................................................................ 27-11
Path Parameters................................................................................... 27-11
Returns.................................................................................................. 27-12
Type of Web Service................................................................................... 27-12
1-21 Oracle Retail Xstore Suite Services Guide

Security Protocol/Grant Type (if OAuth)................................................ 27-12
Client ............................................................................................................ 27-12
Server............................................................................................................ 27-12
Endpoint - ConfigPath ...................................................................................... 27-12
URI................................................................................................................ 27-12
HTTP Protocol ............................................................................................ 27-12
GET........................................................................................................ 27-12
Parameters............................................................................................ 27-12
Returns.................................................................................................. 27-13
Client ............................................................................................................ 27-13
Server............................................................................................................ 27-13
Endpoints - DTX ................................................................................................ 27-13
URI................................................................................................................ 27-13
HTTP Protocol ............................................................................................ 27-13
GET........................................................................................................ 27-13
Path Parameters.......................................................................................... 27-13
Returns ......................................................................................................... 27-13
URI................................................................................................................ 27-14
HTTP Protocol ............................................................................................ 27-14
GET........................................................................................................ 27-14
Path Parameters.......................................................................................... 27-14
Parameters............................................................................................ 27-14
Returns.................................................................................................. 27-14
URI................................................................................................................ 27-14
HTTP Protocol ............................................................................................ 27-14
POST...................................................................................................... 27-14
Parameters............................................................................................ 27-14
Body ...................................................................................................... 27-15
Returns.................................................................................................. 27-15
URI................................................................................................................ 27-15
HTTP Protocol ............................................................................................ 27-15
POST...................................................................................................... 27-15
Body ...................................................................................................... 27-16
Returns.................................................................................................. 27-16
Client ............................................................................................................ 27-16
Server............................................................................................................ 27-16
Endpoint - Replicate.......................................................................................... 27-16
URI................................................................................................................ 27-16
HTTP Protocol ............................................................................................ 27-16
POST...................................................................................................... 27-16
Parameters............................................................................................ 27-17
Returns.................................................................................................. 27-17

Client ............................................................................................................ 27-17
Server............................................................................................................ 27-17
Endpoint - DeployStatus .................................................................................. 27-17
URI................................................................................................................ 27-17
HTTP Protocol ............................................................................................ 27-17
POST...................................................................................................... 27-17
Body ...................................................................................................... 27-17
Returns.................................................................................................. 27-17
Client ............................................................................................................ 27-18
Server............................................................................................................ 27-18
Endpoint - SystemDateTime ............................................................................ 27-18
URI................................................................................................................ 27-18
HTTP Protocol ............................................................................................ 27-18
GET ............................................................................................................... 27-18
Parameters............................................................................................ 27-18
Returns.................................................................................................. 27-19
Client ............................................................................................................ 27-19
Server............................................................................................................ 27-19
Endpoint - ShowStatus (On-Premise ONLY) ................................................ 27-19
URI................................................................................................................ 27-19
HTTP Protocol ............................................................................................ 27-19
GET........................................................................................................ 27-19
Path Parameters................................................................................... 27-20
Returns.................................................................................................. 27-20
Client ............................................................................................................ 27-20
Server............................................................................................................ 27-20
Endpoint - EnrollStore (Cloud ONLY)........................................................... 27-20
URI................................................................................................................ 27-20
HTTP Protocol ............................................................................................ 27-20
GET........................................................................................................ 27-20
Parameters............................................................................................ 27-20
Returns.................................................................................................. 27-21
Client ............................................................................................................ 27-21
Server............................................................................................................ 27-21
Endpoint - EnrollClient (Cloud ONLY) ......................................................... 27-21
URI................................................................................................................ 27-21
HTTP Protocol ............................................................................................ 27-21
GET........................................................................................................ 27-21
Parameters............................................................................................ 27-21
Returns.................................................................................................. 27-21

Client ............................................................................................................ 27-21
Server............................................................................................................ 27-22
Endpoint – tempstore....................................................................................... 27-22
URI................................................................................................................ 27-22
HTTP Protocol ............................................................................................ 27-22
POST...................................................................................................... 27-22
Body ...................................................................................................... 27-22
Returns.................................................................................................. 27-22
PUT........................................................................................................ 27-22
Body ...................................................................................................... 27-22
Returns.................................................................................................. 27-22
Type of Web Service ........................................................................... 27-22
Client ..................................................................................................... 27-22
Server .................................................................................................... 27-23
Endpoint - cancelleddeployments................................................................... 27-23
URI................................................................................................................ 27-23
HTTP Protocol ............................................................................................ 27-23
GET........................................................................................................ 27-23
Returns.................................................................................................. 27-23
Type of Web Service ........................................................................... 27-23
Client ..................................................................................................... 27-23
Server .................................................................................................... 27-23
Endpoint - broadcasterstatus ........................................................................... 27-23
URI................................................................................................................ 27-23
HTTP Protocol ............................................................................................ 27-23
GET........................................................................................................ 27-23
Parameters............................................................................................ 27-24
Returns.................................................................................................. 27-24
Client ............................................................................................................ 27-24
Server............................................................................................................ 27-24
Endpoint - healthcheck (Cloud Only)............................................................. 27-24
URI................................................................................................................ 27-24
HTTP Protocol ............................................................................................ 27-24
GET........................................................................................................ 27-24
Parameters ................................................................................................... 27-25
Returns ......................................................................................................... 27-25
Client ............................................................................................................ 27-25
Server............................................................................................................ 27-25
Endpoint - Pay by Link Notification Resource (On-Premise ONLY) ........ 27-25
URI................................................................................................................ 27-25
HTTP Protocol ............................................................................................ 27-25
POST...................................................................................................... 27-25

Parameters............................................................................................ 27-26
Returns.................................................................................................. 27-26
Client ............................................................................................................ 27-26
Server............................................................................................................ 27-26
Data Privacy Endpoints .......................................................................................... 27-26
Endpoint - privatedata...................................................................................... 27-26
URI................................................................................................................ 27-26
Customer/ Employee Lookup Service..................................................... 27-26
Customer/Employee Validate Service..................................................... 27-27
Customer/Employee Anonymization Service........................................ 27-27
Xadmin Endpoints ................................................................................................... 27-27
Endpoint - Receipt Viewer ............................................................................... 27-27
URI................................................................................................................ 27-27
HTTP Protocol ............................................................................................ 27-27
GET........................................................................................................ 27-27
Parameters............................................................................................ 27-28
Returns.................................................................................................. 27-28
Client ............................................................................................................ 27-28
Server............................................................................................................ 27-28
Endpoint - healthcheck (Cloud Only)............................................................. 27-28
URI................................................................................................................ 27-28
HTTP Protocol ............................................................................................ 27-28
GET........................................................................................................ 27-28
Parameters............................................................................................ 27-28
Returns.................................................................................................. 27-28
Client ............................................................................................................ 27-29
Server............................................................................................................ 27-29
A Appendix: DTX Names and Database Tables .............................. A-1
B Revision History ............................................................................. B-1

Version 21.0 Revision 01.............................................................................................B-1
Version 20.0.1 Revision 01..........................................................................................B-2

Version 17.0...................................................................................................................B-5
Version 16.0.0.1.............................................................................................................B-5
Version 16.0...................................................................................................................B-6
Version 15.0...................................................................................................................B-6
Version 7.0.....................................................................................................................B-6
Version 6.5.....................................................................................................................B-7
Version 6.0.....................................................................................................................B-7
Version 5.5...................................................................................................................B-16

Send Us Your Comments
Oracle Retail Xstore Suite Services Guide, Release 21.0

Oracle welcomes customers' comments and suggestions on the quality and usefulness of
this document.
Your feedback is important, and helps us to best meet your needs as a user of our
products. For example:
• Are the implementation steps correct and complete?
• Did you understand the context of the procedures?
• Did you find any errors in the information?
• Does the structure of the information help you with your tasks?
• Do you need different information or graphics? If so, where, and in what format?
• Are the examples correct? Do you need more examples?
If you find any errors or have any other suggestions for improvement, then please tell us
your name, the name of the company who has licensed our products, the title and part
number of the documentation and the chapter, section, and page number (if available).
Note: Before sending us your comments, you might like to check that
you have the latest version of the document and if any concerns are
already addressed. To do this, access the Online Documentation
available on the Oracle Help Center (docs.oracle.com) site. It contains
the most current Documentation Library plus all documents revised or
released recently.
Send your comments to us using the electronic mail address: retail-doc_us@oracle.com

Please give your name, address, electronic mail address, and telephone number
(optional).
If you need assistance with Oracle software, then please contact your support
representative or Oracle Support Services.
If you require training or instruction in using Oracle software, then please contact your
Oracle local office and inquire about our Oracle University offerings. A list of Oracle
offices is available on our Web site at www.oracle.com
28
Preface
This Services Guide describes the requirements and procedures to communicate with
the applications of this Oracle Retail Xstore Suite release through web service interfaces.
Audience
This Services Guide is for the following audience:
• System analysts and programmers
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility
Program website at http://www.oracle.com/pls/topic/
lookup?ctx=acc&id=docacc.
Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For
information, visit http://www.oracle.com/pls/topic/
lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/
lookup?ctx=acc&id=trs if you are hearing impaired.
Related Documents
For more information, see the following documents in the Xstore Suite 21.0
documentation set:
• Xstore Suite Release Notes
• Xstore Suite Implementation and Security Guide
Customer Support
To contact Oracle Customer Support, access My Oracle Support at the following URL:
https://support.oracle.com
When contacting Customer Support, please provide the following:
• Product version and program/module name
• Functional and technical description of the problem (include business impact)
• Detailed step-by-step instructions to re-create
• Exact error message received
• Screen shots of each step you take
Review Patch Documentation

When you install the application for the first time, you install either a base release (for
example, 21.0) or a later patch release (for example, 21.0.1). If you are installing the base
29
Oracle Retail Documentation on the Oracle Help Center (docs.oracle.com)
release or additional patch releases, read the documentation for all releases that have
occurred since the base release before you begin installation. Documentation for patch
releases can contain critical information related to the base release, as well as
information about code changes since the base release.
Oracle Retail Documentation on the Oracle Help Center

(docs.oracle.com)
Oracle Retail product documentation is also available on the following Web site:
https://docs.oracle.com/en/industries/retail/index.html
(Data Model documents can be obtained through My Oracle Support.)
Conventions
Navigate: This is a navigate statement. It tells you how to get to the start of the procedure
and ends with a screen shot of the starting point and the statement “the Window Name
window opens.”
This is a code sample
It is used to display examples of code
30
Conventions
31
1
Introduction
This manual describes the methods and classes used by Xstore Point of Service 18.0
Services. The Xstore Point of Service Services interface is accessed through separate
services, each with its own application programming interface (API). Each API is
described using Web Service Description Language (WSDL) and in a corresponding
XML Schema Definition (XSD).
Note: Communication with Xstore Point of Service Services is

performed through SOAP XML messaging. However, because this
interface is invisible to the APIs, the messaging information is not
described in this document.
About This Chapter

This chapter contains the following information:
• “Examples” provides examples of how methods and classes are documented in this
manual.
• “Common Data Types” documents data types that are commonly used by many of
the services.
• “About this Manual” lists all the services chapters in this manual.
Introduction 1-1
Examples
Examples
The following information shows the format used to describe the methods and data
types for each API.
methodExample
classExample methodExample (
int variable1,
decimal variable2,
decimal variable3,
string variable4)
Methods can include any number of variables, or even no variables at all. The
methodExample above contains the following variables:
• variable1 of type int
• variable2 of type decimal
• variable3 of type decimal
• variable4 of type string
The variables can be of simple data types, or complex data types.
- See “Simple Data Types” for a list of the simple data types available in Xstore
Point of Service Services.
- A blue Type name indicates that it is a complex type and that there is a link to
the type description.
Methods often provide information through a return value. The methodExample
method returns a classExample object. The blue Type name indicates that it is a complex
type and that there is a link to the type description.
classExample
Some classes extend other classes. This information will be shown just below the class’s
name.
This class contains the following elements:
Table 1-1: classExample Elements
Type Element Description
decimal simpleElement An element with a simple data type. See

“Simple Data Types” for a list of the
simple data types available in Xstore
Point of Service Services.
string[] simpleElementArray An array of values using a simple data

type. This array can include any number
of values.
subClass definedType A complex type described in the XSD for

the API. The blue Type name indicates
that it is a complex type and that there is a
link to the type description.

Examples
Table 1-1: classExample Elements (continued)
subClass[] definedTypeArray An array of complex types. This array can

include any number of values.
subClass
Table 1-2: subClass Elements
????? elements Each subclass can include any number of

additional data types. This can include
more subclasses.
Simple Data Types

The simple data types available in Xstore Point of Service Services include the following:
• boolean - A boolean (true of false) value.
• dateTime - A date and time.
• decimal - A 64-bit, floating-point number.
• int - A 32-bit integer.
• long - A 64-bit integer.
• string - A string of characters.
Introduction 1-3
Common Data Types
Common Data Types

The following data types are used by every service in Xstore Point of Service.
codeValueObject
Table 1-3: codeValueObject Elements
string category Code category.
string code Code value.
string description Description of the code.
int sortOrder Number used to sort the code.
serviceContext
All service calls take this class as their first argument. This class defines the location that
is originating the message.
Table 1-4: serviceContext Elements
string employeeId ID for the employee.
string localeId ID for the store locale.
long organizationId ID for the organization.
long retailLocationId ID for the retail location.
long workstationId ID for the workstation.
serviceResponse
Every response returned from a method is an extension of this class. This is true for all
services and methods described in this manual.
Table 1-5: serviceResponse Elements
string failureCode ID code for the failure, if any.
string failureMessage Message text of the failure, if any.
string promptMessage Message displayed in the

acknowledgement prompt for the failure,
if any.

About this Manual
statusServiceResponse
This class extends the serviceResponse class.
Table 1-6: statusServiceResponse Elements
string status Status.
About this Manual

This manual contains the following chapters, each of which describes an API in Xstore
Point of Service Services:
• Chapter 2, “Address” • Chapter 16, “Ping”
• Chapter 3, “Clienteling” • Chapter 17, “Printing”
• Chapter 4, “Configuration” • Chapter 18, “Reason Code”
• Chapter 5, “Customer” • Chapter 19, “Receiving”
• Chapter 6, “Discount” • Chapter 20, “Register”
• Chapter 7, “Employee” • Chapter 21, “Retail Location”
• Chapter 8, “House Account” • Chapter 22, “Shipping”
• Chapter 9, “Input” • Chapter 23, “Tax”
• Chapter 10, “Inventory” • Chapter 22, “Tender”
• Chapter 12, “Inventory Count” • Chapter 24, “Timeclock”
• Chapter 13, “Item” • Chapter 24, “Timeclock PD”
• Chapter 14, “Logging” • Chapter 25, “Transaction”
Introduction 1-5
About this Manual

2
Address
Overview
This chapter provides the information necessary to send messages contained in the
Address Services API. Information can be obtained using the Web Service Description
Language (WSDL) in conjunction with a Simple Object Access Protocol (SOAP), XML
Schema, and various methods contained in the classes of the API to provide the web
service described above.
The URL for the Address Services WSDL is:
https://<hostname>:8443/ws/AddressServices?wsdl
where <hostname> is the name or address of the server.
The information presented below describes the methods and classes.
The format of the method and any arguments is shown along with an explanation of
what the method does and any other information that is necessary to use the method
properly. If an argument is shown in dark blue, it is a class and the class name is a link to
a description of the class and its attributes.
The class section shows the elements and attributes of the classes, along with an
explanation of each element and attribute and, when necessary, when they are used.
Address 2-1
Methods
Methods
This section presents the methods used in the Address Services API.
decodePostalCode
postalCodeListResponse decodePostalCode (
serviceContext ServiceContext,
string PostalCode,
string Country,
string Mode)
The decodePostalCode method returns city and state/province information for a

postal code/ZIP code.
This method returns a postalCodeListResponse object.
Table 2-1: decodePostalCode Variables
Type Variable Required? Description
serviceContext ServiceContext [OPTIONAL] Information about the location and

organization from which the message
originates.
string PostalCode [OPTIONAL] Postal/ZIP code being searched for.
string Country [OPTIONAL] Country for the Postal/ZIP code.
string Mode [OPTIONAL] System location of lookup (for example,

CUSTOMER, TENDER, REPORTING, or
SHIPSALE).
Use DEFAULT if you are unsure of the
proper value.
getAvailableCountries
countryListResponse getAvailableCountries (
serviceContext ServiceContext)
The getAvailableCountries method returns a list of countries that can be used in

addresses.
This method returns a postalCodeResponse object.
Table 2-2: getAvailableCountries Variables

originates.

Methods
translatePostalCode
postalCodeResponse translatePostalCode (
string PostalCode,
string Country,
string Mode)
The translatePostalCode method returns city and state/province information for a

postal code/ZIP code.
Table 2-3: translatePostalCode Variables

originates.
string PostalCode [OPTIONAL] Postal/ZIP code being searched for.
string Country [OPTIONAL] Country for the Postal/ZIP code.
string Mode [OPTIONAL] System location of lookup (e.g.

CUSTOMER, TENDER, REPORTING, or
SHIPSALE).
Use DEFAULT if you are unsure of the
proper value.
validateAddress
addressValidationResponse validateAddress (
string Address1,
string Address2,
string Apartment,
string City,
string State,
string PostalCode,
string Country)
The validateAddress method checks whether an address is valid and, if an address is

invalid, attempts to find one or more addresses that could be the correct address. If one
or more addresses are found, a list of those “corrected” addresses are returned.
Table 2-4: validateAddress Variables

originates.
Address 2-3
Classes
Table 2-4: validateAddress Variables (continued)
string Address1 [OPTIONAL] Address line 1.
string Address2 [OPTIONAL] Address line 2.
string Apartment [OPTIONAL] Apartment.
string City [OPTIONAL] City.
string State [OPTIONAL] State/Province code.
string PostalCode [OPTIONAL] Postal/ZIP code.
string Country [OPTIONAL] Country code.
Classes
address
Table 2-5: address Elements
string address1 Address line 1.
string apartment Apartment.
string city City.
string country Country code.
string postalCode Postal/ZIP Code.
string shipTo Name of the customer.
string state State/Province code.
addressValidationResponse
Table 2-6: addressValidationResponse Elements
address[] addressList List of addresses.

If the status is valid or invalid, contains the original
address.
If the status is corrected, contains a list of possible,
corrected addresses.

Classes
Table 2-6: addressValidationResponse Elements (continued)
string status Status of the address. This field can have the following,
possible values:
valid - Address is valid.
corrected - Address is invalid, but can be corrected.
invalid - Address is invalid and cannot be corrected.
country
Table 2-7: country Elements
string countryCode Country code for the country.
string countryDesc Name of the country.
countryListResponse
Table 2-8: countryListResponse Elements
country[] countries Array of countries.
postalCodeResponse
Table 2-9: postalCodeResponse Elements
string city The city of the postal code.
string country The country of the postal code.
string postalCode The postal code.
string state The state/province of the postal code.
serviceContext
For a description of this class, see “serviceContext”.
serviceResponse
For a description of this class, see “serviceResponse”.
Address 2-5
Classes
postalCodeListResponse

3
Clienteling
Overview
Clienteling Services API. Information can be obtained using the Web Service Description
The URL for the Clienteling Services WSDL is:
https://<hostname>:8443/<companycode>/ClientelingServices?wsdl
where <hostname> is the name or address of the server, and <companycode> is the
code assigned to the company at installation.
Clienteling 3-1
Methods
Methods
This section presents the methods used in the Clienteling Services API.
addCustomerNote
serviceResponse addCustomerNote (
string PartyId,
customerNote CustomerNote)
The addCustomerNote method adds a note to a customer record.

This method returns a serviceResponse object.
Table 3-1: addCustomerNote Variables

originates.
string PartyId [OPTIONAL] ID of the customer.
customerNote CustomerNote [OPTIONAL] A customer note.
getAppointmentStatuses
appointmentStatusResponse getAppointmentStatuses (
The getAppointmentStatuses method retrieves the appointment statuses in the

system.
This method returns a appointmentStatusResponse object.
Table 3-2: getAppointmentStatuses Variables

originates.

Methods
getAssociateAppointments
associateAppointmentsResponse getAssociateAppointments (
string EmployeeId,
dateTime SearchDate)
The getAssociateAppointments method retrieves the tasks assigned to a specified

associated that are active on a specified date.
This method returns a associateAppointmentsResponse object.
Table 3-3: getAssociateAppointments Variables

originates.
string EmployeeId [OPTIONAL] ID of the associate.
dateTime SearchDate [OPTIONAL] Date on which to search for active

tasks.
getAssociateTasks
associateTasksResponse getAssociateTasks (
string EmployeeId,
dateTime StartWeekDate,
boolean Appointment)
The getAssociateTasks method retrieves the tasks assigned to an associate, and

which are active during a specified week.
This method returns a associateTasksResponse object.
Table 3-4: getAssociateTasks Variables

originates.
string EmployeeId [OPTIONAL] ID of the employee.
dateTime StartWeekDate [OPTIONAL] Date of the week during the tasks are
active.
boolean Appointment [REQUIRED] Indicates whether to search for

appointments.
Clienteling 3-3
Methods
getAssociatesAssignments
associateAssignmentResponse getAssociatesAssignments (
string PartyId)
The getAssociatesAssignments method retrieves the associates assigned to a

customer.
This method returns a associateAssignmentResponse object.
Table 3-5: getAssociatesAssignments Variables

originates.
getClientelingConfig
clientelingConfig getClientelingConfig (
The getClientelingConfig method retrieves the clienteling configurations for the

system.
This method returns a clientelingConfig object.
Table 3-6: getClientelingConfig Variables

originates.
getCustomerAppointments
customerAppointmentResponse getCustomerAppointments (
string PartyId)
The getCustomerAppointments method retrieves the appointments associated with

a customer.
This method returns a customerAppointmentResponse object.
Table 3-7: getCustomerAppointments Variables

originates.

Methods
Table 3-7: getCustomerAppointments Variables (continued)
string PartyId [OPTIONAL] ID of the customer
getCustomerNotes
customerNotesResponse getCustomerNotes (
string PartyId)
The getCustomerNotes method retrieve the notes associated with a specified

customer.
This method returns a customerNotesResponse object.
Table 3-8: getCustomerNotes Variables

originates.
getCustomerPrefrences
codesLookupResponse getCustomerPrefrences (
The getCustomerPrefrences method retrieves all the customer preferences in the

system.
This method returns a codesLookupResponse object.
Table 3-9: getCustomerPrefrences Variables

originates.
Clienteling 3-5
Methods
getCustomerRSVPForEvent
customerRSVPResponse getCustomerRSVPForEvent (
int EventId)
The getCustomerRSVPForEvent method retrieves the customer RSVPs for an event.

This method returns a customerRSVPResponse object.
Table 3-10: getCustomerRSVPForEvent Variables

originates.
int EventId [OPTIONAL] ID of the event.
getCustomerRSVPs
customerRSVPResponse getCustomerRSVPs (
string PartyId)
The getCustomerRSVPs method retrieves all the RSVPs received from a customer.
This method returns a customerRSVPResponse object.
Table 3-11: getCustomerRSVPs Variables

originates.
getStoreEvents
storeEventLookupResponse getStoreEvents (
The getStoreEvents method retrieves all store events.

This method returns a storeEventLookupResponse object.
Table 3-12: getStoreEvents Variables

originates.

Methods
getSuggestSellingItems
itemSearchResponse getSuggestSellingItems (
string ItemId,
long TransSeq)
The getSuggestSellingItems method searches for a list of items to suggest to a

customer that is purchasing a specified item.
This method returns a itemSearchResponse object.
Table 3-13: getSuggestSellingItems Variables

originates.
string ItemId [OPTIONAL] ID of item.
long TransSeq [OPTIONAL] Sequence number the transaction.
markContactCustomer
serviceResponse markContactCustomer (
string PartyId)
The markContactCustomer method indicates that a customer has been contacted.

Table 3-14: markContactCustomer Variables

originates.
Clienteling 3-7
Methods
saveAssociateTask
associateTaskResponse saveAssociateTask (
associateTask AssociateTask)
The saveAssociateTask method creates/updates an associate task.

This method returns a associateTaskResponse object.
Table 3-15: saveAssociateTask Variables

originates.
associateTask associateTask [OPTIONAL] A task for an associate.
saveAssociateTest
associateTaskResponse saveAssociateTest (
associateTask ATask,
string EmployeeId)
The saveAssociateTest method adds or updates the associate assigned to a task.

This method returns a associateTaskResponse object.
Table 3-16: saveAssociateTest Variables

originates.
associateTask ATask [OPTIONAL] Task assigned to the associate.
strring EmployeeId [OPTIONAL] ID of the associate to whom the task

will be assigned.

Methods
saveAssociatesAssignment
serviceResponse saveAssociatesAssignment (
string PartyId,
associateAssignment AssociateAssignment)
The saveAssociatesAssignment method assigns an associate to a customer.

Table 3-17: saveAssociatesAssignment Variables
serviceContext ServiceContext [OPTIONAL] Information about the location

and organization from which the
message originates.
associateAssig AssociateAssignment [OPTIONAL] Associate assignment to the

nment
saveCustomerAppointment
serviceResponse saveCustomerAppointment (
associateTask AssociateTask)
The saveCustomerAppointment method saves a customer appointment.

Table 3-18: saveCustomerAppointment Variables

originates.
associateTask AssociateTask [OPTIONAL] Task associated with a customer.
Clienteling 3-9
Methods
saveCustomerRSVP
serviceResponse saveCustomerRSVP (
storeEventRSVP StoreEventRSVP)
The saveCustomerRSVP method saves a customer RSVP to a store event.

Table 3-19: saveCustomerRSVP Variables

originates.
storeEventRS StoreEventRSVP [OPTIONAL] Customer RSVP for a store event.

VP
searchCustomersByAssociate
clientelCustomerSearchResponse searchCustomersByAssociate (
string EmployeeId,
string SegmentId,
int StartRecordNumber,
int NumberOfRecords)
The searchCustomersByAssociate method retrieves the customers assigned to an

associate.
This method returns a clientelCustomerSearchResponse object.
Table 3-20: searchCustomersByAssociate Variables
serviceConte ServiceContext [OPTIONAL] Information about the location

xt and organization from which the
message originates.
string SegmentId [OPTIONAL] ID of the segment.
int StartRecordNumber [REQUIRED] Sequential number of the first

customer record to retrieve.
int NumberOfRecords [REQUIRED] Number of customer records to

retrieve.

Classes
Classes
appointmentStatusResponse
Table 3-21: appointmentStatusResponse Elements
codeValueObject[] statuses Array of appointment statuses.
associateAppointmentsResponse
Table 3-22: associateAppointmentsResponse Elements
associateTask[] associateTasks An array of tasks.
dateTime currentDate Date for the tasks.
associateAssignment
Table 3-23: associateAssignment Elements
commissionedAssociate assignedAssociate Associate assigned through the role.
associateRole associateRole Associate role.
commissionedAssociate[ availableAssociates Associates that can be assigned through

] the role.
boolean lockedFlag Indicates whether the associate

assignment is locked.
associateAssignmentResponse
Table 3-24: associateAssignmentResponse Elements
associateAssignment associateAssignments Array of the associates assigned to the

[] customer.
string partyId ID of the customer.
Clienteling 3-11
Classes
associateRole
Table 3-25: associateRole Elements
boolean activeFlag Indicates whether the role is currently active.
boolean primaryFlag Indicates whether the role is the primary role.
string roleId ID of the role.
string roleName Name of the role.
associateTask
Table 3-26: associateTask Elements
string assignTo ID of the associate to whom the task is assigned.
string createdBy ID of the associate who created the task.
string customer ID of the customer associated with the task.
dateTime endDateTime Date and time the event ends.
dateTime startDateTime Date and time the event starts.
long storeNumber ID number for the location of the event.
long taskId ID of the task.
string taskNote Note about the task.
string taskPriority Priority of the task.
string taskStatus Status of the task.
string taskSubject Subject of the task.
string taskType Type of task.
boolean voidFlag Indicates whether the task has been voided.
associateTaskResponse
Table 3-27: associateTaskResponse Elements
associateTask associateTask An associate task.

Classes
associateTasksResponse
Table 3-28: associateTasksResponse Elements
string employeeId ID of the associate assigned to the tasks.
weeklyAssociateTas weeklyAssociateTasks Array of associate tasks for each week.

k[]
clientelCustomerSearchResponse
This class extends the customerSearchResponse class.
Table 3-29: clientelCustomerSearchResponse Elements
boolean moreRecords Indicates whether more customer records after the

current set.
int startRecordNumber Sequential starting number of the list of customers.
int totalNumberOfRecords Number of customer records returned.
clientelingConfig
This class extends the startupConfiguration class.
Table 3-30: clientelingConfig Elements
associateRole[] availableAssociateRoles Array of the associate roles available.
codeValueObject availableCustomerSegments Array of the customer segments available.

[]
codeValueObject availableNoteTypes Array of the note types available.

[]
codeValueObject availableRSVPStatus Array of the RSVP statuses available.

[]
codeValueObject availableTaskPriorities Array of the task priorities available.

[]
codeValueObject availableTaskStatus Array of the task statuses available.

[]
boolean displayManagerOptions Indicates whether the system displays

manager options.
Clienteling 3-13
Classes
Table 3-30: clientelingConfig Elements (continued)
int numberOfCustomerRetrieve Maximum number of customers to be

retrieved by a search.
codeValueObject
For a description of this class, see “codeValueObject”.
codesLookupResponse
Table 3-31: codesLookupResponse Elements
codeValueObject[] categoryCodes Array of codes.
commissionedAssociate
Table 3-32: commissionedAssociate Elements
boolean clockInFlag Indicates whether the associate must clock in.
string employeeId ID of the associate.
string firstName Associate first name.
string lastName Associate last name.
customer
For a description of this class, see “customer”.
customerAppointmentResponse
Table 3-33: customerAppointmentResponse Elements
associateTask[] customerAppointments Array of appointments associated with a

customer.

Classes
customerNote
Table 3-34: customerNote Elements
string enteredBy ID of the associate who entered the note.
dateTime enteredDate Date the note was entered.
string noteLocation ID of the location where the note was entered.
long noteSeq Sequence number of the note.
string noteText Text of the note.
string noteType Type of note.
string partyId ID of the customer to whom the note is assigned.
customerNotesResponse
Table 3-35: customerNotesResponse Elements
customerNote[] customerNotes An array of customer notes.
customerRSVPResponse
Table 3-36: customerRSVPResponse Elements
storeEventRSVP[] customerRSVPs Array of customer RSVPs.
customerSearchResponse
For a description of this class, see “customerSearchResponse”.
dailyAssociateTask
Clienteling 3-15
Classes

Table 3-37: dailyAssociateTask Elements
associateTask[] associateTasks Array of associate tasks assigned for a day.
dateTime currentDate Day for which the tasks are assigned.
item
For a description of this class, see “item”.
itemSearchResponse
Table 3-38: itemSearchResponse Elements
item[] items An array of items.
storeEvent
This class extends the associateTask class.
Table 3-39: storeEvent Elements
long acceptedRSVPCount Number of customers who RSVPed that they will attend an
event.
long declinedRSVPCount Number of customers who RSVPed that they will not attend
an event.
long leftMessageRSVPCount Number of customers who were sent invitation messages.
long tentativeRSVPCount Number of customers who RSVPed that they may or may
not attend an event.
storeEventLookupResponse
Table 3-40: storeEventLookupResponse Elements
storeEvent[] storeEvents Array of store events.
storeEventRSVP
This class extends the customer class.

Classes

Table 3-41: storeEventRSVP Elements
string RSVPStatus RSVP status for the customer.
storeEvent storeEvent The store event for which the customer RSVPed.
weeklyAssociateTask
Table 3-42: weeklyAssociateTask Elements
dailyAssociateTask[] dailyAssociateTasks Array of tasks assigned for each day in

the week.
string weekName Name of the week.
serviceContext
serviceResponse
startupConfiguration
For a description of the class, see “startupConfiguration”.
For a description of this class, see “statusServiceResponse”.
Clienteling 3-17
Classes

4
Configuration
Overview
Configuration Services API. Information can be obtained using the Web Service
Description Language (WSDL) in conjunction with a Simple Object Access Protocol
(SOAP), XML Schema, and various methods contained in the classes of the API to
provide the web service described above.
The URL for the Configuration Services WSDL is:
https://<hostname>:8443/ws/ConfigurationServices?wsdl
Configuration 4-1
Methods
Methods
This section presents the methods used in the Configuration Services API.
checkFirmwareUpdate
checkForFirmwareUpdateResponse checkFirmwareUpdate (
string FirmwareVersion,
string SdkVersion,
string SerialNumber,
string HardwareNamePrefix)
The checkFirmwareUpdate checks for updates to the firmware.

This method returns a checkForFirmwareUpdateResponse object.
Table 4-1: checkFirmwareUpdate Variables

originates.
string FirmwareVersion [OPTIONAL] Current version of the firmware.
string SdkVersion [OPTIONAL] Current version of the SDK.
string SerialNumber [OPTIONAL] Serial number of the hardware.
string HardwareName [OPTIONAL] Prefix of the hardware name.

Prefix
checkForEncryptionKeyUpdate
checkForFirmwareUpdateResponse checkForEncryptionKeyUpdate (
string HardwareId,
string CurrentKeyId,
string Data)
The checkForEncryptionKeyUpdate checks for updates to the firmware.

This method returns a checkForFirmwareUpdateResponse object.
Table 4-2: checkForEncryptionKeyUpdate Variables

originates.
string HardwareId [OPTIONAL] ID for the hardware.
string CurrentKeyId [OPTIONAL] ID of the current encryption key.

Classes
Table 4-2: checkForEncryptionKeyUpdate Variables (continued)
string Date [OPTIONAL] Date the current encryption key was

issued.
getSystemStartupConfig
startupConfiguration getSystemStartupConfig (
The getSystemStartupConfig method retrieves initial configurations for the system.

This method returns a startupConfiguration object.
Table 4-3: getSystemStartupConfig Variables

originates.
Classes
encryptionKeyUpdateResponse
Table 4-4: encryptionKeyUpdateResponse Elements
string encryptionKey Encryption key.
string encryptionKeyCert Certificate for the encryption key.
string encryptionKeyCert Hash of the encryption key certificate.

Hash
string encryptionKeyId ID of the encryption key.
string encryptionKeyIdCert Certificate for the encryption key ID

certificate.
string encryptionKeyIdCert Hash of the certificate for the encryption

Hash key ID certificate.
string encryptionUpdate Encryption update bundle.

Bundle
string encryptionUpdate Hash of the encryption update bundle.

BundleHash
boolean keyNeedsUpdate Indicates whether the encryption key

needs to be updated.
Configuration 4-3
Classes
checkForFirmwareUpdateResponse
Table 4-5: checkForFirmwareUpdateResponse Elements
string base64Payload Base64 firmware payload.
string payloadChecksum Checksum for the payload.
boolean updateAvailable Indicates whether an update is available.
string versionNumber Version number of the firmware.
string versionPriority Priority for the firmware.
operationConfig
Table 4-6: operationConfig Elements
string operationName The name of the operation.
operationConfig[] operations Array of OpChains that will run after the

current operation.
serviceContext
serviceResponse
Table 4-7: startupConfiguration Elements
operationConfig[] opChainConfigs Array of OpChains that will run on the

system.
systemConfig[] systemConfigs Array of system configurations.

Classes
systemConfig
Table 4-8: systemConfig Elements
string systemConfigKey Name of the system configuration.
string systemConfigValue Value set for the named system

configuration.
Configuration 4-5
Classes

5
Customer
Overview
Customer Services API. Information can be obtained using the Web Service Description
The URL for the Customer Services WSDL is:
https://<hostname>:8443/ws/CustomerServices?wsdl
Customer 5-1
Methods
Methods
addNewCustomer
customerLookupResponse addNewCustomer (
customerParty CustomerParty)
The addNewCustomer method adds a new customer to the system and returns
information about the new customer record.
This method returns a customerLookupResponse object.
Table 5-1: addNewCustomer Variables
Type Element Required? Description

originates.
customerParty CustomerParty [OPTIONAL] Customer information to be entered

into the new customer record.
getCustomerByParty
customerLookupResponse getCustomerByParty (
string PartyId)
The getCustomerByParty method retrieves customer information by the customer’s

party ID.
Table 5-2: getCustomerByParty Variables

originates.
string PartyId [OPTIONAL] Party ID for the customer.
getCustomerHistory
customerHistoryResult getCustomerHistory (
string PartyId)
The getCustomerHistory method retrieves the transaction history for a customer.

Methods
This method returns a customerHistoryResult object.

Table 5-3: getCustomerHistory Variables

originates.
saveCustomerChanges
customerLookupResponse saveCustomerChanges (
customerParty CustomerParty)
The saveCustomerChanges saves the changes made to a customer and returns

information about the updated customer record.
Table 5-4: saveCustomerChanges Variables

originates.
customerParty CustomerParty [OPTIONAL] Customer information to be saved in

the customer record.
searchCustomers
customerSearchResponse searchCustomers (
string Name,
string Phone,
string[] CustomerNumberInput,
string CustomerInputType,
string PostalCode)
The searchCustomers method retrieves all customers that match a set of search
criteria.
This method returns a customerSearchResponse objects.
Table 5-5: searchCustomers Variables

message originates.
string Name [OPTIONAL] Customer name.
Customer 5-3
Classes
Table 5-5: searchCustomers Variables (continued)
string Phone [OPTIONAL] Customer phone number.
string[] CustomerNumberInput [OPTIONAL] Array of customer numbers

entered.
string CustomerInputType [OPTIONAL] Method used to enter the

customer search information.
string PostalCode [OPTIONAL] Customer postal/ZIP code.
Classes
awardCoupon
Table 5-6: awardCoupon Elements
boolean changed Indicates whether the coupon has been

changed.
decimal couponAmount Amount of the coupon.
string couponId ID of the coupon.
dateTime expirationDate Expiration date of the coupon.
commercialAccount
Table 5-7: commercialAccount Elements
string accountCode Type code for the account type.
string accountId ID for the account.
decimal creditLimit Credit limit on the account.
string status Current status of the account.
customer
Table 5-8: customer Elements
string address1 Customer address line 1.
string addressType Type of address.

Classes
Table 5-8: customer Elements (continued)
string city Customer city.
boolean commercialCustomer Indicates whether the customer is a

commercial customer.
string companyName Name of the customer’s company.
customerGroup[] customerGroups Customer groups to which the customer

belongs.
string customerId ID for the customer.
string emailAddress Email address for the customer.
string employeeId If the customer is an employee, the

employee’s ID.
string firstName Customer first name.
dateTime lastContactDate Date of the last attempt to contact the

customer.
string lastName Customer last name.
dateTime lastPurchaseDate Data of the customer’s last purchase.
string partyId ID for the customer’s party.
string phone Customer phone number.
string postal Customer postal code.
string state Customer state/province.
decimal totalPurchaseAmt Total amount of all purchases made by

the customer.
customerEmail
Table 5-9: customerEmail Elements
string address Email address.
boolean contact Indicates whether the customer can be

contacted with this email.
string format Preferred format for emails sent to this

address.
boolean primary Indicates whether this email is the

primary email.
int sequence Sequence number for the email.
Customer 5-5
Classes
Table 5-9: customerEmail Elements (continued)
string type Type of email address.
customerGroup
Table 5-10: customerGroup Elements
string description Description of the group.
string groupId ID of the group.
customerHistoryItem
Table 5-11: customerHistoryItem Elements
dateTime businessDate Date of the transaction.
string itemDescription Description of the item.
string itemId ID of the item.
string itemUrl URL associated with the item.
long lineItemSeq Sequence number of the item.
decimal price Price of the item.
decimal qty Item quantity.
long retailLocId ID of the retail location.
boolean return Indicates whether the item was returned

(true) or sold (false).
string saleItemType Type of sale item.
string serialNumber Serial number of the item.
long transSeq Sequence number of the transaction.
string vendorId ID of the item’s vendor.
string vendorName Name of the item’s vendor.
long wkstnId ID of the workstation where the

transaction was performed.

Classes
customerHistoryResult
Table 5-12: customerHistoryResult Elements
customerHistoryIte historyItems Array of items in the customer history.

m[]
decimal netItems Number of items in the customer history.
decimal netTotal Net value of the items in history.
decimal returnItems Number of return items in the history.
decimal returnTotal Total value of all return items.
decimal saleItems Number of sale items in the history.
decimal saleTotal Total value of all sale items.
customerLookupResponse
Table 5-13: customerLookupResponse Elements
customerParty customer Customer information.
boolean promptToJoinLoyalty Indicates whether to display a prompt

asking whether the customer wants to
join a loyalty program.
customerLoyaltyAccount
Table 5-14: customerLoyaltyAccount Elements
string accountId ID for the account.
decimal balance Current balance of the account.
string cardNumber Card number associated with the account.
dateTime expirationDate Expiration date of the account.
string type Type of account.
Customer 5-7
Classes
customerLoyaltyCard
Table 5-15: customerLoyaltyCard Elements
string cardNumber Card number associated with the account.
boolean changed Indicates whether the loyalty card has

been changed.
dateTime effectiveDate Effective date of the account.
dateTime expirationDate Expiration date of the account.
string partyId ID of the party.
decimal pointsToNextAward Number of points to be earned for the

next award.
string primaryAwardAcctId ID of the primary award account

associated with the card.
decimal primaryAwardBalance Balance of primary award account.
awardCoupon[] primaryAwardCoupons Coupons awarded by the primary award

account.
decimal primaryLoyaltyBalance Balance of primary loyalty account.
customerParty
This class extends the customer class.
Table 5-16: customerParty Elements
boolean active Indicates whether the customer is active.
string apartment Apartment number.
dateTime birthday Customer birthday.
string cellPhone Customer cell phone number.
boolean cellPhoneContact Indicates whether the customer allows

contact through their cell phone.
commercialAccount[ commercialAccounts Commercial accounts for the customer.

]
string contactPreference Preferred contact method for customer.

Classes
Table 5-16: customerParty Elements (continued)
string country Customer country.
boolean emailContact Indicates whether to contact the customer

by email.
boolean emailRcpt Indicates whether to email copies of

receipts to the customer.
customerEmail[] emails Email addresses associated with the

customer.
boolean faxContact Indicates whether to contact the customer

by fax.
string faxNumber Customer fax number.
string gender Customer gender.
boolean homePhoneContact Indicates whether to contact the customer

by their home phone.
customerLoyaltyAcc loyaltyAccounts Loyalty accounts for the customer.

ount[]
customerLoyaltyCar loyaltyCards Loyalty cards belonging to the customer.

d[]
boolean mailingList Indicates whether the customer is on the

mailing list.
string middleName Customer middle name.
string nationalTaxId National tax identification number for the

customer.
string orgType Type code for the organization.
partyProperty[] partyProperties Properties of the customer party.
string personalTaxId ID used for determining tax.
boolean privacyCard Indicates whether the customer has a

privacy card.
string salutation Salutation for the customer.
string signUpLocationId ID of the location where the customer was

signed up.
taxExemption[] taxExemptions Tax exemptions for the customer.
customerTelephone[] telephones Telephone numbers associated with the

customer.
string workPhone Customer work phone number.
boolean workPhoneContact Indicates whether to contact the customer

by work phone.
Customer 5-9
Classes
customerSearchResponse
Table 5-17: customerSearchResponse Elements
customer[] customers Array of customers matching the search

criteria.
customerTelephone
Table 5-18: customerTelephone Elements
boolean contact Indicates whether the customer can be

contacted with this telephone number.
string contactType Type of contacts that the customer

permits through this telephone number.
string number Telephone number.
boolean primary Indicates whether the number is the

primary telephone number.
string type Type of email address.
partyProperty
Table 5-19: partyProperty Elements
dateTime dateValue Date value of the property.
decimal decimalValue Decimal value of the property.
string propertyCode ID code of the property.
string propertyType Type of property (date, decimal, or

string).
string stringValue String value of the property.
serviceContext
serviceResponse

Classes
taxExemption
Table 5-20: taxExemption Elements
string certificateCountry Country that issued the certificate.
string certificateHolderName Name of the holder of the tax exemption

certificate.
string certificateNumber ID number of the certificate.
string certificateState State that issued the certificate.
dateTime expirationDate Expiration date of the exemption.
string objectState State that issued the tax exemption.
string partyId ID of the party to which the tax

exemption belongs.
string taxExemptionId ID of the tax exemption.
Customer 5-11
Classes

6
Discount
Overview
Discount Services API. Information can be obtained using the Web Service Description
The URL for the Discount Services WSDL is:
https://<hostname>:8443/ws/DiscountServices?wsdl
Discount 6-1
Methods
Methods
This section presents the methods used in the Discount Services API.
getCouponDiscount
couponLookupResponse getCouponDiscount (
string CouponId,
string CouponType,
string CouponEntryType,
string PartyId)
The getCouponDiscount method retrieves the discount for a coupon.

This method returns a couponLookupResponse object.
Table 6-1: getCouponDiscount Variables

message originates.
string CouponId [OPTIONAL] ID of the coupon.
string CouponType [OPTIONAL] Type of coupon.
string CouponEntryType [OPTIONAL] Method used to enter the

coupon.
string PartyId [OPTIONAL] Party ID of customer redeeming

the coupon.
getDiscountsByApplicationMethod
discountLookupResponse getDiscountsByApplicationMethod (
string ApplicationMethod,
string PartyId)
The getDiscountsByApplicationMethod method retrieves all discounts with a

defined application method.
This method returns a discountLookupResponse object.
Table 6-2: getDiscountsByApplicationMethod Variables

message originates.
string ApplicationMethod [OPTIONAL] Application method.
string PartyId [OPTIONAL] Party ID of customer.

Classes
Classes
coupon
Table 6-3: coupon Elements
string couponType Type of coupon.
string discountCode ID code for the discount associated with

the coupon.
couponLookupResponse
Table 6-4: couponLookupResponse Elements
coupon coupon The coupon.
discount discount The discount associated with the coupon.
discount
Table 6-5: discount Elements
string applicationMethod Method used when applying the

discount.
string calculationMethod The type of calculation performed to

determine the discount.
string description A description of the discount.
decimal discountAmt Amount of the discount (only used when

the discount is a fixed amount).
string discountCode ID code for the discount.
decimal discountPercent Percentage of the discount (only used

when the discount is a percentage).
string privilegeType Type of privilege required for an

employee to apply the discount.
string prompt Prompt message.
boolean serializedDiscount Indicates whether the discount is

serialized.
Discount 6-3
Classes
Table 6-5: discount Elements (continued)
int sortOrder Order in which the discount is applied.
discountLookupResponse
Table 6-6: discountLookupResponse Elements
discount[] discounts Array of discounts.
serviceContext
serviceResponse

7
Employee
Overview
Employee Services API. Information can be obtained using the Web Service Description
The URL for the Employee Services WSDL is:
https://<hostname>:8443/ws/EmployeeServices?wsdl
Employee 7-1
Methods
Methods
addMessage
employeeMsgResponse addMessage (
employeeMessage EmployeeMessage)
The addMessage method creates a new employee message.

This method returns an employeeMsgResponse object.
Table 7-1: addMessage Variables

message originates.
employeeMessa EmployeeMessage [OPTIONAL] Message information.

ge
authenticate
employeeAuthResponse authenticate (
string LoginInput,
string Password,
string LoginInputType)
The authenticate method returns information about an employee that has been
authenticated by the system.
This method returns an employeeAuthResponse object.
Table 7-2: authenticate Variables

originates.
string LoginInput [OPTIONAL] Login name entered.
string Password [OPTIONAL] Login password entered.
string LoginInputType [OPTIONAL] Method used to enter login

information.

Methods
authorize
userAuthorizeResponse authorize (
string LoginInput,
string Password,
string LoginInputType,
string Privilege)
The authorize method indicates whether an employee is authorized to use a certain

Privilege in a ServiceContext.
This method returns an userAuthorizeResponse object.
Table 7-3: authorize Variables

originates.
string LoginInput [OPTIONAL] Entered login name.
string Password [OPTIONAL] Entered password.

information.
string Privilege [OPTIONAL] Login privilege requested.
changePassword
employeeAuthResponse changePassword (
string[] LoginInput,
string CurrentPassword,
string NewPassword,
string ReEnterNewPassword)
The changePassword method changes the password for an employee.

This method returns an employeeAuthResponse object.
Table 7-4: changePassword Variables

originates.
string[] LoginInput [OPTIONAL] Array of usernames for the user.
string CurrentPasswor [OPTIONAL] Current password.

d
string NewPassword [OPTIONAL] New password.
Employee 7-3
Methods
Table 7-4: changePassword Variables (continued)
string ReEnterNew [OPTIONAL] Confirmation of new password.

Password
deleteMessage
employeeMsgResponse deleteMessage (
long MessageId)
The deleteMessage method deletes an existing employee message.

Table 7-5: deleteMessage Variables

originates.
long MessageId [REQUIRED] ID of the message.
getCommissionedAssociates
retrieveCommAsscResponse getCommissionedAssociates (
dateTime BusinessDate)
The getCommissionedAssociates method retrieves the associates who received a

commission in the ServiceContext on the BusinessDate.
This method returns an retrieveCommAsscResponse object.
Table 7-6: getCommissionedAssociates Variables

originates.
dateTime BusinessDate [OPTIONAL] Business date.
updateMessage
employeeMsgResponse updateMessage (
string MessageId,
employeeMessage EmployeeMessage)
The updateMessage method updates an existing employee message.

Classes

Table 7-7: updateMessage Variables

message originates.
string MessageId [REQUIRED] ID of the message.
employeeMessa EmployeeMessage [OPTIONAL] Message information.

ge
validateEmp
validateEmployeeResponse validateEmp (
string EmployeeId)
The validateEmp method returns information about an employee indicated by

EmployeeId and whether the employee has been validated.
This method returns an validateEmployeeResponse object.
Table 7-8: validateEmp Variables

originates.
Classes
boolean clockInFlag Indicates whether the employee was

clocked in.
string employeeId ID of the associate.
string firstName First name of the employee.
string lastName Last name of the employee.
Employee 7-5
Classes
employee
Table 7-10: employee Elements
boolean clockinRequired Indicates whether the employee must be

clocked in.
string currentWorkCode Work code currently used by the

employee.
string firstName Employee first name.
string lastName Employee last name.
string locale ID of the employee’s locale.
string partyId Party ID for the employee.
string privileges Privilege settings for the employee.
employeeAuthResponse
Table 7-11: employeeAuthResponse Elements
employee employee Employee information.
employeeMessage
Table 7-12: employeeMessage Elements
string content Message content.
dateTime endDate Final date of the message.
string messageURL URL of the message.
string priority Priority of the message.
dateTime startDate Start date of the message.
int workStationId ID of the workstation/register on which to

display the message.
boolean workStationSpecific Indicates whether the message is specific

to one workstation/register.

Classes
employeeMsgResponse
Table 7-13: employeeMsgResponse Elements
employeeMessage employeeMsg Message information.
string messageId ID of the message.
retrieveCommAsscResponse
Table 7-14: retrieveCommAsscResponse Elements
commissionedAssociate[ associates Array of associates/employees who

] received a commission.
serviceContext
serviceResponse
userAuthorizeResponse
Table 7-15: authorizeResponse Elements
boolean userAuthorized Indicates whether the user has been

authorized.
validateEmployeeResponse
Table 7-16: validateEmployeeResponse Elements
string employeeId ID of employee.
Employee 7-7
Classes
Table 7-16: validateEmployeeResponse Elements (continued)
boolean valid Indicates whether the employee

information has been validated.

8
House Account
Overview
Customer Account Services API. Information can be obtained using the Web Service
The URL for the House Account Services WSDL is:
https://<hostname>:8443/ws/HouseAccountServices?wsdl
House Account 8-1

Methods
Methods
This section presents the methods used in the Customer Account Services API.
createAccount
houseAccountRetrieveResponse createAccount(
string PartyId,
decimal CreditLimit)
The createAccount method creates a new house account.

This method returns a houseAccountRetrieveResponse object.
Table 8-1: createAccount Variables

originates.
decimal CreditLimit [OPTIONAL] Credit limit to assign to the account.
retrieveById
houseAccountRetrieveResponse retrieveById(
string AccountId)
The retrieveById method retrieves a house account by account ID.

Table 8-2: retrieveById Variables

originates.
string AccountId [OPTIONAL] ID of the account.
searchByAccountName
houseAccountSearchResponse searchByAccountName(
string AccountName)
The searchByAccountName searches for house accounts by the name of the account.

Methods
This method returns a houseAccountSearchResponse object.

Table 8-3: searchByAccountName Variables

originates.
string AccountName [OPTIONAL] Name of the account.
searchByCustomerNamePhone
houseAccountSearchResponse searchByCustomerNamePhone(
string FirstName,
string MiddleName,
string LastName,
string CustomerPhone)
The searchByCustomerNamePhone searches for house accounts by customer name

and telephone number.
This method returns a houseAccountSearchResponse object.
Table 8-4: searchByCustomerNamePhone Variables

originates.
string FirstName [OPTIONAL] Customer first name.
string MiddleName [OPTIONAL] Customer middle name.
string LastName [OPTIONAL] Customer last name.
string CustomerPhone [OPTIONAL] Telephone number for the customer.
updateAccount
houseAccountRetrieveResponse updateAccount(
consumerChargeAccount Account)
The updateAccount method updates a house account.
House Account 8-3

Classes

Table 8-5: updateAccount Variables

message originates.
consumerChargeAcco Account [OPTIONAL] Updates for the account.

unt
Classes
adaptedHouseAccountSearchResult
Table 8-6: adaptedHouseAccountSearchResult Elements
string accountId ID of the account.
decimal creditLimit Credit limit of the account.
string firstName First name of customer.
string lastName Last name of customer.
string partyId ID of party.
string status Account status.
chargeAccountUser
Table 8-7: chargeAccountUser Elements
dateTime effectiveDate Date on which the user became effective.
dateTime expirationDate Date on which the user is no longer

eligible for the account.
string firstName User first name.
string lastName User last name.
boolean primary Indicates whether the user is the primary

user for the account.
string userId ID of the user.

Classes
consumerChargeAccount
Table 8-8: consumerChargeAccount Elements
string accountId ID of account.
chargeAccountUser[] accountUsers Users associated with the charge account.
boolean corporateAccount Indicates whether the account is a

corporate account.
decimal creditLimit Account credit limit.
customerParty customerParty Principal customer party associated with

the account.
dateTime lastActivityDate Date of most recent activity performed on

the account.
decimal lastPaymentAmount Amount of last payment on account.
dateTime lastPaymentDate Date of most recent payment.
long locationId ID of location.
boolean onHold Indicates whether the account is currently

on hold.
boolean poReq Indicates whether the customer must

provide a purchase order to use this
account for
string status Status of the account.
customerParty
For a description of this class, see “customerParty”.
houseAccountRetrieveResponse
Table 8-9: houseAccountRetrieveResponse Elements
consumerChargeAcco houseAccount Charge account for the consumer.

unt
House Account 8-5

Classes
houseAccountSearchResponse
Table 8-10: houseAccountSearchResponse Elements
adaptedHouseAccountSearchResu accounts Accounts that match the search criteria.

lt[]
serviceContext
serviceResponse

9
Input
Overview
This chapter provides the information necessary to send messages contained in the Input
Services API. Information can be obtained using the Web Service Description Language
(WSDL) in conjunction with a Simple Object Access Protocol (SOAP), XML Schema, and
various methods contained in the classes of the API to provide the web service described
above.
The URL for the Input Services WSDL is:
https://<hostname>:8443/ws/InputServices?wsdl
Input 9-1
Methods
Methods
This section presents the methods used in the Input Services API.
translateInput
inputResponse translateInput (
string[] InputData,
string InputType,
string ContextMode,
string[] ExpectedInputTypes)
The translateInput method returns input that was entered into the system.
This method returns a inputResponse object.
Table 9-1: translateInput Variables

message originates.
string[] InputData [OPTIONAL] Array of input data.
string InputType [OPTIONAL] Type of input.
string ContextMode [OPTIONAL] Context mode of the input.
string[] ExpectedInputTypes [OPTIONAL] Expected types of input.
Classes
inputEvent
Table 9-2: inputEvent Elements
string inputData Data that was entered into the system.
string inputDataType Type of data contained in the

inputData.
string inputType Type of data entry performed.
inputResponse

Classes

Table 9-3: inputResponse Elements
inputEvent[] inputEvent Array of input events.
serviceContext
serviceResponse
Input 9-3
Classes

10
Inventory
Overview
Inventory Services API. Information can be obtained using the Web Service Description
The URL for the Inventory Services WSDL is:
https://<hostname>:8443/ws/InventoryServices?wsdl
Inventory 10-1
Methods
Methods
This section presents the methods used in the Inventory Services API.
getOnHandStockLedger
stockLedger getOnHandStockLedger (
string ItemId)
The getOnHandStockLedger method returns the on-hand stock ledger information

for an item at the local inventory location.
This method returns a stockLedger object.
Table 10-1: getOnHandStockLedger Variables

originates.
getStockLedger
stockLedger getStockLedger (
string ItemId,
string InventoryLocation,
string BucketId)
The getStockLedger method returns stock ledger information for an item at a

specified location, in to a specified bucket.
This method returns a stockLedger object.
Table 10-2: getStockLedger Variables

organization from which the
message originates.
string InventoryLocation [OPTIONAL] ID of inventory location.
string BucketId [OPTIONAL] ID of inventory bucket.

Classes
Classes
stockLedger
Table 10-3: stockLedger Elements
string bucketId ID for the bucket in which the item is

located.
string inventoryLocationId ID for the inventory location of the item.
string itemId ID for the item.
long retailLocationId ID for the retail location of the item.
decimal unitCount Unit count of the item.
serviceContext
serviceResponse
Inventory 10-3
Classes

11
Inventory Adjustment
Overview
Inventory Adjustment Services API. Information can be obtained using the Web Service
The URL for the Inventory Adjustment Services WSDL is:
https://<hostname>:8443/ws/InvAdjustServices?wsdl
Inventory Adjustment 11-1

Methods
Methods
This section presents the methods used in the Inventory Adjustment Services API.
addLine
invAdjustmentResponse addLine (
string InventoryItemId,
decimal AdjustmentQty,
string SourceLocation,
string SourceBucket,
string DestinationLocation,
string DestinationBucket,
string ReasonCode,
string ReasonCodeComment,
reasonCodePromptProperties[] ReasonCodePromptProperties)
The addLine method adds an item to an inventory adjustment.

This method returns a invAdjustmentResponse object.
Table 11-1: addLine Variables

message originates.
string InventoryItemId [OPTIONAL] ID of the inventory item.
decimal AdjustmentQty [OPTIONAL] Quantity of the item being

adjusted.
string SourceLocation [OPTIONAL] ID for the current item location.
string SourceBucket [OPTIONAL] ID for the current item inventory

bucket.
string Destination [OPTIONAL] ID for the new location of the

Location item.
string DestinationBucket [OPTIONAL] ID for the new item inventory

bucket.
string ReasonCode [OPTIONAL] ID for the reason code for the

move.
string ReasonCode [OPTIONAL] Additional comments about the

Comment reason for the move.
string SerialNumber [OPTIONAL] Serial number for the item.
reasonCodePro ReasonCode [OPTIONAL] Array of properties for the

mptProperties[] PromptProperties prompts associated with the
reason code.

Methods
cancelInvAdjustment
invAdjustmentResponse cancelInvAdjustment (
The cancelInvAdjustment method cancels an inventory adjustment.

Table 11-2: cancelInvAdjustment Variables

message originates.
changeLineLocBucket
invAdjustmentResponse changeLineLocBucket (
long DocumentLineNumber,
string SourceLocation,
string SourceBucket,
string DestinationLocation,
string DestinationBucket)
The changeLineLocBucket changes the location and inventory bucket for an item in
an inventory document.
Table 11-3: changeLineLocBucket Variables

message originates.
long DocumentLine [OPTIONAL] Line number in the document.

Number
string SourceLocation [OPTIONAL] ID for the current item location.
string SourceBucket [OPTIONAL] ID for the current item inventory

bucket.
string Destination [OPTIONAL] ID for the new location of the

Location item.
string DestinationBucket [OPTIONAL] ID for the new item inventory

bucket.

Methods
changeLineQty
invAdjustmentResponse changeLineQty (
decimal NewQty,
long DocumentLineNumber)
The changeLineQty method adds an item to an inventory adjustment.

Table 11-4: changeLineQty Variables

message originates.
decimal NewQty [OPTIONAL] New quantity of the item being

adjusted.

Number
changeLineReason
invAdjustmentResponse changeLineReason (
long DocumentLineNumber,
string ReasonCode,
string ReasonCodeComment,
The changeLineReason changes the reason for an inventory adjustment.

Table 11-5: changeLineReason Variables

message originates.

Number
string ReasonCode [OPTIONAL] ID for the reason code for the

move.
string ReasonCode [OPTIONAL] Additional comments about the

Comment reason for the move.
reasonCodePro ReasonCode [OPTIONAL] Array of properties for the

mptProperties[] PromptProperties prompts associated with the
reason code.

Methods
getInventoryAdjustmentConfig
invAdjustmentConfiguration getInventoryAdjustmentConfig (
The getInventoryAdjustmentConfig method retrieves configuration information

for inventory adjustments.
This method returns a invAdjustmentConfiguration object.
Table 11-6: getInventoryAdjustmentConfig Variables

message originates.
initializeInvAdjustment
inventoryDocumentResponse initializeInvAdjustment (
The initializeInvAdjustment creates an inventory adjustment.

This method returns a inventoryDocumentResponse object.
Table 11-7: initializeInvAdjustment Variables

message originates.
saveInvAdjustment
inventoryResponse saveInvAdjustment (
The saveInvAdjustment saves an inventory adjustment.

This method returns a inventoryResponse object.
Table 11-8: saveInvAdjustment Variables

message originates.

Methods
saveItmTransfer
inventoryResponse saveItmTransfer (
The saveItmTransfer saves an item transfer.

Table 11-9: saveItmTransfer Variables

message originates.
validateLine
validateDocumentLineItemResponse validateLine (
string InventoryItemId)
The validateLine returns information about an item.

This method returns a validateDocumentLineItemResponse object.
Table 11-10: validateLine Variables

message originates.
string InventoryItemId [OPTIONAL] ID of an item.
voidLine
invAdjustmentResponse voidLine (
The voidLine removes a line item from an inventory adjustment.

Table 11-11: voidLine Variables

message originates.
long DocumentLine [OPTIONAL] Line number in an inventory

Number adjustment document.

Classes
Classes
adjustmentLineItem
Table 11-12: adjustmentLineItem Elements
string comment Comment about the line item.
string destBucketId ID of the destination inventory bucket.
string destInvLocationid ID of the destination location.
string dimension1 First dimension for the item.
string dimension2 Second dimension for the item.
string dimension3 Third dimension for the item.
string dimension4 Fourth dimension for the item.
string dimension5 Fifth dimension for the item.
decimal itemCount Quantity for the line item.
string itemId ID of the itme.
int lineNumber Line number for the line item.
string parentItemId ID of the item’s parent.
reasonCode reasonCode Reason code for the adjustment.
reasonCodePromptP reasonCodePrompt Array of properties for the prompts

roperties[] Properties associated with the reason code.
string serialNumber Serial number for the item.
string sourceBucketId ID of the source inventory bucket.
string sourceInvLocationId ID of the source location.
inputEvent
Table 11-13: inputEvent Elements
string inputData Data that was entered into the system.
string inputDataType Type of data contained in the

inputData.

Classes
Table 11-13: inputEvent Elements (continued)
string inputType Type of data entry performed.
invAdjustmentConfiguration
Table 11-14: invAdjustmentConfiguration Elements
inventoryBucket[] inventoryBuckets Array of available inventory buckets.
inventoryLocation[] inventoryLocations Array of available inventory buckets.
reasonCode[] reasonCodes Array of available reason codes.
invAdjustmentResponse
Table 11-15: inputResponse Elements
item[] items Array of items.
inventoryBucket
For a description of this class, see “inventoryBucket”.
inventoryDocumentResponse
For a description of this class, see “inventoryDocumentResponse”.
inventoryLocation
Table 11-16: inventoryLocation Elements
string inventoryLocId ID of the inventory location.
string inventoryLocName Name of the inventory location.
boolean systemLocation Indicates whether the inventory location

is a system location.
inventoryResponse
For a description of this class, see “inventoryResponse”.

Classes
item
reasonCode
For a description of this class, see “reasonCode”.
reasonCodePromptProperties
For a description of this class, see “reasonCodePromptProperties”.
serviceContext
serviceResponse
For a description of this class, see “startupConfiguration”.
validateDocumentLineItemResponse
Table 11-17: validateDocumentLineItemResponse Elements
item inventoryItem Item in the line.
boolean promptModelNumber Indicates whether to prompt for a model

number for this item.
boolean promptQty Indicates whether to prompt for a

quantity of this item.
boolean promptReceiving Indicates whether to prompt for a

Location receiving location for the item.
boolean promptRetailPrice Indicates whether to prompt for a retail

price for the item.
boolean promptSerialNumber Indicates whether to prompt for a serial

number for the item.

Classes

12
Inventory Count
Overview
Inventory Count Services API. Information can be obtained using the Web Service
The URL for the Inventory Count Services WSDL is:
https://<hostname>:8443/<companycode>/
InventoryCountServices?wsdl
where <hostname> is the name or address of the server, and <companycode> is the
code assigned to the company at installation.
Inventory Count 12-1

Methods
Methods
This section presents the methods used in the Inventory Count Services API.
addInventoryCountLineItem
inventoryCountDocumentResponse addInventoryCountLineItem (
string DocumentId,
string BucketId,
string InventoryLocationId,
string BarcodeType)
The addInventoryCountLineItem method adds a line item to an inventory count.

This method returns a inventoryCountDocumentResponse object.
Table 12-1: addInventoryCountLineItem Variables

message originates.
string DocumentId [OPTIONAL] ID of the inventory count

document.
string BucketId [OPTIONAL] ID of the inventory bucket.
string SerialNumber [OPTIONAL] Item serial number.
string InventoryLocationId [OPTIONAL] ID of the inventory location.
string BarcodeType [OPTIONAL] Type of barcode.

Methods
cancelCurrentInventoryCountSession
statusServiceResponse cancelCurrentInventoryCountSession (
The cancelCurrentInventoryCountSession method cancels the inventory count

currently being performed.
This method returns a statusServiceResponse object.
Table 12-2: cancelCurrentInventoryCountSession Variables

originates.
cancelInventoryCountDocument
statusServiceResponse cancelInventoryCountDocument (
string DocumentId)
The cancelInventoryCountDocument method cancels an inventory count

document.
Table 12-3: cancelInventoryCountDocument Variables

originates.
string DocumentId [OPTIONAL] ID of the inventory document.
changeInventoryCountLineItemQty
inventoryCountDocumentResponse changeInventoryCountLineItemQty (
string DocumentId,
string BucketId,
string InventoryLocationId,
string QuantityChange)
The changeInventoryCountLineItemQty method changes quantity of the item

within an inventory count.

Methods

Table 12-4: changeInventoryCountLineItemQty Variables

message originates.
string SerialNumber [OPTIONAL] Serial number of the item.
string BucketId [OPTIONAL] ID of the item’s inventory

bucket.
string InventoryLocationId [OPTIONAL] ID of the item’s inventory

location.
decimal QuantityChange [OPTIONAL] Change in item quantity.
completeInventoryCount
inventoryResponse completeInventoryCount (
string DocumentId)
The completeInventoryCount method completes an inventory count currently being

performed.
Table 12-5: completeInventoryCount Variables

originates.
createNewInventoryCountDoc
inventoryCountDocumentResponse createNewInventoryCountDoc (
string CountType,
inventoryCountElement[] Elements,
item[] Items,
string CountStartDate)
The createNewInventoryCountDoc method creates a new inventory count

document.

Methods

Table 12-6: createNewInventoryCountDoc Variables

originates.
string CountType [OPTIONAL] Type of count.
inventoryCou Elements [OPTIONAL] Inventory elements to be counted.

ntElement[]
item[] Items [OPTIONAL] Items to be counted.
string CountStartDate [OPTIONAL] Start date for the count.
getInventoryCountConfig
inventoryCountConfiguration getInventoryCountConfig (
The getInventoryCountConfig method retrieves the configurations for all inventory

counts.
This method returns a inventoryCountConfiguration object.
Table 12-7: getInventoryCountConfig Variables

originates.
getInventoryCountDocument
inventoryCountDocumentResponse getInventoryCountDocument (
string DocumentId)
The getInventoryCountDocument method retrieves an inventory count document.

Table 12-8: getInventoryCountDocument Variables

originates.

Methods
getInventoryCountSheetsForCycle
inventoryCountSheetsForCycleResponse getInventoryCountSheetsForCycle (
string DocumentId)
The getInventoryCountSheetsForCycle method retrieves the count sheets for the

current cycle count in an inventory document.
This method returns a inventoryCountSheetsForCycleResponse object.
Table 12-9: getInventoryCountSheetsForCycle Variables

originates.
getInventoryCountSummaryForCycle
inventoryCountSummaryForCycleResponse getInventoryCountSummaryForCycle (
string DocumentId)
The getInventoryCountSummaryForCycle method retrieves a summary of the

current cycle count for an inventory count document.
This method returns a inventoryCountSummaryForCycleResponse object.
Table 12-10: getInventoryCountSummaryForCycle Variables

originates.

Methods
getVarianceReport
inventoryCountVarianceReportResponse getVarianceReport (
string InventoryCountId,
string CountCycle)
The getVarianceReport method retrieves the items for which the inventory count
and the expected quantity are different. It prints variance report for a specific count cycle
in the inventory count document.
This method returns a inventoryCountVarianceReportResponse object.
Table 12-11: getVarianceReport Variables

originates.
string InventoryCount [OPTIONAL] ID of the inventory document.

Id
string CountCycle [OPTIONAL] The count cycle for the report.
initiateInventoryCount
inventoryCountDocumentResponse initiateInventoryCount (
string DocumentId)
The initiateInventoryCount method starts an inventory count.

Table 12-12: initiateInventoryCount Variables

originates.

Methods
saveInventoryCount
inventoryCountDocumentResponse saveInventoryCount (
string DocumentId)
The saveInventoryCount method saves the changes made to an inventory count.

Table 12-13: saveInventoryCount Variables

originates.
searchInventoryCountDocuments
inventoryCountDocSearchResponse searchInventoryCountDocuments (
string CountType,
string CountStatus,
string DocumentId)
The searchInventoryCountDocuments method searches for a list of inventory

documents that meet certain, defined criteria.
This method returns a inventoryCountDocSearchResponse object.
Table 12-14: searchInventoryCountDocuments Variables

originates.
string CountType [OPTIONAL] Type of count.
string CountStatus [OPTIONAL] Status of the count.
submitInventoryCount
inventoryCountDocumentResponse submitInventoryCount (
string DocumentId)
The submitInventoryCount method submits a count cycle, generates a variance

report, and then generates another count cycle and/or count sheets. Note that this

Classes
method only submits the counts for a count cycle; it does not complete an inventory
document.
Table 12-15: submitInventoryCount Variables

originates.
Classes
codeValueObject
inventoryBucket
Table 12-16: inventoryBucket Elements
string adjustmentAction Action performed by the bucket.
string bucketId ID of the inventory bucket.
string defaultLocationId ID of the default inventory location.
string functionCode Function code for the bucket.
string name Name of the bucket.
boolean systemBucket Indicates whether the bucket is a system bucket.
inventoryCountConfiguration
This element extends the serviceResponse class.
Table 12-17: inventoryCountConfiguration Elements
boolean allowCountingBefore Indicates whether the inventory

Snapshot count can be performed before an
inventory snapshot is taken.
inventoryCountElement[ availableElements Array of inventory elements in the

] inventory count.
inventoryDocType[] docTypes Array of inventory document types

in the count.

Classes
Table 12-17: inventoryCountConfiguration Elements (continued)
inventoryBucket[] inventoryBuckets Array of inventory buckets in the

count.
codeValueObject[] inventoryLocations Array of codes in the count.
inventoryCountCycle
Table 12-18: inventoryCountCycle Elements
boolean allowRepeatCycle Indicates whether the cycle count can be

repeated.
inventoryCountCycl childrenCycles Array of child cycle counts.

e[]
string cycleName Name of the cycle.
string cycleType Type of cycle.
inventoryCountCycl parentCycle Parent cycle count.

e
inventoryCountCycleSummary
Table 12-19: inventoryCountCycleSummary Elements
string styleDescription Description of the style.
string styleId ID of the style.
inventoryCountDocSearchResponse
Table 12-20: inventoryCountDocSearchResponse Elements
inventoryCountDocument[] document Array of inventory document.

Classes
inventoryCountDocument
Table 12-21: inventoryCountDocument Elements
dateTime beginDate Start date of the inventory count.
boolean changed Indicates whether the inventory

document has been changed.
string countDescription Description of the inventory count.
inventoryCountElement[ countElements Array of inventory elements in the

] inventory count.
string countId ID of the inventory count.
string countStatus Status of the count.
string countType Type of count.
string countTypeDescription Description of the count type.
int currentCountCycle If the inventory count is a cycle

count, the number of the current
cycle count.
dateTime endDate End date of the count.
inventoryCountLineIte lineItems Array of inventory items being

m[] counted.
string statusDescription Description of the count status.
boolean storeCreatedFlag Indicates whether the store created

the count (true), or if the count
originated from corporate (false).
boolean voidFlag Indicates whether the count has been

voided.
inventoryCountDocumentResponse
Table 12-22: inventoryCountDocumentResponse Elements
boolean completed Indicates whether the inventory count has

been completed.
inventoryCountCycle countCycle An inventory cycle count.
inventoryCountDocume document Inventory count document.

nt

Classes
inventoryCountElement
Table 12-23: inventoryCountElement Elements
codeValueObject availableValues Array of codes for the element.

[]
string elementType Type of inventory element.
string elementTypeDescription Description of the inventory element.
string elementValue ID of the element.
string parentElementId ID of the parent element.
inventoryCountLineItem
Table 12-24: inventoryCountLineItem Elements
string alternateId Alternate ID for the item.
string bucketId Inventory bucket ID.
boolean changed Indicates whether the line item has been

changed.
int countCycle If the count is a cycle count, the number

of the cycle.
string countId ID of the count.
int countSheetNumber Number of the count sheet.
string countType Type of count.
string dimensionSummary Summary of the item dimension.
decimal expectedQty Number of items expected.
string inventoryLocationId ID of the inventory location.
decimal quantity Counted quantity of the item.

Classes
inventoryCountSheet
Table 12-25: inventoryCountSheet Elements
boolean checkedOut Indicates whether the count sheet is checked out.
int countCycle Number of the cycle count.
int countSheetNumber Count sheet number.
string inventoryBucketId ID of the inventory bucket.
string inventoryBucketName Name of the inventory bucket.
string inventoryCountId ID of the inventory count.
long organizationId ID of the organization.
long retailLocationId ID of the retail location.
string sectionId ID of the section.
int sectionNumber Number of the section.
string sheetStatus Status of the count sheet.
inventoryCountSheetsForCycleResponse
Table 12-26: inventoryCountSheetsForCycleResponse Elements
string documentid ID of the inventory document.
inventoryCountShee inventoryCountSheets Array of count sheets for the inventory

t[] document.
inventoryCountSummaryForCycleResponse
Table 12-27: inventoryCountSummaryForCycleResponse Elements
inventoryCountCycleSummary[] cycleSummary Array of cycle count summaries.

Classes
inventoryCountVarianceReportResponse
Table 12-28: inventoryCountVarianceReportResponse Elements
inventoryCountLineIte varianceList Array of inventory items whose counts

m[] vary from their expected counts.
inventoryDocType
Table 12-29: inventoryDocType Elements
string docTypeDescription Description of the document type.
string inventoryDocName Name of the inventory document.
string inventoryDocType Type of inventory document.
inventoryResponse
This class contains no additional elements.
item
serviceContext
serviceResponse

13
Item
Overview
This chapter provides the information necessary to send messages contained in the Item
above.
The URL for the Item Services WSDL is:
https://<hostname>:8443/ws/ItemServices?wsdl
Item 13-1
Methods
Methods
This section presents the methods used in the Item Services API.
checkProductAvailability
inventoryLocatorResponse checkProductAvailability (
string ItemId,
string ItemQty,
string MaximumDistance)
The checkProductAvailability method checks whether an item that meets

specified criteria is available at another location.
This method returns a inventoryLocatorResponse object.
Table 13-1: checkProductAvailability Variables

originates.
string ItemId [OPTIONAL] ID of the item.
string ItemQty [OPTIONAL] Quantity of the item to locate.
string MaximumDistance [OPTIONAL] Maximum distance from the

requesting location.
getCatalog
catalogResponse getCatalog (
string Catalog)
The getCatalog method returns the contents of a specific catalog.

This method returns a catalogResponse object.
Table 13-2: getCatalog Variables

originates.
string Catalog [OPTIONAL] ID of the catalog.

Methods
getCatalogList
catalogListResponse getCatalogList (
The getCatalogList method returns a list of all active catalogs in the system.
This method returns a catalogListResponse object.
Table 13-3: getCatalogList Variables

originates.
getCurrentItemPrices
itemPricesResponse getCurrentItemPrices (
string ItemId)
The getCurrentItemPrices method returns all the prices (past, present, and future)
configured for an item.
This method returns a itemPricesResponse object.
Table 13-4: getCurrentItemPrices Variables

originates.
getGiftCardItems
itemSearchResponse getGiftCardItems (
The getGiftCardItems method retrieves information about all the gift card items
available.
Table 13-5: getGiftCardItems Variables

originates.
Item 13-3
Methods
getItemById
itemLookupResponse getItemById (
string ItemId)
The getItemById method retrieves an item by its ItemId.

This method returns a itemLookupResponse object.
Table 13-6: getItemById Variables

originates.
getItemBySaleType
itemLookupResponse getItemBySaleType (
string ItemId,
string SaleType)
The getItemBySaleType method retrieves an item by its ItemId and the SaleType
of the item.
Table 13-7: getItemBySaleType Variables

originates.
string SaleType [OPTIONAL] Type of sale.
getItemDeals
itemDealListResponse getItemDeals (
string ItemId,
int FutureDays)
The getItemDeals method retrieves the deals that will be active for an item
FutureDays from now.

Methods
This method returns a itemDealListResponse object.

Table 13-8: getItemDeals Variables

originates.
int FutureDays [REQUIRED] Number of days in the future to

check for active deals.
getItemNotOnFileItems
itemSearchResponse getItemNotOnFileItems (
The getItemNotOnFileItems method returns the items that have been sold, but are
not on file in the system.
Table 13-9: getItemNotOnFileItems Variables

originates.
getItemPriceHistory
itemPriceHistoryResponse getItemPriceHistory (
string ItemId)
The getItemPriceHistory method returns the price history of an item.

This method returns a itemPriceHistoryResponse object.
Table 13-10: getItemPriceHistory Variables

originates.
Item 13-5
Methods
getItemVariations
itemSearchResponse getItemVariations (
string ItemId)
The getItemVariations method retrieves items that are variations of an item.

Table 13-11: getItemVariations Variables

originates.
getItemsByDimensions
itemSearchResponse getItemsByDimensions (
string StyleItemId,
string DimensionCode1,
string DimensionValue1,
string DimensionValue2,
string DimensionValue3)
The getItemsByDimensions method retrieves the items that have the defined
dimension code(s) and corresponding dimension value(s).
Table 13-12: getItemsByDimensions Variables

originates.
string StyleItemId [OPTIONAL] ID of style.
string DimensionCode1 [OPTIONAL] ID of dimension 1.
string DimensionValue1 [OPTIONAL] Value of dimension 1.

Methods
getItemsForCategory
itemSearchResponse getItemsForCategory (
string CategoryId)
The getItemsForCategory method returns items in a certain category.

Table 13-13: getItemsForCategory Variables

originates.
string CategoryId [OPTIONAL] ID of a category.
getNonPhysicalItems
itemSearchResponse getNonPhysicalItems (
string Type,
string Subtype)
The getNonPhysicalItems method retrieves all the nonphysical items in the system.
Table 13-14: getNonPhysicalItems Variables

originates.
string Type [OPTIONAL] Item type.
string Subtype [OPTIONAL] Item subtype.
getProductCategories
productCategoriesResponse getProductCategories (
string CategoryId)
The getProductCategories method returns item category information.
Item 13-7
Methods
This method returns a productCategoriesResponse object.

Table 13-15: getProductCategories Variables

originates.
string CategoryId [OPTIONAL] ID of category.
getSimilarItems
itemSearchResponse getSimilarItems (
string ItemId)
The getSimilarItems method returns items similar to an item.

Table 13-16: getSimilarItems Variables

originates.
getSingleItemDealPrice
itemLookupResponse getSingleItemDealPrice (
string ItemId)
The getSingleItemDealPrice method returns a single item with its current price.
Table 13-17: getSingleItemDealPrice Variables

originates.

Methods
getVoucherItemForActivity
itemLookupResponse getVoucherItemForActivity (
string VoucherId,
string VoucherActivity)
The getVoucherItemForActivity method retrieves the voucher item with

VoucherId that is associated with the activity VoucherActivity.
Table 13-18: getVoucherItemForActivity Variables

originates.
string VoucherId [OPTIONAL] ID of voucher.
string VoucherActivity [OPTIONAL] Voucher activity.
printItemLabel
statusServiceResponse printItemLabel (
string ItemId,
string Printer,
int Quantity)
The printItemLabel method prints a specified number of labels for an item.

Table 13-19: printItemLabel Variables

originates.
string Printer [OPTIONAL] ID of the label printer.
int Quantity [OPTIONAL] Number of labels to print.
Item 13-9
Methods
searchCatalogForItem
catalogPageResponse searchCatalogForItem (
string Catalog,
string Item)
The searchCatalogForItem method returns a list of catalog pages on which an item

appears.
This method returns a catalogPageResponse object.
Table 13-20: searchCatalogForItem Variables

originates.
string Catalog [OPTIONAL] ID of the catalog.
string Item [OPTIONAL] ID of the item.
searchItemsByDescription
itemSearchResponse searchItemsByDescription (
string Description)
The searchItemsByDescription method returns all items containing

Description in their item descriptions.
Table 13-21: searchItemsByDescription Variables

originates.
string Description [OPTIONAL] Item description.
searchItemsByIdOrDescription
itemSearchResponse searchItemsByIdOrDescription (
string Description,
string[] Descriptions)
The searchItemsByIdOrDescription method searches for the item with a

Description item ID, or all items containing certain text in their item descriptions.

Classes

Table 13-22: searchItemsByIdOrDescription Variables

originates.
string Description [OPTIONAL] Item ID.
string[] Descriptions [OPTIONAL] Array of text items.
Classes
catalog
This class contains the following element:
Table 13-23: catalog Elements
string catalogId ID of the catalog.
string catalogType Type of catalog.
string description Description of the catalog.
dateTime effectiveDate First date on which the catalog is valid.
dateTime expirationDate Last date on which the catalog is valid.
catalogPage[] pages Catalog pages.
string previewImageURL URL of the catalog preview image.
int sortOrder Sort order for the catalog.
string title Catalog title.
catalogListResponse
Table 13-24: catalogListResponse Elements
catalog[] catalogs Array of catalogs.
Item 13-11
Classes
catalogPage
Table 13-25: catalogPage Elements
catalogPageItem[] items Catalog items on the page.
string pageImageURL URL of the page image.
int pageIndex Page number for the index.
string thumbnailImageURL URL of the page thumbnail image.
catalogPageItem
Table 13-26: catalogPageItem Elements
int pageIndex Page number for the index.
int pageLocationX X coordinate of the item’s origination on

the page.
int pageLocationY Y coordinate of the item’s origination on

the page.
catalogPageResponse
Table 13-27: catalogPage Elements
catalogPage[] pages Array of catalog pages.
catalogResponse
Table 13-28: catalogResponse Elements
catalog catalog Catalog information.

Classes
inventoryLocatorResponse
Table 13-29: inventoryLocatorResponse Elements
boolean deliveryAvailable Indicates whether the item is

available for delivery.
retailLocationStockLevel retailLocationStockLevels Array of location and stock level

[] information for an item.
item
Table 13-30: item Elements
decimal currentSellingPrice Current selling price of the item.
string departmentDesc Description of the item’s department.
string departmentId ID of the item’s department.
string desc Description of the item.
string dimensionSummary Summary of the item dimension.
boolean disallowSendSale Indicates whether to disallow send

sales (if true, item cannot be included
in a send sale).
boolean giftCard Indicates whether the item is a gift

card.
string[] imageUrls Array of URLs holding images of the

item.
string itemClassDesc Description of the item class.
string itemClassId ID of the item class.
itemDimension[] itemDimensions Array of dimensions available for the

item.
string itemId ID for the item.
string itemLevelCode Level code for the item.
itemPromptProperty itemPromptProperties Array of prompt properties available

[] for the item.
itemProperty[] itemProperties Array of item properties.
string itemSubClassDesc Description of the item’s subclass.
string itemSubClassId ID of the item’s subclass.
Item 13-13
Classes
Table 13-30: item Elements (continued)
string itemTypeCode Code identifying the type of item.
int minAgeRequired The minimum age required for a

customer to be allowed to purchase
the item.
string nonPhysicalItemTypeCode Code identifying the type of

nonphysical item.
string nonPhysicalSubTypeCode Code identifying the type of

nonphysical subtype to which the
item belongs.
string parentItemId ID of the item’s parent.
boolean promptForDescription Indicates whether to prompt for a

description of the item.
boolean promptForPrice Indicates whether to prompt for an

item price.
boolean promptForQty Indicates whether to prompt for item

quantity.
boolean promptForWeight Indicates whether to prompt for item

weight.
int qtyScale The scaling amount used for the item

quantity.
decimal quantityOnHand The current quantity of the item on

hand.
boolean serializeItem Indicates whether the item is

serialized.
string stockStatus The current stock status of the item.
string subdepartmentDesc Description of the item’s

subdepartment.
string subdepartmentId ID of the item’s subdepartment.
itemDeal
Table 13-31: itemDeal Elements
boolean active Indicates whether the deal is currently

active.
dateTime activeDate Date on which the deal is activated.
string description Description of the deal.

Classes
itemDealListResponse
Table 13-32: itemDealListResponse Elements
itemDeal[] deals Array of item deals.
itemDimension
Table 13-33: itemDimension Elements
string dimensionCode Code identifying the dimension.
string dimensionValue Value of the dimension.
itemDimensionValu possibleValues Possible values for the dimension.

e[]
string promptText Prompt displayed when asking for the

dimension value.
itemDimensionValue
Table 13-34: itemDimensionValue Elements
string imageSwatchUrl URL used to access a swatch image.
string label Label displayed for the value.
string value The dimension value.
itemLookupResponse
Table 13-35: itemLookupResponse Elements
item item The item.
Item 13-15
Classes
itemPrice
Table 13-36: itemPrice Elements
dateTime effectiveDate Date on which the price becomes

effective.
dateTime expirationDate Date on which the price expires.
string levelCode Code identifying the level type.
string levelValue Value identifying the level.
decimal price Price of the item.
string priceType Type of price.
decimal pricingQuantity Item quantity to which the price is

applied.
itemPriceHistory
Table 13-37: itemPriceHistory Elements
dateTime endDate Last date on which the price was valid.
decimal itemPrice Price of the item.
dateTime startDate First date on which the price was valid.
itemPriceHistoryResponse
Table 13-38: itemPriceHistoryResponse Elements
itemPriceHistory[] priceHistories Array of historical item prices.

Classes
itemPricesResponse
Table 13-39: itemPricesResponse Elements
itemPrice[] prices Array of item prices.
itemPromptProperty
Table 13-40: itemPromptProperty Elements
string[] possibleValues Possible values of the prompt.
string promptMethod Method used to enter a value.
string promptText Text of the item prompt.
string promptTitle Title for the prompt.
string propertyCode Code identifying the property.
string propertyValue Value of the property.
boolean valueRequired Indicates whether a value must be

entered for the property.
itemProperty
Table 13-41: itemProperty Elements
string propertyDataType Data type used for the property

information.
string propertyDescription Description of the property.
string propertyTypeCode Type of property.
string propertyValue Value of the property.
itemSearchResponse
Item 13-17
Classes

Table 13-42: itemSearchResponse Elements
item[] items Array of items matching the search criteria.
productCategoriesResponse
Table 13-43: productCategoriesResponse Elements
productCategory[] categories Array of product categories.
productCategory
Table 13-44: productCategory Elements
string categoryDescription Description of the category.
string categoryId ID of the category.
item[] items Array of items in the category.
productCategory[] subCategories Subcategories of the category.
retailLocation
For a description of this class, see “retailLocation”.
retailLocationStockLevel
Table 13-45: retailLocationStockLevel Elements
retailLocation retailLocation Retail location where the item can be

found.
decimal stockLevel Quantity of the item.
serviceContext
serviceResponse

Classes
Item 13-19
Classes

14
Logging
Overview
Logging Services API. Information can be obtained using the Web Service Description
The URL for the Logging Services WSDL is:
https://<hostname>:8443/ws/LoggingServices?wsdl
Logging 14-1
Methods
Methods
This section presents the methods used in the Logging Services API.
logEvent
loggingResponse logEvent (
logEntry Entry)
The logEvent method places one Entry in the log.

This method returns a loggingResponse object.
Table 14-1: logEvent Variables

originates.
logEntry Entry [OPTIONAL] Log entry.
logList
loggingResponse logList (
logEntry[] Entries)
The logList method posts a set of Entries in the log.

This method returns a loggingResponse object.
Table 14-2: logList Variables

originates.
logEntry[] Entries [OPTIONAL] Log entries.
Classes
logEntry
Table 14-3: logEntry Elements
string category Category of log entry.
string level Priority level of the log entry.

Classes
Table 14-3: logEntry Elements (continued)
string message Log entry message text.
string source Source of the log entry.
dateTime timestamp Time at which the log entry was made.
loggingResponse
This class contains no additional elements or attributes.
serviceContext
serviceResponse
Logging 14-3
Classes

15
Order
Overview
Order Services API. Information can be obtained using the Web Service Description
The URL for the Order Services WSDL is:
https://<hostname>:8443/ws/OrderServices?wsdl
Order 15-1
Methods
Methods
This section presents the methods used in the Order Services API.
cancelOrder
orderResponse cancelOrder (
orderUpdate OrderUpdate)
The cancelOrder method cancels an order.

This method returns a orderResponse object.
Table 15-1: cancelOrder Variables

message originates.
orderUpdate OrderUpdate [OPTIONAL] Order to be canceled.
submitOrder
orderResponse submitOrder (
long TransSeq)
The submitOrder method submits an order.

This method returns a orderResponse object.
Table 15-2: submitOrder Variables

message originates.
long TransSeq [OPTIONAL] Sequence number for the order

transaction.
Classes
orderDelivery
Table 15-3: orderDelivery Elements
string freightAmount Amount of freight for the transaction.

Classes
Table 15-3: orderDelivery Elements (continued)
orderShipTransactionD orderShipTransaction Detail information for items in the order.

etails Details
string shipVia ID for the entity shipping the order.
string shipViaDescription Description of the entity shipping the

order.
orderEntity
Table 15-4: orderEntity Elements
string apt Apartment number.
string attention Attention line for the address.
string city City for the address.
string companyName Company name.
string country Country of the address.
string email Contact email.
string first Person’s first name.
string last Person’s last name.
string middle Person’s last name.
string phone1 Phone number 1.
string phone2 Phone number 2.
string postal Postal or zip code.
string prefix Prefix for the person’s name.
string province Province or state for the address.
string suffix Suffix for the person’s name.
Order 15-3
Classes
orderInfo
Table 15-5: orderInfo Elements
string balanceDue Balance due on the order.
string currency Currency used for the order.
string employeeId ID of the employee who created the order.
orderTenders orderTenders Tenders applied to the order.
string requestingRetail Retail location making the order request.

Location
orderSoldTo soldTo Customer to whom the order was sold.
string transactionNumber Transaction number for the order.
string transactionSubtotal Subtotal for the order transaction.
string transactionTax Tax applied to the order transaction.
string transactionTotal Total amount of the order transaction.
orderLocation
Table 15-6: orderLocation Elements
string city Destination city for the order.
string contacName Contact name for the order.
string countryCode Destination country for the order.
string email Contact email for the order.
string extension Extension for the contact phone number.
string fax Contact fax number.
string locationCode Code for the location.
string locationHours Hours the location is open.
string name Name associated with the order.
string phone Contact phone number for the order.
string postalCode Destination postal code or zip code for

the order.
string rank Rank for the order.
string region Destination region for the order.

Classes
Table 15-6: orderLocation Elements (continued)
string stateProvinceCode ID code for the destination state or

province for the order.
string street Destination street address for the order.
orderLocationsResponse
Table 15-7: orderLocationsResponse Elements
orderLocation[] orderLocations Array of destination locations.
orderPickup
This class extends the orderInfo class.
Table 15-8: orderPickup Elements
orderPickupTransact orderPickupTransaction Details about the order pickup

ionDetails Details transaction.
orderPickupTransactionDetail
This class extends the orderTransactionDetail class.
Table 15-9: orderPickupTransactionDetail Elements
string locationCode Location code for the pickup location.
orderPickupTransactionDetails
Table 15-10: orderPickupTransactionDetails Elements
orderPickupTransact orderPickupTransaction Array of transaction details about the

ionDetail[] Detail order pickup.
orderResponse
Order 15-5
Classes

Table 15-11: orderResponse Elements
string description Description of the order.
string fulfillmentLocation Location fulfilling an order.

Code
string fulfillmentSystemCode System code for the type of fulfillment.
string orderId ID of the order.
string requestId ID of the order request.
string responseCode ID code for the order response.
orderRetailPickup
This class extends the orderInfo class.
Table 15-12: orderRetailPickup Elements
orderShipTransactio orderShipTransaction Details about the order to be picked up.

nDetails Details
orderShipTransactionDetail
This class extends the orderTransactionDetail class.
Table 15-13: orderShipTransactionDetails Elements
orderEntity shipTo Shipping destination for the order.
orderShipTransactionDetails
Table 15-14: orderShipTransactionDetails Elements
orderShipTransactio orderShipTransaction Array of transaction details.

nDetail[] Detail

Classes
orderSoldTo
Table 15-15: orderSoldTo Elements
string customerNumber ID number for the customer.
orderEntity orderEntity Address and contact information for the

customer.
orderTax
Table 15-16: orderTax Elements
string amount Amount of the tax.
string description Description of the tax.
string lineItemNumber Line item number for the tax.
orderTaxes
Table 15-17: orderTaxes Elements
orderTax[] orderTax Array of taxes.
orderTender
Table 15-18: orderTender Elements
string lineItemNumber Line item number for the tender.
string tenderAmount Amount of the tender.
string tenderDescription Description of the tender.
orderTenders
Table 15-19: orderTenders Elements
orderTender[] orderTender Array of tenders.
Order 15-7
Classes
orderTransactionDetail
Table 15-20: orderTransactionDetail Elements
string lineItemNumber Line number of the item.
orderTaxes orderTaxes Taxes on the item.
string quantity Quantity of the item.
string unitPrice Unit price of the item.
orderUpdate
Table 15-21: orderUpdate Elements
string employeeId ID of the employee who created the order.
string requestId ID of the order request.
string requestingRetail ID of the location from which the order

Location request was created.
serviceContext
serviceResponse

16
Ping
Overview
This chapter provides the information necessary to send messages contained in the Ping
above.
The URL for the Ping Services WSDL is:
https://<hostname>:8443/ws/PingServices?wsdl
Ping 16-1
Methods
Methods
This section presents the methods used in the Ping Services API.
pingServer
pingResponse pingServer (
The pingServer method checks whether the server is available on the network.
This method returns a pingResponse object.
Table 16-1: pingServer Variables

originates.
Classes
pingResponse
This class extends the statusServiceResponse class.
Table 16-2: pingResponse Elements
long pingReplyTime Time required for a ping packed response

to be received from the server.
serviceContext
serviceResponse

17
Printing
Overview
Printing Services API. Information can be obtained using the Web Service Description
The URL for the Printing Services WSDL is:
https://<hostname>:8443/ws/PrintingServices?wsdl
Printing 17-1
Methods
Methods
This section presents the methods used in the Printing Services API.
getAvailablePrinters
printerResponse getAvailablePrinters (
string Type)
The getAvailablePrinters method returns the printers that are available to the
system.
This method returns a printerResponse object.
Table 17-1: getAvailablePrinters Variables

originates.
string Type [optional] Type of printer.
printTestReceipt
printerResponse printTestReceipt (
string Printer)
The printTestReceipt method returns the printers that are available to the system.
This method returns a printerResponse object.
Table 17-2: printTestReceipt Variables

originates.
string Printer [optional] ID of printer.
Classes
printer
Table 17-3: printer Elements
string id ID of the printer.

Classes
Table 17-3: printer Elements (continued)
string name Name of the printer.
string type Type of printer.
printerResponse
Table 17-4: printerResponse Elements
printer[] printers Array of printers.
serviceContext
serviceResponse
Printing 17-3
Classes

18
Reason Code
Overview
Reason Code Services API. Information can be obtained using the Web Service
The URL for the Reason Code Services WSDL is:
https://<hostname>:8443/ws/ReasonCodeServices?wsdl
Reason Code 18-1

Methods
Methods
This section presents the methods used in the Reason Code Services API.
getReasonCodesByType
reasonCodeLookupResponse getReasonCodesByType (
string ReasonCodeType)
The getReasonCodesByType method retrieves all the reason codes of

ReasonCodeType.
This method returns a reasonCodeLookupResponse object.
Table 18-1: getReasonCodesByType Variables

originates.
string ReasonCodeTyp [OPTIONAL] Type of reason code.

e
Classes
reasonCodeLookupResponse
Table 18-2: postalCodeResponse Elements
reasonCode[] reasonCodes Array of reason codes.
reasonCode
Table 18-3: reasonCode Elements
string actionCode ID code for the action associated with the

reason code.
string commentRequired Indicates whether a comment is required.
string customerMessage Message to customer.
string description Description of the reason code.
string privilegeType Type of privilege required to use the

reason code.

Classes
Table 18-3: reasonCode Elements (continued)
reasonCodePromptP promptProperties Array of properties for the prompts

roperties[] associated with the reason code.
string reasonCode Reason code value.
int sortOrder Order in which the reason code is

displayed.
Table 18-4: reasonCodePromptProperties Elements
string promptDataType Type of data requested by the prompt.
string promptText Text of the prompt.
string promptTitle Title of the prompt.
string promptTypeCode ID code for the type of prompt.
string value Value of the reason code.

entered.
serviceContext
serviceResponse
Reason Code 18-3

Classes

19
Receiving
Overview
Receiving Services API. Information can be obtained using the Web Service Description
The URL for the Receiving Services WSDL is:
https://<hostname>:8443/ws/ReceivingServices?wsdl
Receiving 19-1
Methods
Methods
This section presents the methods used in the Receiving Services API.
addLine
inventoryCartonResponse addLine (
string DocumentId,
string CartonId,
string ModelNumber,
decimal RetailPrice,
decimal LineItemQty,
string ReceivingLocation,
string SerialNumber)
The addLine method adds a line to a carton.

This method returns a inventoryCartonResponse object.

originates.
string DocumentId [OPTIONAL] ID of document.
string CartonId [OPTIONAL] ID of carton.
string InventoryItemId [OPTIONAL] ID of item.
string ModelNumber [OPTIONAL] ID number for item model.
decimal RetailPrice [OPTIONAL] Retail price of item.
decimal LineItemQty [OPTIONAL] Quantity of the item.
string ReceivingLocatio [OPTIONAL] Location receiving the item.

n
string SerialNumber [OPTIONAL] Item serial number.
addToExpress
expressReceivingResponse addToExpress (
string DocumentId,
string CartonId,
long PONumber)
The addToExpress method adds a carton to an express document.

Methods
This method returns a expressReceivingResponse object.

Table 19-2: addToExpress Variables

originates.
long PONumber [OPTIONAL] Purchase order number.
cancelDocumentChanges
inventoryResponse cancelDocumentChanges (
string DocumentId)
The cancelDocumentChanges method cancels all pending changes to a document.

Table 19-3: cancelDocumentChanges Variables

originates.
cancelExpress
inventoryResponse cancelExpress (
The cancelExpress method cancels all pending changes to an express document.

Table 19-4: cancelExpress Variables

originates.
Receiving 19-3
Methods
changeLineQty
inventoryCartonResponse changeLineQty (
string DocumentId,
string CartonId,
decimal NewQty,
The changeLineQty method changes the quantity of a document line item.


originates.
decimal NewQty [OPTIONAL] New quantity for line.
long DocumentLineN [OPTIONAL] Line number being changed.

umber
createNewDocument
inventoryDocumentResponse createNewDocument (
string DocumentType,
string DocumentId,
string DestinationId,
string DestinationDescription)
The createNewDocument method creates a new receiving document.

Table 19-6: createNewDocument Variables

originates.
string DocumentType [OPTIONAL] Type of document.
string DestinationId [OPTIONAL] ID of destination.
string Destination [OPTIONAL] Description of the destination.

Description

Methods
getCarton
inventoryCartonResponse getCarton (
string DocumentId,
string CartonId)
The getCarton method retrieves information about a receiving carton.

Table 19-7: getCarton Variables

originates.
string DocumentId [OPTIONAL] ID of the document.
string CartonId [OPTIONAL] ID of the carton.
getDocument
inventoryDocumentResponse getDocument (
string DocumentId)
The getDocument method retrieves information about a receiving document.

Table 19-8: getDocument Variables

originates.
getReceiveFromLocations
inventoryDestinationResponse getReceiveFromLocations (
string DocumentType)
The getShipToLocations method retrieves the locations from which items can be
received with a DocumentType document.
Receiving 19-5
Methods
This method returns a inventoryDestinationResponse object.

Table 19-9: getReceiveFromLocations Variables

originates.
getReceivingConfig
receivingConfiguration getReceivingConfig (
The getReceivingConfig method retrieves configuration information for receiving.

This method returns a receivingConfiguration object.
Table 19-10: getReceivingConfig Variables

originates.
receiveCartonInFull
inventoryCartonResponse receiveCartonInFull (
string DocumentId,
string CartonId)
The receiveCartonInFull method lists all items in a carton as being received.

Table 19-11: receiveCartonInFull Variables

originates.

Methods
receiveInFull
inventoryResponse receiveInFull (
string DocumentId)
The receiveInFull method lists all items in a receiving document as being received.
Table 19-12: receiveInFull Variables

originates.
string DocumentId [OPTIONAL] ID of the receiving document.
saveDocument
inventoryResponse saveDocument (
string DocumentId,
boolean CloseDocument)
The saveDocument method saves all the changes made to a receiving document.
Table 19-13: saveDocument Variables

originates.
string DocumentId [OPTIONAL] ID of the document.
boolean CloseDocument [OPTIONAL] Indicates whether to close the

receiving document.
saveExpress
inventoryResponse saveExpress (
The saveExpress method saves all the changes made to an express document.
Receiving 19-7
Methods

Table 19-14: saveExpress Variables

originates.
searchDocuments
documentSearchResultResponse searchDocuments (
string DocumentId)
The searchDocuments method retrieves all documents with the DocumentId.

This method returns a documentSearchResultResponse object.
Table 19-15: searchDocuments Variables

originates.
updatePONumber
inventoryResponse updatePONumber (
string DocumentId,
string CartonId,
string PONumber)
The updatePONumber method changes the purchase order number for a document.
Table 19-16: updatePONumber Variables

originates.
string PONumber [OPTIONAL] Purchase order number.

Methods
validateControlNumber
inventoryResponse validateControlNumber (
string DocumentId,
string CartonId,
string ControlNumber)
The validateControlNumber method validates the control number for a carton and
document.
Table 19-17: validateControlNumber Variables

originates.
string ControlNumber [OPTIONAL] Control number to be validated.
validateId
validateInvIdResponse validateId (
string InventoryId)
The validateId method checks whether an InventoryId is valid.

This method returns a validateInvIdResponse object.
Table 19-18: validateId Variables

originates.
string InventoryId [OPTIONAL] Inventory ID.
validateLine
string DocumentId,
The validateLine method retrieves validation information about an item.
Receiving 19-9
Methods


originates.
string InventoryItemId [OPTIONAL] ID of inventory item being validated.
validateOrAddCarton
inventoryDocumentResponse validateOrAddCarton (
string DocumentId,
string CartonId)
The validateOrAddCarton method checks whether a CartonId has been added to a

DocumentId. If it has not, the carton is added to the document.
This method returns an inventoryDocumentResponse object.
Table 19-20: validateOrAddCarton Variables

originates.
voidFromExpress
expressReceivingResponse voidFromExpress (
string DocumentId,
string CartonId)
The voidFromExpress method voids a carton from an express document.

This method returns a expressReceivingResponse object.
Table 19-21: voidFromExpress Variables

originates.

Classes
Table 19-21: voidFromExpress Variables (continued)
voidLine
inventoryCartonResponse voidLine (
string DocumentId,
string CartonId,
The voidLine method voids a line in a document.


originates.
long DocumentLineN [OPTIONAL] Line number being voided in

umber document.
Classes
cartonLineItem
Table 19-23: cartonLineItem Elements
string cartonId ID of carton.
boolean changed Indicates whether the line item has

been changed.
string controlNumber Control number.
string documentId ID of document.
string documentTypeCode Code indicating the type of

document.
documentLineItem[] lineItems Line items in the document.
Receiving 19-11
Classes
Table 19-23: cartonLineItem Elements (continued)
boolean promptForControlNumber Indicates whether to prompt for a

control number.
long retailLocationId ID of retail location.
string statusCode Status code of line item.
string statusDescription Description of status.
decimal totalItemCount Total quantity of item(s).
documentLineItem
Table 19-24: documentLineItem Elements
string cartonId ID of carton.
boolean changed Indicates whether the line item has been

changed.
int documentLineNumber Line number on document.
string documentTypeCode Code indicating the type of document.
string enteredItemDescription Description of entered item.
string enteredItemId ID of entered item.
decimal expectedCount Expected inventory count.
string inventoryItemId ID of inventory item.
string itemDescription Description of item.
string modelNumber Model number of item.
decimal postedCount Posted inventory count.
decimal retailValue Retail value.
string serialNumber Item serial number.
string statusCode Code indicating status.
decimal unitCount Unit count of item.

Classes
documentSearchResultResponse
Table 19-25: documentSearchResultResponse Elements
inventoryDocument[] documents Array of documents.
expressLineItem
Table 19-26: expressLineItem Elements
string cartonId ID of the carton.
boolean document Indicates whether there is an associated

document.
decimal itemCount Quantity of the line item.
int lineNumber Line number.
string poReferenceNumber Reference number for the purchase order.
boolean promptForPO Indicates whether the user must be

prompted for a purchase order number.
string status Status of line item.
expressReceivingResponse
Table 19-27: expressReceivingResponse Elements
expressLineItem[] items Array of items.
inventoryCartonResponse
Table 19-28: inventoryCartonResponse Elements
cartonLineItem carton Inventory carton.
Receiving 19-13
Classes
inventoryDestination
Table 19-29: inventoryDestination Elements
string destinationDescription Description of the destination.
string destinationId ID of the destination.
string destinationType Type of destination.
int sortOrder Order is which the destination is

displayed.
inventoryDestinationResponse
Table 19-30: inventoryDestinationResponse Elements
inventoryDestinatio destinations Array of shipping destinations.

n[]
shipperOption[] shippers Array of shippers.
inventoryDocument
Table 19-31: inventoryDocument Elements
boolean cartonShipping Indicates whether cartons are used in

the document.
cartonLineItem[] cartons Cartons in the document.
boolean changed Indicates whether the document has

been changed.
string description Description of document.
string documentCreationType Method used to created document.
string documentSubTypeCode Code indicating the subtype of

document.
string documentTypeCode Code indicating the type of

document.

Classes
Table 19-31: inventoryDocument Elements (continued)
string expectedDate Date on which the shipment is

expected to be received.
string invoiceNumber Invoice number.
boolean itemLevelReceiving Indicates whether item-level

receiving is required.
long lastActivityDate Date of last document activity.
documentLineItem[] lineItems Line items in the document.
string poReferenceNumber Reference number to related

purchase order.
boolean promptForControlNumber Indicates whether to prompt for a

control number.
boolean promptForPO Indicates whether to prompt for a

purchase order.
boolean promptForPackingSlip Indicates whether to prompt for a

packing slip.
string statusCode Code indicating status.
decimal totalItemCount Total quantity of item(s).
string trackingNumber Tracking number.
Table 19-32: inventoryDocumentResponse Elements
inventoryDocument document Inventory document.
inventoryResponse
item
Receiving 19-15
Classes
receivingConfiguration
serviceContext
serviceResponse
shipperOption
Table 19-33: shipperOption Elements
string shipperCode ID code for the shipper.
string shipperDescription Description of the shipper.
int sortOrder Order is which the shipper is displayed.
validateInvIdResponse
Table 19-34: validateInvIdResponse Elements
expressLineItem[] items Array of express line items.
Table 19-35: validateDocumentLineItemResponse Elements
item inventoryItem Inventory item.
boolean promptModelNumber Indicates whether to prompt for a model

number.
boolean promptQty Indicates whether to prompt for an item

quantity.

Classes
Table 19-35: validateDocumentLineItemResponse Elements (continued)
boolean promptReceivingLocation Indicates whether to prompt for a receiving

location.
boolean promptRetailPrice Indicates whether to prompt for a retail price.
boolean promptSerialNumber Indicates whether to prompt for a serial

number.
Receiving 19-17
Classes

20
Register
Overview
Register Services API. Information can be obtained using the Web Service Description
The URL for the Register Services WSDL is:
https://<hostname>:8443/ws/RegisterServices?wsdl
Register 20-1
Methods
Methods
This section presents the methods used in the Register Services API.
closeRegister
statusServiceResponse closeRegister (
The closeRegister method closes a register.

Table 20-1: closeRegister Variables

originates.
getRegisterStoreStatus
registerStoreStatusResponse getRegisterStoreStatus (
The getRegisterStoreStatus method retrieves the status of a store in a register.

This method returns a registerStoreStatusResponse object.
Table 20-2: getRegisterStoreStatus Variables

originates.
openRegister
statusServiceResponse openRegister (
The openRegister method opens a register.

Table 20-3: openRegister Variables

originates.

Classes
validateRegisterOpen
statusServiceResponse validateRegisterOpen (
The validateRegisterOpen method checks whether a register is open.

Table 20-4: validateRegisterOpen Variables

originates.
Classes
registerStoreStatusResponse
This class extends the statusServiceResponse class.
Table 20-5: registerStoreStatusResponse Elements
dateTime businessDate Business date.
boolean registerOpen Indicates whether the register is open.
boolean storeOpen Indicates whether the store is open.
serviceContext
serviceResponse
Register 20-3
Classes

21
Retail Location
Overview
Retail Location Services API. Information can be obtained using the Web Service
The URL for the Retail Location Services WSDL is:
https://<hostname>:8443/ws/RetailLocationServices?wsdl
Retail Location 21-1

Methods
Methods
This section presents the methods used in the Retail Location Services API.
closeStore
statusServiceResponse closeStore (
string EmployeeId)
The closeStore method closes a store.

Table 21-1: closeStore Variables

originates.
string EmployeeId [optional] ID of employee closing the store.
getRetailLocation
retailLocationLookupResponse getRetailLocation (
The getRetailLocation method retrieves location information for the local store.
This method returns a retailLocationLookupResponse object.
Table 21-2: getRetailLocation Variables

originates.
getRetailLocationWithId
retailLocationLookupResponse getRetailLocationWithId (
string RetailLocId)
The getRetailLocationWithId method looks up a retail location by ID.

Methods
This method returns a retailLocationLookupResponse object.

Table 21-3: getRetailLocationWithId Variables

originates.
string RetailLocId [optional] ID of retail location.
locateSendSaleStores
retailLocationSearchResponse locateSendSaleStores (
The locateSendSaleStores method searches for stores that can be used for send
sales.
This method returns a retailLocationSearchResponse object.
Table 21-4: locateSendSaleStores Variables

originates.
locateStores
retailLocationSearchResponse locateStores (
decimal LatitudeFrom,
decimal LongitutdeFrom,
int MilesWithin)
The locateStores method finds all stores within a defined radius of a specified
latitude and longitude.
This method returns a retailLocationSearchResponse object.
Table 21-5: locateStores Variables

originates.
decimal LatitudeFrom [OPTIONAL] Starting latitude.
decimal LongitdeFrom [OPTIONAL] Starting longitude.
int MilesWithin [OPTIONAL] Number of miles of radius from the

starting latitude and longitude
within which to search for stores.

Methods
openStore
statusServiceResponse openStore (
string EmployeeId,
date BusinessDate)
The openStore method opens a store.

Table 21-6: openStore Variables

originates.
string EmployeeId [optional] ID of employee opening the store.
date BusinessDate [optional] Business date for the store open.
validateStoreClosed
validationResponse validateStoreClosed (
The validateStoreClosed method checks whether a store is closed.

This method returns a validationResponse object.
Table 21-7: validateStoreClosed Variables

originates.
validateStoreOpen
validationResponse validateStoreOpen (
The validateStoreOpen method checks whether the local store is open.

Table 21-8: validateStoreOpen Variables

originates.

Classes
Classes
retailLocation
Table 21-9: retailLocation Elements
string address1 Line 1 of the store address.
string address2 Line 2 of the store address.
string apartment Apartment number of the store address.
string area Area of the store.
string city City of the store.
string country Country of the store.
string currencyId ID of the currency used in the store’s area.
string dataSource Data source for the store.
string description Description of the store.
decimal distanceFromStartingPoint Distance to the store from another,

defined location.
string district District of the store.
string emailAddress Email address for the store.
decimal latitude Latitude of the store.
string locale Locale of the store.
decimal longitude Longitude of the store.
long organizationId Store’s organization ID.
string postalCode Postal code/ZIP Code for the store.
string region Region of the store.
long retailLocationId ID of the retail location.
string state State/Province of the store.
string storeManager Employee ID of the store manager.
string storeNumber Store number.
string telephone1 First telephone number for the store.
string telephone2 Second telephone number for the store.
string telephone3 Third telephone number for the store.
string telephone4 Fourth telephone number for the store.

Classes
retailLocationLookupResponse
Table 21-10: retailLocationLookupResponse Elements
retailLocation retailLocation Retail location information.
retailLocationSearchResponse
Table 21-11: retailLocationSearchResponse Elements
retailLocation[] retailLocations Array of locations matching the search

criteria.
serviceContext
serviceResponse
validationResponse
Table 21-12: validationResponse Elements
boolean valid Indicates whether the store is open.

22
Shipping
Overview
Shipping Services API. Information can be obtained using the Web Service Description
The URL for the Receiving Services WSDL is:
https://<hostname>:8443/ws/ShippingServices?wsdl
Note: The Carton ID is not used in the Xstore Shipping functions.
Shipping 22-1
Methods
Methods
This section presents the methods used in the Shipping Services API.
addDocumentComment
inventoryResponse addDocumentComment (
string DocumentId,
string Comment)
The addDocumentComment method adds a comment to a document.

Table 22-1: addDocumentComment Variables

originates.
string Comment [OPTIONAL] Comment.
addLine
shippingBundleResponse addLine (
string DocumentId,
string CartonId,
string ModelNumber,
decimal RetailPrice,
decimal LineItemQty,
string ShippingLocation,
string SerialNumber)
The addLine method adds a line item to a document.

This method returns a shippingBundleResponse object.

originates.

Methods
Table 22-2: addLine Variables (continued)
string ModelNumber [OPTIONAL] Number identifying item model.
string RetailPrice [OPTIONAL] Retail price of item.
string LineItemQty [OPTIONAL] Quantity of item.
string ShippingLocation [OPTIONAL] ID of location from which the item is

being shipped.
string SerialNumber [OPTIONAL] Serial number of item.
cancelDocumentChanges
inventoryResponse cancelDocumentChanges (
string DocumentId)
The cancelDocumentChanges method cancels all pending changes to a document.

Table 22-3: cancelDocumentChanges Variables

originates.
changeLineQty
shippingBundleResponse changeLineQty (
string DocumentId,
string CartonId,
decimal NewQty,
The changeLineQty method changes the quantity of a document line item.


originates.
Shipping 22-3
Methods
Table 22-4: changeLineQty Variables (continued)
decimal NewQty [OPTIONAL] New quantity for line number.
long DocumentLineN [OPTIONAL] Line number in document.

umber
createNewDocument
inventoryDocumentResponse createNewDocument (
string DocumentType,
string DocumentId,
string DestinationId,
string DestinationDescription,
string ShipperCode)
The createNewDocument method creates a new shipping document.

Table 22-5: createNewDocument Variables

originates.
string DocumentId [optional] ID of the document.
string DestinationId [OPTIONAL] ID of destination.
string Destination [OPTIONAL] Description of destination.

Description
string ShipperCode [OPTIONAL] Code identifying the shipper.
getCarton
inventoryCartonResponse getCarton (
string DocumentId,
string CartonId)
The getCarton method retrieves information about a shipping carton.

Methods

Table 22-6: getCarton Variables

originates.
string DocumentId [OPTIONAL] ID of inventory document.
getDocument
inventoryDocumentResponse getDocument (
string DocumentId)
The getDocument method retrieves a shipping document.

Table 22-7: getDocument Variables

originates.
getShipToLocations
inventoryDestinationResponse getShipToLocations (
string DocumentType)
The getShipToLocations method retrieves the locations to which items can be

shipped with a DocumentType document.
This method returns a inventoryDestinationResponse object.
Table 22-8: getShipToLocations Variables

originates.
Shipping 22-5
Methods
getShippingConfig
shippingConfiguration getShippingConfig (
The getShippingConfig method retrieves configuration information for shipping.

This method returns a shippingConfiguration object.
Table 22-9: getShippingConfig Variables

originates.
getShippingMethods
orderShippingMethodResponse getShippingMethods (
The getShippingMethods method retrieves the methods that can be used for
shipping.
This method returns a orderShippingMethodResponse object.
Table 22-10: getShippingConfig Variables

originates.
saveDocument
inventoryResponse saveDocument (
string DocumentId,
boolean CloseDocument,
boolean ShipItemsSoFar,
int PackingSlipCopies,
boolean PrintShippingLabel)
The saveDocument method saves all the changes made to a shipping document.
Table 22-11: saveDocument Variables

originates.

Methods
Table 22-11: saveDocument Variables (continued)
boolean CloseDocument [OPTIONAL] Indicates whether to close the

document.
boolean ShipItemsSoFar [OPTIONAL] Indicates whether to ship the items

currently in the document.
int PackingSlipCopies [OPTIONAL] Number of copies of the packing slip.
boolean PrintShippingLabel [OPTIONAL] Indicates whether to print a shipping

label.
searchDocuments
documentSearchResultResponse searchDocuments (
string DocumentId)
The searchDocuments method retrieves all documents with the DocumentId.

This method returns a documentSearchResultResponse object.
Table 22-12: searchDocuments Variables

originates.
updatePONumber
inventoryResponse updatePONumber (
string DocumentId,
string PONumber)
The updatePONumber method sets a new ID number for a purchase order.

Table 22-13: updatePONumber Variables

originates.
string DocumentId [OPTIONAL] ID of shipping document.
Shipping 22-7
Methods
Table 22-13: updatePONumber Variables (continued)
string PONumber [OPTIONAL] Purchase Order number.
validateLine
string DocumentId,
The validateLine method retrieves validation information about an inventory item.


originates.
validateOrAddCarton
inventoryDocumentResponse validateOrAddCarton (
string DocumentId,
string CartonId)
The validateOrAddCarton method checks whether a carton has been added to a

shipping document and, if not, adds the carton to the shipping document.
Table 22-15: validateOrAddCarton Variables

originates.
string DocumentId [OPTIONAL] ID of shipping document.

Classes
voidLine
shippingBundleResponse voidLine (
string DocumentId,
string CartonId,
The voidLine method voids a line in a document.


message originates.
long DocumentLineNumber [OPTIONAL] Line number to void.
Classes
cartonLineItem
For a description of this class, see “cartonLineItem”.
documentSearchResultResponse
For a description of this class, see “documentSearchResultResponse”.
inventoryCartonResponse
For a description of this class, see “inventoryCartonResponse”.
inventoryDestinationResponse
For a description of this class, see “inventoryDestinationResponse”.
inventoryDocument
For a description of this class, see “inventoryDocument”.
For a description of this class, see “inventoryDocumentResponse”.
inventoryResponse
For a description of this class, see “inventoryResponse”.
Shipping 22-9
Classes
orderShippingMethodResponse
Table 22-17: orderShippingMethodResponse Elements
shippingMethod shippingMethods Array of methods that can be used for shipping.

[]
serviceContext
serviceResponse
shippingBundleResponse
Table 22-18: shippingBundleResponse Elements
cartonLineItem carton Carton information.
inventoryDocument document Inventory document information.
shippingConfiguration
shippingMethod
Table 22-19: shippingMethod Elements
string shippingMethod Name of the shipping method.
string shippingMethodDesc Description of the shipping method.
int sortOrder Order in which the method will appear.

Classes
For a description of this class, see “validateDocumentLineItemResponse”.
Shipping 22-11
Classes

23
Tax
Overview
This chapter provides the information necessary to send messages contained in the Tax
above.
The URL for the Tax Services WSDL is:
https://<hostname>:8443/ws/TaxServices?wsdl
Tax 23-1
Methods
Methods
This section presents the methods used in the Tax Services API.
getTaxLocations
taxLocationLookupResponse getTaxLocations (
string PostalCode)
The getTaxLocations method retrieves the tax locations that have jurisdiction over a
specified PostalCode.
This method returns a taxLocationLookupResponse object.
Table 23-1: getTaxLocations Variables

originates.
string PostalCode [OPTIONAL] Postal/ZIP Code.
Classes
serviceContext
serviceResponse
taxLocation
Table 23-2: taxLocation Elements
string description Description of the tax location.
string name Name of the tax location.
string taxLocationId ID of the tax location.

Classes
taxLocationLookupResponse
Table 23-3: taxLocationLookupResponse Elements
taxLocation[] taxLocations Array of tax locations.
Tax 23-3
Classes

24
Timeclock
Overview
Timeclock Services API. Information can be obtained using the Web Service Description
The URL for the Timeclock Services WSDL is:
https://<hostname>:8443/ws/TimeclockServices?wsdl
Timeclock 24-1
Methods
Methods
This section presents the methods used in the Timeclock Services API.
employeeChangeWorkCode
timeClockResponse employeeChangeWorkCode (
string EmployeeId,
string Password,
string OldWorkCode,
string NewWorkCode,
string ReceiptPrinter)
The employeeChangeWorkCode method changes the work code for the employee.
This method returns a timeClockResponse object.
Table 24-1: employeeChangeWorkCode Variables

originates.
string EmployeeId [OPTIONAL] ID of employee.
string Password [OPTIONAL] Password entered.
string OldWorkCode [OPTIONAL] Previous work code for employee.
string NewWorkCode [OPTIONAL] New work code for employee.
string ReceiptPrinter [OPTIONAL] ID for receipt printer.
employeeClockIn
timeClockResponse employeeClockIn (
string EmployeeId,
string Password,
string WorkCode,
The employeeClockIn method clocks in an employee.

Table 24-2: employeeClockIn Variables

originates.
string EmployeeId [OPTIONAL] ID for employee.

Methods
Table 24-2: employeeClockIn Variables (continued)
string WorkCode [OPTIONAL] Work code currently assigned to

employee.
string ReceiptPrinter [optional] ID of the receipt printer.
employeeClockOut
timeClockResponse employeeClockOut (
string EmployeeId,
string Password,
string WorkCode,
The employeeClockOut method clocks out an employee.

Table 24-3: employeeClockOut Variables

originates.
string WorkCode [OPTIONAL] Work code assigned to employee.
string ReceiptPrinter [OPTIONAL] ID for receipt printer.
employeeTimeclockHistory
employeeTimeClockEntriesResponse employeeTimeclockHistory (
string LoginInput,
string Password,
dateTime StartDate,
dateTime EndDate)
The employeeTimeclockHistory method retrieves the clock-in and clock-out

information for an employee.
Timeclock 24-3
Methods
This method returns a employeeTimeClockEntriesResponse object.

Table 24-4: employeeTimeclockHistory Variables

originates.
string LoginInput [OPTIONAL] Login name input for employee.
string Password [OPTIONAL] Passwords entered.

information.
dateTime StartDate [OPTIONAL] Start date for timeclock session.
dateTime EndDate [OPTIONAL] End date for timeclock session.
validateEmployeeChangeWorkCode
validateTimeClockResponse validateEmployeeChangeWorkCode (
string Password,
string CurrentWorkCode)
The validateEmployeeChangeWorkCode method validates whether the employee

can change their work code to the CurrentWorkCode.
This method returns a validateTimeClockResponse object.
Table 24-5: validateEmployeeChangeWorkCode Variables

originates.
string[] LoginInput [OPTIONAL] Login names entered.

information.
string CurrentWorkCode [OPTIONAL] Current work code assigned to

employee.

Methods
validateEmployeeClockIn
validateTimeClockResponse validateEmployeeClockIn (
string LoginInput,
string Password,
The validateEmployeeClockIn method validates whether an employee can be

clocked in.
Table 24-6: validateEmployeeClockIn Variables

originates.
string LoginInput [OPTIONAL] Login name entered.

information.
validateEmployeeClockInWithoutAuth
validateTimeClockResponse validateEmployeeClockInWithoutAuth (
string EmployeeId)
The validateEmployeeClockInWithoutAuth method validates whether the

employee can be clocked in without entering authorization information.
Table 24-7: validateEmployeeClockInWithoutAuth Variables

originates.
string EmployeeId [OPTIONAL] ID for employee.
Timeclock 24-5
Methods
validateEmployeeClockOut
validateTimeClockResponse validateEmployeeClockOut (
string Password,
The validateEmployeeClockOut method validates whether employees can be

clocked out.
Table 24-8: validateEmployeeClockOut Variables

originates.
string[] LoginInput [OPTIONAL] Employee login names.
string Password [OPTIONAL] Employee password.
string LoginInputType [OPTIONAL] Method used to enter employee

logins.
validateEmployeeIsClockedIn
statusServiceResponse validateEmployeeIsClockedIn (
string EmployeeId)
The validateEmployeeIsClockedIn method validates whether the employee is

currently clocked in.
Table 24-9: validateEmployeeIsClockedIn Variables

originates.

Classes
Classes
dailyTimeClockEntries
Table 24-10: dailyTimeClockEntries Elements
string businessDate Business date of the entries.
timeClockEntry[] timeClockEntries Time clock entries on the business date.
employee
Table 24-11: employee Elements
boolean clockinRequired Indicates whether the employee must

clock in.
string currentWorkCode Current work code for the employee.
string employeeId ID for employee.
string locale Locale for employee.
string partyId Party ID for employee.
string[] privileges Privileges granted to the employee.
employeeAuthResponse
Table 24-12: employeeAuthResponse Elements
employee employee Authorized employee.
employeeMessage
For information about this element, see “employeeMessage”.
employeeTimeClockEntriesResponse
This class extends the timeClockResponse class.
Timeclock 24-7
Classes

Table 24-13: employeeTimeClockEntriesResponse Elements
dailyTimeClockEntr dailyTimeClockEntries Array of time clock entries for the

ies[] employee.
serviceContext
serviceResponse
timeClockEntry
Table 24-14: timeClockEntry Elements
string businessDate Business date.
string clockInTimestamp Clock-in time.
string clockOutTimestamp Clock-out time.
long duration Time between clock-in and clock-out

times.
boolean openEntry Indicates whether the entry is still open.
string workCode Work code assigned to the employee for

the time worked.
timeClockResponse
This class extends then employeeAuthResponse class.
Table 24-15: timeClockResponse Elements
employeeMessage[] employeeMessages Messages for employee.
string failureMessage Failure message.
string status Clocked-in status.
validateTimeClockResponse
This class extends the employeeAuthResponse class.

Classes

Table 24-16: validateTimeClockResponse Elements
workCode[] workCodes Array of work codes for the employee.
workCode
Table 24-17: workCode Elements
string code ID code.
string description Description of the work code.
int sortOrder Order in which the work code is

displayed.
Timeclock 24-9
Classes

25
Transaction
Overview
Transaction Services API. Information can be obtained using the Web Service
The URL for the Transaction Services WSDL is:
https://<hostname>:8443/ws/TransServices?wsdl
Transaction 25-1
Methods
Methods
This section presents the methods used in the Transaction Services API.
addCouponLineItem
posTrans addCouponLineItem (
long TransSeq,
string CouponId,
string CouponType,
string CouponEntryType)
The addCouponLineItem method adds a coupon line item to a transaction.

This method returns a posTrans object.
Table 25-1: addCouponLineItem Variables

originates.
long TransSeq [REQUIRED] Sequence number for the transaction.
string CouponId [OPTIONAL] ID of coupon.
string CouponType [OPTIONAL] Type of coupon.
string CouponEntryType [OPTIONAL] Method used to enter coupon.

Methods
addCreditDebitTenderLineItem
posTrans addCreditDebitTenderLineItem (
long TransSeq,
string TenderId,
string LineItemToken,
string ExpirationDate,
string Cid,
string PostalCode,
decimal TenderAmount,
string AdjudicationCode,
string AuthCode,
string EntryMethodCode,
string Ps2000,
string BankReferenceNumber,
string CustomerName,
string CardLevelIndicator,
string AuthorizationToken,
string Signature,
string AuthMethodCode,
string PinBlock,
string PinSerial)
The addCreditDebitTenderLineItem method adds a credit card tender line item to

a transaction.
Table 25-2: addCreditDebitTenderLineItem Variables

originates.
string TenderId [OPTIONAL] ID of the tender.
string LineItemToken [OPTIONAL] Token referencing the tender’s

account number and track data.
string ExpirationDate [OPTIONAL] Credit card expiration date.
string Cid [OPTIONAL] CID for the credit card.
string PostalCode [OPTIONAL] Postal/ZIP Code.
decimal TenderAmount [OPTIONAL] Amount applied to credit card.
string AdjudicationCode [OPTIONAL] Adjudication code for the credit card.
string AuthCode [OPTIONAL] Authorization code for the credit

card.
Transaction 25-3
Methods
Table 25-2: addCreditDebitTenderLineItem Variables (continued)
string EntryMethodCode [OPTIONAL] Method used to enter the credit card

information.
string Ps2000 [OPTIONAL] PS 2000 data for the credit card.
string BankReference [OPTIONAL] Reference number for the bank

Number associated with the credit card.
string CustomerName [OPTIONAL] Name on the credit card.
string CardLevel [OPTIONAL] Indicator for the card level.

Indicator
string Authorization [OPTIONAL] Authorization token for the credit

Token card.
string Signature [OPTIONAL] Customer signature.
string AuthMethodCode [OPTIONAL] Method used to authorize the credit

card.
string PinBlock [OPTIONAL] PIN block (encrypted).
string PinSerial [OPTIONAL] PIN serial (encrypted).
addCustomerToRetailTrans
posTrans addCustomerToRetailTrans (
string PartyId,
long TransSeq)
The addCustomerToRetailTrans method adds a customer to a transaction.

Table 25-3: addCustomerToRetailTrans Variables

originates.

Methods
addLocalCurrencyTenderLineItem
posTrans addLocalCurrencyTenderLineItem (
long TransSeq,
string TenderId,
decimal TenderAmount)
The addLocalCurrencyTenderLineItem method adds the local currency as a cash

tender line item.
Table 25-4: addLocalCurrencyTenderLineItem Variables

originates.
decimal TenderAmount [OPTIONAL] Amount applied to the tender.
addSaleLineItem
posTrans addSaleLineItem (
long TransSeq,
string ItemIdInputType,
string ItemId,
decimal Qty,
decimal Price,
decimal Weight,
string ItemDescription,
string[] CommissionedAssociates,
itemPromptProperty[] ItemPromptProperties)
The addSaleLineItem method adds a sale line item to a transaction.

Table 25-5: addSaleLineItem Variables

message originates.
long TransSeq [REQUIRED] Sequence number for the

transaction.
Transaction 25-5
Methods
Table 25-5: addSaleLineItem Variables (continued)
string ItemIdInputType [OPTIONAL] Method used to enter Item ID.
string ItemId [OPTIONAL] ID of item to be added.
decimal Qty [OPTIONAL] Quantity of the item.
decimal Price [OPTIONAL] Price of the item.
decimal Weight [OPTIONAL] Weight of the item.
string ItemDescription [OPTIONAL] Description of the item.
string SerialNumber [OPTIONAL] Serial number of the item.
string[] Commissioned [OPTIONAL] Employee IDs of the employees

Associates receiving commissions for the
item.
itemPromptProperty ItemPrompt [OPTIONAL] Properties of prompts associated

[] Properties with the item.
addVoucherSaleLineItem
posTrans addVoucherSaleLineItem (
long TransSeq,
string ItemId,
decimal Qty,
string VoucherId,
decimal Amount,
string AuthCode,
decimal UnspentBalanceAmount,
string AuthMethodCode)
The addVoucherSaleLineItem method adds the sale of a voucher to a transaction.

Table 25-6: addVoucherSaleLineItem Variables

message originates.

transaction.
string ItemId [OPTIONAL] Item ID for the voucher.

Methods
Table 25-6: addVoucherSaleLineItem Variables (continued)
decimal Qty [OPTIONAL] Number of vouchers being sold.
string[] Commissioned [OPTIONAL] IDs of the employees receiving

Associates commissions for the transaction.
string VoucherId [OPTIONAL] ID of the voucher.
string LineItemToken [OPTIONAL] Token that references the credit

card account number and track
data.
decimal Amount [OPTIONAL] Amount of the voucher.
string AdjudicationCode [OPTIONAL] Adjudication code for the

voucher.
string AuthCode [OPTIONAL] Authorization code for the

voucher.
string EntryMethodCode [OPTIONAL] Code identifying the method

used to enter the voucher
information.
string BankReferenceCode [OPTIONAL] Code identifying the bank

associated with the voucher.
decimal UnspentBalance [OPTIONAL] Unspent balance on the voucher.

Amount
string AuthMethodCode [OPTIONAL] Code identifying the method

used to authorize the voucher.
addVoucherTenderLineItem
posTrans addVoucherTenderLineItem (
long TransSeq,
string TenderId,
decimal TenderAmount,
string AuthCode,
string AuthorizationToken,
decimal UnspentBalance,
string AuthMethodCode)
The addVoucherTenderLineItem method adds a voucher tender line item to a

transaction.
Transaction 25-7
Methods

Table 25-7: addVoucherTenderLineItem Variables

originates.
string TenderId [OPTIONAL] Tender ID of the voucher.
string LineItemToken [OPTIONAL] Token that references the credit card

decimal TenderAmount [OPTIONAL] Amount applied to the voucher.
string AdjudicationCode [OPTIONAL] Adjudication code for the voucher.
string AuthCode [OPTIONAL] Authorization code for the voucher.
string EntryMethodCode [OPTIONAL] Code identifying the method used to

enter the voucher.
string BankReference [OPTIONAL] Reference number for the bank

Number associated with the voucher.
string Authorization [OPTIONAL] Authorization token for the voucher.

Token
decimal UnspentBalance [OPTIONAL] Unspent balance left on the voucher.
string AuthMethodCode [OPTIONAL] Code identifying the method used to

authorize the voucher.
applyLineItemTaxExemption
posTrans applyLineItemTaxExemption (
long TransSeq,
long LineNumber,
taxExemption TaxExemption,
string ReasonCode,
string Comment,
The applyLineItemTaxExemption method applies a tax exemption to a line item.

Table 25-8: applyLineItemTaxExemption Variables

message originates.

Methods
Table 25-8: applyLineItemTaxExemption Variables (continued)

transaction.
long LineNumber [OPTIONAL] Line number of the item

receiving the tax exemption.
taxExemption TaxExemption [OPTIONAL] Tax exemption being applied.
string ReasonCode [OPTIONAL] Reason code for the tax

exemption.
string Comment [OPTIONAL] Additional comments.
reasonCodePro ReasonCodePromp [OPTIONAL] Array of reason code prompt

mptProperties[] tProperties properties.
authorizeVoucherSale
authResponse authorizeVoucherSale (
long TransSeq,
string ItemId,
string VoucherId,
string TenderId,
decimal Amount,
string Pin,
string EntryMethodCode)
The authorizeVoucherSale method authorizes the sale of a voucher and activates

the voucher.
This method returns a authResponse object.
Table 25-9: authorizeVoucherSale Variables

originates.
string VoucherId [OPTIONAL] ID of the voucher.
string LineItemToken [OPTIONAL] Token that references the credit card

decimal Amount [OPTIONAL] Amount of the voucher.
Transaction 25-9
Methods
Table 25-9: authorizeVoucherSale Variables (continued)
string Pin [OPTIONAL] PIN for the voucher.
string EntryMethodCode [OPTIONAL] Code identifying the method used

for entering the voucher.
cancelRetailTransaction
statusServiceResponse cancelRetailTransaction (
long TransSeq,
string ReasonCode,
string Comment,
reasonCodePromptProperties[] ReasonCodePromptProperties,
The cancelRetailTransaction method cancels a previously performed retail

transaction.
Table 25-10: cancelRetailTransaction Variables

message originates.

transaction.
string ReasonCode [OPTIONAL] Code identifying the reason for

canceling the transaction.
string Comment [OPTIONAL] Additional comment.
reasonCodePro reasonCodePrompt [OPTIONAL] Array of reason code prompt

mptProperties[] Properties properties.
string ReceiptPrinter [OPTIONAL] ID of the receipt printer.
changeLineItemCommissionedAssociate
posTrans changeLineItemCommissionedAssociate (
long TransSeq,
long LineNumber,
string[] CommissionedAssociates)
The changeLineItemCommissionedAssociate method changes the associate(s)

who are receiving a commission on a transaction line item.

Methods

Table 25-11: changeLineItemCommissionedAssociate Variables

originates.
long LineNumber [OPTIONAL] Line number of the line item.
string[] Commissioned [OPTIONAL] Employee IDs of the associates being

Associates changed.
changeLineItemPrice
posTrans changeLineItemPrice (
long TransSeq,
long LineNumber,
decimal NewPrice,
string ReasonCode,
string Comment,
The changeLineItemPrice method changes the price of a sale line item.

Table 25-12: changeLineItemPrice Variables

message originates.

transaction.
long LineNumber [REQUIRED] Line number of item.
decimal NewPrice [OPTIONAL] New price for item.
string ReasonCode [OPTIONAL] Code identifying reason for price

change.

Transaction 25-11
Methods
changeLineItemQty
posTrans changeLineItemQty (
long TransSeq,
long LineNumber,
decimal NewQty)
The changeLineItemQty method changes the quantity of a sale line item.

Table 25-13: changeLineItemQty Variables

originates.
long LineNumber [REQUIRED] Line number of the item.
decimal NewQty [OPTIONAL] New item quantity.
changeLineItemTax
posTrans changeLineItemTax (
long TransSeq,
long LineNumber,
decimal TaxAmount,
decimal TaxPercent,
string ReasonCode,
string Comment,
The changeLineItemTax method changes the tax on a sale line item.

Table 25-14: changeLineItemTax Variables

message originates.

transaction.
long LineNumber [REQUIRED] Line number of item to which

the tax is being applied.
decimal TaxAmount [OPTIONAL] Amount of the tax.

Methods
Table 25-14: changeLineItemTax Variables (continued)
decimal TaxPercent [OPTIONAL] Percentage of the tax.
string ReasonCode [OPTIONAL] Reason code indicating the

reason for assigning the tax.

changeLineItemTaxLocation
posTrans changeLineItemTaxLocation (
long TransSeq,
long LineNumber,
string TaxLocationId,
string ReasonCode,
string Comment,
The changeLineItemTaxLocation method changes the tax location for a sale line
item.
Table 25-15: changeLineItemTaxLocation Variables

message originates.

transaction.
long LineNumber [REQUIRED] Line number to be changed.
string TaxLocationId [OPTIONAL] ID of the new tax location.

changing the tax location.

Transaction 25-13
Methods
changeTransactionCommissionedAssociate
posTrans changeTransactionCommissionedAssociate (
long TransSeq,
string[] CommissionedAssociates)
The changeTransactionCommissionedAssociate method changes the associate(s)

receiving a commission for an entire transaction.
Table 25-16: changeTransactionCommissionedAssociate Variables

originates.
string[] Commissioned [OPTIONAL] IDs of employees receiving a

Associates commission for the transaction.
changeTransactionTax
posTrans changeTransactionTax (
long TransSeq,
decimal TaxAmount,
decimal TaxPercent,
string ReasonCode,
string Comment,
The changeTransactionTax method changes the tax applied to a transaction.

Table 25-17: changeTransactionTax Variables

message originates.

transaction.
decimal TaxAmount [OPTIONAL] New tax amount for the

transaction.
decimal TaxPercent [OPTIONAL] New tax percentage for the

transaction.
string ReasonCode [OPTIONAL] ID code for the reason for the

change.

Methods
Table 25-17: changeTransactionTax Variables (continued)
string Comment [OPTIONAL] Comments on the change.
reasonCodePro ReasonCodePromp [OPTIONAL] Array of properties for reason

mptProperties[] tProperties code prompts.
changeTransactionTaxLocation
posTrans changeTransactionTaxLocation (
long TransSeq,
string TaxLocationId,
string ReasonCode,
string Comment,
The changeTransactionTaxLocation method changes the location used for tax

purposes in a transaction.
Table 25-18: changeTransactionTaxLocation Variables

message originates.

transaction.
string TaxLocationId [OPTIONAL] ID of the new tax location.
string ReasonCode [OPTIONAL] ID code for the reason for

changing the tax location.

Transaction 25-15
Methods
commitRetailTransaction
statusServiceResponse commitRetailTransaction (
long TransSeq,
long[] GiftRcptLines,
string EmailAddress,
boolean PrintReceipt,
The commitRetailTransaction method commits a retail transaction so that it is

logged in the system.
Table 25-19: commitRetailTransaction Variables

originates.
long[] GiftRcptLines [OPTIONAL] Array of line numbers for which gift

receipts are to be printed.
string EmailAddress [OPTIONAL] Email address to which the gift

receipts will be sent.
boolean PrintReceipt [OPTIONAL] Determines whether physical receipts

will be printed.
string ReceiptPrinter [OPTIONAL] ID of the receipt printer to use, if

PrintReceipt is set to true.
convertSaleItemToSendSale
sendSaleTransResponse convertSaleItemToSendSale (
long TransSeq,
long LineNumber,
sendSaleAccount SendSaleAccount)
The convertSaleItemToSendSale method changes a sale item to a send sale item.

This method returns a sendSaleTransResponse object.
Table 25-20: convertSaleItemToSendSale Variables

message originates.

Methods
Table 25-20: convertSaleItemToSendSale Variables (continued)

transaction.
long LineNumber [REQUIRED] Line number of the item being

converted to send sale.
sendSaleAccoun SendSaleAccount [OPTIONAL] Account to which the send sale

t item is being added.
convertSendSaleItemToSale
posTrans convertSendSaleItemToSale (
long TransSeq,
long LineNumber)
The convertSendSaleItemToSale method changes a send sale item to a sale item.

Table 25-21: convertSendSaleItemToSale Variables

originates.
long LineNumber [REQUIRED] Line number of the item.
createNewRetailTransaction
posTrans createNewRetailTransaction (
The createNewRetailTransaction method creates a new retail transaction in the

system.
Table 25-22: createNewRetailTransaction Variables

originates.
Transaction 25-17
Methods
createOrderSale
orderSaleTransResponse createOrderSale (
long TransSeq,
orderSaleAccount OrderSaleAccount)
The createOrderSale method creates an order sale.

This method returns a orderSaleTransResponse object.
Table 25-23: createOrderSale Variables

message originates.

transaction.
orderSaleAccou OrderSaleAccount [OPTIONAL] Account associated with the

nt order.
discountGroupLineItems
posTrans discountGroupLineItems (
long TransSeq,
long[] LineNumbers,
string DiscountCode,
decimal DiscountAmt,
decimal DiscountPercent,
string DiscountSerialNumber,
string ReasonCode,
string Comment,
The discountGroupLineItems method applies a discount to a sale line item.

Table 25-24: discountGroupLineItems Variables

message originates.

transaction.
long[] LineNumbers [OPTIONAL] Line numbers of the items being

discounted.
string DiscountCode [OPTIONAL] ID code for the discount.

Methods
Table 25-24: discountGroupLineItems Variables (continued)
decimal DiscountAmt [OPTIONAL] Amount of the discount.
decimal DiscountPercent [OPTIONAL] Percentage of the discount.
string DiscountSerial [OPTIONAL] Serial number of the discount.

Number

discount.

discountLineItem
posTrans discountLineItem (
long TransSeq,
long LineNumber,
decimal NewQty,
decimal NewPrice,
string ReasonCode,
string Comment,
reasonCodePromptProperties ReasonCodePromptProperties)
The discountLineItem method applies a discount to a sale line item.

Table 25-25: discountLineItem Variables

message originates.

transaction.
long LineNumber [REQUIRED] Line number receiving the

discount.
string DiscountCode [OPTIONAL] Code identifying the discount.
Transaction 25-19
Methods
Table 25-25: discountLineItem Variables (continued)
decimal NewQty [OPTIONAL] New item quantity.
decimal NewPrice [OPTIONAL] New price.

Number

applying the discount.
reasonCodePro ReasonCodePromp [OPTIONAL] Array of reason codes associated

mptProperties[] tProperties with the discount.
discountTransaction
posTrans discountTransaction (
long TransSeq,
string ReasonCode,
string Comment,
The discountTransaction method applies a discount to a transaction.

Table 25-26: discountTransaction Variables

message originates.

transaction.
string DiscountCode [OPTIONAL] Code identifying the discount.

Number

the discount.

Methods
Table 25-26: discountTransaction Variables (continued)

finalizeRetailTransaction
statusServiceResponse finalizeRetailTransaction (
long TransSeq)
The finalizeRetailTransaction method completes a retail transaction.

Table 25-27: finalizeRetailTransaction Variables

originates.
generateRetailTransactionDocuments
statusServiceResponse generateRetailTransactionDocuments (
long TransSeq,
The generateRetailTransactionDocuments method creates transaction

documents (such as receipts) and emails and/or prints them.
Table 25-28: generateRetailTransactionDocuments Variables

originates.
string EmailAddress [OPTIONAL] Email address to which the

transaction documents are to be sent.
If left blank, documents will not be
emailed.
Transaction 25-21
Methods
Table 25-28: generateRetailTransactionDocuments Variables (continued)
boolean PrintReceipt [OPTIONAL] Indicates whether the documents are

to be printed.
string ReceiptPrinter [OPTIONAL] ID of printer where documents are to

be printed.
getBounceBackCoupon
bounceBackCouponResponse getBounceBackCoupon (
long TransSeq)
The getBounceBackCoupon method retrieves a bounceback coupon from a

transaction.
This method returns a bounceBackCouponResponse object.
Table 25-29: getBounceBackCoupon Variables

originates.
long TransSeq [optional] Sequence number of the line item in

the transaction.
getEligibleGiftReceiptItems
giftReceiptEligibilityResponse getEligibleGiftReceiptItems (
The getEligibleGiftReceiptItems method retrieves a list of all items in the

current transaction for which a gift receipt can be printed.
This method returns a giftReceiptEligibilityResponse object.
Table 25-30: getEligibleGiftReceiptItems Variables

originates.

Methods
getPosConfig
posConfiguration getPosConfig (
The getPosConfig method retrieves configuration information for the local POS
system.
This method returns a posConfiguration object.
Table 25-31: getPosConfig Variables

originates.
getSuspendedTransactions
suspendedTransResultResponse getSuspendedTransactions (
The getSuspendedTransactions method retrieves a list of all the suspended

transactions.
This method returns a suspendedTransResultResponse object.
Table 25-32: getSuspendedTransactions Variables

originates.
getTransPromptProperties
transPromptPropertyResponse getTransPromptProperties (
long TransSeq,
string TransState)
The getTransPromptProperties method retrieves all prompt properties for a

transaction.
This method returns a transPromptPropertyResponse object.
Table 25-33: getTransPromptProperties Variables

originates.
Transaction 25-23
Methods
Table 25-33: getTransPromptProperties Variables (continued)
string TransState [OPTIONAL] State of the transaction.
isBounceBackCouponInRange
validationResponse isBounceBackCouponInRange (
string DocId)
The isBounceBackCouponInRange indicates whether a bounceback coupon is in

range.
Table 25-34: isBounceBackCouponInRange Variables

originates.
string DocId [REQUIRED] ID for the bounceback coupon.
issueRedeemBounceBackCoupon
validationResponse issueRedeemBounceBackCoupon (
long TransSeq,
string SeriesId,
string DocId,
string DocStatus,
string DocType,
date IssueDate,
date EffectiveDate,
date ExpirationDate,
decimal MaxAmount,
string Action,
string DealId)
The issueRedeemBounceBackCoupon method issues and redeems bounceback

coupons.
Table 25-35: issueRedeemBounceBackCoupon Variables

originates.

Methods
Table 25-35: issueRedeemBounceBackCoupon Variables (continued)
string SeriesId [OPTIONAL] ID of the bounceback coupon series.
string DocId [OPTIONAL] ID of the bounceback coupon.
string DocStatus [OPTIONAL] Status of the bounceback coupon.
string DocType [OPTIONAL] Type of bounceback coupon.
date IssueDate [OPTIONAL] Date on which the bounceback

coupon was issued.
date EffectiveDate [OPTIONAL] First date on which the bounceback

coupon can be redeemed.
date ExpirationDate [OPTIONAL] Last date on which the bounceback

coupon can be redeemed.
decimal MaxAmount [OPTIONAL] Maximum amount of the bounceback

coupon.
string Action [OPTIONAL] Action being performed on the

bounceback coupon.
string DealId [OPTIONAL] ID of the deal associated with the

bounceback coupon.
joinLoyaltyProgram
posTrans joinLoyaltyProgram (
long TransSeq,
string[] CustomerCardInput,
string CustomerCardInputType,
string PartyId)
The joinLoyaltyProgram method adds a customer to a loyalty program.

Table 25-36: joinLoyaltyProgram Variables

message originates.

transaction.
string[] CustomerCardInput [OPTIONAL] IDs of loyalty cards.
string CustomerCardInputType [OPTIONAL] Method used to enter loyalty

cards data.
Transaction 25-25
Methods
Table 25-36: joinLoyaltyProgram Variables (continued)
string PartyId [OPTIONAL] Party ID for a customer.
lookupTrans
posTrans lookupTrans (
long TransSeq,
dateTime BusinessDate,
long RetailLocationId,
long WorkstationId)
The lookupTrans method searches for a transaction.

Table 25-37: lookupTrans Variables

originates.
dateTime BusinessDate [OPTIONAL] Business date of the transaction.
long RetailLocationId [OPTIONAL] ID of the retail location where the

long WorkstationId [OPTIONAL] ID of the workstation where the

lookupTransByBarcode
posTrans lookupTransByBarcode (
string Barcode)
The lookupTransByBarcode method retrieves a transaction by a receipt barcode.

Table 25-38: lookupTransByBarcode Variables

originates.
string Barcode [OPTIONAL] Barcode to look up.

Methods
postVoidTransaction
statusServiceResponse postVoidTransaction (
long TransSeq,
dateTime BusinessDate,
long WorkstationId,
The postVoidTransaction method post voids a transaction.

Table 25-39: postVoidTransaction Variables

originates.
dateTime BusinessDate [OPTIONAL] Date of the transaction that is being

post voided.
long RetailLocationId [REQUIRED] ID of the location where the

long WorkstationId [REQUIRED] ID of the workstation where the

redeemLoyaltyAward
posTrans redeemLoyaltyAward (
long TransSeq,
string LoyaltyCardNumber,
string LoyaltyAwardAcctId,
decimal LoyaltyAwardAmount,
string[] LoyaltyAwardCoupons)
The redeemLoyaltyAward method redeems a loyalty award.

Table 25-40: redeemLoyaltyAward Variables

message originates.
Transaction 25-27
Methods
Table 25-40: redeemLoyaltyAward Variables (continued)

transaction.
string LoyaltyCardNumber [OPTIONAL] Card number of loyalty card.
string LoyaltyAwardAcctId [OPTIONAL] ID of loyalty award account.
string LoyaltyAwardAmount [OPTIONAL] Amount to be redeemed.
string[] LoyaltyAwardCoupons [OPTIONAL] Coupons given by the

redemption.
refreshTransaction
posTrans refreshTransaction (
long TransSeq)
The refreshTransaction method retrieves transaction information currently stored

in the system.
Table 25-41: refreshTransaction Variables

originates.
regenerateTransactionDocuments
statusServiceResponse regenerateTransactionDocuments (
long WorkstationId,
date BusinessDate,
long TransSeq,
The regenerateTransactionDocuments method regenerates, reprints, and/or

resends transaction documents (receipts, invoices, emails, etc.) created by a transaction.
This includes printing, sending, or saving documents in the same manner as the original
transaction.

Methods

Table 25-42: regenerateTransactionDocuments Variables

originates.
long RetailLocationId [REQUIRED] ID of the transaction’s retail location.

date BusinessDate [OPTIONAL] Business date of the transaction.
string EmailAddress [OPTIONAL] Email address to which the

documents will be sent.
boolean PrintReceipt [OPTIONAL] Determines whether the physical

receipt(s) will be reprinted.
string ReceiptPrinter [OPTIONAL] ID of the receipt printer to use if

PrintReceipt is true. If this value
is null, the receipt(s) will be sent to
the default printer.
removeCustomerFromRetailTrans
posTrans removeCustomerFromRetailTrans (
long TransSeq)
The removeCustomerFromRetailTrans method removes a customer association

from a transaction.
Table 25-43: removeCustomerFromRetailTrans Variables

originates.
resumeTransaction
resumeTransResponse resumeTransaction (
long TransSeq)
The resumeTransaction method resumes a suspended transaction.
Transaction 25-29
Methods
This method returns a resumeTransResponse object.

Table 25-44: resumeTransaction Variables

originates.
saveSendSaleAddress
sendSaleAccountResponse saveSendSaleAddress (
long TransSeq,
sendSaleAccount SendSaleAccount)
The saveSendSaleAddress method saves the address to which send sale items are to
be sent.
This method returns a sendSaleAccountResponse object.
Table 25-45: saveSendSaleAddress Variables

message originates.

transaction.
sendSaleAccoun SendSaleAccount [OPTIONAL] Send sale account information to

t be saved.
searchTrans
transactionListResponse searchTrans (
long TransSeq,
dateTime StartBusinessDate,
dateTime EndBusinessDate,
long WorkstationId,
string EmployeeId,
string CustomerName,
string CustomerId,
string LineItemToken)
The searchTrans method searches for a set of transaction matching the search criteria.

Methods
This method returns a transactionListResponse object.

Table 25-46: searchTrans Variables

message originates.

transaction.
dateTime StartBusinessDate [OPTIONAL] Date and time the transaction

started.
dateTime EndBusinessDate [OPTIONAL] Date and time the transaction

ended.
long RetailLocationId [REQUIRED] ID of the location where the


string EmployeeId [OPTIONAL] ID of the employee who

performed the transaction.
string CustomerName [OPTIONAL] Name of the customer associated

with the transaction.
string CustomerId [OPTIONAL] ID of the customer associated

with the transaction.
string LineItemToken [OPTIONAL] Token referencing the tender

searchTransByCustomerAndItem
transactionListResponse searchTransByCustomerAndItem (
string CustomerId,
string ItemId)
The searchTransByCustomerAndItem method searches for all transactions

associated with a customer containing a certain item.
This method returns a transactionListResponse object.
Table 25-47: searchTransByCustomerAndItem Variables

originates.
string CustomerId [OPTIONAL] ID of the customer.
Transaction 25-31
Methods
selectLoyaltyCard
posTrans selectLoyaltyCard (
long TransSeq,
string[] CustomerCardInput,
string CustomerCardInputType)
The selectLoyaltyCard method adds a customer card to a transaction.

Table 25-48: selectLoyaltyCard Variables

message originates.

transaction.
string[] CustomerCardInput [OPTIONAL] Array of ID for loyalty cards.
string CustomerCardInputType [OPTIONAL] Method used to enter loyalty

cards data.
setTaxExemptionAccount
posTrans setTaxExemptionAccount (
taxExemption TaxExemption,
long TransSeq)
The setTaxExemptionAccount method adds a tax exemption account to a

transaction.
Table 25-49: setTaxExemptionAccount Variables

originates.
taxExemption taxExemption [REQUIRED] Tax exemption account.
long TransSeq [OPTIONAL] Sequence number of the transaction

to which the tax exemption will be
applied.

Methods
setTransProperties
posTrans setTransProperties (
long TransSeq,
transPromptProperty[] TransPromptProperties)
The setTransProperties method sets the properties for a transactions.

Table 25-50: setTransProperties Variables

originates.
transPromptPr TransPrompt [OPTIONAL] Properties of transaction prompts.

operty[] Properties
suspendRetailTransaction
statusServiceResponse suspendRetailTransaction (
long TransSeq,
long[] GiftRcptLines,
string TransProperty,
The suspendRetailTransaction method suspends a retail transaction.

Table 25-51: suspendRetailTransaction Variables

originates.
long TransSeq [REQUIRED] Sequence number in transaction.
long[] GiftRcptLines [OPTIONAL] Sequence numbers of gift receipts

associated with the transaction.
string TransProperty [OPTIONAL] Transaction property.
Transaction 25-33
Methods
updateSendSaleItems
sendSaleTransResponse updateSendSaleItems (
long TransSeq,
sendSaleAccount[] SendSaleAccounts)
The updateSendSaleItems method updates the list of send sale items in a set of send
sale accounts.
This method returns a sendSaleTransResponse object.
Table 25-52: updateSendSaleItems Variables

message originates.

transaction.
sendSaleAccount[ SendSaleAccounts [OPTIONAL] Array of send sale account

] updates.
validateCommissionedAssociates
validationResponse validateCommissionedAssociates (
int MinNumberCommissionedAssociates,
int MaxNumberCommissionedAssociates)
The validateCommissionedAssociates method checks whether a set of

commissioned associates are valid.
Table 25-53: validateCommissionedAssociates Variables

message originates.
string[] Commissioned [OPTIONAL] IDs of employees to be validated.

Associates
int MinNumberCommissio [REQUIRED] Minimum number of associates

nedAssociates to be assigned to a commission.
int MaxNumberCommissi [REQUIRED] Maximum number of associates

onedAssociates to be assigned to a commission.

Methods
validateCreditCardTender
validationResponse validateCreditCardTender (
long TransSeq,
string TenderId,
The validateCreditCardTender method validates whether a credit card tender can

be used in a transaction.
Table 25-54: validateCreditCardTender Variables

message originates.
long TransSeq [REQUIRED] Sequence number of the

transaction.

data.
string EntryMethodCode [OPTIONAL] ID code for the method used to

enter the credit card number.
validateGroupDiscount
validationResponse validateGroupDiscount (
long TransSeq,
long[] LineNumbers)
The validateGroupDiscount method validates whether one or more line items are
eligible for a given group discount.
Table 25-55: validateGroupDiscount Variables

originates.
long TransSeq [REQUIRED] Sequence number of the transaction.
Transaction 25-35
Methods
Table 25-55: validateGroupDiscount Variables (continued)
long[] LineNumbers [OPTIONAL] Array of line numbers to which the

discount will be applied.
validateLineItemChangePrice
validationResponse validateLineItemChangePrice (
long TransSeq,
long LineNumber)
The validateLineItemChangePrice method checks whether a price change can be

made on a sale line item.
Table 25-56: validateLineItemChangePrice Variables

originates.
long LineNumber [REQUIRED] Line number of the item whose price

is being changed.
validateLineItemChangeQty
validationResponse validateLineItemChangeQty (
long TransSeq,
long LineNumber)
The validateLineItemChangeQty method checks whether the quantity can be

changed on a sale line item.
Table 25-57: validateLineItemChangeQty Variables

originates.
long LineNumber [REQUIRED] Line number of the line item being

changed.

Methods
validateLineItemDiscount
validationResponse validateLineItemDiscount (
long TransSeq,
long LineNumber)
The validateLineItemDiscount method checks whether a discount can be applied

to a sale line item.
Table 25-58: validateLineItemDiscount Variables

originates.
long LineNumber [REQUIRED] Line number of the discount.
validateLineItemVoid
validationResponse validateLineItemVoid (
long TransSeq,
long LineNumber)
The validateLineItemVoid method checks whether a sale line item can be voided.
Table 25-59: validateLineItemVoid Variables

originates.
long LineNumber [REQUIRED] Line number of the line item being

validated.
Transaction 25-37
Methods
validateTenderLineItemVoid
validationResponse validateTenderLineItemVoid (
long TransSeq,
long LineNumber)
The validateTenderLineItemVoid method checks whether a tender line item can

be voided.
Table 25-60: validateTenderLineItemVoid Variables

originates.
long LineNumber [REQUIRED] Line number of the tender line item

being validated.
validateTransactionDiscount
validationResponse validateTransactionDiscount (
long TransSeq,
string DiscountAmt,
string DiscountPercent,
string ReasonCode,
string Comment)
The validateTransactionDiscount method validates whether a transaction

discount can be applied to a transaction.
Table 25-61: validateTransactionDiscount Variables

originates.
decimal DiscountPercent [OPTIONAL] Discount percentage.

Methods
Table 25-61: validateTransactionDiscount Variables (continued)

Number

discount.
validateVoucherSale
validateSaleVoucherResponse validateVoucherSale (
long TransSeq,
string ItemId,
string VoucherId,
string ActivityType,
string VoucherNumber,
trackSet TrackSet,
trackSet EncryptedTrackSet,
string HardwareId,
The validateVoucherSale method checks whether a voucher can be sold.

This method returns a validateSaleVoucherResponse object.
Table 25-62: validateVoucherSale Variables

originates.
string VoucherId [OPTIONAL] ID for the voucher.
string ActivityType [OPTIONAL] Type of validation activity.
string VoucherNumber [OPTIONAL] ID number of the voucher.
trackSet TrackSet [OPTIONAL] Track data for the voucher.
trackSet EncryptedTrackSet [OPTIONAL] Encrypted track data for the voucher.
string HardwareId [OPTIONAL] ID of the hardware used to determine

the decryption method.
string EntryMethodCode [OPTIONAL] Method used to enter the voucher.
Transaction 25-39
Methods
validateVoucherTender
validationResponse validateVoucherTender (
long TransSeq,
string TenderId,
The validateVoucherTender method checks whether a voucher is valid.

Table 25-63: validateVoucherTender Variables

originates.
string TenderId [OPTIONAL] ID of the voucher tender.
string LineItemToken [OPTIONAL] Token referencing the account

number and track data.
string EntryMethodCode [OPTIONAL] Method used to enter the account

information.
voidLineItem
posTrans voidLineItem (
long TransSeq,
long LineNumber,
string ReasonCode,
string Comment,
The voidLineItem method voids a sale line item.

Table 25-64: voidLineItem Variables

message originates.

transaction.
long LineNumber [REQUIRED] Line number of the line item

being voided.

Methods
Table 25-64: voidLineItem Variables (continued)

voiding the item.

voidLineItemDiscount
posTrans voidLineItemDiscount (
long TransSeq,
long LineNumber,
long PropertyLineNumber)
The voidLineItemDiscount method voids a discount applied to a sale line item.

Table 25-65: voidLineItemDiscount Variables

originates.
long LineNumber [REQUIRED] Line number of discount being

voided.
long PropertyLine [REQUIRED] Line number of the property.

Number
voidTenderLineItem
posTrans voidTenderLineItem (
long TransSeq,
long LineNumber,
string ReasonCode,
string Comment,
The voidTenderLineItem method voids a tender line item.
Transaction 25-41
Classes

Table 25-66: voidTenderLineItem Variables

message originates.

transaction.
long LineNumber [REQUIRED] Line number of the tender line

item.

data.

voiding the tender.

voidTransactionDiscount
posTrans voidTransactionDiscount (
long TransSeq,
long LineNumber)
The voidTransactionDiscount method voids a discount applied to an entire

transaction.
Table 25-67: voidTransactionDiscount Variables

originates.
long LineNumber [REQUIRED] Line number of the discount.
Classes
authResponse

Classes

Table 25-68: authResponse Elements
string adjudicationCode Adjudication code.
decimal approvedAmount Amount approved.
tenderMoreInfo[ authInfo Additional tender authorization

] information.
string authMessage Authorization message.
string authNumber Authorization number.
string authStatus Authorization status.
string authorizationToken Authorization token.
string bankReferenceNumber Bank reference number.
string cardLevelIndicator Indicator for card level.
string customerName Name of customer.
string entryMethodCode Method used to enter tender.
string[] failedOptions Array of failed options.
string lineItemToken Token that references the credit card

string ps2000 PS2000 data.
decimal unspentBalanceAmount Balance remaining.
awardCoupon
Table 25-69: awardCoupon Elements
boolean changed Indicates whether the coupon has been

changed.
decimal couponAmount Amount of the coupon.
dateTime expirationDate Date on which the award expires.
Transaction 25-43
Classes
bounceBackCoupon
Table 25-70: bounceBackCoupon Elements
decimal amtToNextBounceBackCoupon Amount customer must spend before

receiving another bounceback coupon.
decimal amtToTriggerPromptBefore Amount customer must spend before

ThresholdMet receiving a prompt for how close they are
to another bounceback coupon.
decimal bounceBackCouponAmt Amount of the bounceback coupon.
boolean bounceBackCouponInTransaction Indicates whether the customer received a

bounceback coupon in the transaction.
string bounceBackDescription Description of the bounceback coupon.
decimal bounceBackThresholdAmt Amount customer must spend to receive

the bounceback coupon.
boolean bounceBackThresholdMet Indicates whether the customer has met

the bounceback coupon threshold.
string dealId ID of the deal associated with the

bounceback coupon.
dateTime effectiveDate First date on which the bounceback

coupon is valid.
dateTime endDate Last date on which the bounceback

coupon is valid.
bounceBackCouponResponse
Table 25-71: bounceBackCouponResponse Elements
bounceBackCoupon bounceBackCoupon The bounceback coupon.
boolean valid Indicates whether the bounceback coupon

is valid.
codeValueObject

Classes
boolean clockInFlag Indicates whether the employee/

associated was clocked in.
customerLoyaltyCard
Table 25-73: customerLoyaltyCard Elements
string cardNumber Card number.
boolean changed Indicates whether the card has been

changed.
dateTime effectiveDate Date after which the card is effective.
dateTime expirationDate Date after which the card is inactive.
string partyId ID of the party associated with the card.
decimal pointsToNextAward Number of the points to the next award.
string primaryAwardAcctId ID of primary award account.
decimal primaryAwardBalance Current balance of the award account.
awardCoupon[] primaryAwardCoupons Award coupons issued by the primary

award account.
decimal primaryLoyaltyBalance Current balance of the primary loyalty

account.
giftReceiptEligibilityResponse
Table 25-74: giftReceiptEligibilityResponse Elements
int[] eligibleLineItems Item IDs for eligible items.
Transaction 25-45
Classes
item
itemPromptProperty
For a description of this class, see “itemPromptProperty”.
orderSaleAccount
Table 25-75: orderSaleAccount Elements
string address1 Line 1 of the customer’s address.
string apt Apartment number for customer.
string email Customer email address.
string orderType Type of order. Valid entries are:

• STANDARD_DELIVERY,
• STANDARD_PICKUP and
• DELAYED_PICKUP.
string postalCode Postal/ZIP code for customer.
string telephone1 Customer telephone number.
orderSaleTransResponse
Table 25-76: orderSaleTransResponse Elements
orderSaleAccount orderSaleAccount Account associated with the order sale.

Classes
Table 25-76: orderSaleTransResponse Elements (continued)
posTrans posTrans Order sale transaction.
posConfiguration
Table 25-77: posConfiguration Elements
codeValueObject availableContactPreferences Contact preferences available on the

[] system.
codeValueObject availableCustGroups Customer groups available on the system.

[]
codeValueObject availableOrgTypes Organization types available on the

[] system.
tender[] availableTenders Tenders available on the system.
string taxDisplayRule Rules used for displaying tax on the

system.
posTrans
Table 25-78: posTrans Elements
decimal amountDue Amount due for the transaction.
bounceBackCoupon bounceBackCoupon Bounceback coupon information for the

transaction.
dateTime businessDate Business date of the transaction.
string cashierId Employee ID of the cashier who

performed the transaction.
boolean changed Indicates whether the transaction has

been changed since it was performed.
string customerEmailAddress Email address for the customer.
string customerFirstName First name of the customer.
string customerLastName Last name of the customer.
posTransDiscountLine discountLines Array of discounts used in the

[] transaction.
Transaction 25-47
Classes
Table 25-78: posTrans Elements (continued)
customerLoyaltyCard loyaltyCard Loyalty card used in the transaction.
posTransSaleLine[] saleLines Array of sale line items in the transaction.
posTenderLine[] tenderLines Array of tender line items in the

transaction.
decimal totalDiscountAmt Total amount of all discounts in the

transaction.
int totalItemSold Number of items sold in the transaction.
decimal totalTaxAmt Total amount of all taxes in the

transaction.
decimal totalTenderAmt Total amount of all tenders used in the

transaction.
transPromptProperty[] transProperties Array of transaction prompt properties.
long transSeq Sequence number of the transaction.
decimal transSubTota Transaction subtotal amount.
decimal transTotal Transaction total amount due.
posTransDiscountLine
Table 25-79: posTransDiscountLine Elements
boolean changed Indicates whether the discount line was

changed.
decimal discountAmount Amount of the discount.
string discountCode Code identifying the discount.
string discountDescription Description of the discount.
decimal discountPercent Percentage of the discount.

long lineNumber Line number on which the transaction

occurs.
string serialNumber Serial number of the coupon through

which the discount was applied.
boolean voidFlag Indicates whether the discount was

voided.

Classes
posTransSaleLine
Table 25-80: posTransSaleLine Elements
string authCode Authorization code for the sale

line.
boolean changed Indicates whether the sale line

has been changed.
commissionedAssociate[] commissionedAssociates Array of associates who received

a commission on the sale line.
boolean giftReceiptFlag Indicates whether a gift receipt

was given for the sale line.
item item Item on the sale line.
string itemSerialNumber Serial number of the item.
string lineItemToken Token that references the credit

data.
long lineNumber Line number of the sale line.
posTransSaleLineProperti properties Properties of the sale line.

es[]
decimal qty Quantity of the item.
decimal quantityAvailableForReturn Quantity of the item that can be

returned.
decimal returnedQuantity Quantity of the item returned.
string saleItemType Type of sale item.
decimal totalLineDiscountAmount Total amount of all discounts

applied to the sale line.
decimal totalLinePrice Total price of the line.
decimal unitPrice Price of one unit of the sale line

item.
boolean voidFlag Indicates whether the sale line

was voided.
Transaction 25-49
Classes
posTransSaleLineProperties
Table 25-81: posTransSaleLineProperties Elements
boolean changed Indicates whether the properties have

been changed.
string description Description of the sale line.
long lineNumber Line number within the transaction.
string propertyId ID of the property.
string propertyType Type of property.
string serialNumber Serial number of the sale line item.
decimal totalPropertyAmt Total amount of property on the sale line.
decimal unitAmt Quantity of the item that equates to one

sale unit.
boolean voidFlag Indicates whether the sale line was

voided.
posTenderLine
Table 25-82: posTenderLine Elements
string accountNumber Account number for the tender.
string adjudicationCode Adjudication code.
decimal amount Amount applied to the tender.
string authCode Authorization code.
string bankReferenceNumber Bank reference number.
string cardLevelIndicator Indicator for card level.
boolean changed Indicates whether the tender line was

changed.
string cid Customer identification information.
string customerName Name of customer.
string entryMethod Entry method for the tender.
string expDate Expiration date of the tender.
string last4Digits Last 4 digits of a card number.

Classes
Table 25-82: posTenderLine Elements (continued)

long lineNumber Line number of the tender line.
string maskAccountNumber The masked account number.
string ps2000 PS2000 data.
string tenderDescription Description of the tender.
string tenderId ID of the tender.
string tenderType Type of tender.
string track1 Track 1 data.
boolean voidFlag Indicates whether the tender line was

voided.
string zip Zip code.
Table 25-83: reasonCodePromptProperties Elements
string promptDataType Type of data requested by the prompt.
string promptTypeCode ID code for the type of prompt.
string value Value of the reason code.

entered.
resumeTransResponse
Table 25-84: resumeTransResponse Elements
customerParty customerParty Customer associated with the transaction.
Transaction 25-51
Classes
Table 25-84: resumeTransResponse Elements (continued)
posTrans resumedTransaction Transaction that was resumed.
sendSaleAccount
Table 25-85: sendSaleAccount Elements
string apt Apartment number for customer.
item[] availableShippingFeeItems Array of items that are available for

shipping.
string bldg Customer building.
string block Customer block.
string district Customer district.
int[] lineItems Item IDs assigned to the account.
string postalCode Postal/ZIP code for customer.
boolean promptShippingFeeAmount Indicates whether to prompt the user for

a shipping fee amount.
string shipToStoreName Name of the store where the items are to

be shipped.
string shipToStoreNumber ID of the store where the items are to be

shipped.
decimal shippingFeeAmount Amount of the shipping fee.
string shippingFeeItemId Item ID for the shipping fee.
string shippingFeeItemIdPrevious Item ID for the original shipping fee.
string shippingMethod Method used to ship items.

Classes
Table 25-85: sendSaleAccount Elements (continued)
string telephone1 Customer telephone number.
string trackingCode Tracking code for the send sale.
sendSaleAccountResponse
Table 25-86: sendSaleAccountResponse Elements
posTrans posTrans Updated transaction.
sendSaleAccount sendSaleAccount Updated send sale account information.
sendSaleTransResponse
Table 25-87: sendSaleTransResponse Elements
sendSaleAccount[] changedSendSaleAccounts Send sale accounts affected by the action.
posTrans posTrans Transaction information.
serviceContext
serviceResponse
sourceStoreInfo
Table 25-88: sourceStoreInfo Elements
string address1 First line of the address.
string address2 Second line of the address.
string city Store city.
string country Store country.
Transaction 25-53
Classes
Table 25-88: sourceStoreInfo Elements (continued)
string locationId ID of the location.
string locationName Name of the location.
string postalCode Postal/Zip code for the store.
string state Store state.
string systemCode System code for the store.
suspendedTrans
Table 25-89: suspendedTrans Elements
dateTime businessDate Date of the transaction.
string cashierId ID of the cashier performing the transaction.
string customerName Name of the customer associated with the transaction.
long organizationId ID of the organization.
long retailLocationId ID of the store.
dateTime startingTime Time at which the transaction started.
long transSeq Sequence number for the transaction.
long workstationId ID of the workstation where the transaction was being

performed.
suspendedTransResultResponse
Table 25-90: suspendedTransResultResponse Elements
suspendedTrans[] suspendedTrans Array of suspended transactions.
taxExemption
For a description of this class, see “taxExemption”.

Classes
tender
For a description of this class, see “tender”.
tenderMoreInfo
Table 25-91: tenderMoreInfo Elements
tenderMoreInfoField[] moreInfoFields Array of fields containing more

information.
string moreInfoMessage Message for more information.
tenderMoreInputField[] moreInputFields Array of fields containing more input.
tenderMoreInfoField
Table 25-92: tenderMoreInfoField Elements
string infoData Information data.
string infoLabel Information label.
tenderMoreInputField
Table 25-93: tenderMoreInputField Elements
string inputData Data input.
string inputLabel Label for input.
trackSet
For a description of this class, see “trackSet”.
transPromptProperty
Table 25-94: transPromptProperty Elements
string[] possibleValues Array of possible values for the prompt

property.
string promptMethod Method of prompting for the property.
Transaction 25-55
Classes
Table 25-94: transPromptProperty Elements (continued)
string propertyCode Code for the property.
string propertyValue Value set for the property.

entered in the prompt.
transPromptPropertyResponse
Table 25-95: transPromptPropertyResponse Elements
transPromptPropert transPromptProperties Array of prompt properties.

y[]
transactionHistoryResult
Table 25-96: transactionHistoryResult Elements
dateTime businessDate Business date of the transaction.
string customerId ID of customer associated with the

transaction.
string customerName Name of the customer associated with the

transaction.
decimal grandTotal Total amount of transaction.
long organizationId Organization ID.
long transactionSequence Sequence number of transaction.
long workstationId ID of workstation where the transaction

was performed.
transactionListResponse

Classes

Table 25-97: transactionListResponse Elements
transactionHistoryResul transactions Array of transactions.

t[]
validateSaleVoucherResponse
Table 25-98: validateSaleVoucherResponse Elements
item[] items Array of items being sold.
string lineItemToken Token referencing the voucher’s account

number and track data.
tender voucherAsscTender Voucher used in the sale.
validationResponse
Table 25-99: validationResponse Elements
boolean valid Indicates whether the element is valid.
Transaction 25-57
Classes

26
ReSTful Web Services
Overview
This chapter gives an overview about the ReSTful web service implementation for Xstore
Point of Service.
Resources
The xservices.war file contains the following resources:
• GetByQueryResource
• GetByIdResource
GetByQueryResource
The GetByQueryResource allows the service to retrieve DTX elements by a keyed
query.
Method GET
@GET
@Compress
@Produces(value={"application/json"})
@Path(value="query/{queryKey}")
ReST URI
Execute a query specified by the given key. The key matches the name of the query.
Call this method through the ReSTful Web Service:
GET Example:
http://localhost:8081/rest/default/20/dtx/query/
TRANS_AVAILABLE_FOR_RETURN?argOrganizationId=1&argReturnCutOffDat
e=2016-10-
19+00%3A00%3A00.0&argHashedAcct=46CB20E9ED6BC42E6262E7D8BCD8A7171
07C3BE5
Input Parameters
• argUriInfo - the URI information
• argQueryKey - the query key
ReSTful Web Services 26-1

Resources
Method POST
@POST
@Compress
@Consumes(value={"application/xml"})
@Produces(value={"application/json"})
@Path(value="query")
ReST URI
Execute a query to update the system's definition of the query, as cached by the "name"
of the query.
Note: The query must not contain a raw SQL string. It can only
contain DTXQL. For more information on queries through DTXQL, see
the Oracle Retail Xstore Point of Service Frameworks & Technologies Guide.
Call this method through the ReSTful Web Service:

Example:
1. POST:
http://localhost:8081/rest/default/20/dtx/
query?argOrganizationId=1&argEmployeeId=101
2. Accept: application/json
3. Authorization
4. Content-Type: application/xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<query xmlns:ns2="http://micros.com/xstore/config/common"
xmlns:ns3="http://micros.com/xstore/config/query"
name="EMPLOYEE_BY_EMPLOYEE_ID">
<ns3:Select from="Employee"/>
<ns3:Where>
<ns3:Required field="organizationId"/>
<ns3:Required field="employeeId"/>
</ns3:Where>
</query>
Parameters
• argUriInfo - the URI information
• argQuery - the query configuration
Construct URL - GetByIdResource

This section describes how to construct a URL by using the GetByIdResource.

Resources
To retrieve the records from the crm_party table for the party_id 100, follow the
steps listed below.
1. Search the Appendix: DTX Names and Database Tables section for the crm_party
table.
2. The Party entry is displayed.
3. To construct the URL the DTX name is Party and the keys are OrganizationId
and PartyId (in that order).
4. To query the party 100 in the organization 1000, construct the URL as following:
[server/port/and so on]/dtx/Party/1000::100
Example:
http://localhost:8080/rest/default/20/dtx/Party/
1000::100(server/port/etc)/dtx/Party/1000::100
GetByIDResource
The GetByIDResource allows the service to retrieve DTX elements by their ID.
ReST URI
GET /rest/{merchantCode}/20/dtx/{object}/{name}/{id}
GET example:
http://localhost:8080/rest/default/20/dtx/Party/1000::100
Response
Example:
{
"model": [
{ "v": "1", "type": "Party", "cmd": "CLEAN", "recordtype": "dao",
"originDS": "Xcenter" } ,
{

Resources
"OrganizationId": 1000,
"PartyId": 100,
"CreateDate": 1539184312927,
"CreateUserId": "BASEDATA",
"UpdateDate": 1539184312927,
"UpdateUserId": "BASEDATA",
"AllegianceRetailLocationId": 0,
"EmployeeId": "[emplyee id]",
"FirstName": "[first name]",
"LastName": "[last name]",
"PreferredLocale": "en_US",
"OrganizationName": "Oracle",
"OrganizationTypeCode": "COMPANY",
"PartyTypeCode": "EMPLOYEE",
"SignUpRetailLocationId": 0,
"SocialSecurityNbr": "xxx-xx-xxxx",
"Void": false,
"Active": true,
"EmailRcpts": false,
"Prospect": false,
"Rent": false,
"PrivacyCard": false,
"CommercialCustomer": false
}
Construct Query XML - GetByQueryResource

This section describes how to construct a query XML by using the
GetByQueryResource.
[server/port/and so on]/dtx/query?argStoreNum=101
To create a query XML, for example, to look up a party by store ID, use the information
retrieved from the Appendix: DTX Names and Database Tables and send this URI as a
HTTP body, with the arguments shown above.
Example Query XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<query xmlns:ns2="http://micros.com/xstore/config/common"
xmlns:ns3="http://micros.com/xstore/config/query"
name="MY_GET_PARTY_BY_STORE_ID_QUERY">
<ns3:Select from="Party"/>
<ns3:Where>
<ns3:Required field="allegianceRetailLocationId"
parameter="argStoreNum" />
</ns3:Where>
</query>

Resources
ReST Xservices Lookup

The table below describes how to look up existing services by using the
GetByQueryResource and GetByIdResource.
Table 26-1: ReST Xservices
Existing SOAP
Service Existing Method ReST URI/Examples
CustomerServices GetCustomerBy /rest/default/20/dtx/Party/ORG_ID::PARTY_ID

Party
Example:
Party/1000::100
GetCustomer /rest/default/20/dtx/query/
History CUSTOMER_TRANS_HISTORY?argOrganizationId=ORG
_ID&argPartyId=PARTY_ID&argStartDate=START&a
rgEndDate=END
Example:
query/
CUSTOMER_TRANS_HISTORY?argPartyId=101&argSta
rtDate=2001-01-01&argEndDate=2099-12-31
SearchCustomers /rest/default/20/dtx/query/
CRM_CUSTOMER_LOOKUP?argOrganizationId=ORG_ID
&argVoidFlag=false&argActiveFlag=true&argLas
tName=LAST_NAME&argPostalCode=POSTAL_CODE
Example:
query/
CRM_CUSTOMER_LOOKUP?argVoidFlag=false&argAct
iveFlag=true&argLastName=Smith
DiscountServices GetCoupon /rest/default/20/dtx/Coupon/

Discount COUPON_ID::ORG_ID::ORG_CODE::ORG_VALUE
Example:
Coupon/NODEAL::1000::*::*
GetDiscountsBy /rest/default/20/dtx/query/
Application DISCOUNT_LIST?argOrganizationId=ORG_ID&@argT
Method ypeCode=DISCOUNT&@argApplicationMethod=METHO
D&@paramGroups=DEFAULT&systemDate=TODAY
Example:
query/
DISCOUNT_LIST?@argTypeCode=DISCOUNT&@argAppl
icationMethod=TRANSACTION&@paramGroups=DEFAU
LT&systemDate=2018-08-09

Resources
Existing SOAP
EmployeeServices GetCommissioned /rest/default/20/dtx/query/

Associates COMM_ASSOC_LOOKUP_SQL?argOrganizationId=ORG_
ID&argRetailLocationId=RTL_LOC_ID&argBusines
sDate="BUSINESS_DATE"&argDeleteFlag=false&ar
gOpenRecordFlag=true
Example:
query/
COMM_ASSOC_LOOKUP_SQL?argRetailLocationId=20
9&argBusinessDate=2018-12-
31&argDeleteFlag=false&argOpenRecordFlag=tru
e
HouseAccount RetrieveById /rest/default/20/dtx/CustomerAccount/

Services ORG_ID::ACCT_ID::HOUSE_ACCOUNT
Example:
CustomerAccount/
1000::C01010001000015::HOUSE_ACCOUNT
SearchByAccount /rest/default/20/dtx/query/
Name XSERVICES.ACCOUNTS_RECEIVABLE_LOOKUP_CUST?ar
gOrganizationId=ORG_ID&argAccountName=NAME
Example:
query/
XSERVICES.ACCOUNTS_RECEIVABLE_LOOKUP_CUST?ar
gAccountName=Example%20Co
SearchByCustomer /rest/default/20/dtx/query/
NamePhone XSERVICES.ACCOUNTS_RECEIVABLE_LOOKUP_CUST?ar
gOrganizationId=ORG_ID&argCustomerFirstName=
NAME&argCustomerMiddleName=NAME&argCustomerL
astName=NAME&argPhoneNumber=NBR
Example:
query/
XSERVICES.ACCOUNTS_RECEIVABLE_LOOKUP_CUST?ar
gCustomerFirstName=Timothy&argCustomerLastNa
me=London
InventoryServices GetOnHandStock /rest/default/20/dtx/query/

Ledger STOCK_LEDGER_FOR_ITEM?argOrganizationId=ORG_
ID&argItemId=ID&argRetailLocationId=ID&argBu
cketId=ON_HAND&argActiveFlag=true
Example:
query/
STOCK_LEDGER_FOR_ITEM?argItemId=1002&argReta
ilLocationId=209&argBucketId=ON_HAND&argActi
veFlag=true

Resources
Existing SOAP
GetStockLedger /rest/default/20/dtx/query/
STOCK_LEDGER_FOR_ITEM?argOrganizationId=ORG_
ID&argItemId=ID&argRetailLocationId=ID&argBu
cketId=BUCKET&argActiveFlag=true
Example:
query/
STOCK_LEDGER_FOR_ITEM?argItemId=1002&argReta
ilLocationId=209&argBucketId=ON_HAND&argActi
veFlag=true
InvAdjustServices GetInventory /rest/default/20/dtx/query/

AdjustmentConfig INVENTORY_TRANSFER_LOCATIONS?argOrganization
Id=ORG_ID&argRetailLocationId=ID&argActiveFl
ag=true
Example:
query/
INVENTORY_TRANSFER_LOCATIONS?argRetailLocati
onId=209&argActiveFlag=true
Inventory Count GetInventory /rest/default/20/dtx/query/

Services CountDocument INVENTORY_COUNT_SHEETS?argOrganizationId=ORG
_ID&argRetailLocationId=ID&argCountId=ID
Example:
query/
INVENTORY_COUNT_SHEETS?argRetailLocationId=2
09&argCountId=209001000002
GetInventory /rest/default/20/dtx/query/
CountSheetsFor INVENTORY_COUNT_SHEETS?argOrganizationId=ORG
Cycle _ID&argRetailLocationId=ID&argCountId=ID
Example:
query/
INVENTORY_COUNT_SHEETS?argRetailLocationId=2
09&argCountId=209001000002
GetInventory /rest/default/20/dtx/query/
CountSummaryForC STYLES_TO_COUNT_FOR_CYCLE?argOrganizationId=
ycle ORG_ID&argRetailLocationId=ID&argCountId=ID&
argCountCycle=INDEX
Example:
query/
STYLES_TO_COUNT_FOR_CYCLE?argRetailLocationI
d=209&argCountId=209001000002&argCountCycle=
1
ItemServices GetItemById /rest/default/20/dtx/Item/ORG_ID::ITEM_ID

Example:
Item/1000::1002

Resources
Existing SOAP
GetItemDeals /rest/default/20/dtx/query/
XSERVICES.ITEM_DEALS?argOrganizationId=ORG_I
D&argItemId=ID&argToday=[yyyy-mm-
dd]&argFutureDay=[yyyy-mm-dd]
Example:
query/
XSERVICES.ITEM_DEALS?argItemId=1020&argToday
=2018-12-01&argFutureDay=2018-12-31
GetItemNotOnFile /rest/default/20/dtx/query/
Items ITEM_LOOKUP?argOrganizationId=ORG_ID&argItem
TypeCode=NOT_ON_FILE&argInventoryLocationId=
LOC_ID&argBucketId=BUCKET_ID
Example:
query/
ITEM_LOOKUP?argOrganizationId=1000&argItemTy
peCode=NOT_ON_FILE&argInventoryLocationId=20
9&argBucketId=ON_HAND
GetItem /rest/default/20/dtx/query/
Variations ITEMS_BY_DIMENSION?argOrganizationId=ORG_ID&
argItemId=ID&argDim1=DIM1&argDim2=DIM2&argDi
m3=DIM3
Example:
query/
ITEMS_BY_DIMENSION?argItemId=330000&argDim1=
BLUE&argDim2=L
SearchItemsBy /rest/default/20/dtx/query/
Description XSERVICES.ITEM_LOOKUP_SERVICE?argOrganizatio
nId=ORG_ID&argDescription=DESCRIPTION
Example:
query/
XSERVICES.ITEM_LOOKUP_SERVICE?argDescription
=shirt
ReasonCodeServices GetReasonCodesBy /rest/default/20/dtx/query/

Type REASON_CODE_LOOKUP?argOrganizationId=ORG_ID&
argCategory=TYPE
Example:
query/
REASON_CODE_LOOKUP?argCategory=DISCOUNT
RetailLocation GetRetail /rest/default/20/dtx/RetailLocation/

Services Location ORG_ID::RTL_LOC_ID
Example:
RetailLocation/1000::209

Resources
Existing SOAP
GetRetail /rest/default/20/dtx/RetailLocation/
LocationWithId ORG_ID::RTL_LOC_ID
Example:
RetailLocation/1000::209

Resources

27
Xstore Office Services
Overview
This chapter describes the Xstore Office Services. The Xstore Office Services interface is
accessed through separate services, each with its own application programming
interface (API).
Note: Communication with Xstore Office Services is performed

through REST and various payload types, including JSON. Additional
information about the types accepted and returned from the services
can be found in the Javadoc of the corresponding class.
Note: For 19.x Cloud environments, the APIs are as described below.
Example:
https://<host>:<port>/<endpoint_path>
For 20.x Cloud environments, the <tenancy_id> needs to be added

after the <host>:<port> where <tenancy_id> references the prod, stage
or dev environments. It will be of the format rgbu-omni-<cust>-
<env><num>-xocs and is part of the application url.
Example:
https://<host>:<port>/<tenancy_id>/<endpoint_path>
RTLog Endpoints
This section describes services exposed by RTLog.
Endpoint - RTLog Mapping Config

This section describes the RTLog Mapping Config service.
URI
/rtlog-generator/rest/config/file/v1/RTLogMappingConfig
HTTP Protocol
PUT, GET, DELETE
PUT
Response Media Type is application/json.
Xstore Office Services 27-1

RTLog Endpoints
Creates or, if one exists, replaces the active uploaded RTLogMappingConfig.xml file.
Example call:
PUT
https://<host>:<port>/rest/config/file/v1/RTLogMappingConfig
Body
RTLogConfigMapping.xml file content
Returns
Response Code 200 when successful (including the number of bytes written), otherwise
an Error Response code.
GET
Response media type is application/json.
Gets and returns the active RTLogMappingConfig.xml file.
Example call:
GET
Returns
The active RTLogMappingConfig.xml file content. A HTTP response header property
named Uploaded-Configuration indicates if the source of the configuration was
uploaded or if it is from the root RTLogMappingConfig.xml.
DELETE
Deletes the uploaded RTLogMappingConfig.xml file, if one exists.
Example call:
DELETE
Returns
Response object with status indicator. 200 indicates a file was removed, 204 indicates
there was no uploaded file to remove, and 500 indicates a system error.
Type of Web Service

REST
Security Protocol/Grant Type (if OAuth)

On Prem: N/A
Cloud Services: OAuth2
Client
SI to implement
Server
RTLog Web Application

RTLog Endpoints
Endpoint - RTLog Format Config

This section describes the RTLog Format Config service.
URI
/rtlog-generator/rest/config/file/v1/RTLogFormatConfig
HTTP Protocol
PUT, GET, DELETE
PUT
Response Media Type is application/json.
Creates or, if one exists, replaces the active uploaded RTLogFormatConfig.xml file.
Example call:
PUT
https://<host>:<port>/rest/config/file/v1/RTLogFormatConfig
Body
RTLogConfigFormat.xml file content
Returns
Response Code 200 when successful (including the number of bytes written), otherwise
an Error Response code.
GET
Gets and returns the active RTLogFormatConfig.xml file.
Example call:
GET
Returns
The active RTLogFormatConfig.xml file content. A HTTP response header property
named Uploaded-Configuration indicates if the source of the configuration was
uploaded or if it is from the root RTLogFormatConfig.xml.
DELETE
Deletes the uploaded RTLogFormatConfig.xml file, if one exists.
Example call:
DELETE
Returns
Response object with status indicator. 200 indicates a file was removed, 204 indicates
there was no uploaded file to remove, and 500 indicates a system error.

RTLog Endpoints
Type of Web Service

REST

On Prem: N/A
Client
SI to implement
Server
Endpoint - Published RTLogs

This section describes the Published RTLogs service.
URI
/rtlog-generator/rest/rtlog/files/v1/published
HTTP Protocol
GET
GET
Response media type is application/octet-stream.
Call this service to download any available RTLog ZIP file. Clients may poll this service.
If a ZIP file is available, this service retrieves the oldest available ZIP file and streams it.
If there are no ZIP files available on the ReSA file drop folder, server responds with
HTTP 204 and closes the connection.
Example call:
GET
https://<host>:<port>/rest/config/files/v1/published
Response
The suspended asynchronous response object.
Type of Web Service

REST

On Prem: N/A
Client
SI to implement
Server

RTLog Endpoints
Endpoint - Generate RTLog from PosLog

This section describes the Generate RTLog from PosLog service.
URI
/rtlog-generator/service
HTTP Protocol
POST
POST
@PayloadRoot(localPart="postTransaction", namespace="http://
v20.ws.poslog.xcenter.dtv/")
@ResponsePayload
Post transaction.
Parameters
argTransaction- the transactionReturns: the JAXB
elementThrows:PoslogObjReceiverException_Exception - the poslog obj
receiver exception exception.
Type of Web Service

SOAP

On Prem: BASIC Authentication
Client
Xcenter
Server
Endpoint - healthcheck (Cloud Only)

This section describes RTLog generator health check service.
URI
/rtlog-generator/rest/default/v1/health_check
HTTP Protocol
GET
GET
Service to check if RTLog generator is correctly configured and started.
Returns
Response code 200 and response media type text/plain if health check is OK.

Xcenter Endpoints
Response code 500 if health check is not OK.

Example Call:
Call this method via REST like GET
https://<host>:<port>/rtlog-generator/rest/default/v1/
health_check
Type of Web Service

REST

None (Not Secured)
Client
User
Server
Xcenter Endpoints
This section describes services exposed by Xcenter.
Endpoint - Broadcaster REST Service

This section describes the Braodcaster REST service.
URI
/xcenter/rest/{provisioning.id}/v1/newPOSLogBatch
HTTP Protocol
GET
GET
Entry method of REST service to get the latest broadcasted POSLog data for a particular
orgId and serviceId.
This service returns new POSLogs to the client. New POSLogs refer to POSLogs, which
have not yet been sent to the client. As with all Xcenter Broadcasters, Xcenter keeps track
of what it has (and has not yet) given to a client.
Unlike all other kinds of Broadcasters, this Broadcaster does not actually broadcast, since
clients must come to Xcenter and pro actively request data.
Another way this service differs from other Broadcasters is that in a single call to this
service, multiple POSLogs may be returned in a "batch". The maximum size of a batch is
adjustable as a parameter (see details below). Other Broadcasters only transmit 1 single
POSLog at a time.
This service also behaves in a long polling fashion; this helps to ensure that new data is
immediately sent to the client when it is available. Clients run in a constant loop of
successive requests; requests will block (up to a timeout) when there is no data available,
but return immediately upon data availability.

Xcenter Endpoints
Example Call:
Call this method via rest like GET
https://<host>:<port>/xcenter/rest/default/v1/
newPOSLogBatch?orgId=1&serviceId=mySalesAudit&maxBatchRecords=50&
longPollTimeoutSeconds=30
Parameters:
orgId - the organization id of the retailer
serviceId - broadcaster service id
maxBatchRecords - (optional, via null) max records to return in this one service call
longPollTimeoutSeconds - (optional, via null) seconds to wait before timing out
with HTTP 204
testOnly - (optional, via null, false is the default) use true only for development/
testing purposes; all logic in the service runs identically, except that nothing in the
database is committed so, the POSLog data in the response will not be marked sent.
Returns
JSON data containing list of somewhere between 1 and maxBatchRecords of escaped
Xstore POSLog XML strings.
Type of Web Service

REST

OAuth2
Client
External Integration
Server
Xcenter Web Application
Endpoint - Updates
This section describes the Updates service.
URI
xcenter/rest/{provisioning.id}/20/updates
HTTP Protocol
GET
GET
Service to retrieve configuration and data updates. This service returns a ZIP file
containing manifests and deployment config XML if available, null otherwise.
Example call:
https://<host>:<port>/xcenter/rest/default/20/
updates?org=1&loc=2&date=2017-06-01

Xcenter Endpoints
Parameters
orgId - the organization ID of the retailer
retailLocationId - the location ID where the request originates
date -business date in ISO-8601 format.
Returns
Response octet stream in form of byte array
Type of Web Service

REST

OAuth2
Client
Xenvironment
Server
Endpoint - EventLog
This section describes the EventLog service.
URI
/xcenter/rest/{provisioning.id}/20/eventlog
HTTP Protocol
POST
POS
Accepted media type is application/json.
Service to post event logs. This service is intended to be used by Xenvironment. It
provides a means to report EventLogEntry objects, so it can send useful warning/
error information that can be viewed by administrators in Xadmin.
Example call:
Call this method via REST like POST
https://<host>:<port>/xcenter/rest/default/20/eventlog with
request media type as application/json
Type of Web Service

REST

OAuth2
Client
Xstore Point of Service, Xenvironment

Xcenter Endpoints
Server
Endpoint - File
This section describes the File service.
URI
"/xcenter/rest/{provisioning.id}/20/file/{container} where
{container} is "pospolls", "deployments", "poslog", "autodeploy/
{organization ID}", or "autodeploy/{organization ID}/archive"
HTTP Protocol
GET, PUT, DELETE
GET
Service to get the requested file or directory listing. Accepts a relative URL to file.
Headers
Accept - the content type header, applicable for directory listing, if a value of
application/json is provided then the directory listing is presented in JSON format
otherwise HTML listing is presented.
When using a GET ReST API to receive a file listing in a directory, set the Accept header
as following:
Accept: application/json - to receive JSON responses
Accept: application/html - to receive HTML responses
range - the range header, parameter indicating which portion of a file a client is trying
to download
Example:
Range bytes=0-1433599. See the HTTP/1.1 documentation.
Path Parameters
containers - pospolls, deployments, autodeploy, poslog
org - org Id
name - file or dir name
Example calls:
{} - represent path params
Supported Containers - pospolls, deployments, autodeploy, poslog
Note: For autodeploy, mention the org as path param after container
path param.

GET a file from one of the containers
https://<host>:<port>/xcenter/rest/{provisioning.id}/20/file/
{containers}/{filename.ext}

Xcenter Endpoints
Examples:
GET a pospoll file:
GET https://<host>:<port>/xcenter/rest/default/20/file/pospolls/
pospoll.165.20190406011412.zip
LIST files in the containers(with hyperlinks to download and delete within the listing)
GET https://<host>:<port>/xcenter/rest/{provisioning.id}/20/file/
{containers}
Examples:
List files in autodeploy org 100 folder:
autodeploy/100
List files in deployments folder:
deployments
To download part of the file, set the header as Range bytes=0-1433600/8080384. See the
HTTP/1.1 documentation.
Returns
Response with list of FileInfo objects (JSON format) if it is a directory listing or
"application/octet-stream" as file download.
PUT
Service to save a file.
Headers
Content-Range - the content range header parameter indicating portion of a file a client
is trying to upload
Path Parameters
containers – pospolls, deployments, autodeploy, poslog
org – org Id
name – file or dir name
Example calls:
{} – represent path params
Supported Containers – pospolls, deployments, autodeploy, poslog
path param.
Call this method via REST like PUT

PUT a file into one of the containers:
PUT a file into autodeploy, org 1000 folder:

Xcenter Endpoints
PUT https://<host>:<port>/xcenter/rest/{provisioning.id}/v1/file/
autodeploy/1000/mydatafile.mnt
PUT
https://<host>:<port>/xcenter/rest/default/20/file/autodeploy/1000/couponSKU9102.mnt
PUT a file to pospoll:
PUT https://<host>:<port>/xcenter/rest/{provisioning.id}/20/file/
pospolls/pospoll.165.20170406011412.zip
To upload part of the file, set the header as Content-Range bytes 0-1433600/8080384. See
the HTTP/1.1 documentation.
After all the parts of the file are uploaded, call the GET request on the same file to close
the file. This service will send the SHA-512 hash as response.
GET
{container}/{org}/{name}/hash
Example:
GET
https://<host>:<port>/xcenter/rest/{provisioning.id}/autodeploy/
1000/couponSKU9102.mnt/hash
Returns
Response with status as accepted (if partial file is uploaded) or conflict (if file with same
name is already present) or accepted (complete file upload) with SHA-512 hash of file
accepted.
DELETE
Service to delete previously uploaded file.
Path Parameters
containers - pospolls, deployments, autodeploy, poslog
org - org Id
name - file or dir name
Example call:
{} - represent path params
Supported Containers - pospolls, deployments, autodeploy, poslog
path param.
Call this method via REST like DELETE

DELETE files in the containers:
DELETE

Xcenter Endpoints
Example:
DELETE
http://<host>:<port>/xcenter/rest/{provisioning.id}/20/file/
pospoll/1000_2_!!_config.cip
where "1000_2_!!_config.cip" is the file to delete from
"pospolls" container.
Returns
Response with 204
Type of Web Service

REST

OAuth2
Client
Xenvironment, Xadmin (logged in user), External integrations
Server
Endpoint - ConfigPath
This section describes the ConfigPath service.
URI
/xcenter/rest/{provisioning.id}/20/configPath
HTTP Protocol
GET
GET
Service for providing config path information to an Xstore POS register, based on the
personality and landscape configurations defined in Xadmin.
Example call:
configPath?org=1&loc=2&wkstn=3
Parameters
org - the organization ID of the retailer
loc - the location ID where the request originates
wkstn- the device performing the request
wkstnStart - the starting workstation ID in the range of workstation IDs for which
config paths should be returned

Xcenter Endpoints
wkstnEnd - the ending workstation ID in the range of workstation IDs for which config
paths should be returned
Returns
A properties object converted to JSON with the config path entries needed by Xstore
Point of Service.
Type of Web Service

REST

OAuth2
Client
Xenvironment
Server
Endpoints - DTX
This section describes the DTXservice.DTX provides a common mechanism through
which specific data access implementations can be built for Java Database Connectivity
(JDBC), ReSTful resources, web servers, and applications. These implementations
retrieve, persist, and replicate data between local, remote, and external sources through
DTX.
URI
/xcenter/rest/{provisioning.id}/20/dtx/{name}/{id}
HTTP Protocol
GET
GET
Service to retrieve a DTX object by primary key, where "::" serves as the separator
between composite keys.
Path Parameters
name - The DTX name
id - The primary key separated by "::"
Example call:
https://<host>:<port>/xcenter/rest/default/20/dtx/Item/1000::1002
Returns
Response with HTTP status code 200 and json representation of query results.

Xcenter Endpoints
URI
/xcenter/rest/{provisioning.id}/20/dtx/{queryKey}
HTTP Protocol
GET
GET
Service to execute a query specified by a pre-defined query key.
Path Parameters
queryKey - The pre-defined query key
Parameters
Parameters for the query, which vary based on the query being executed.
Example call:
https://<host>:<port>/xcenter/rest/default/20/dtx/query/
TRANS_AVAILABLE_FOR_RETURN?argOrganizationId=1000&argReturnCutOff
Date=2016-10-19+00%3A00%3A00.0
Returns
URI
/xcenter/rest/{provisioning.id}/20/dtx/query
HTTP Protocol
POST
POST
Service to execute a DTXQL query provided in request body. The query must not contain
raw SQL string. It can only contain DTXQL.
Parameters
Parameters for the query, which vary based on the query being executed.
Example call:
Call this method via REST like
1 > POST https://<host>:<port>/xcenter/rest/default/20/dtx/
query?argOrganizationId=1000&argEmployeeId=101
1 > Accept: application/json 1 > Authorization:
1 > Content-Type: application/xml
<query xmlns:ns3="http://micros.com/xstore/config/
query" name="EMPLOYEE_BY_EMPLOYEE_ID">
<ns3:Select from="Employee"/>

Xcenter Endpoints
<ns3:Where>
<ns3:Required field="organizationId"/>
<ns3:Required field="employeeId"/>
</ns3:Where>
</query>
Body
The query xml data.
Returns
URI
/xcenter/rest/{provisioning.id}/20/dtx
HTTP Protocol
POST
POST
Service to save a DTX immediately.
Example call:
Call this method via REST like
1 > POST https://<host>:<port>/xcenter/rest/default/20/dtx
1 > Accept: application/json
1 > Authorization:
1 > Content-Type: application/json
{
"Timeout": 1000,
"persistables": [
[
{
"v": 20,
"type": "Item",
"cmd": "INSERT",
"recordtype": "dao"
},
{
"OrganizationId": 1,
"ItemId": "1622",
"CreateDate": 1526463366239,

Xcenter Endpoints
"OrgCode": "*",
"OrgValue": "*",
"Description": "FOOBARSTOOL",
"SerializedItem": false,
}
]
]
}
Body
The data
Returns
Response with HTTP status code 202 (Accepted)
Type of Web Service

REST

OAuth2
Client
Server
Endpoint - Replicate
This section describes the Replicate service.
URI
/xcenter/rest/{provisioning.id}/20/dtx/replicate
HTTP Protocol
POST
POST
Service call to replicate a payload of DTX persistables.
Example call:
POST
https://<host>:<port>/xcenter/rest/default/20/dtx/
replicate?org=1&loc=1&wkstn=1&creation=1287631726

Xcenter Endpoints
Parameters
org- the organization ID
loc- the retail location ID
wkstn - the workstation ID
creation - the time stamp
Returns
Response with HTTP status code 202 (Accepted)
Type of Web Service

REST

OAuth2
Client
Xstore Point of Service,
Server
Endpoint - DeployStatus
This section describes the Deploy Status service.
URI
/xcenter/rest/{provisioning.id}/20/deploystatus
HTTP Protocol
POST
POST
Service to post deploy status to report on the status of various phases of deploying files
that are part of an Xadmin deployment. This service is intended to be used by
Xenvironment.
Example call:
https://<host>:<port>/xcenter/rest/default/20/deploystatus with
request media type as application/json
Body
The data containing the status of the current client which is processing the deployment.
Returns
The status of the overall deployment

Xcenter Endpoints
Type of Web Service

REST

OAuth2
Client
Server
Endpoint - SystemDateTime
This section describes the SystemDateTime service.
URI
/xcenter/rest/{provisioning.id}/20/misc/systemDateTime
HTTP Protocol
GET
GET
Response media type is text/plain.
The entry method for this REST service resource. This method returns a data time string
formatted by
DateFormatUtils.ISO_8601_EXTENDED_DATETIME_TIME_ZONE_FORMAT.
This service provides a centralized date/time service. When a request comes in, it returns
the system date/time of the server where Xcenter runs on at the time of the request. The
response is a plain text containing date/time in ISO-8601 format, yyyy-MM-
dd'T'HH:mm:ssZZ, for example, 2016-04-06T14:45:03-04:00.
HTTP requests have information about originating system, such as org, storeNum,
registerNum, local system date/time, acceptable range and so on. If the requesting
system date/time is out of sync, it creates and saves an event log entry about this incident
into the database; at later stage, the event log entries will be reviewed by administrators
in Xadmin.
Example call:
https://<host>:<port>/xcenter/rest/default/20/misc/
systemDateTime?org=1&loc=2&wkstn=3&time=2017-04-11T10%3A00%3A34-
05%3A00&acceptableDelta=5&acceptableDeltaUnit=SECOND
Parameters
loc - the location ID where the request originates
wkst - the device performing the request
time - Client's current dateTime in the same ISO-8601 format.

Xcenter Endpoints
acceptableDelta - the delta of time between the client and server that is acceptable.
Defaults to 0.
acceptableDeltaUnit - the unit of the delta. Defaults to second.
Returns
The formatted date time of the server.
Type of Web Service

REST

OAuth2
Client
Xenvironment
Server
Endpoint - ShowStatus (On-Premise ONLY)

This section describes the ShowStatus service.
Note: This endpoint is only available for on-premise applications. It is

not available for Xstore Office Cloud Service.
URI
/xcenter/rest/{provisioning.id}/20/status
HTTP Protocol
GET
GET
Gets the status for a particular module. Any module name appended to URI must be a
key name in the map of status reporters as configured in the Spring context like:
<bean id="showStatusReporters"
class="com.micros_retail.xcenter.servlet.filter.StatusReporterHol
der">
<property name="map">
<map value-
type="com.micros_retail.xcenter.servlet.filter.IStatusReporter">
<entry key="dtx" value-ref="dtxStatusReporter"/>
<entry key="cluster" value-ref="clusterStatusReporter"/>
<entry key="replication" value-
ref="replicationStatusReporter"/>
<entry key="broadcaster" value-
ref="broadcasterStatusReporter"/>

Xcenter Endpoints
</map>
</property>
</bean>
Example call:
GET
https://<host>:<port>/xcenter/rest/default/20/status/dtx
Path Parameters
module - the module
Returns
HTML response with status information
Type of Web Service

REST
Client
User
Server
Endpoint - EnrollStore (Cloud ONLY)

This section describes the EnrollStore service.
Note: This endpoint is only available for Cloud applications. It is not

available for Xstore Office on-premise.
URI
/xcenter/rest/{provisioning.id}/20/enrollstore
HTTP Protocol
GET
GET
Rest service for enrolling an Xstore Client as an OAuth Client in the Identity Provider
(IDP). The typical response of this request contains the OAuth Client ID, OAuth Client
Secret, the IDP Connection URL and a flag indicating whether this client already existed.
Example:
Call this method via REST like GET:
enrollstore?org=1000&loc=101
Parameters
org - organization ID

Xcenter Endpoints
loc - retail location ID
Returns
Json data containing information about the OAuth Client
Type of Web Service

REST
Client
Xenvironment, Xstore Office On-Premises
Server
Endpoint - EnrollClient (Cloud ONLY)

This section describes the EnrollClient service.
Note: This endpoint is only available for Cloud applications. It is not

available for Xstore Office on-premise.
URI
/xcenter/rest/{provisioning.id}/20/enrollclient
HTTP Protocol
GET
GET
Rest service for enrolling a client system as an OAuth Client in the Identity Provider
(IDP). The typical response of this request contains the OAuth Client ID, OAuth Client
Secret, the IDP Connection URL and a flag indicating whether this client already existed.
Example:
Call this method via REST like GET:
enrollclient?type=setup
Parameters
type - the type of app
Returns
Json data containing information about the OAuth Client
Type of Web Service

REST
Client
External System

Xcenter Endpoints
Server
Endpoint – tempstore
This section describes the tempstore service.
URI
/xcenter/rest/{provisioning.id}/20/tempstore
HTTP Protocol
POST, PUT
POST
Service to post temporary store requests. This service is intended to be used by Xstore
Point of Service. It provides a means to add TemporaryStoreRequest objects to Xcenter so
they can be viewed in Xadmin.
Body
json representation of the temporary store request
Returns
Response code 204 when successful; otherwise, an Error Response code.
Example Call:
https://<host>:<port>/xcenter/rest/default/20/tempstore
followed by the json representation of the temporary store request data.
PUT
Accepted Media Type is application/json.
Service to update the status of a TemporaryStoreRequest object in the Xcenter database.
Body
json representation of the temporary store request status change data
Returns
Response code 204 when successful; otherwise, an Error Response code.
Example Call:
Call this method via REST like PUT
https://<host>:<port>/xcenter/rest/default/20/tempstore
followed by the json representation of the temporary store request status change data.
Type of Web Service

REST
Client
Xstore Point of Service

Xcenter Endpoints
Server
Endpoint - cancelleddeployments
This section describes the cancelled deployments service.
URI
/xcenter/rest/{provisioning.id}/20/cancelleddeployments
HTTP Protocol
GET
GET
Service to fetch the list of cancelled deployments since a given date. This service is
intended to be used by Xenvironment to fetch the list of cancelled deployments since a
given date.
Returns
JSON representation of list of cancelled deployment IDs.
Example Call:
cancelleddeployments?org=<orgId>&loc=<storeId>&date=
<BUSINESS_DATE>
Type of Web Service

REST
Client
Xenvironment
Server
Endpoint - broadcasterstatus
This section describes the broadcaster status service.
URI
/xcenter/rest/{provisioning.id}/20/broadcasterstatus
HTTP Protocol
GET
GET

Xcenter Endpoints
Service to fetch a list of broadcaster status data for a broadcaster service id. The org and
service id are required. Optionally the return list can be further filtered by passing in a
location id, a date, and a max results limit.
Parameters
serviceID - the broadcaster service ID
loc - the location ID where the status data originates
date - the create date (in ISO-8601 format) of the status data
maxResults - the maximum number of results to return
Returns
JSON representation of list of broadcaster status data.
Example Call:
broadcasterstatus?org=<orgId>&serviceID=<broadcasterServiceId>&lo
c=<storeId>&date=<ISO-8601 date>&maxResults=<maxResultCount>
broadcasterstatus?org=1000&serviceID=RESA_1000&loc=101&date=2021-
04-22T00:00:00-05:00&maxResults=10
Type of Web Service

REST

OAuth2
Client
User
Server

This section describes Xcenter health check service.
URI
/xcenter/health_check
HTTP Protocol
GET
GET
Service to fetch Xcenter build version, build date, database schema version, database
schema date, and the current server time. It also reports the online status of database
schema Xcenter, XcenterAdmin, and XcenterReplication, bootstrap status and site status.

Xcenter Endpoints
Parameters
format - the response format to return. Valid values are:
HTML, JSON, NONE
It is defaulting to HTML if not specified.
Returns
Response code 200 and response media type text/html if health check is OK and the
format requested is HTML.
Response code 200 and response media type application/json if health check is OK
and the format requested is JSON.
Response code 204 with no body content if health check is OK and the format requested
in NONE.
Example Call:
https://<host>:<port>/xcenter/health_check?format=HTML
https://<host>:<port>/xcenter/health_check?format=JSON
https://<host>:<port>/xcenter/health_check?format=NONE
https://<host>:<port>/xcenter/health_check
Type of Web Service

REST

None (Not Secured)
Client
User
Server
Endpoint - Pay by Link Notification Resource (On-Premise ONLY)

This section describes a service that is hosted on behalf of Adyen, who provides the
capability of taking and processing payments for merchandise by going to a URL and
making a payment online.
URI
/xcenter/rest/adyen/v1/{orgId}/notification
HTTP Protocol
POST
POST
Both the accepted type and the response media type are application/json.

Data Privacy Endpoints
The Pay by Link functionality allows a sales associate to provide a way for a customer to
pay for merchandise without ever handing over any sort of payment item or
communicating any sort of payment info to the sales associate. Instead, the customer will
be presented with a link which they can visit to enter their payment information securely
and pay for their merchandise.
This service accepts notifications from the Adyen payment processor that indicate the
results of payments that were made by customers. The notifications are received in the
Xcenter application, and they are stored in the Xcenter database.
Parameters
There are no URL query parameters that are exposed for this service. Adyen sends all of
the necessary information in the JSON body of the message.
Returns
As required by Adyen, this service simply returns the JSON string "[accepted]" when a
notification has been received and properly saved to the Xcenter database.
Type of Web Service

REST

OAuth2
Client
External Integration
Server
Data Privacy Endpoints

This section describes the data privacy services.
Endpoint - privatedata
This section privatedata service.
URI
/privatedata
Customer/ Employee Lookup Service

The Customer/Employee Lookup Service uses the GET request method type and takes
the argument customer ID, which is a combination of organization ID and party ID
({organization_id}::{party_id}) and returns customer information via a JSON object.
Example call:
GET
{service host}:{port}/xcenter/rest/privatedata/
{organization_id}::{party_id}?type=customer

Xadmin Endpoints
Customer/Employee Validate Service

The Customer/Employee Validate service uses the GET request method type and takes
the argument customer ID, which is a combination of organization ID and party ID
({organization_id}::{party_id}). If the customer information can be safely anonymize
then the service returns a response with the status code '200', otherwise it will return a
response with the status code '412'.
Example call:
GET
{service host}:{port}/xcenter/rest/privatedata/validateForget/
Customer/Employee Anonymization Service

The Customer/Employee anonymization service uses the DELETE request method type
and takes the argument customer ID, which is a combination of organization ID and
party ID ({organization_id}::{party_id}). This service calls the validate service before
proceeding to anonymize customer/employee information. If the validation fails it will
return a response with the status code '412'. If the validation is successful, it will retrieve
the location of the AutoFileTransferDirectory from Xadmin and create a download file
which contains one of more of the record types of CUSTOMER_ANONYMIZE and
EMPLOYEE_ANONYMIZE and save it to the above mentioned location.
Example Call:
DELETE
{service port}:{port}/xcenter/rest/privatedata/
Xadmin Endpoints
This section describes the Xadmin services.
Endpoint - Receipt Viewer

This section describes the Receipt Viewer service.
URI
xadmin/rest/v1/receiptViewer
HTTP Protocol
GET
GET
Response media type is text/html.
Returns the response containing the receipt view of a transaction
Example call:
GET
https://localhost:8443/xadmin/rest/v1/
receiptViewer?trans_id=6090&reg_id=1&trans_date=20180308&rtl_loc=
201&org_id=1000

Xadmin Endpoints
Parameters
trans_id - the transaction ID
reg_id - the workstation ID
trans_date - the transaction business date
rtl_loc - the retail location ID
org_id - the organization ID
Returns
The receipt view response.
Type of Web Service

REST
Client
XBRi
Server
Xadmin Web Application

This section describes Xadmin health check service.
URI
xadmin/health_check
HTTP Protocol
GET
GET
Service to fetch Xadmin build version, build date, database schema version, database
schema date, and the current server time. It also reports the online status of database
schema Xcenter, XcenterAdmin, and XcenterReplication, bootstrap status and site status.
Parameters
format - the response format to return. Valid values are:
HTML, JSON, NONE
It is defaulting to HTML if not specified.
Returns
Response code 200 and response media type text/html if health check is OK and the
format requested is HTML.
Response code 200 and response media type application/json if health check is OK
and the format requested is JSON.
Response code 204 with no body content if health check is OK and the format requested
in NONE.

Xadmin Endpoints
Example Call:
https://<host>:<port>/xadmin/health_check?format=HTML
https://<host>:<port>/xadmin/health_check?format=JSON
https://<host>:<port>/xadmin/health_check?format=NONE
https://<host>:<port>/xadmin/health_check
Type of Web Service

REST

None (Not Secured)
Client
User
Server
Xadmin Web Application

Xadmin Endpoints

A
Appendix: DTX Names and Database
Tables
This chapter lists the DTX names and database tables needed to construct a URL or
Query XML by using the GetByQueryResource and the GetByIdResource. See
below.
A-1
AccessControlList
Table: sec_acl
Fields:
OrganizationId (organization_id) - LONG

SecuredObjectId (secured_object_id) - STRING
AuthenticationRequired (authentication_req_flag) - BOOLEAN
CreateDate (create_date) - DATE
CreateUserId (create_user_id) - STRING
UpdateDate (update_date) - DATE
UpdateUserId (update_user_id) - STRING
Relationships:
AclEntries - AclAccessType
Properties - AccessControlListProperty
AccessControlListProperty
Table: sec_acl_p
Fields:

PropertyCode (property_code) - STRING
The name of the property.
Type (type) - STRING
The type of property. Valid values are 'STRING', 'DATE', 'BIGDECIMAL', and 'BOOLEAN'.
StringValue (string_value) - STRING
The value of the property if 'type' is 'STRING'.
DateValue (date_value) - DATE
The value of the property if 'type' is 'DATE'.
DecimalValue (decimal_value) - DECIMAL
The value of the property if 'type' is 'BIGDECIMAL' or 'BOOLEAN'. For 'BOOLEAN' type, the value
should be 0 or 1.
The ID of the user who created the record.
The date and time the record was created.
The ID of the user who last updated the record.
The date and the record was last updated.
AccountCreditTenderLineItem
Table: ttr_acct_credit_tndr_lineitm
Extends: TenderLineItem
Fields:

RetailLocationId (rtl_loc_id) - LONG
BusinessDate (business_date) - DATE
WorkstationId (wkstn_id) - LONG
TransactionSequence (trans_seq) - LONG
RetailTransactionLineItemSequence (rtrans_lineitm_seq) - INTEGER
CustAccountId (cust_acct_id) - STRING
CustAccountCode (cust_acct_code) - STRING
AccountReceivableSaleLineItem
Table: trl_ar_sale_lineitm
Extends: SaleReturnLineItem
Fields:

ActivityCode (activity_code) - STRING
AdjudicationCode (adjudication_code) - STRING
AuthorizationCode (auth_code) - STRING
AuthorizationMethodCode (auth_mthd_code) - STRING
EntryMethodCode (entry_mthd_code) - STRING
AccountNumber (acct_nbr) - STRING
BankReferenceNumber (reference_nbr) - STRING
AccountUserId (acct_user_id) - STRING
AccountUserName (acct_user_name) - STRING
OriginalTransmissionDateTime (orig_transmission_date_time) - STRING
OriginalSTAN (orig_STAN) - STRING
AccountReceivableTenderLineItem
Table: ttr_ar_tndr_lineitm
Fields:

ApprovalCode (approval_code) - STRING
PartyId (party_id) - LONG
PoNumber (po_number) - STRING
AclAccessType
Table: sec_access_types
Fields:
AccessTypeCode (access_typcode) - STRING

GroupMembershipRaw (group_membership) - CLOB
NoAccessSettings (no_access_settings) - STRING
Relationships:
Properties - AclAccessTypeProperty
AclAccessTypeProperty
Table: sec_access_types_p
Fields:
AccessTypeCode (access_typcode) - STRING
should be 0 or 1.
Address
Table: com_address
Fields:

AddressId (address_id) - STRING
OrgCode (org_code) - STRING
OrgValue (org_value) - STRING
Address1 (address1) - STRING
Apartment (apartment) - STRING
City (city) - STRING
State (territory) - STRING
PostalCode (postal_code) - STRING
Country (country) - STRING
Neighborhood (neighborhood) - STRING
County (county) - STRING
Relationships:
Properties - AddressProperty
AddressCountry
Table: com_address_country
Fields:

CountryId (country_id) - STRING
AddressMode (address_mode) - STRING
CountryName (country_name) - STRING
PostalCodeMaxLength (max_postal_length) - INTEGER
Relationships:
Properties - AddressCountryProperty
AddressCountryProperty
Table: com_address_country_p
Fields:

should be 0 or 1.
AddressModifier
Table: xom_address_mod
Fields:
OrderId (order_id) - STRING
Sequence (address_seq) - LONG
State (state) - STRING
Relationships:
Properties - AddressModifierProperty
AddressModifierProperty
Table: xom_address_mod_p
Fields:

Sequence (address_seq) - LONG
should be 0 or 1.
AddressPostalCode
Table: com_address_postalcode
Fields:

PostalCodeId (postal_code_id) - STRING
StateId (state_id) - STRING
CityName (city_name) - STRING
Relationships:
Properties - AddressPostalCodeProperty
AddressPostalCodeProperty
Table: com_address_postalcode_p
Fields:

PostalCodeId (postal_code_id) - STRING
should be 0 or 1.
AddressProperty
Table: com_address_p
Fields:

should be 0 or 1.
AddressState
Table: com_address_state
Fields:

StateName (state_name) - STRING
Relationships:
Properties - AddressStateProperty
AddressStateProperty
Table: com_address_state_p
Fields:

should be 0 or 1.
Airport
Table: com_airport
Fields:

AirportCode (airport_code) - STRING
ZoneId (zone_id) - STRING
AirportName (airport_name) - STRING
CountryCode (country_code) - STRING
Relationships:
Properties - AirportProperty
AirportProperty
Table: com_airport_p
Fields:

should be 0 or 1.
AirportZone
Table: com_airport_zone
Fields:

Description (description) - STRING
Relationships:
Properties - AirportZoneProperty
AirportZoneDetail
Table: com_airport_zone_detail
Fields:

DestinationZoneId (destination_zone_id) - STRING
TaxCalculationMode (tax_calculation_mode) - STRING
Relationships:
Properties - AirportZoneDetailProperty
AirportZoneDetailProperty
Table: com_airport_zone_detail_p
Fields:

DestinationZoneId (destination_zone_id) - STRING
should be 0 or 1.
AirportZoneProperty
Table: com_airport_zone_p
Fields:

should be 0 or 1.
AttachedItems
Table: itm_attached_items
Fields:
AttachedItemId (attached_item_id) - STRING

SoldItemId (sold_item_id) - STRING
LevelCode (level_code) - STRING
LevelValue (level_value) - STRING
BeginDatetime (begin_datetime) - DATE
EndDatetime (end_datetime) - DATE
PromptToAdd (prompt_to_add_flag) - BOOLEAN
PromptToAddMsgKey (prompt_to_add_msg_key) - STRING
QuantityToAdd (quantity_to_add) - DECIMAL
LineItemAssociationTypeCode (lineitm_assoc_typcode) - STRING
PromptForReturn (prompt_for_return_flag) - BOOLEAN
PromptForReturnMsgKey (prompt_for_return_msg_key) - STRING
ExternalId (external_id) - STRING
ExternalSystem (external_system) - STRING
Relationships:
AttachedItem - Item
SoldItem - Item
AssociationType - LineItemAssociationTypeCode
Properties - AttachedItemsProperty
AttachedItemsProperty
Table: itm_attached_items_p
Fields:
AttachedItemId (attached_item_id) - STRING

SoldItemId (sold_item_id) - STRING
should be 0 or 1.
AwardAccount
Table: cat_award_acct
Fields:

CardNumber (cust_card_nbr) - STRING
AccountId (acct_id) - STRING
Relationships:
AwardCoupons - AwardAccountCoupon
Properties - AwardAccountProperty
AwardAccountCoupon
Table: cat_award_acct_coupon
Fields:

CouponId (coupon_id) - STRING
Amount (amount) - DECIMAL
ExpirationDate (expiration_date) - DATE
Relationships:
Properties - AwardAccountCouponProperty
AwardAccountCouponProperty
Table: cat_award_acct_coupon_p
Fields:

should be 0 or 1.
AwardAccountProperty
Table: cat_award_acct_p
Fields:

should be 0 or 1.
BalanceModifier
Table: xom_balance_mod
Fields:

Sequence (detail_seq) - INTEGER
DetailLineNumber (detail_line_number) - INTEGER
ModSequence (mod_seq) - INTEGER
TypeCode (typcode) - STRING
Void (void_flag) - BOOLEAN
Relationships:
Properties - BalanceModifierProperty
BalanceModifierProperty
Table: xom_balance_mod_p
Fields:

should be 0 or 1.
BroadcasterOption
Table: com_broadcaster_options
Fields:

OptionId (option_id) - LONG
TranslationKey (translation_key) - STRING
DefaultTranslation (default_translation) - STRING
Xpath (xpath) - STRING
Relationships:
Properties - BroadcasterOptionProperty
BroadcasterOptionProperty
Table: com_broadcaster_options_p
Fields:

OptionId (option_id) - LONG
should be 0 or 1.
ButtonGrid
Table: com_button_grid
Fields:

GridId (grid_id) - STRING
RowId (row_id) - INTEGER
ColumnId (column_id) - INTEGER
ComponentId (component_id) - STRING
SortOrder (sort_order) - INTEGER
ChildId (child_id) - STRING
KeyName (key_name) - STRING
Data (data) - STRING
Text (text) - STRING
TextX (text_x) - INTEGER
TextY (text_y) - INTEGER
ImageFilename (image_filename) - STRING
ImageX (image_x) - INTEGER
ImageY (image_y) - INTEGER
VisibilityRule (visibility_rule) - STRING
HeightSpan (height_span) - INTEGER
WidthSpan (width_span) - INTEGER
BackgroundRgb (background_rgb) - STRING
ForegroundRgb (foreground_rgb) - STRING
ButtonStyle (button_style) - STRING
ActionIdx (action_idx) - INTEGER
AnimationIdx (animation_idx) - INTEGER
RecordState (record_state) - STRING
Relationships:
Properties - ButtonGridProperty
ButtonGridProperty
Table: com_button_grid_p
Fields:

GridId (grid_id) - STRING
RowId (row_id) - INTEGER
ColumnId (column_id) - INTEGER
ComponentId (component_id) - STRING
should be 0 or 1.
Carton
Table: inv_carton
Fields:
DocumentId (invctl_document_id) - STRING

DocumentTypeCode (document_typcode) - STRING
CartonId (carton_id) - STRING
CartonStatusCode (carton_statcode) - STRING
ControlNumber (control_number) - STRING
RecordCreationType (record_creation_type) - STRING
Relationships:
Properties - CartonProperty
CartonProperty
Table: inv_carton_p
Fields:

should be 0 or 1.
CategoryServiceLocation
Table: cwo_category_service_loc
Fields:

ServiceLocationId (service_loc_id) - STRING
CategoryId (category_id) - STRING
LeadTimeQuantity (lead_time_qty) - DECIMAL
LeadTimeUnit (lead_time_unit_enum) - STRING
CreateShipment (create_shipment_flag) - BOOLEAN
Relationships:
CategoryServiceLocation - ServiceLocation
Properties - CategoryServiceLocationProperty
CategoryServiceLocationProperty
Table: cwo_category_service_loc_p
Fields:

should be 0 or 1.
ChargeAccountHistory
Table: cat_charge_acct_history
Fields:

HistorySeq (history_seq) - LONG
ActivityDate (activity_date) - DATE
ActivityEnum (activity_enum) - STRING
Amt (amt) - DECIMAL
AccountBalance (acct_balance) - DECIMAL
ReversedFlag (reversed_flag) - BOOLEAN
Relationships:
Properties - ChargeAccountHistoryProperty
ChargeAccountHistoryProperty
Table: cat_charge_acct_history_p
Fields:

HistorySeq (history_seq) - LONG
should be 0 or 1.
ChargeAccountInvoice
Table: cat_charge_acct_invoice
Fields:

InvoiceNumber (invoice_number) - STRING
OriginalInvoiceBalance (original_invoice_balance) - DECIMAL
InvoiceBalance (invoice_balance) - DECIMAL
LastActivityDate (last_activity_date) - DATE
InvoiceDate (invoice_date) - DATE
Relationships:
Properties - ChargeAccountInvoiceProperty
ChargeAccountInvoiceProperty
Table: cat_charge_acct_invoice_p
Fields:

should be 0 or 1.
ChargeAccountUser
Table: cat_charge_acct_users
Fields:

EffectiveDate (effective_date) - DATE
PrimaryContact (primary_contact_flag) - BOOLEAN
AccountUserFirstName (acct_user_first_name) - STRING
AccountUserLastName (acct_user_last_name) - STRING
Relationships:
Properties - ChargeAccountUserProperty
ChargeAccountUserProperty
Table: cat_charge_acct_users_p
Fields:

should be 0 or 1.
CheckTenderLineItem
Table: ttr_check_tndr_lineitm
Fields:

AuthorizationCode (auth_nbr) - STRING
BankId (bank_id) - STRING
CheckAccountNumber (check_acct_nbr) - STRING
CheckSequenceNumber (check_seq_nbr) - STRING
CustomerBirthDate (cust_birth_date) - DATE
MicrData (micr) - STRING
CheetahClientDeviceAccess
Table: ctl_cheetah_device_access
Fields:

Token (token) - STRING
Status (status) - STRING
SecretHash (secret_hash) - STRING
SecretExpirationDate (secret_exp_date) - DATE
Relationships:
Properties - CheetahClientDeviceAccessProperty
CheetahClientDeviceAccessProperty
Table: ctl_cheetah_device_access_p
Fields:

Token (token) - STRING
should be 0 or 1.
CloseDates
Table: loc_close_dates
Fields:

CloseDate (close_date) - DATE
ReasonCode (reason_code) - STRING
Relationships:
Properties - CloseDatesProperty
CloseDatesProperty
Table: loc_close_dates_p
Fields:

CloseDate (close_date) - DATE
should be 0 or 1.
ClosingMessage
Table: loc_closing_message
Fields:

ClosingMessage (closing_message) - STRING
Relationships:
Properties - ClosingMessageProperty
ClosingMessageProperty
Table: loc_closing_message_p
Fields:

should be 0 or 1.
CodeValue
Table: com_code_value
Fields:

Category (category) - STRING
Code (code) - STRING
ConfigElement (config_element) - STRING
Hidden (hidden_flag) - BOOLEAN
Rank (rank) - INTEGER
ImageUrl (image_url) - STRING
Relationships:
Properties - CodeValueProperty
CodeValueProperty
Table: com_code_value_p
Fields:

should be 0 or 1.
CommissionModifier
Table: trl_commission_mod
Fields:

CommissionModifierSequenceNbr (commission_mod_seq_nbr) - INTEGER
Amount (amt) - DECIMAL
Percentage (percentage) - DECIMAL
PercentageOfItem (percentage_of_item) - DECIMAL
UnverifiableEmployeeId (unverifiable_emp_id) - STRING
EmployeePartyId (employee_party_id) - LONG
Relationships:
EmployeeParty - Party
Properties - CommissionModifierProperty
CommissionModifierProperty
Table: trl_commission_mod_p
Fields:

CommissionModifierSequenceNbr (commission_mod_seq_nbr) - INTEGER
should be 0 or 1.
CorrectionModifier
Table: trl_correction_mod
Fields:

OriginalRetailLocationId (original_rtl_loc_id) - LONG
OriginalWorkstationId (original_wkstn_id) - LONG
OriginalBusinessDate (original_business_date) - DATE
OriginalTransactionSequence (original_trans_seq) - LONG
OriginalRetailTransactionLineItemSequence (original_rtrans_lineitm_seq) - INTEGER
ReasonCode (reascode) - STRING
Notes (notes) - STRING
OriginalTaxAmt (original_tax_amt) - DECIMAL
OriginalExtendedPrice (original_extended_amt) - DECIMAL
OriginalUnitPrice (original_unit_amt) - DECIMAL
OriginalBaseExtendedPrice (original_base_extended_amt) - DECIMAL
OriginalBaseUnitPrice (original_base_unit_amt) - DECIMAL
Relationships:
Properties - CorrectionModifierProperty
CorrectionModifierProperty
Table: trl_correction_mod_p
Fields:

should be 0 or 1.
CountryReturnMap
Table: com_country_return_map
Fields:

PurchasedFrom (purchased_from) - STRING
ReturnTo (return_to) - STRING
DisallowCrossBorderFlag (disallow_cross_border_flag) - BOOLEAN
Relationships:
Properties - CountryReturnMapProperty
CountryReturnMapProperty
Table: com_country_return_map_p
Fields:

PurchasedFrom (purchased_from) - STRING
ReturnTo (return_to) - STRING
should be 0 or 1.
Coupon
Table: dsc_coupon_xref
Fields:
CouponSerialNumber (coupon_serial_nbr) - STRING

DiscountCode (discount_code) - STRING
CouponType (coupon_type) - STRING
TenderId (tndr_id) - STRING
Serialized (serialized_flag) - BOOLEAN
Relationships:
CouponDiscount - Discount
Tender - Tender
Properties - CouponProperty
CouponLineItem
Table: trl_coupon_lineitm
Extends: RetailTransactionLineItem
Fields:

CouponTypeCode (typcode) - STRING
ExpirationDate (expr_date) - DATE
ManufacturerId (manufacturer_id) - STRING
ValueCode (value_code) - STRING
AmountEntered (amt_entered) - DECIMAL
ManufacturerFamilyCode (manufacturer_family_code) - STRING
Serialized (serialized_flag) - BOOLEAN
Authorized (authorized_flag) - BOOLEAN
RedemptionTransId (redemption_trans_id) - STRING
CouponProperty
Table: dsc_coupon_xref_p
Fields:
CouponSerialNumber (coupon_serial_nbr) - STRING

should be 0 or 1.
CouponTenderLineItem
Table: ttr_coupon_tndr_lineitm
Fields:

CouponTypeCode (typcode) - STRING
KeyEntered (key_entered_flag) - BOOLEAN
ManufacturerFamilyCode (manufacturer_family_code) - STRING
ManufacturerId (manufacturer_id) - STRING
PromotionCode (promotion_code) - STRING
ScanCode (scan_code) - STRING
CreditDebitTenderLineItem
Table: ttr_credit_debit_tndr_lineitm
Fields:

AuthorizationCode (auth_nbr) - STRING
BankReferenceNumber (bank_reference_number) - STRING
CustomerName (customer_name) - STRING
Ps2000 (ps2000) - STRING
MediaIssuerId (mediaissuer_id) - STRING
PersonalIdReferenceNumber (personal_id_ref_nbr) - STRING
PersonalIdRequiredTypeCode (personal_id_req_typcode) - STRING
ExpirationDateString (expr_date) - STRING
CashbackAmount (cashback_amt) - DECIMAL
CardLevelIndicator (card_level_indicator) - STRING
AccountNumberHash (acct_nbr_hash) - STRING
AuthorizationToken (authorization_token) - STRING
TransactionReferenceData (transaction_reference_data) - STRING
TraceNumber (trace_number) - STRING
TaxAmount (tax_amt) - DECIMAL
DiscountAmount (discount_amt) - DECIMAL
FreightAmount (freight_amt) - DECIMAL
DutyAmount (duty_amt) - DECIMAL
OriginalLocalDateTime (orig_local_date_time) - STRING
TransactionIdentifier (transaction_identifier) - STRING
CcvErrorCode (CCV_error_code) - STRING
PosEntryModeChange (POS_entry_mode_change) - STRING
ProcessingCode (processing_code) - STRING
PosEntryMode (POS_entry_mode) - STRING
PosAdditionalData (POS_addl_data ) - STRING
NetworkResultIndicator (network_result_indicator ) - STRING
MerchantCategoryCode (merchant_cat_code ) - STRING
UsageReasonCode (usage_reason_code) - STRING
DccCurrencyId (dcc_currency_id) - STRING
CustomerAccount
Table: cat_cust_acct
Fields:

ClassName (dtv_class_name) - STRING
CustIdentityReq (cust_identity_req_flag) - BOOLEAN
CustIdentityTypeCode (cust_identity_typcode) - STRING
CustAccountStateCode (cust_acct_statcode) - STRING
AccountSetupDate (acct_setup_date) - DATE
AccountPurchaseOrderNumber (acct_po_nbr) - STRING
Relationships:
Journals - CustomerAccountJournal
PaymentSchedule - PaymentSchedule
RetailLocation - RetailLocation
CustAccountNotes - CustomerAccountNote
Properties - CustomerAccountProperty
CustomerAccountAuthorization
Table: cat_authorizations
Fields:

StatusCode (status_code) - STRING
StatusDatetime (status_datetime) - DATE
AuthorizationType (authorization_type) - STRING
Relationships:
Properties - CustomerAccountAuthorizationProperty
CustomerAccountAuthorizationProperty
Table: cat_authorizations_p
Fields:

should be 0 or 1.
CustomerAccountJournal
Table: cat_cust_acct_journal
Fields:

JournalSequence (journal_seq) - LONG
CustIdentityTypeCode (cust_identity_typcode) - STRING
TransRetailLocationId (trans_rtl_loc_id) - LONG
TransWorkstationId (trans_wkstn_id) - LONG
TransBusinessDate (trans_business_date) - DATE
TransSequence (trans_trans_seq) - LONG
Relationships:
Properties - CustomerAccountJournalProperty
CustomerAccountJournalProperty
Table: cat_cust_acct_journal_p
Fields:

should be 0 or 1.
CustomerAccountNote
Table: cat_acct_note
Fields:
NoteSequence (note_seq) - LONG

EntryTimestamp (entry_timestamp) - DATE
EntryPartyId (entry_party_id) - LONG
Note (note) - CLOB
Relationships:
Properties - CustomerAccountNoteProperty
CustomerAccountNoteProperty
Table: cat_acct_note_p
Fields:

should be 0 or 1.
CustomerAccountPlan
Table: cat_cust_acct_plan
Fields:

PlanId (plan_id) - STRING
PlanDescription (plan_description) - STRING
DisplayOrder (display_order) - INTEGER
Relationships:
Properties - CustomerAccountPlanProperty
CustomerAccountPlanProperty
Table: cat_cust_acct_plan_p
Fields:

PlanId (plan_id) - STRING
should be 0 or 1.
CustomerAccountProperty
Table: cat_cust_acct_p
Fields:

should be 0 or 1.
CustomerAffiliation
Table: crm_customer_affiliation
Fields:

CustomerGroupId (cust_group_id) - STRING
Relationships:
Properties - CustomerAffiliationProperty
CustomerAffiliationProperty
Table: crm_customer_affiliation_p
Fields:

should be 0 or 1.
CustomerConsentInfo
Table: crm_consent_info
Fields:

TermsAndConditions (terms_and_conditions) - STRING
Consent1Text (consent1_text) - STRING
Relationships:
Properties - CustomerConsentInfoProperty
CustomerConsentInfoProperty
Table: crm_consent_info_p
Fields:

should be 0 or 1.
CustomerConsumerChargeAccount
Table: cat_cust_consumer_charge_acct
Extends: CustomerAccount
Fields:

CreditLimit (credit_limit) - DECIMAL
PoRequired (po_req_flag) - BOOLEAN
OnHold (on_hold_flag) - BOOLEAN
IsCorporateAccount (corporate_account_flag) - BOOLEAN
Relationships:
ChargeAccountUsers - ChargeAccountUser
ChargeAccountHistories - ChargeAccountHistory
CustomerItemAccount
Table: cat_cust_item_acct
Extends: CustomerAccount
Fields:

AccountTotal (acct_total) - DECIMAL
AccountPayments (total_payment_amt) - DECIMAL
ActiveAccountPayments (active_payment_amt) - DECIMAL
ActiveAccountTotal (active_acct_total) - DECIMAL
Relationships:
DeliveryModifier - DeliveryModifier
CustItemAccountDetails - CustomerItemAccountDetail
CustomerItemAccountActivity
Table: cat_cust_item_acct_activity
Fields:

CustAccountDetailNum (cust_item_acct_detail_item_nbr) - LONG
SequenceNumber (seq_nbr) - LONG
ExtendedAmount (extended_amt) - DECIMAL
ActivityDateTime (activity_datetime) - DATE
ActivityCode (item_acct_activity_code) - STRING
AccountLineItemStateCode (item_acct_lineitm_statcode) - STRING
TypeCode (line_typcode) - STRING
TransSequence (trans_seq) - LONG
TransLineItemSeq (rtrans_lineitm_seq) - LONG
NetAmount (net_amt) - DECIMAL
UnitPrice (unit_price) - DECIMAL
Quantity (quantity) - DECIMAL
ScheduledPickupDate (scheduled_pickup_date) - DATE
Relationships:
Properties - CustomerItemAccountActivityProperty
CustomerItemAccountActivityProperty
Table: cat_cust_item_acct_activity_p
Fields:

should be 0 or 1.
CustomerItemAccountDetail
Table: cat_cust_item_acct_detail
Fields:

StateCode (item_acct_lineitm_statcode) - STRING
TypeCode (line_typcode) - STRING
OrigItemAddDate (original_item_add_date) - DATE
ScheduledPickupDate (scheduled_pickup_date) - DATE
SourceLocationId (source_loc_id) - LONG
DeliveryType (delivery_type_id) - STRING
FullfillmentLocationId (fullfillment_loc_id) - LONG
ReceivedByCustDate (received_by_cust_date) - DATE
Relationships:
RetailLineItem - RetailTransactionLineItem
CustItemAccountActivities - CustomerItemAccountActivity
SourceLocation - RetailLocation
FullfillmentLocation - RetailLocation
Properties - CustomerItemAccountDetailProperty
CustomerItemAccountDetailProperty
Table: cat_cust_item_acct_detail_p
Fields:

should be 0 or 1.
CustomerItemAccountJournal
Table: cat_cust_item_acct_journal
Extends: CustomerAccountJournal
Fields:

AccountTotal (acct_total) - DECIMAL
AccountPayments (total_payment_amt) - DECIMAL
ActiveAccountPayments (active_payment_amt) - DECIMAL
ActiveAccountTotal (active_acct_total) - DECIMAL
CustomerItemAccountModifier
Table: trl_cust_item_acct_mod
Fields:

ItemAccountExtendedPrice (item_acct_extended_price) - DECIMAL
Relationships:
Properties - CustomerItemAccountModifierProperty
CustomerItemAccountModifierProperty
Table: trl_cust_item_acct_mod_p
Fields:

should be 0 or 1.
CustomerLoyaltyAccount
Table: cat_cust_loyalty_acct
Fields:

AccountId (cust_acct_id) - STRING
LoyaltyProgramId (loyalty_program_id) - STRING
LoyaltyProgramName (loyalty_program_name) - STRING
LoyaltyProgramLevelId (loyalty_program_level_id) - STRING
LoyaltyProgramLevelName (loyalty_program_level_name) - STRING
EscrowBalance (escrow_balance) - DECIMAL
BonusBalance (bonus_balance) - DECIMAL
Relationships:
Properties - CustomerLoyaltyAccountProperty
CustomerLoyaltyAccountProperty
Table: cat_cust_loyalty_acct_p
Fields:

AccountId (cust_acct_id) - STRING
should be 0 or 1.
CustomerLoyaltyCard
Table: cat_cust_acct_card
Fields:

CardNumber (cust_acct_card_nbr) - STRING
Relationships:
LoyaltyAccounts - CustomerLoyaltyAccount
AwardAccounts - AwardAccount
Properties - CustomerLoyaltyCardProperty
CustomerLoyaltyCardProperty
Table: cat_cust_acct_card_p
Fields:

CardNumber (cust_acct_card_nbr) - STRING
should be 0 or 1.
CustomerModifier
Table: xom_customer_mod
Fields:

CustomerId (customer_id) - STRING
OrganizationName (organization_name) - STRING
Salutation (salutation) - STRING
FirstName (first_name) - STRING
MiddleName (middle_name) - STRING
LastName (last_name) - STRING
Suffix (suffix) - STRING
Telephone1 (telephone1) - STRING
EmailAddress (email_address) - STRING
AddressSequence (address_seq) - LONG
Relationships:
Address - AddressModifier
Properties - CustomerModifierProperty
CustomerModifierProperty
Table: xom_customer_mod_p
Fields:

should be 0 or 1.
CustomerNote
Table: crm_customer_notes
Fields:

CreatorId (creator_id) - STRING
Note (note) - CLOB
NoteTimeStamp (note_timestamp) - DATE
Relationships:
Properties - CustomerNoteProperty
CustomerNoteProperty
Table: crm_customer_notes_p
Fields:

should be 0 or 1.
CustomizationModifier
Table: xom_customization_mod
Fields:

CustomizationCode (customization_code) - STRING
CustomizationMessage (customization_message) - STRING
Relationships:
Properties - CustomizationModifierProperty
CustomizationModifierProperty
Table: xom_customization_mod_p
Fields:

should be 0 or 1.
CycleQuestion
Table: loc_cycle_questions
Fields:

QuestionId (question_id) - STRING
EffectiveDate (effective_datetime) - DATE
ExpirationDate (expiration_datetime) - DATE
QuestionTextKey (question_text_key) - STRING
QuestionTypeCode (question_typcode) - STRING
CorporateMessage (corporate_message_flag) - BOOLEAN
Relationships:
QuestionChoices - CycleQuestionChoice
Properties - CycleQuestionProperty
CycleQuestionAnswer
Table: loc_cycle_question_answers
Fields:
AnswerId (answer_id) - STRING

AnswerTimestamp (answer_timestamp) - DATE
Relationships:
Properties - CycleQuestionAnswerProperty
CycleQuestionAnswerProperty
Table: loc_cycle_question_answers_p
Fields:

AnswerTimestamp (answer_timestamp) - DATE
should be 0 or 1.
CycleQuestionChoice
Table: loc_cycle_question_choices
Fields:

AnswerTextKey (answer_text_key) - STRING
Relationships:
Properties - CycleQuestionChoiceProperty
CycleQuestionChoiceProperty
Table: loc_cycle_question_choices_p
Fields:

should be 0 or 1.
CycleQuestionProperty
Table: loc_cycle_questions_p
Fields:

should be 0 or 1.
DataLoaderFailure
Table: ctl_dataloader_failure
Fields:

FileName (file_name) - STRING
RunTime (run_timestamp) - LONG
FailureSequence (failure_seq) - INTEGER
FailureMessage (failure_message) - STRING
FailedData (failed_data) - STRING
Relationships:
Properties - DataLoaderFailureProperty
DataLoaderFailureProperty
Table: ctl_dataloader_failure_p
Fields:

FailureSequence (failure_seq) - INTEGER
should be 0 or 1.
DataLoaderSummary
Table: ctl_dataloader_summary
Fields:

Success (success_flag) - BOOLEAN
SuccessfulRows (successful_rows) - INTEGER
FailedRows (failed_rows) - INTEGER
Relationships:
Properties - DataLoaderSummaryProperty
DataLoaderSummaryProperty
Table: ctl_dataloader_summary_p
Fields:

should be 0 or 1.
DatabaseTranslation
Table: com_translations
Fields:

Locale (locale) - STRING
Translation (translation) - STRING
Relationships:
Properties - DatabaseTranslationProperty
DatabaseTranslationProperty
Table: com_translations_p
Fields:

should be 0 or 1.
Deal
Table: prc_deal
Fields:

DealId (deal_id) - STRING
Description for a deal -- in some cases, this will be used as the line item description in the
transaction on line items to which the deal applies.
Consumable (consumable) - BOOLEAN
The field defines whether this transaction-level deal is defined as being exclusive. If it is and this
deal applies then no other transaction-level deal can be applied. Has no effect on item-level deals.
This field will be treated as 'false' unless otherwise set.
Deferred (act_deferred) - BOOLEAN
Typically used for document-related (rebate, bounceback, etc) rulesets, this will cause the deal to
be evaluated as though it were applying its results to a future transaction.
The importance of these deals is reduced by comparison to all other deals and if a small extra
reduction of the total of the current transaction can be obtained at the expense of deferred deals,
the better dealset for the current transaction will always take precedence.
This field will be treated as 'false' unless otherwise set.
This field represents the date on which the deal becomes effective. This may be combined with the
begin and end times to produce a 'happy hour' style of deal.
A null value here will result in an immediately effective deal. @see #getEndDate()
EndDate (end_date) - DATE
Counterpoint to {@link #getEffectiveDate()}, this allows for the end date of a promotional deal to be
encoded into the deal.
A null value here will result in a deal which has no expiration date.
StartTime (start_time) - DATE
The time of day at which this deal becomes effective.
A null value here will result in a deal which is active from the beginning of the day.
EndTime (end_time) - DATE
The time of day at which this deal becomes no longer applicable.
A null value here will result in a deal which has no expiration during the day(s) which it is
applicable.
GenerosityCap (generosity_cap) - DECIMAL
A deal with a generosity cap will never result in a discount of more than the cap set here.
IterationCap (iteration_cap) - INTEGER
A deal with an iteration cap will be allowed to apply to a transaction that many times. This is only
applicable for deals which have a set of items for which they are matching.
PriorityNudge (priority_nudge) - INTEGER
Given two deals which have an equal effect on the transaction, where one may be preferred over
the other (such as two deals with the same result on the current transaction where one is triggered
by the redemption of a bounce-back coupon, and the other is not) this allows the deal definer to
specify which of the deals should be more likely to apply to the transaction.
MinimumSubtotal (subtotal_min) - DECIMAL
This is the minimum subtotal to which the transaction must come for this deal to apply.
MaximumSubtotal (subtotal_max) - DECIMAL
This is the maximum subtotal the transaction may have before this deal is no longer applicable.
TransDeal (trans_deal_flag) - BOOLEAN
When "true", the deal is a transaction deal and a transaction-wide discount action must be
specified; otherwise the deal is an item level deal, and discount action is either set in item rules or
at deal level.
ActionType (trwide_action) - STRING
For a transaction deal, this is the required discount action to take on the entire transaction. No
action should be set for any item rules in this case. For an item level deal, discount action can be
set in this field to apply the discount to all qualified items from all item rules; or more commmonly a
discount action is set in each item rule instead and this field is left blank.
ActionAmount (trwide_amount) - DECIMAL
This is the amount, or argument, to apply with the deal discount action. e.g. If the actionType is
"PercentOff" this is the percentage discount which this deal will apply.
TaxabilityCode (taxability_code) - STRING
This indicates whether tax is calculated before this deal is applied, or after.
HigherNonactionAmt (higher_nonaction_amt_flag) - BOOLEAN
ExcludePriceOverride (exclude_price_override_flag) - BOOLEAN
ExcludeDiscounted (exclude_discounted_flag) - BOOLEAN
UseWeekSchedule (week_sched_flag) - BOOLEAN
Targeted (targeted_flag) - BOOLEAN
When "true", only customers whose records explicitly declare their eligibility for this deal will be
eligible for it. When "false", all customers will be eligible for this deal, including those not associated
with a given transaction. All other deal eligibility restrictions will apply regardless of this setting.
PromotionId (promotion_id) - STRING
GroupId (group_id) - STRING
Relationships:
Items - DealItemAction
CustomerGroups - DealCustomerGroups
Triggers - DealTrigger
Properties - DealProperty
DealCustomerGroups
Table: prc_deal_cust_groups
Fields:

Relationships:
Properties - DealCustomerGroupsProperty
DealCustomerGroupsProperty
Table: prc_deal_cust_groups_p
Fields:

should be 0 or 1.
DealDocumentXref
Table: prc_deal_document_xref
Fields:

SeriesId (series_id) - STRING
DocumentType (document_type) - STRING
Relationships:
Deals - Deal
DocDefinitions - DocumentDefinition
Properties - DealDocumentXrefProperty
DealDocumentXrefProperty
Table: prc_deal_document_xref_p
Fields:

should be 0 or 1.
DealFieldTest
Table: prc_deal_field_test
Fields:

Ordinal (item_ordinal) - INTEGER
ItemConditionGroup (item_condition_group) - INTEGER
ItemConditionSeq (item_condition_seq) - INTEGER
Field (item_field) - STRING
MatchRule (match_rule) - STRING
Value1 (value1) - STRING
Value2 (value2) - STRING
Relationships:
Properties - DealFieldTestProperty
DealFieldTestProperty
Table: prc_deal_field_test_p
Fields:

ItemConditionGroup (item_condition_group) - INTEGER
ItemConditionSeq (item_condition_seq) - INTEGER
should be 0 or 1.
DealItemAction
Table: prc_deal_item
Fields:

Consumable (consumable) - BOOLEAN
MinQty (qty_min) - DECIMAL
MaxQty (qty_max) - DECIMAL
MinItemTotal (min_item_total) - DECIMAL
ActionType (deal_action) - STRING
ActionArg (action_arg) - DECIMAL
ActionArgQty (action_arg_qty) - DECIMAL
Relationships:
FieldTests - DealFieldTest
Properties - DealItemActionProperty
DealItemActionProperty
Table: prc_deal_item_p
Fields:

should be 0 or 1.
DealProperty
Table: prc_deal_p
Fields:

should be 0 or 1.
DealTrigger
Table: prc_deal_trig
Fields:

Trigger (deal_trigger) - STRING
Relationships:
Properties - DealTriggerProperty
DealTriggerProperty
Table: prc_deal_trig_p
Fields:

Trigger (deal_trigger) - STRING
should be 0 or 1.
DealWeek
Table: prc_deal_week
Fields:

DayCode (day_code) - STRING
the day of the week that this deal is active, represented by a three letter day code
the earliest time for a given day/range that a deal is effective
the latest time for a given day/range that a deal is effective
Relationships:
Properties - DealWeekProperty
DealWeekProperty
Table: prc_deal_week_p
Fields:

the day of the week that this deal is active, represented by a three letter day code
the earliest time for a given day/range that a deal is effective
should be 0 or 1.
DeliveryModifier
Table: cat_delivery_modifier
Fields:

DeliveryType (delivery_enum) - STRING
ShippingMethod (shipping_method) - STRING
TrackingNumber (tracking_number) - STRING
Instructions (instructions) - STRING
Extension (extension) - STRING
DeliveryDate (delivery_date) - DATE
StartTime (delivery_start_time) - DATE
EndTime (delivery_end_time) - DATE
GeoCode (geo_code) - STRING
Relationships:
Properties - DeliveryModifierProperty
DeliveryModifierProperty
Table: cat_delivery_modifier_p
Fields:

should be 0 or 1.
DeviceConfig
Table: ctl_device_config
Fields:

HardwareFamilyType (hardware_family_type) - STRING
HardwareUse (hardware_use) - STRING
Relationships:
Properties - DeviceConfigProperty
DeviceConfigProperty
Table: ctl_device_config_p
Fields:

should be 0 or 1.
DeviceFiscalInfo
Table: ctl_device_fiscal_info
Fields:

DeviceId (device_id) - STRING
FiscalSessionNumber (fiscal_session_number) - STRING
Relationships:
Properties - DeviceFiscalInfoProperty
DeviceFiscalInfoProperty
Table: ctl_device_fiscal_info_p
Fields:

should be 0 or 1.
DeviceRegistration
Table: ctl_device_registration
Fields:

IpAddress (ip_address) - STRING
DateTimestamp (date_timestamp) - DATE
XtoreVersion (xstore_version) - STRING
EnvVersion (env_version) - STRING
ActiveFlag (active_flag) - BOOLEAN
ConfigVersion (config_version) - STRING
PrimaryRegister (primary_register_flag) - BOOLEAN
Relationships:
Properties - DeviceRegistrationProperty
DeviceRegistrationProperty
Table: ctl_device_registration_p
Fields:

should be 0 or 1.
DigitalSignature
Table: com_signature
Fields:

SignatureId (signature_id) - STRING
SignatureMode (signature_mode) - STRING
SignatureString (signature_string) - STRING
SignatureSource (signature_source) - STRING
Relationships:
Properties - DigitalSignatureProperty
DigitalSignatureProperty
Table: com_signature_p
Fields:

SignatureId (signature_id) - STRING
SignatureMode (signature_mode) - STRING
should be 0 or 1.
DimensionModifier
Table: trl_dimension_mod
Fields:

DimensionCode (dimension_code) - STRING
Value (value) - STRING
Relationships:
Properties - DimensionModifierProperty
DimensionModifierProperty
Table: trl_dimension_mod_p
Fields:

DimensionCode (dimension_code) - STRING
should be 0 or 1.
Discount
Table: dsc_discount
Fields:

Amount (discount) - DECIMAL
ApplicationMethodCode (app_mthd_code) - STRING
CalculationMethodCode (calculation_mthd_code) - STRING
EffectiveDatetime (effective_datetime) - DATE
ExclusiveDiscount (exclusive_discount_flag) - BOOLEAN
ExpirationDatetime (expr_datetime) - DATE
MaximumTransactionCount (max_trans_count) - LONG
MinimumEligiblePrice (min_eligible_price) - DECIMAL
Percent (percentage) - DECIMAL
Prompt (prompt) - STRING
Sound (sound) - STRING
SerializedDiscount (serialized_discount_flag) - BOOLEAN
PrivilegeType (privilege_type) - STRING
This indicates whether tax is calculated before this discount is applied, or after.
MaxDiscount (max_discount) - DECIMAL
MaxAmount (max_amount) - DECIMAL
MaxPercentage (max_percentage) - DECIMAL
DisallowChange (disallow_change_flag) - BOOLEAN
Relationships:
CompatibleDiscounts - DiscountCompatability
ValidSaleLineItemTypeCodes - DiscountTypeEligibility
CustomerGroups - DiscountGroupMapping
Privilege - Privilege
Properties - DiscountProperty
DiscountCompatability
Table: dsc_discount_compatibility
Fields:
CompatibleDiscountCode (compatible_discount_code) - STRING

PrimaryDiscountCode (primary_discount_code) - STRING
Relationships:
Properties - DiscountCompatabilityProperty
DiscountCompatabilityProperty
Table: dsc_discount_compatibility_p
Fields:
CompatibleDiscountCode (compatible_discount_code) - STRING

PrimaryDiscountCode (primary_discount_code) - STRING
should be 0 or 1.
DiscountGroupMapping
Table: dsc_discount_group_mapping
Fields:

Relationships:
Properties - DiscountGroupMappingProperty
DiscountGroupMappingProperty
Table: dsc_discount_group_mapping_p
Fields:

should be 0 or 1.
DiscountItemExclusions
Table: dsc_discount_item_exclusions
Fields:

ItemId (item_id) - STRING
Relationships:
Properties - DiscountItemExclusionsProperty
DiscountItemExclusionsProperty
Table: dsc_discount_item_exclusions_p
Fields:

should be 0 or 1.
DiscountItemInclusions
Table: dsc_discount_item_inclusions
Fields:

Relationships:
Properties - DiscountItemInclusionsProperty
DiscountItemInclusionsProperty
Table: dsc_discount_item_inclusions_p
Fields:

should be 0 or 1.
DiscountLineItem
Table: trl_discount_lineitm
Fields:

NewPrice (new_price) - DECIMAL
NewPriceQuantity (new_price_quantity) - DECIMAL
SerialNumber (serial_number) - STRING
AwardTransactionId (award_trans_id) - STRING
Relationships:
LineItemDiscount - Discount
DiscountProperty
Table: dsc_discount_p
Fields:

should be 0 or 1.
DiscountTypeEligibility
Table: dsc_disc_type_eligibility
Fields:

SaleLineItemTypeCode (sale_lineitm_typcode) - STRING
Relationships:
Properties - DiscountTypeEligibilityProperty
DiscountTypeEligibilityProperty
Table: dsc_disc_type_eligibility_p
Fields:

SaleLineItemTypeCode (sale_lineitm_typcode) - STRING
should be 0 or 1.
Document
Table: doc_document
Fields:
DocumentId (document_id) - STRING

DocumentStatus (document_status) - STRING
IssueDate (issue_date) - DATE
MaxAmount (max_amount) - DECIMAL
Relationships:
DocumentDefinition - DocumentDefinition
Properties - DocumentProperty
DocumentDefinition
Table: doc_document_definition
Fields:

StartIssueDate (start_issue_date) - DATE
EndIssueDate (end_issue_date) - DATE
StartRedeemDate (start_redeem_date) - DATE
EndRedeemDate (end_redeem_date) - DATE
VendorId (vendor_id) - STRING
ReceiptType (receipt_type) - STRING
SegmentType (segment_type) - STRING
TextCodeValue (text_code_value) - STRING
Relationships:
DocDefProperties - DocumentDefinitionProperties
Properties - DocumentDefinitionProperty
DocumentDefinitionProperties
Table: doc_document_def_properties
Fields:

Sequence (doc_seq_nbr) - LONG
Relationships:
Properties - DocumentDefinitionPropertiesProperty
DocumentDefinitionPropertiesProperty
Table: doc_document_def_properties_p
Fields:

Sequence (doc_seq_nbr) - LONG
should be 0 or 1.
DocumentDefinitionProperty
Table: doc_document_definition_p
Fields:

should be 0 or 1.
DocumentInventoryLocationModifier
Table: inv_inventory_loc_mod
Fields:

DocumentLineNumber (document_line_nbr) - LONG
ModifierSequence (mod_seq) - LONG
SerialNumber (serial_nbr) - STRING
SourceLocationId (source_location_id) - STRING
SourceBucketId (source_bucket_id) - STRING
DestinationLocationId (dest_location_id) - STRING
DestinationBucketId (dest_bucket_id) - STRING
ActionCode (action_code) - STRING
Cost (cost) - DECIMAL
Relationships:
Properties - DocumentInventoryLocationModifierProperty
DocumentInventoryLocationModifierProperty
Table: inv_inventory_loc_mod_p
Fields:

DocumentLineNumber (document_line_nbr) - LONG
should be 0 or 1.
DocumentLineItem
Table: doc_document_lineitm
Fields:

Relationships:
Document - Document
DocumentLineItemNote
Table: inv_document_lineitm_note
Fields:

InventoryDocumentLineNumber (invctl_document_line_nbr) - INTEGER
NoteId (note_id) - LONG
NoteDatetimestamp (note_timestamp) - DATE
Note (note_text) - CLOB
CreatorPartyId (creator_party_id ) - LONG
NoteType (note_type) - STRING
Relationships:
CreatorParty - Party
Properties - DocumentLineItemNoteProperty
DocumentLineItemNoteProperty
Table: inv_document_lineitm_note_p
Fields:

should be 0 or 1.
DocumentNote
Table: inv_document_notes
Fields:

NoteDatetimestamp (note_timestamp) - DATE
Note (note_text) - CLOB
CreatorPartyId (creator_party_id ) - LONG
NoteType (note_type) - STRING
Relationships:
Properties - DocumentNoteProperty
DocumentNoteProperty
Table: inv_document_notes_p
Fields:

should be 0 or 1.
DocumentProperty
Table: doc_document_p
Fields:

should be 0 or 1.
Employee
Table: hrs_employee
Fields:

EmployeeId (employee_id) - STRING
LoginId (login_id) - STRING
ActiveDate (active_date) - DATE
AddDate (add_date) - DATE
AdditionalWithholdings (additional_withholdings) - DECIMAL
BasePay (base_pay) - DECIMAL
ClockInNotRequired (clock_in_not_req_flag) - BOOLEAN
ClockedIn (clocked_in_flag) - BOOLEAN
EmergencyContactName (emergency_contact_name) - STRING
EmergencyContactPhone (emergency_contact_phone) - STRING
EmployeeGroup (employee_group_id) - STRING
EmployeePayStatus (employee_pay_status) - STRING
EmployeeRoleCode (employee_role_code) - STRING
EmployeeStatusCode (employee_statcode) - STRING
EmployeeTypeCode (employee_typcode) - STRING
EmployeeWorkStatus (employee_work_status) - STRING
HireDate (hire_date) - DATE
JobTitle (job_title) - STRING
LastReviewDate (last_review_date) - DATE
MaritalStatus (marital_status) - STRING
NextReviewDate (next_review_date) - DATE
PersonalDays (personal_days) - DECIMAL
PersonalDaysUsed (personal_days_used) - DECIMAL
SickDays (sick_days) - DECIMAL
SickDaysUsed (sick_days_used) - DECIMAL
SpouseName (spouse_name) - STRING
TerminatedDate (terminated_date) - DATE
VacationDays (vacation_days) - DECIMAL
VacationDaysUsed (vacation_days_used) - DECIMAL
TrainingStatusEnum (training_status_enum) - STRING
LockedOut (locked_out_flag) - BOOLEAN
LockedOutTimestamp (locked_out_timestamp) - DATE
OvertimeEligible (overtime_eligible_flag) - BOOLEAN
PrimaryGroupId (primary_group) - STRING
DepartmentId (department_id) - STRING
WorkCodeString (work_code) - STRING
Relationships:
Party - Party
PrimaryGroup - Group
WorkCode - WorkCodes
EmployeeStores - EmployeeStore
EmployeeNotes - EmployeeNote
EmployeeAnswers - EmployeeAnswers
Properties - EmployeeProperty
EmployeeAnswers
Table: hrs_employee_answers
Fields:

ChallengeCode (challenge_code) - STRING
ChallengeAnswer (challenge_answer) - STRING
Relationships:
Properties - EmployeeAnswersProperty
EmployeeAnswersProperty
Table: hrs_employee_answers_p
Fields:

ChallengeCode (challenge_code) - STRING
should be 0 or 1.
EmployeeFingerprint
Table: hrs_employee_fingerprint
Fields:

Sequence (fingerprint_seq) - INTEGER
BiometricStorage (fingerprint_storage) - CLOB
Relationships:
Properties - EmployeeFingerprintProperty
EmployeeFingerprintProperty
Table: hrs_employee_fingerprint_p
Fields:

Sequence (fingerprint_seq) - INTEGER
should be 0 or 1.
EmployeeMessage
Table: hrs_employee_message
Fields:

MessageId (message_id) - LONG
StartDate (start_date) - DATE
Priority (priority) - STRING
StoreCreated (store_created_flag) - BOOLEAN
WorkstationSpecific (wkstn_specific_flag) - BOOLEAN
WorkstationId (wkstn_id) - INTEGER
Description (content) - STRING
MessageURL (message_url ) - STRING
Relationships:
Properties - EmployeeMessageProperty
EmployeeMessageProperty
Table: hrs_employee_message_p
Fields:
MessageId (message_id) - LONG
should be 0 or 1.
EmployeeNote
Table: hrs_employee_notes
Fields:

Note (note) - CLOB
CreatorPartyId (creator_party_id) - LONG
Relationships:
Properties - EmployeeNoteProperty
EmployeeNoteProperty
Table: hrs_employee_notes_p
Fields:

should be 0 or 1.
EmployeePassword
Table: hrs_employee_password
Fields:

Sequence (password_seq) - INTEGER
Password (password) - STRING
Temporary (temp_password_flag) - BOOLEAN
Current (current_password_flag) - BOOLEAN
Relationships:
Properties - EmployeePasswordProperty
EmployeePasswordProperty
Table: hrs_employee_password_p
Fields:

Sequence (password_seq) - INTEGER
should be 0 or 1.
EmployeeProperty
Table: hrs_employee_p
Fields:

should be 0 or 1.
EmployeeStore
Table: hrs_employee_store
Fields:

EmployeeStoreSequence (employee_store_seq) - INTEGER
BeginDate (begin_date) - DATE
TemporaryAssignment (temp_assignment_flag) - BOOLEAN
Relationships:
Properties - EmployeeStoreProperty
EmployeeStoreProperty
Table: hrs_employee_store_p
Fields:

EmployeeStoreSequence (employee_store_seq) - INTEGER
should be 0 or 1.
EmployeeTask
Table: hrs_employee_task
Fields:

TaskId (task_id) - LONG
CompleteDate (complete_date) - DATE
Visibility (visibility) - STRING
AssignmentId (assignment_id) - STRING
Title (title) - STRING
Priority (priority) - STRING
Relationships:
CustomerParty - Party
EmployeeTaskNotes - EmployeeTaskNote
Properties - EmployeeTaskProperty
EmployeeTaskNote
Table: hrs_employee_task_notes
Fields:

Note (note) - CLOB
CreatorPartyId (creator_party_id) - LONG
Relationships:
Properties - EmployeeTaskNoteProperty
EmployeeTaskNoteProperty
Table: hrs_employee_task_notes_p
Fields:

should be 0 or 1.
EmployeeTaskProperty
Table: hrs_employee_task_p
Fields:

should be 0 or 1.
EmployeeTimeOff
Table: sch_emp_time_off
Fields:
TimeOffSeq (time_off_seq) - LONG
StartTime (start_datetime) - DATE
EndTime (end_datetime) - DATE
TypeCode (time_off_typcode) - STRING
Relationships:
Properties - EmployeeTimeOffProperty
EmployeeTimeOffProperty
Table: sch_emp_time_off_p
Fields:

TimeOffSeq (time_off_seq) - LONG
should be 0 or 1.
EscrowAccount
Table: cat_escrow_acct
Fields:

Relationships:
EscrowAccountActivities - EscrowAccountActivity
Properties - EscrowAccountProperty
EscrowAccountActivity
Table: cat_escrow_acct_activity
Fields:

SeqNbr (seq_nbr) - LONG
ActivityDate (activity_date) - DATE
ActivityEnum (activity_enum) - STRING
Amt (amt) - DECIMAL
SourceCustAccountId (source_cust_acct_id) - STRING
SourceCustAccountCode (source_cust_acct_code) - STRING
Relationships:
Properties - EscrowAccountActivityProperty
EscrowAccountActivityProperty
Table: cat_escrow_acct_activity_p
Fields:

SeqNbr (seq_nbr) - LONG
should be 0 or 1.
EscrowAccountProperty
Table: cat_escrow_acct_p
Fields:

should be 0 or 1.
EscrowTransaction
Table: trl_escrow_trans
Extends: PosTransaction
Fields:
ActivitySequenceNumber (activity_seq_nbr) - LONG
EscrowAmount (escrow_amt) - DECIMAL
CustomerPartyId (cust_party_id) - LONG
Relationships:
EscrowAccountActivity - EscrowAccountActivity
EventLogEntry
Table: ctl_event_log
Fields:

OperatorPartyId (operator_party_id) - LONG
LogLevel (log_level) - STRING
LogTimestamp (log_timestamp) - DATE
Source (source) - STRING
ThreadName (thread_name) - STRING
CriticalToDeliver (critical_to_deliver) - BOOLEAN
LoggerCategory (logger_category) - STRING
LogMessage (log_message) - STRING
ArrivalTimestamp (arrival_timestamp) - DATE
ExchangeRateTransLineItem
Table: tsn_xrtrans_lineitm
Fields:

LineItemSequence (line_seq) - INTEGER
BaseCurrency (base_currency) - STRING
TargetCurrency (target_currency) - STRING
OldExchangeRate (old_rate) - DECIMAL
NewExchangeRate (new_rate) - DECIMAL
Relationships:
Properties - ExchangeRateTransLineItemProperty
ExchangeRateTransLineItemProperty
Table: tsn_xrtrans_lineitm_p
Fields:

LineItemSequence (line_seq) - INTEGER
should be 0 or 1.
ExchangeRateTransaction
Table: trl_rtrans
Fields:

Relationships:
ExchangeRateTransLineItems - ExchangeRateTransLineItem
ExternalSystemMap
Table: com_external_system_map
Fields:
SystemId (system_id) - STRING

SystemCd (system_cd) - STRING
Relationships:
Properties - ExternalSystemMapProperty
ExternalSystemMapProperty
Table: com_external_system_map_p
Fields:
SystemId (system_id) - STRING

should be 0 or 1.
FeeModifier
Table: xom_fee_mod
Fields:

TaxAmount (tax_amount) - DECIMAL
Relationships:
Properties - FeeModifierProperty
FeeModifierProperty
Table: xom_fee_mod_p
Fields:

should be 0 or 1.
FiscalYear
Table: inv_stock_fiscal_year
Fields:

FiscalYear (fiscal_year) - INTEGER
Relationships:
Properties - FiscalYearProperty
FiscalYearProperty
Table: inv_stock_fiscal_year_p
Fields:

should be 0 or 1.
FlightInformation
Table: com_flight_info
Fields:

ScheduledDateTime (scheduled_date_time) - DATE
FlightNumber (flight_number) - STRING
OriginAirport (origin_airport) - STRING
DestinationAirport (destination_airport) - STRING
Via1Airport (via_1_airport) - STRING
Relationships:
Properties - FlightInformationProperty
FlightInformationProperty
Table: com_flight_info_p
Fields:

ScheduledDateTime (scheduled_date_time) - DATE
should be 0 or 1.
FulfillmentModifier
Table: xom_fulfillment_mod
Fields:

LocationId (loc_id) - STRING
LocationName1 (loc_name1) - STRING
Telephone1 (telephone) - STRING
Relationships:
Properties - FulfillmentModifierProperty
FulfillmentModifierProperty
Table: xom_fulfillment_mod_p
Fields:

should be 0 or 1.
GiftRegistryJournal
Table: crm_gift_registry_journal
Fields:

RegistryId (registry_id) - LONG
RegistryStatus (registry_status) - STRING
TransSequence (trans_trans_seq) - LONG
Relationships:
Properties - GiftRegistryJournalProperty
GiftRegistryJournalProperty
Table: crm_gift_registry_journal_p
Fields:

should be 0 or 1.
GiftRegistryTransaction
Table: trn_gift_registry_trans
Fields:

RegistryId (registry_id) - LONG
Group
Table: sec_groups
Fields:

BitmapPosition (bitmap_position) - INTEGER
GroupRank (group_rank) - INTEGER
Relationships:
Properties - GroupProperty
GroupProperty
Table: sec_groups_p
Fields:

should be 0 or 1.
IdentityVerification
Table: ttr_identity_verification
Fields:

IdentityVerificationSequence (identity_verification_seq) - INTEGER
IdNumber (id_nbr) - STRING
IdTypeCode (id_typcode) - STRING
IssuingAuthority (issuing_authority) - STRING
Relationships:
Properties - IdentityVerificationProperty
IdentityVerificationProperty
Table: ttr_identity_verification_p
Fields:

IdentityVerificationSequence (identity_verification_seq) - INTEGER
should be 0 or 1.
InventoryBucket
Table: inv_bucket
Fields:

BucketId (bucket_id) - STRING
Name (name) - STRING
FunctionCode (function_code) - STRING
AdjustmentAction (adjustment_action) - STRING
DefaultLocationId (default_location_id) - STRING
SystemBucket (system_bucket_flag) - BOOLEAN
Relationships:
Properties - InventoryBucketProperty
InventoryBucketProperty
Table: inv_bucket_p
Fields:

should be 0 or 1.
InventoryCostItemYearEnd
Table: inv_cst_item_yearend
Fields:

WacQuantityReceived (wac_qty_rcvd) - DECIMAL
WacValueReceived (wac_value_rcvd) - DECIMAL
PwacQuantityOnhandEndofyear (pwac_qty_onhand_endofyear) - DECIMAL
PwacValueOnhandEndofyear (pwac_value_onhand_endofyear) - DECIMAL
Relationships:
Properties - InventoryCostItemYearEndProperty
InventoryCostItemYearEndProperty
Table: inv_cst_item_yearend_p
Fields:

should be 0 or 1.
InventoryCount
Table: inv_count
Fields:

InventoryCountId (inv_count_id) - STRING
TypeCode (inv_count_typcode) - STRING
CountStatus (count_status) - STRING
Relationships:
InventoryCountBuckets - InventoryCountBucket
Properties - InventoryCountProperty
InventoryCountBucket
Table: inv_count_bucket
Fields:

InventoryBucketId (inv_bucket_id) - STRING
CountCycle (count_cycle) - INTEGER
BucketStatus (bucket_status) - STRING
InventoryBucketName (inv_bucket_name) - STRING
Relationships:
Properties - InventoryCountBucketProperty
InventoryCountBucketProperty
Table: inv_count_bucket_p
Fields:

should be 0 or 1.
InventoryCountProperty
Table: inv_count_p
Fields:

should be 0 or 1.
InventoryCountSection
Table: inv_count_section
Fields:

SectionId (section_id) - STRING
Relationships:
SectionDetails - InventoryCountSectionDetail
Properties - InventoryCountSectionProperty
InventoryCountSectionDetail
Table: inv_count_section_detail
Fields:

SectionDetailNumber (section_detail_nbr) - INTEGER
MerchandiseHierarchyLevel (merch_hierarchy_level) - STRING
MerchandiseHierarchyId (merch_hierarchy_id) - STRING
Relationships:
Properties - InventoryCountSectionDetailProperty
InventoryCountSectionDetailProperty
Table: inv_count_section_detail_p
Fields:

SectionDetailNumber (section_detail_nbr) - INTEGER
should be 0 or 1.
InventoryCountSectionProperty
Table: inv_count_section_p
Fields:

should be 0 or 1.
InventoryCountSheet
Table: inv_count_sheet
Fields:

CountSheetNumber (count_sheet_nbr) - INTEGER
SectionNumber (section_nbr) - INTEGER
SheetStatus (sheet_status) - STRING
CheckedOut (checked_out_flag) - BOOLEAN
Relationships:
CountSheetLineItems - InventoryCountSheetLineItem
Properties - InventoryCountSheetProperty
InventoryCountSheetLineItem
Table: inv_count_sheet_lineitm
Fields:

LineItemNumber (lineitm_nbr) - INTEGER
PageNumber (page_nbr) - INTEGER
AlternateId (alternate_id) - STRING
Relationships:
Properties - InventoryCountSheetLineItemProperty
InventoryCountSheetLineItemProperty
Table: inv_count_sheet_lineitm_p
Fields:

LineItemNumber (lineitm_nbr) - INTEGER
should be 0 or 1.
InventoryCountSheetProperty
Table: inv_count_sheet_p
Fields:

should be 0 or 1.
InventoryCountSnapshot
Table: inv_count_snapshot
Fields:

InventoryLocationId (inv_location_id) - STRING
SnapshotDate (snapshot_date) - DATE
Relationships:
Properties - InventoryCountSnapshotProperty
InventoryCountSnapshotProperty
Table: inv_count_snapshot_p
Fields:

InventoryLocationId (inv_location_id) - STRING
should be 0 or 1.
InventoryDocument
Table: inv_invctl_document
Fields:

CompleteDateTime (complete_date_timestamp) - DATE
CreateDateTime (create_date_timestamp) - DATE
OriginatorId (originator_id) - STRING
DocumentSubtypeCode (document_subtypcode) - STRING
OriginatorName (originator_name) - STRING
PoReferenceNumber (po_ref_nbr) - STRING
OriginatorAddressId (originator_address_id) - STRING
SubmitDate (submit_date) - DATE
Relationships:
InventoryDocumentLineItems - InventoryDocumentLineItem
Shipments - Shipment
Cartons - Carton
Notes - DocumentNote
OriginatorAddress - Address
Properties - InventoryDocumentProperty
InventoryDocumentCrossReference
Table: inv_invctl_document_xref
Fields:

CrossRefOrganizationId (cross_ref_organization_id) - LONG
CrossRefDocumentId (cross_ref_document_id) - STRING
CrossRefLineNumber (cross_ref_line_number) - INTEGER
CrossRefDocumentTypeCode (cross_ref_document_typcode) - STRING
CrossRefRetailLocationId (cross_ref_rtl_loc_id) - LONG
Relationships:
Properties - InventoryDocumentCrossReferenceProperty
InventoryDocumentCrossReferenceProperty
Table: inv_invctl_document_xref_p
Fields:
should be 0 or 1.
InventoryDocumentLineItem
Table: inv_invctl_document_lineitm
Fields:

InventoryItemId (inventory_item_id) - STRING
LineItemBusinessDate (lineitm_business_date) - DATE
LineItemRetailLocationId (lineitm_rtl_loc_id) - LONG
LineItemRetailTransactionLineItemSequence (lineitm_rtrans_lineitm_seq) - INTEGER
LineItemTransactionSequence (lineitm_trans_seq) - LONG
LineItemTypeCode (lineitm_typcode) - STRING
LineItemWorkstationId (lineitm_wkstn_id) - LONG
UnitCount (unit_count) - DECIMAL
UnitCost (unit_cost) - DECIMAL
ExpectedCount (expected_count) - DECIMAL
PostedCount (posted_count) - DECIMAL
PostedCost (posted_cost) - DECIMAL
EnteredItemDescription (entered_item_description) - STRING
EnteredItemId (entered_item_id) - STRING
Retail (retail) - DECIMAL
ModelNumber (model_nbr) - STRING
OriginalBucketId (original_bucket_id) - STRING
OriginalLocationId (original_loc_id) - STRING
ShippingWeight (shipping_weight) - DECIMAL
Relationships:
CustomerItemAccountMod - InventoryItemAccountModifier
SerialNumbers - InventoryDocumentLineSerial
DocumentInventoryLocationModifiers - DocumentInventoryLocationModifier
InventoryReplenishmentDocumentLineItem - InventoryReplenishmentDocumentLineItem
Notes - DocumentLineItemNote
InventoryLineCrossReference - InventoryDocumentCrossReference
Properties - InventoryDocumentLineItemProperty
InventoryDocumentLineItemProperty
Table: inv_invctl_document_lineitm_p
Fields:

should be 0 or 1.
InventoryDocumentLineSerial
Table: inv_invctl_doc_lineserial
Fields:

SerialLineNumber (serial_line_nbr) - INTEGER
Relationships:
Properties - InventoryDocumentLineSerialProperty
InventoryDocumentLineSerialProperty
Table: inv_invctl_doc_lineserial_p
Fields:

SerialLineNumber (serial_line_nbr) - INTEGER
should be 0 or 1.
InventoryDocumentModifier
Table: trl_invctl_document_mod
Fields:
DocumentModifierSequence (invctl_document_mod_seq) - INTEGER
Relationships:
InventoryDocument - InventoryDocument
Properties - InventoryDocumentModifierProperty
InventoryDocumentModifierProperty
Table: trl_invctl_document_mod_p
Fields:

DocumentModifierSequence (invctl_document_mod_seq) - INTEGER
should be 0 or 1.
InventoryDocumentProperty
Table: inv_invctl_document_p
Fields:

should be 0 or 1.
InventoryItemAccountModifier
Table: inv_item_acct_mod
Fields:

Relationships:
Properties - InventoryItemAccountModifierProperty
InventoryItemAccountModifierProperty
Table: inv_item_acct_mod_p
Fields:
should be 0 or 1.
InventoryJournal
Table: inv_inventory_journal
Fields:

TransactionLineItemSequence (trans_lineitm_seq) - LONG
InventoryItemId (inventory_item_id) - STRING
ItemSerialNumber (item_serial_nbr) - STRING
Relationships:
Properties - InventoryJournalProperty
InventoryJournalProperty
Table: inv_inventory_journal_p
Fields:

should be 0 or 1.
InventoryLocation
Table: inv_location
Fields:

LocationId (inv_location_id) - STRING
SystemLocation (system_location_flag) - BOOLEAN
Active (active_flag) - BOOLEAN
Relationships:
InventoryLocationBuckets - InventoryLocationBucket
AvailabilityCodes - InventoryLocationAvailability
Properties - InventoryLocationProperty
InventoryLocationAvailability
Table: inv_location_availability
Fields:

LocationId (location_id) - STRING
AvailabilityCode (availability_code) - STRING
Relationships:
Privilege - Privilege
Properties - InventoryLocationAvailabilityProperty
InventoryLocationAvailabilityProperty
Table: inv_location_availability_p
Fields:

should be 0 or 1.
InventoryLocationBucket
Table: inv_location_bucket
Fields:

TrackingMethod (tracking_method) - STRING
Relationships:
InventoryBucket - InventoryBucket
Properties - InventoryLocationBucketProperty
InventoryLocationBucketProperty
Table: inv_location_bucket_p
Fields:

should be 0 or 1.
InventoryLocationProperty
Table: inv_location_p
Fields:

LocationId (inv_location_id) - STRING
should be 0 or 1.
InventoryMovementPending
Table: inv_movement_pending
Fields:

LineItemSequence (trans_lineitm_seq) - INTEGER
Reconciled (reconciled_flag) - BOOLEAN
Relationships:
MovementPendingDetails - InventoryMovementPendingDetail
Item - Item
SaleLineItem - SaleReturnLineItem
InventoryTransactionDetail - InventoryTransactionDetail
Properties - InventoryMovementPendingProperty
InventoryMovementPendingDetail
Table: inv_movement_pending_detail
Fields:

LineItemSequence (trans_lineitm_seq) - LONG
PendingSequence (pending_seq) - LONG
Relationships:
Properties - InventoryMovementPendingDetailProperty
InventoryMovementPendingDetailProperty
Table: inv_movement_pending_detail_p
Fields:

LineItemSequence (trans_lineitm_seq) - LONG
PendingSequence (pending_seq) - LONG
should be 0 or 1.
InventoryMovementPendingProperty
Table: inv_movement_pending_p
Fields:

should be 0 or 1.
InventoryReplenishmentDocumentLineItem
Table: inv_rep_document_lineitm
Fields:

SuggestedOrderQuantity (suggested_order_qty) - DECIMAL
OrderQuantity (order_quantity) - DECIMAL
ConfirmedQuantity (confirmed_quantity) - DECIMAL
ConfirmationDate (confirmation_date) - DATE
ConfirmationNumber (confirmation_number) - STRING
ShipVia (ship_via) - STRING
ShippedQuantity (shipped_quantity) - DECIMAL
ShippedDate (shipped_date) - DATE
ReceivedQuantity (received_quantity) - DECIMAL
ReceivedDate (received_date) - DATE
SourceType (source_type) - STRING
SourceId (source_id) - STRING
SourceName (source_name) - STRING
ParentDocumentId (parent_document_id) - STRING
Relationships:
Properties - InventoryReplenishmentDocumentLineItemProperty
InventoryReplenishmentDocumentLineItemProperty
Table: inv_rep_document_lineitm_p
Fields:

should be 0 or 1.
InventorySummaryCountTransaction
Table: trn_trans
Fields:

Relationships:
InventorySummaryCountTransactionDetails - InventorySummaryCountTransactionDetail
InventorySummaryCountTransactionDetail
Table: inv_sum_count_trans_dtl
Fields:

TransLineSequence (trans_line_seq) - INTEGER
SystemCount (system_count) - DECIMAL
DeclaredCount (declared_count) - DECIMAL
Relationships:
Properties - InventorySummaryCountTransactionDetailProperty
InventorySummaryCountTransactionDetailProperty
Table: inv_sum_count_trans_dtl_p
Fields:
TransLineSequence (trans_line_seq) - INTEGER
should be 0 or 1.
InventoryTransaction
Table: inv_invctl_trans
Fields:

OldStatusCode (old_status_code) - STRING
NewStatusCode (new_status_code) - STRING
ReasonCode (invctl_trans_reascode) - STRING
InventoryDocumentRetailLocationId (invctl_document_rtl_loc_id) - LONG
DocumentDate (document_date) - DATE
Relationships:
InventoryDocument - InventoryDocument
InventoryTransactionDetails - InventoryTransactionDetail
InventoryTransactionDetail
Table: inv_invctl_trans_detail
Fields:

InventoryDetailSequence (invctl_trans_seq) - INTEGER
OldStatusCode (old_status_code) - STRING
NewStatusCode (new_status_code) - STRING
PreviousUnitCount (previous_unit_count) - DECIMAL
NewUnitCount (new_unit_count) - DECIMAL
NewPostedCount (new_posted_count) - DECIMAL
PreviousPostedCount (previous_posted_count) - DECIMAL
InventoryDocumentRetailLocationId (invctl_document_rtl_loc_id) - LONG
InventoryItemId (item_id) - STRING
Relationships:
InventoryDocumentLineItem - InventoryDocumentLineItem
Properties - InventoryTransactionDetailProperty
InventoryTransactionDetailProperty
Table: inv_invctl_trans_detail_p
Fields:

InventoryDetailSequence (invctl_trans_seq) - INTEGER
should be 0 or 1.
InventoryValidDestinations
Table: inv_valid_destinations
Fields:

DestinationTypeEnum (destination_type_enum) - STRING
DestinationId (destination_id) - STRING
Relationships:
Properties - InventoryValidDestinationsProperty
InventoryValidDestinationsProperty
Table: inv_valid_destinations_p
Fields:

DestinationTypeEnum (destination_type_enum) - STRING
DestinationId (destination_id) - STRING
should be 0 or 1.
Invoice
Table: cwo_invoice
Fields:

AmountDue (amount_due) - DECIMAL
Relationships:
InvoiceServiceLocation - ServiceLocation
LineItems - InvoiceLineItem
Properties - InvoiceProperty
InvoiceLineItem
Table: cwo_invoice_lineitm
Fields:

InvoiceLineItemSequence (invoice_lineitm_seq) - INTEGER
LineItemTypeCode (lineitm_typcode) - STRING
GlAccount (gl_account) - STRING
Relationships:
Properties - InvoiceLineItemProperty
InvoiceLineItemProperty
Table: cwo_invoice_lineitm_p
Fields:

InvoiceLineItemSequence (invoice_lineitm_seq) - INTEGER
should be 0 or 1.
InvoiceProperty
Table: cwo_invoice_p
Fields:

should be 0 or 1.
IpCashDrawerDevice
Table: ctl_ip_cashdrawer_device
Fields:

CashDrawerId (cash_drawer_id) - STRING
DrawerStatus (drawer_status) - STRING
ProductName (product_name) - STRING
TcpPort (tcp_port) - LONG
MacAddress (mac_address) - STRING
SubnetMask (subnet_mask) - STRING
Gateway (gateway) - STRING
DnsHostName (dns_hostname) - STRING
Dhcp (dhcp_flag) - BOOLEAN
FirmwareVersion (firmware_version) - STRING
Kup (kup) - STRING
KupUpdateDate (kup_update_date) - DATE
BeepOnOpen (beep_on_open_flag) - BOOLEAN
BeepLongOpen (beep_long_open_flag) - BOOLEAN
Relationships:
Properties - IpCashDrawerDeviceProperty
IpCashDrawerDeviceProperty
Table: ctl_ip_cashdrawer_device_p
Fields:

should be 0 or 1.
Item
Table: itm_item
Fields:

ItemLevelCode (item_lvlcode) - STRING
ItemTypeCode (item_typcode) - STRING
MerchLevel1Id (merch_level_1) - STRING
SerializedItem (serialized_item_flag) - BOOLEAN
ParentItemId (parent_item_id) - STRING
DisallowItemMatrixDisplay (disallow_matrix_display_flag) - BOOLEAN
ItemMatrixColor (item_matrix_color) - STRING
DimensionSystem (dimension_system) - STRING
Dimension1 (dimension1) - STRING
ListPrice (list_price) - DECIMAL
MeasurementRequired (measure_req_flag) - BOOLEAN
NotInventoried (not_inventoried_flag) - BOOLEAN
Relationships:
ItemOptions - ItemOptions
ParentItem - Item
ItemDealProperties - ItemDealProperty
ItemPromptProperties - ItemPromptProperty
ItemLabelProperties - ItemLabelProperties
ItemImages - ItemImage
ItemDimensionTypes - ItemDimensionType
ItemDimensionValues - ItemDimensionValue
Properties - ItemProperty
ItemCrossReference
Table: itm_item_cross_reference
Fields:
ManufacturerUpc (manufacturer_upc) - STRING

Manufacturer (manufacturer) - STRING
PrimaryFlag (primary_flag) - BOOLEAN
Relationships:
Item - Item
Properties - ItemCrossReferenceProperty
ItemCrossReferenceProperty
Table: itm_item_cross_reference_p
Fields:
ManufacturerUpc (manufacturer_upc) - STRING

should be 0 or 1.
ItemDealProperty
Table: itm_item_deal_prop
Fields:

ItemDealPropertyCode (itm_deal_property_code) - STRING
Relationships:
Properties - ItemDealPropertyProperty
ItemDealPropertyProperty
Table: itm_item_deal_prop_p
Fields:

ItemDealPropertyCode (itm_deal_property_code) - STRING
should be 0 or 1.
ItemDimensionType
Table: itm_item_dimension_type
Fields:

Dimension (dimension) - STRING
Sequence (seq) - INTEGER
PromptMessage (prompt_msg) - STRING
Relationships:
DimensionValues - ItemDimensionValue
Properties - ItemDimensionTypeProperty
ItemDimensionTypeProperty
Table: itm_item_dimension_type_p
Fields:

should be 0 or 1.
ItemDimensionValue
Table: itm_item_dimension_value
Fields:

DimensionValue (value) - STRING
Relationships:
Properties - ItemDimensionValueProperty
ItemDimensionValueProperty
Table: itm_item_dimension_value_p
Fields:

DimensionValue (value) - STRING
should be 0 or 1.
ItemImage
Table: itm_item_images
Fields:

FeatureId (feature_id) - STRING
Relationships:
Properties - ItemImageProperty
ItemImageProperty
Table: itm_item_images_p
Fields:

FeatureId (feature_id) - STRING
should be 0 or 1.
ItemLabelBatch
Table: itm_item_label_batch
Fields:

BatchName (batch_name) - STRING
StockLabel (stock_label) - STRING
Count (count) - LONG
OverridenPrice (overriden_price) - DECIMAL
Relationships:
Item - Item
Properties - ItemLabelBatchProperty
ItemLabelBatchProperty
Table: itm_item_label_batch_p
Fields:

BatchName (batch_name) - STRING
should be 0 or 1.
ItemLabelProperties
Table: itm_item_label_properties
Fields:

LogoUrl (logo_url) - STRING
Relationships:
Properties - ItemLabelPropertiesProperty
ItemLabelPropertiesProperty
Table: itm_item_label_properties_p
Fields:

should be 0 or 1.
ItemMessage
Table: itm_item_msg
Fields:
MessageId (msg_id) - STRING

ContentType (content_type) - STRING
Contents (contents) - OBJECT
ExpirationDate (expr_datetime) - DATE
MessageKey (msg_key) - STRING
TitleKey (title_key) - STRING
Relationships:
LineItemTypes - ItemMessageTypes
ItemIds - ItemMessageCrossReference
Properties - ItemMessageProperty
ItemMessageCrossReference
Table: itm_item_msg_cross_reference
Fields:

Relationships:
Properties - ItemMessageCrossReferenceProperty
ItemMessageCrossReferenceProperty
Table: itm_item_msg_cross_reference_p
Fields:

should be 0 or 1.
ItemMessageProperty
Table: itm_item_msg_p
Fields:

should be 0 or 1.
ItemMessageTypes
Table: itm_item_msg_types
Fields:

LineItemType (sale_lineitm_typcode) - STRING
Relationships:
Properties - ItemMessageTypesProperty
ItemMessageTypesProperty
Table: itm_item_msg_types_p
Fields:

LineItemType (sale_lineitm_typcode) - STRING
should be 0 or 1.
ItemModifier
Table: xom_item_mod
Fields:

Relationships:
Properties - ItemModifierProperty
ItemModifierProperty
Table: xom_item_mod_p
Fields:

should be 0 or 1.
ItemOptions
Table: itm_item_options
Fields:

ApplyRestockingFee (apply_restocking_fee_flag) - BOOLEAN
AttachedItems (attached_items_flag) - BOOLEAN
CompareAtPrice (compare_at_price) - DECIMAL
DisallowDiscounts (disallow_discounts_flag) - BOOLEAN
DisallowDeals (disallow_deals_flag) - BOOLEAN
DisallowPriceChange (disallow_price_change_flag) - BOOLEAN
DisallowSendSale (disallow_send_sale_flag) - BOOLEAN
DisallowCommission (disallow_commission_flag) - BOOLEAN
DisallowLayaway (disallow_layaway_flag) - BOOLEAN
DisallowWorkOrder (disallow_work_order_flag) - BOOLEAN
DisallowSpecialOrder (disallow_special_order_flag) - BOOLEAN
DisallowSelfcheckout (disallow_self_checkout_flag) - BOOLEAN
DisallowOrder (disallow_order_flag) - BOOLEAN
DisallowRainCheck (disallow_rain_check) - BOOLEAN
ForceQuantityOfOne (force_quantity_of_one_flag) - BOOLEAN
MaximumSaleUnitCount (max_sale_unit_count) - DECIMAL
MinimumSaleUnitCount (min_sale_unit_count) - DECIMAL
NoGiveaways (no_giveaways_flag) - BOOLEAN
NotReturnable (not_returnable_flag) - BOOLEAN
PartNumber (part_number) - STRING
PromptForPrice (prompt_for_price_flag) - BOOLEAN
PromptForQuantity (prompt_for_quantity_flag) - BOOLEAN
PromptForDescription (prompt_for_description_flag) - BOOLEAN
PromptForCustomer (prompt_for_customer) - STRING
RestockingFee (restocking_fee) - DECIMAL
SeasonCode (season_code) - STRING
SubstituteAvailable (substitute_available_flag) - BOOLEAN
VendorId (vendor) - STRING
SpecialOrderLeadDays (special_order_lead_days) - INTEGER
QtyScale (qty_scale) - INTEGER
Messages (messages_flag) - BOOLEAN
UnitOfMeasureCode (unit_of_measure_code) - STRING
TaxGroupId (tax_group_id) - STRING
Warranty (warranty_flag) - BOOLEAN
GenericItem (generic_item_flag) - BOOLEAN
CurrentSalePrice (curr_sale_price) - DECIMAL
InitialSaleQuantity (initial_sale_qty) - DECIMAL
DispositionCode (disposition_code) - STRING
ItemAvailabilityCode (item_availability_code) - STRING
StockStatus (stock_status) - STRING
FoodStampEligible (foodstamp_eligible_flag) - BOOLEAN
PackSize (pack_size) - DECIMAL
DefaultSourceType (default_source_type) - STRING
DefaultSourceId (default_source_id) - STRING
SellingGroupId (selling_group_id) - STRING
ExcludeFromNetSales (exclude_from_net_sales_flag) - BOOLEAN
FiscalItemId (fiscal_item_id) - STRING
FiscalItemDescription (fiscal_item_description) - STRING
TareValue (tare_value) - DECIMAL
TareUnitOfMeasureCode (tare_unit_of_measure_code) - STRING
Relationships:
ItemVendor - Vendor
Properties - ItemOptionsProperty
ItemOptionsProperty
Table: itm_item_options_p
Fields:

should be 0 or 1.
ItemPrices
Table: itm_item_prices
Fields:

ItemPricePropertyCode (itm_price_property_code) - STRING
PricingQuantity (price_qty) - DECIMAL
Price (price) - DECIMAL
Relationships:
Properties - ItemPricesProperty
ItemPricesProperty
Table: itm_item_prices_p
Fields:

ItemPricePropertyCode (itm_price_property_code) - STRING
PricingQuantity (price_qty) - DECIMAL
should be 0 or 1.
ItemPromptProperty
Table: itm_item_prompt_properties
Fields:

PromptPropertyCode (itm_prompt_property_code) - STRING
PromptMethodCode (prompt_mthd_code) - STRING
CodeGroup (code_group) - STRING
PromptTitleKey (prompt_title_key) - STRING
PromptMessageKey (prompt_msg_key) - STRING
Required (required_flag) - BOOLEAN
Relationships:
Properties - ItemPromptPropertyProperty
ItemPromptPropertyProperty
Table: itm_item_prompt_properties_p
Fields:

PromptPropertyCode (itm_prompt_property_code) - STRING
should be 0 or 1.
ItemProperty
Table: itm_item_p
Fields:

should be 0 or 1.
ItemRestrictGS1
Table: itm_restrict_gs1
Fields:

FieldId (field_id) - STRING
StartValue (start_value) - STRING
AiType (ai_type) - STRING
EndValue (end_value) - STRING
Relationships:
Properties - ItemRestrictGS1Property
ItemRestrictGS1Property
Table: itm_restrict_gs1_p
Fields:

FieldId (field_id) - STRING
StartValue (start_value) - STRING
should be 0 or 1.
KitComponent
Table: itm_kit_component
Fields:

KitItemId (kit_item_id) - STRING
ComponentItemId (component_item_id) - STRING
QuantityPerKit (quantity_per_kit) - INTEGER
Relationships:
Properties - KitComponentProperty
KitComponentModifier
Table: trl_kit_component_mod
Fields:

ComponentItemDesc (component_item_desc) - STRING
Quantity (quantity) - INTEGER
Relationships:
KitComponent - KitComponent
Properties - KitComponentModifierProperty
KitComponentModifierProperty
Table: trl_kit_component_mod_p
Fields:

should be 0 or 1.
KitComponentProperty
Table: itm_kit_component_p
Fields:

should be 0 or 1.
LegalEntity
Table: loc_legal_entity
Fields:

LegalEntityId (legal_entity_id) - STRING
District (district) - STRING
Area (area) - STRING
EmailAddr (email_addr) - STRING
TaxId (tax_id) - STRING
FiscalCode (fiscal_code) - STRING
TaxationRegime (taxation_regime) - STRING
LegalEmployerId (legal_employer_id) - STRING
TaxOfficeCode (tax_office_code) - STRING
StatisticalCode (statistical_code) - STRING
Relationships:
Properties - LegalEntityProperty
LegalEntityProperty
Table: loc_legal_entity_p
Fields:

should be 0 or 1.
LineItemAssociationModifier
Table: trl_lineitm_assoc_mod
Fields:
BusinessDate (parent_business_date) - DATE

LineItemAssociationModifierSequence (lineitm_assoc_mod_seq) - INTEGER
RetailLocationId (parent_rtl_loc_id) - LONG
RetailTransactionLineItemSequence (parent_rtrans_lineitm_seq) - INTEGER
TransactionSequence (parent_trans_seq) - LONG
WorkstationId (parent_wkstn_id) - LONG
ChildBusinessDate (child_business_date) - DATE
ChildRetailLocationId (child_rtl_loc_id) - LONG
ChildRetailTransactionLineItemSequence (child_rtrans_lineitm_seq) - INTEGER
ChildTransactionSequence (child_trans_seq ) - LONG
ChildWorkstationId (child_wkstn_id ) - LONG
LineItemAssociationTypeCodeString (lineitm_assoc_typcode ) - STRING
Relationships:
ChildLineItem - SaleReturnLineItem
LineItemAssociationTypeCode - LineItemAssociationTypeCode
Properties - LineItemAssociationModifierProperty
LineItemAssociationModifierProperty
Table: trl_lineitm_assoc_mod_p
Fields:
BusinessDate (parent_business_date) - DATE

LineItemAssociationModifierSequence (lineitm_assoc_mod_seq) - INTEGER
RetailLocationId (parent_rtl_loc_id) - LONG
RetailTransactionLineItemSequence (parent_rtrans_lineitm_seq) - INTEGER
TransactionSequence (parent_trans_seq) - LONG
WorkstationId (parent_wkstn_id) - LONG
should be 0 or 1.
LineItemAssociationTypeCode
Table: trl_lineitm_assoc_typcode
Fields:
CascadeDelete (cascade_delete_flag) - BOOLEAN
CascadeQuantity (cascade_quantity_flag) - BOOLEAN
ChildRestrictDelete (child_restrict_delete_flag) - BOOLEAN
ChildRestrictPrice (child_restrict_price_flag) - BOOLEAN
ChildRestrictQuantity (child_restrict_quantity_flag) - BOOLEAN
ParentRestrictDelete (parent_restrict_delete_flag) - BOOLEAN
ParentRestrictPrice (parent_restrict_price_flag) - BOOLEAN
ParentRestrictQuantity (parent_restrict_quantity_flag) - BOOLEAN
Relationships:
Properties - LineItemAssociationTypeCodeProperty
LineItemAssociationTypeCodeProperty
Table: trl_lineitm_assoc_typcode_p
Fields:

should be 0 or 1.
LineItemGenericStorage
Table: trn_generic_lineitm_storage
Fields:
LineItemSequence (rtrans_lineitm_seq) - INTEGER
DataStorage (data_storage) - CLOB
Relationships:
Properties - LineItemGenericStorageProperty
LineItemGenericStorageProperty
Table: trn_generic_lineitm_storage_p
Fields:

LineItemSequence (rtrans_lineitm_seq) - INTEGER
should be 0 or 1.
MatrixSortOrder
Table: itm_matrix_sort_order
Fields:
MatrixSortType (matrix_sort_type) - STRING
MatrixSortId (matrix_sort_id) - STRING
Relationships:
Properties - MatrixSortOrderProperty
MatrixSortOrderProperty
Table: itm_matrix_sort_order_p
Fields:

MatrixSortType (matrix_sort_type) - STRING
MatrixSortId (matrix_sort_id) - STRING
should be 0 or 1.
Measurement
Table: com_measurement
Fields:

Symbol (symbol) - STRING
Factor (factor) - DECIMAL
QtyScale (qty_scale) - INTEGER
Relationships:
Properties - MeasurementProperty
MeasurementProperty
Table: com_measurement_p
Fields:

should be 0 or 1.
MerchandiseHierarchy
Table: itm_merch_hierarchy
Fields:
HierarchyId (hierarchy_id) - STRING

ParentId (parent_id) - STRING
DisallowItemMatrixDisplay (disallow_matrix_display_flag) - BOOLEAN
ItemMatrixColor (item_matrix_color) - STRING
Relationships:
Properties - MerchandiseHierarchyProperty
MerchandiseHierarchyProperty
Table: itm_merch_hierarchy_p
Fields:
HierarchyId (hierarchy_id) - STRING

should be 0 or 1.
MobileServer
Table: ctl_mobile_server
Fields:

Hostname (hostname) - STRING
Port (port) - LONG
Alias (alias) - STRING
Relationships:
Properties - MobileServerProperty
MobileServerProperty
Table: ctl_mobile_server_p
Fields:

Port (port) - LONG
should be 0 or 1.
MovementPendingTransaction
Table: trn_trans
Fields:

Relationships:
MovementPendingTransactionLineItems - MovementPendingTransactionLineItem
MovementPendingTransactionLineItem
Table: inv_mptrans_lineitm
Fields:

OriginalLineItemSequence (original_trans_lineitm_seq) - INTEGER
QuantityReconciled (quantity_reconciled) - DECIMAL
Relationships:
InventoryMovementPending - InventoryMovementPending
Properties - MovementPendingTransactionLineItemProperty
MovementPendingTransactionLineItemProperty
Table: inv_mptrans_lineitm_p
Fields:

should be 0 or 1.
NoSaleTransaction
Table: trn_no_sale_trans
Fields:

NoSaleReasonCode (no_sale_reascode) - STRING
NonPhysicalItem
Table: itm_non_phys_item
Extends: Item
Fields:

NonPhysicalItemTypeCode (non_phys_item_typcode) - STRING
NonPhysicalItemSubtype (non_phys_item_subtype) - STRING
Order
Table: xom_order
Fields:

OrderType (order_type) - STRING
OrderDate (order_date) - DATE
OrderLocationId (order_loc_id) - STRING
Subtotal (subtotal) - DECIMAL
Total (total) - DECIMAL
BalanceDue (balance_due) - DECIMAL
ReferenceNumber (ref_nbr) - STRING
AdditionalFreightCharges (additional_freight_charges) - DECIMAL
AdditionalCharges (additional_charges) - DECIMAL
ShipComplete (ship_complete_flag) - BOOLEAN
FreightTax (freight_tax) - DECIMAL
OrderMessage (order_message) - STRING
GiftMessage (gift_message) - STRING
UnderReview (under_review_flag) - BOOLEAN
StatusCodeReason (status_code_reason) - STRING
StatusCodeReasonNote (status_code_reason_note) - STRING
Relationships:
Customer - CustomerModifier
Payments - OrderPayment
Fees - OrderFee
OrderLines - OrderLine
Properties - OrderProperty
OrderFee
Table: xom_order_fee
Fields:

Relationships:
Properties - OrderFeeProperty
OrderFeeProperty
Table: xom_order_fee_p
Fields:

should be 0 or 1.
OrderLine
Table: xom_order_line
Fields:

FulfillmentType (fulfillment_type) - STRING
ItemUpcCode (item_upc_code) - STRING
ItemEanCode (item_ean_code) - STRING
Relationships:
Item - ItemModifier
OrderLineDetails - OrderLineDetail
Properties - OrderLineProperty
OrderLineDetail
Table: xom_order_line_detail
Fields:

ExternalOrderId (external_order_id) - STRING
FulfillmentType (fulfillment_type) - STRING
ExtendedPrice (extended_price) - DECIMAL
SelectedShipMethod (selected_ship_method) - STRING
ActualShipMethod (actual_ship_method) - STRING
TrackingNumber (tracking_nbr) - STRING
DropShip (drop_ship_flag) - BOOLEAN
StatusCodeReason (status_code_reason) - STRING
StatusCodeReasonNote (status_code_reason_note) - STRING
ExtendedFreight (extended_freight) - DECIMAL
CustomizationCharge (customization_charge) - DECIMAL
GiftWrap (gift_wrap_flag) - BOOLEAN
ShipAlone (ship_alone_flag) - BOOLEAN
ShipWeight (ship_weight) - DECIMAL
LineMessage (line_message) - STRING
Relationships:
SourceModifier - SourceModifier
FulfillmentModifier - FulfillmentModifier
BalanceModifiers - BalanceModifier
CustomizationModifiers - CustomizationModifier
Fees - FeeModifier
Properties - OrderLineDetailProperty
OrderLineDetailProperty
Table: xom_order_line_detail_p
Fields:

should be 0 or 1.
OrderLineProperty
Table: xom_order_line_p
Fields:

should be 0 or 1.
OrderModifier
Table: xom_order_mod
Fields:

ExternalOrderId (external_order_id) - STRING
OrderType (order_type) - STRING
DetailType (detail_type) - STRING
Relationships:
Properties - OrderModifierProperty
OrderModifierProperty
Table: xom_order_mod_p
Fields:

should be 0 or 1.
OrderPayment
Table: xom_order_payment
Fields:

Sequence (sequence) - INTEGER
Relationships:
Properties - OrderPaymentProperty
OrderPaymentProperty
Table: xom_order_payment_p
Fields:

should be 0 or 1.
OrderProperty
Table: xom_order_p
Fields:

should be 0 or 1.
OrgHierarchy
Table: loc_org_hierarchy
Fields:

LevelCode (org_code) - STRING
LevelValue (org_value) - STRING
ParentCode (parent_code) - STRING
ParentValue (parent_value) - STRING
LevelManager (level_mgr) - STRING
LevelOrder (level_order) - INTEGER
Inactive (inactive_flag) - BOOLEAN
Relationships:
ParentElement - OrgHierarchy
Properties - OrgHierarchyProperty
OrgHierarchyProperty
Table: loc_org_hierarchy_p
Fields:

LevelCode (org_code) - STRING
LevelValue (org_value) - STRING
should be 0 or 1.
Organizer
Table: rpt_organizer
Fields:

ReportName (report_name) - STRING
ReportGroup (report_group) - STRING
ReportElement (report_element) - STRING
ReportOrder (report_order) - INTEGER
Relationships:
Properties - OrganizerProperty
OrganizerProperty
Table: rpt_organizer_p
Fields:

ReportName (report_name) - STRING
ReportGroup (report_group) - STRING
ReportElement (report_element) - STRING
should be 0 or 1.
Party
Table: crm_party
Fields:

AllegianceRetailLocationId (allegiance_rtl_loc_id) - LONG
BirthDate (birth_date) - DATE
CustomerId (cust_id) - STRING
NationalTaxId (national_tax_id) - STRING
FirstName2 (first_name2) - STRING
Gender (gender) - STRING
LastName2 (last_name2) - STRING
PreferredLocale (preferred_locale) - STRING
OrganizationTypeCode (organization_typcode) - STRING
PartyTypeCode (party_typcode) - STRING
PictureUri (picture_uri) - STRING
SignUpRetailLocationId (sign_up_rtl_loc_id) - LONG
SocialSecurityNbr (social_security_nbr) - STRING
PersonalTaxId (personal_tax_id) - STRING
Active (active_flag) - BOOLEAN
EmailRcpts (email_rcpts_flag) - BOOLEAN
AnniversaryDate (anniversary_date) - DATE
Prospect (prospect_flag) - BOOLEAN
Rent (rent_flag) - BOOLEAN
PrivacyCard (privacy_card_flag) - BOOLEAN
CommercialCustomer (commercial_customer_flag) - BOOLEAN
ContactPref (contact_pref) - STRING
Relationships:
AlternatePartyIds - PartyIdCrossReference
CustomerGroups - CustomerAffiliation
LocaleInformation - PartyLocaleInformation
TelephoneInformation - PartyTelephone
EmailInformation - PartyEmail
LoyaltyCards - CustomerLoyaltyCard
CustomerNotes - CustomerNote
Properties - PartyProperty
PartyCrossReference
Table: crm_party_cross_reference
Fields:
ChildPartyId (child_party_id) - LONG

ParentPartyId (parent_party_id) - LONG
PartyRelationshipTypeCode (party_relationship_typcode) - STRING
Relationships:
Properties - PartyCrossReferenceProperty
PartyCrossReferenceProperty
Table: crm_party_cross_reference_p
Fields:
ChildPartyId (child_party_id) - LONG

ParentPartyId (parent_party_id) - LONG
PartyRelationshipTypeCode (party_relationship_typcode) - STRING
should be 0 or 1.
PartyEmail
Table: crm_party_email
Fields:

Sequence (email_sequence) - INTEGER
EmailType (email_type) - STRING
EmailFormat (email_format) - STRING
Contact (contact_flag) - BOOLEAN
Primary (primary_flag) - BOOLEAN
Relationships:
Properties - PartyEmailProperty
PartyEmailProperty
Table: crm_party_email_p
Fields:

Sequence (email_sequence) - INTEGER
should be 0 or 1.
PartyIdCrossReference
Table: crm_party_id_xref
Fields:

AlternateIdOwner (alternate_id_owner) - STRING
AlternateId (alternate_id) - STRING
Relationships:
Properties - PartyIdCrossReferenceProperty
PartyIdCrossReferenceProperty
Table: crm_party_id_xref_p
Fields:

AlternateIdOwner (alternate_id_owner) - STRING
should be 0 or 1.
PartyLocaleInformation
Table: crm_party_locale_information
Fields:

Sequence (party_locale_seq) - INTEGER
AddressType (address_type) - STRING
Relationships:
Properties - PartyLocaleInformationProperty
PartyLocaleInformationProperty
Table: crm_party_locale_information_p
Fields:

Sequence (party_locale_seq) - INTEGER
should be 0 or 1.
PartyProperty
Table: crm_party_p
Fields:

should be 0 or 1.
PartyTelephone
Table: crm_party_telephone
Fields:

TelephoneType (telephone_type) - STRING
ContactType (contact_type) - STRING
TelephoneNumber (telephone_number) - STRING
Relationships:
Properties - PartyTelephoneProperty
PartyTelephoneProperty
Table: crm_party_telephone_p
Fields:

TelephoneType (telephone_type) - STRING
should be 0 or 1.
PaymentSchedule
Table: cat_payment_schedule
Fields:

IntervalTypeEnum (interval_type_enum) - STRING
IntervalCount (interval_count) - INTEGER
TotalPaymentAmount (total_payment_amt) - DECIMAL
PaymentCount (payment_count) - INTEGER
Relationships:
Properties - PaymentScheduleProperty
PaymentScheduleProperty
Table: cat_payment_schedule_p
Fields:

should be 0 or 1.
Payroll
Table: thr_payroll
Fields:
RetailLocId (rtl_loc_id) - LONG

PayrollCategory (payroll_category) - STRING
HoursCount (hours_count) - DECIMAL
Posted (posted_flag) - BOOLEAN
PostedDate (posted_date) - DATE
PayrollStatus (payroll_status) - STRING
ReviewedDate (reviewed_date) - DATE
PayCode (pay_code) - STRING
Relationships:
Properties - PayrollProperty
PayrollCategory
Table: thr_payroll_category
Fields:

IncludeInOverTime (include_in_overtime_flag) - BOOLEAN
PayCode (pay_code) - STRING
WorkingCategory (working_category_flag) - BOOLEAN
Relationships:
Properties - PayrollCategoryProperty
PayrollCategoryProperty
Table: thr_payroll_category_p
Fields:

should be 0 or 1.
PayrollHeader
Table: thr_payroll_header
Fields:

WeekEndingDate (week_ending_date) - DATE
ReviewedDate (reviewed_date) - DATE
Relationships:
Properties - PayrollHeaderProperty
PayrollHeaderProperty
Table: thr_payroll_header_p
Fields:

should be 0 or 1.
PayrollNotes
Table: thr_payroll_notes
Fields:

NoteSeq (note_seq) - LONG
NoteText (note_text) - CLOB
Relationships:
Properties - PayrollNotesProperty
PayrollNotesProperty
Table: thr_payroll_notes_p
Fields:

should be 0 or 1.
PayrollProperty
Table: thr_payroll_p
Fields:

should be 0 or 1.
PosLogData
Table: trn_poslog_data
Fields:

PoslogBytes (poslog_bytes) - OBJECT
Relationships:
Properties - PosLogDataProperty
PosLogDataProperty
Table: trn_poslog_data_p
Fields:

should be 0 or 1.
PosTransaction
Table: trn_trans
Fields:

BeginDateTimestamp (begin_datetime) - DATE
TransactionDate (trans_date) - DATE
BeginTimeInt (begin_time_int) - INTEGER
EndDateTimestamp (end_datetime) - DATE
KeyedOffline (keyed_offline_flag) - BOOLEAN
SessionId (session_id) - LONG
Subtotal (subtotal) - DECIMAL
TaxAmount (taxtotal) - DECIMAL
RoundedAmount (roundtotal) - DECIMAL
Total (total) - DECIMAL
TransactionStatusCode (trans_statcode) - STRING
TransactionTypeCode (trans_typcode) - STRING
TransactionCancelledReasonCode (trans_cancel_reascode) - STRING
GenericStorage (generic_storage_flag) - BOOLEAN
OperatorPartyId (operator_party_id) - LONG
PostVoid (post_void_flag) - BOOLEAN
FiscalNumber (fiscal_number) - STRING
DeviceId (device_id) - STRING
FiscalSessionNumber (fiscal_session_number) - STRING
Relationships:
OperatorParty - Party
RetailTransactionLineItems - RetailTransactionLineItem
TransactionLinks - PosTransactionLink
TransactionNotes - TransactionNotes
Properties - PosTransactionProperty
PosTransactionLink
Table: trn_trans_link
Fields:

LinkBusinessDate (link_business_date) - DATE
LinkRetailLocationId (link_rtl_loc_id) - LONG
LinkTransactionSequence (link_trans_seq) - LONG
LinkWorkstationId (link_wkstn_id) - LONG
LinkTypeCode (link_typcode) - STRING
Relationships:
LinkedTransaction - PosTransaction
Properties - PosTransactionLinkProperty
PosTransactionLinkProperty
Table: trn_trans_link_p
Fields:

LinkBusinessDate (link_business_date) - DATE
LinkRetailLocationId (link_rtl_loc_id) - LONG
LinkTransactionSequence (link_trans_seq) - LONG
LinkWorkstationId (link_wkstn_id) - LONG
should be 0 or 1.
PosTransactionProperty
Table: trn_trans_p
Fields:

should be 0 or 1.
PostVoidTransaction
Table: trn_post_void_trans
Fields:

VoidedTransactionEntryCode (voided_trans_entry_code) - STRING
VoidedBusinessDate (voided_business_date) - DATE
VoidedWorkstationId (voided_wkstn_id) - LONG
VoidedTransactionId (voided_trans_id) - LONG
VoidedRetailStoreId (voided_rtl_store_id) - LONG
VoidedOrganizationId (voided_org_id) - LONG
PostVoidReasonCode (post_void_reascode) - STRING
Relationships:
VoidedTransaction - PosTransaction
PostalCodeMapping
Table: tax_postal_code_mapping
Fields:

TaxLocationId (tax_loc_id) - STRING
Relationships:
PostalTaxLocation - TaxLocation
Properties - PostalCodeMappingProperty
PostalCodeMappingProperty
Table: tax_postal_code_mapping_p
Fields:

should be 0 or 1.
PricingHierarchy
Table: loc_pricing_hierarchy
Fields:

ParentValue (parent_value) - STRING
LevelOrder (level_order) - INTEGER
Relationships:
ParentElement - PricingHierarchy
Properties - PricingHierarchyProperty
PricingHierarchyProperty
Table: loc_pricing_hierarchy_p
Fields:

should be 0 or 1.
Privilege
Table: sec_privilege
Fields:

AuthenticationRequired (authentication_req) - BOOLEAN
Overridable (overridable_flag) - BOOLEAN
SecondPromptSettings (second_prompt_settings) - STRING
SecondPromptReqrDiffEmp (second_prompt_req_diff_emp) - BOOLEAN
SecondPromptGroupMembershipRaw (second_prompt_group_membership) - CLOB
Relationships:
Properties - PrivilegeProperty
PrivilegeProperty
Table: sec_privilege_p
Fields:

should be 0 or 1.
QuickItem
Table: itm_quick_items
Fields:

ParentId (parent_id) - STRING
Relationships:
Item - Item
Properties - QuickItemProperty
QuickItemProperty
Table: itm_quick_items_p
Fields:

should be 0 or 1.
RainCheck
Table: trn_raincheck
Fields:

RainCheckId (rain_check_id) - STRING
SalePrice (sale_price) - DECIMAL
ExpirationBusinessDate (expiration_business_date) - DATE
RedeemedFlag (redeemed_flag) - BOOLEAN
Relationships:
Item - Item
Properties - RainCheckProperty
RainCheckProperty
Table: trn_raincheck_p
Fields:

should be 0 or 1.
RainCheckTransaction
Table: trn_raincheck_trans
Fields:

Relationships:
RainCheck - RainCheck
ReasonCode
Table: com_reason_code
Fields:

ReasonTypeCode (reason_typcode) - STRING
CommentRequired (comment_req) - STRING
GlAccountNumber (gl_acct_nbr) - STRING
MinimumAmt (minimum_amt) - DECIMAL
MaximumAmt (maximum_amt) - DECIMAL
CustomerMessage (cust_msg) - STRING
InventoryActionCode (inv_action_code) - STRING
InventoryLocationId (location_id) - STRING
InventoryBucketId (bucket_id) - STRING
Relationships:
Properties - ReasonCodeProperty
ReasonCodeProperty
Table: com_reason_code_p
Fields:

ReasonTypeCode (reason_typcode) - STRING
should be 0 or 1.
ReceiptData
Table: trn_receipt_data
Fields:

ReceiptId (receipt_id) - STRING
ReceiptBytes (receipt_data) - OBJECT
Relationships:
Properties - ReceiptDataProperty
ReceiptDataProperty
Table: trn_receipt_data_p
Fields:

ReceiptId (receipt_id) - STRING
should be 0 or 1.
ReceiptText
Table: com_receipt_text
Fields:

TextCode (text_code) - STRING
TextSequence (text_seq) - INTEGER
TextSubcode (text_subcode) - STRING
ReceiptText (receipt_text) - STRING
LineFormat (line_format) - STRING
Reformat (reformat_flag) - BOOLEAN
Relationships:
Properties - ReceiptTextProperty
ReceiptTextProperty
Table: com_receipt_text_p
Fields:

TextCode (text_code) - STRING
TextSequence (text_seq) - INTEGER
TextSubcode (text_subcode) - STRING
should be 0 or 1.
RefundSchedule
Table: itm_refund_schedule
Fields:

MaximumFullRefundTime (max_full_refund_time) - INTEGER
MinimumNoRefundTime (min_no_refund_time) - INTEGER
Relationships:
Properties - RefundScheduleProperty
RefundScheduleProperty
Table: itm_refund_schedule_p
Fields:

should be 0 or 1.
ReportData
Table: com_report_data
Fields:

OwnerId (owner_id) - STRING
OwnerType (owner_type_enum) - STRING
ReportId (report_id) - STRING
ReportDataBytes (report_data) - OBJECT
Delete (delete_flag) - BOOLEAN
Relationships:
Properties - ReportDataProperty
ReportDataProperty
Table: com_report_data_p
Fields:

should be 0 or 1.
ReportLookup
Table: com_report_lookup
Fields:

ReportUrl (report_url) - STRING
RecordType (record_type_enum) - STRING
RecordCreationDate (record_creation_date) - DATE
RecordLevel (record_level_enum) - STRING
ParentReportId (parent_report_id) - STRING
Relationships:
Properties - ReportLookupProperty
ReportLookupProperty
Table: com_report_lookup_p
Fields:

should be 0 or 1.
ReprintReceiptTransaction
Table: trn_reprint_receipt
Fields:

ReceiptType (receipt_type) - STRING
Relationships:
ReprintReceiptTransactionDetails - ReprintReceiptTransactionDetail
ReprintReceiptTransactionDetail
Table: trn_reprint_receipt_dtl
Fields:

ReprintDetailSequence (reprint_detail_seq) - INTEGER
OriginalGiftLineItemSequence (original_gift_lineitm_seq) - INTEGER
Relationships:
Properties - ReprintReceiptTransactionDetailProperty
ReprintReceiptTransactionDetailProperty
Table: trn_reprint_receipt_dtl_p
Fields:

ReprintDetailSequence (reprint_detail_seq) - INTEGER
should be 0 or 1.
Restriction
Table: itm_restriction
Fields:

RestrictionId (restriction_id) - STRING
RestrictionDescription (restriction_description) - STRING
Relationships:
RestrictionMapping - RestrictionMapping
RestrictionType - RestrictionType
Properties - RestrictionProperty
RestrictionCalendar
Table: itm_restriction_calendar
Fields:

RestrictionTypeCode (restriction_typecode) - STRING
Relationships:
Properties - RestrictionCalendarProperty
RestrictionCalendarProperty
Table: itm_restriction_calendar_p
Fields:

should be 0 or 1.
RestrictionMapping
Table: itm_restriction_mapping
Fields:

MerchHierarchyLevel (merch_hierarchy_level) - STRING
MerchHierarchyId (merch_hierarchy_id) - STRING
Relationships:
Properties - RestrictionMappingProperty
RestrictionMappingProperty
Table: itm_restriction_mapping_p
Fields:

MerchHierarchyLevel (merch_hierarchy_level) - STRING
MerchHierarchyId (merch_hierarchy_id) - STRING
should be 0 or 1.
RestrictionProperty
Table: itm_restriction_p
Fields:

should be 0 or 1.
RestrictionType
Table: itm_restriction_type
Fields:

ValueType (value_type) - STRING
BooleanValue (boolean_value) - BOOLEAN
ExcludeReturns (exclude_returns_flag) - BOOLEAN
Relationships:
RestrictionCalendar - RestrictionCalendar
Properties - RestrictionTypeProperty
RestrictionTypeProperty
Table: itm_restriction_type_p
Fields:

should be 0 or 1.
RetailInventoryLocationModifier
Table: trl_inventory_loc_mod
Fields:

TransactionLineItemSequence (rtrans_lineitm_seq) - LONG
Relationships:
Properties - RetailInventoryLocationModifierProperty
RetailInventoryLocationModifierProperty
Table: trl_inventory_loc_mod_p
Fields:

TransactionLineItemSequence (rtrans_lineitm_seq) - LONG
should be 0 or 1.
RetailLocation
Table: loc_rtl_loc
Fields:

CurrencyId (currency_id) - STRING
StoreName (store_name) - STRING
StoreNbr (store_nbr) - STRING
AlternateStoreNbr (alternate_store_nbr) - STRING
Latitude (latitude) - DECIMAL
Longitude (longitude) - DECIMAL
DefaultTaxPercentage (default_tax_percentage) - DECIMAL
StoreManager (store_manager) - STRING
LocationType (location_type) - STRING
DeliveryAvailable (delivery_available_flag) - BOOLEAN
PickupAvailable (pickup_available_flag) - BOOLEAN
TransferAvailable (transfer_available_flag) - BOOLEAN
EmailAddress (email_addr) - STRING
GeoCode (geo_code) - STRING
UezIndicator (uez_flag) - BOOLEAN
District (district) - STRING
Area (area) - STRING
UseTillAccountability (use_till_accountability_flag) - BOOLEAN
DepositBankName (deposit_bank_name) - STRING
DepositBankAcctNbr (deposit_bank_account_number) - STRING
Relationships:
LegalEntity - LegalEntity
Properties - RetailLocationProperty
RetailLocationProperty
Table: loc_rtl_loc_p
Fields:

should be 0 or 1.
RetailLocationTaxMapping
Table: tax_rtl_loc_tax_mapping
Fields:

Relationships:
TaxLocation - TaxLocation
Properties - RetailLocationTaxMappingProperty
RetailLocationTaxMappingProperty
Table: tax_rtl_loc_tax_mapping_p
Fields:

should be 0 or 1.
RetailPriceModifier
Table: trl_rtl_price_mod
Fields:

RetailPriceModifierSequenceNbr (rtl_price_mod_seq_nbr) - INTEGER
PriceChangeAmount (price_change_amt) - DECIMAL
PriceChangeReasonCode (price_change_reascode) - STRING
PromotionId (promotion_id) - STRING
RetailPriceModifierReasonCode (rtl_price_mod_reascode) - STRING
DiscountGroupId (discount_group_id) - INTEGER
DiscBusinessDate (disc_business_date) - DATE
DiscRetailLocationId (disc_rtl_loc_id) - LONG
DiscRetailTransactionLineItemSequence (disc_rtrans_lineitm_seq) - INTEGER
DiscTransactionSequence (disc_trans_seq) - LONG
DiscWorkstationId (disc_wkstn_id) - LONG
DiscountReasonCode (discount_reascode) - STRING
DealAmount (deal_amt) - DECIMAL
Relationships:
Discount - Discount
ReasonLineItem - RetailTransactionLineItem
Properties - RetailPriceModifierProperty
RetailPriceModifierProperty
Table: trl_rtl_price_mod_p
Fields:

RetailPriceModifierSequenceNbr (rtl_price_mod_seq_nbr) - INTEGER
should be 0 or 1.
RetailTransaction
Table: trl_rtrans
Fields:

LoyaltyCard (loyalty_card_number) - STRING
CustomerPartyId (cust_party_id) - LONG
TaxExemptionId (tax_exemption_id) - STRING
Relationships:
InventoryDocumentModifiers - InventoryDocumentModifier
TaxExemption - TaxExemption
FlightInformation - RetailTransactionFlightInfo
RetailTransactionDealLineItem
Table: trl_deal_lineitm
Fields:

ReasonCode (discount_reascode) - STRING
RetailTransactionExchangeLineItem
Table: trl_rtrans_serial_exchange
Fields:

OriginalSerialNumber (orig_serial_nbr) - STRING
NewSerialNumber (new_serial_nbr) - STRING
OriginalRetailLocationId (orig_rtl_loc_id) - LONG
OriginalBusinessDate (orig_business_date) - DATE
OriginalWorkstationId (orig_wkstn_id) - LONG
OriginalTransactionSequence (orig_trans_seq) - LONG
OiginalLineItemSequence (orig_lineitm_seq) - INTEGER
ExchangeReasonCode (exchange_reason_code) - STRING
ExchangeComment (exchange_comment) - STRING
Relationships:
RetailInventoryLocationModifiers - RetailInventoryLocationModifier
Item - Item
RetailTransactionFlightInfo
Table: trl_rtrans_flight_info
Fields:

DestinationAirport (destination_airport) - STRING
DestinationCountry (destination_country) - STRING
DestinationZone (destination_zone) - STRING
DestinationAirportName (destination_airport_name) - STRING
TaxCalculationMode (tax_calculation_mode) - STRING
FirstFlightNumber (first_flight_number) - STRING
FirstDestinationAirport (first_destination_airport) - STRING
FirstOriginAirport (first_origin_airport) - STRING
FirstFlightSeatNumber (first_flight_seat_number) - STRING
FirstFlightScheduledDate (first_flight_scheduled_date) - DATE
Relationships:
DestinationZoneObject - AirportZone
Properties - RetailTransactionFlightInfoProperty
RetailTransactionFlightInfoProperty
Table: trl_rtrans_flight_info_p
Fields:

should be 0 or 1.
RetailTransactionLineItem
Table: trl_rtrans_lineitm
Fields:

BeginDateTimestamp (begin_date_timestamp) - DATE
EndDateTimestamp (end_date_timestamp) - DATE
LineItemStatusCode (rtrans_lineitm_statcode) - STRING
LineItemTypeCode (rtrans_lineitm_typcode) - STRING
VoidLineItemReasonCode (void_lineitm_reascode) - STRING
GenericStorage (generic_storage_flag) - BOOLEAN
TLogSequence (tlog_lineitm_seq) - INTEGER
Relationships:
CorrectionModifier - CorrectionModifier
Signature - TenderSignature
Properties - RetailTransactionLineItemProperty
RetailTransactionLineItemNotes
Table: trl_lineitm_notes
Fields:

Note (note) - CLOB
NoteDatetimestamp (note_datetime) - DATE
Relationships:
Properties - RetailTransactionLineItemNotesProperty
RetailTransactionLineItemNotesProperty
Table: trl_lineitm_notes_p
Fields:

should be 0 or 1.
RetailTransactionLineItemProperty
Table: trl_rtrans_lineitm_p
Fields:

should be 0 or 1.
ReturnedItemCount
Table: trl_returned_item_count
Fields:

ReturnedCount (returned_count) - DECIMAL
Relationships:
Properties - ReturnedItemCountProperty
ReturnedItemCountProperty
Table: trl_returned_item_count_p
Fields:

should be 0 or 1.
ReturnedItemJournal
Table: trl_returned_item_journal
Fields:

ReturnedCount (returned_count) - DECIMAL
ReturnedRetailLocationId (rtn_rtl_loc_id) - LONG
ReturnedWorkstationId (rtn_wkstn_id) - LONG
ReturnedBusinessDate (rtn_business_date) - DATE
ReturnedRetailTransactionLineItemSequence (rtn_rtrans_lineitm_seq) - INTEGER
ReturnedTransactionSequence (rtn_trans_seq) - LONG
Relationships:
Properties - ReturnedItemJournalProperty
ReturnedItemJournalProperty
Table: trl_returned_item_journal_p
Fields:

should be 0 or 1.
SafeBag
Table: tsn_safe_bag
Fields:

SafeBagId (safe_bag_id) - STRING
BagStatus (bag_status) - STRING
Relationships:
Session - Session
Properties - SafeBagProperty
SafeBagProperty
Table: tsn_safe_bag_p
Fields:

should be 0 or 1.
SaleReturnLineItem
Table: trl_sale_lineitm
Fields:

BaseExtendedPrice (base_extended_price) - DECIMAL
BaseUnitPrice (base_unit_price) - DECIMAL
GiftReceiptCount (rcpt_count) - INTEGER
GrossAmount (gross_amt) - DECIMAL
InventoryActionCode (inventory_action_code) - STRING
ItemIdEntryMethodCode (item_id_entry_mthd_code) - STRING
RptBaseUnitPrice (rpt_base_unit_price) - DECIMAL
OriginalLineItemSequence ( original_rtrans_lineitm_seq) - INTEGER
PriceDerivationMethodCode (price_derivtn_mthd_code) - STRING
PriceEntryMethodCode (price_entry_mthd_code) - STRING
ReturnComment (return_comment) - STRING
Return (return_flag) - BOOLEAN
ReturnTypeCode (return_typcode) - STRING
SaleReturnLineItemTypeCode (sale_lineitm_typcode) - STRING
ScannedItemId (scanned_item_id) - STRING
EnteredDescription (entered_description) - STRING
VatAmount (vat_amt) - DECIMAL
ForceZeroExtendedAmt (force_zero_extended_amt_flag) - BOOLEAN
ReturnReasonCode (return_reascode) - STRING
NetQuantity (net_quantity) - DECIMAL
GrossQuantity (gross_quantity) - DECIMAL
FoodStampsAppliedAmount (food_stamps_applied_amount) - DECIMAL
RegularBasePrice (regular_base_price) - DECIMAL
PricePropertyCode (price_property_code) - STRING
AttachedItemFlag (attached_item_flag) - BOOLEAN
InitialQuantity (initial_quantity) - DECIMAL
NotReturnable (not_returnable_flag) - BOOLEAN
ExcludeFromNetSales (exclude_from_net_sales_flag) - BOOLEAN
MeasurementRequired (measure_req_flag) - BOOLEAN
WeightEntryMethodCode (weight_entry_mthd_code) - STRING
TareValue (tare_value) - DECIMAL
TareType (tare_type) - STRING
TareUnitOfMeasureCode (tare_unit_of_measure_code) - STRING
Relationships:
BaseReturnedQuantity - ReturnedItemCount
CommissionModifiers - CommissionModifier
DimensionModifiers - DimensionModifier
InventoryDocumentLineItems - InventoryDocumentLineItem
LineItemAssociationModifiers - LineItemAssociationModifier
RetailPriceModifiers - RetailPriceModifier
TaxGroup - TaxGroup
TaxModifiers - SaleTaxModifier
CustomerAccountModifier - CustomerItemAccountModifier
Item - Item
LineItemNotes - RetailTransactionLineItemNotes
RetailInventoryLocationModifiers - RetailInventoryLocationModifier
OrderModifier - OrderModifier
KitComponentModifiers - KitComponentModifier
SaleTaxModifier
Table: trl_sale_tax_lineitm
Fields:

SaleTaxModifierSequence (sale_tax_lineitm_seq) - INTEGER
TaxPercentage (tax_percentage) - DECIMAL
RawTaxAmount (raw_tax_amount) - DECIMAL
RawTaxPercentage (raw_tax_percentage) - DECIMAL
ExemptTaxAmount (exempt_tax_amount) - DECIMAL
TaxExemptAmount (tax_exempt_amt) - DECIMAL
TaxOverrideAmount (tax_override_amt) - DECIMAL
TaxOverride (tax_override_flag) - BOOLEAN
TaxOverridePercentage (tax_override_percentage) - DECIMAL
TaxOverrideReasonCode (tax_override_reascode) - STRING
TaxOverrideComment (tax_override_comment) - STRING
TaxableAmount (taxable_amt) - DECIMAL
TaxRuleSequence (tax_rule_seq_nbr) - INTEGER
AuthorityId (authority_id) - STRING
AuthorityName (authority_name) - STRING
AuthorityTypeCode (authority_type_code) - STRING
TaxOverrideBracket (tax_override_bracket_id) - STRING
OrigTaxableAmount (orig_taxable_amount) - DECIMAL
OrigTaxGroupId (orig_tax_group_id) - STRING
Relationships:
SaleTaxGroupRule - TaxGroupRule
Properties - SaleTaxModifierProperty
SaleTaxModifierProperty
Table: trl_sale_tax_lineitm_p
Fields:

SaleTaxModifierSequence (sale_tax_lineitm_seq) - INTEGER
should be 0 or 1.
SalesGoal
Table: sls_sales_goal
Fields:

SalesGoalId (sales_goal_id) - STRING
SalesGoalValue (sales_goal_value) - DECIMAL
This is the amount to use when calculating the goal. It can be a percentage, dollar amount, or item
count depending on the associated template criteria.
Description for a sales goal
Relationships:
Properties - SalesGoalProperty
SalesGoalProperty
Table: sls_sales_goal_p
Fields:

SalesGoalId (sales_goal_id) - STRING
should be 0 or 1.
Schedule
Table: sch_schedule
Fields:

ScheduleSeq (schedule_seq) - LONG
ScheduleDuration (schedule_duration) - LONG
BreakDuration (break_duration) - LONG
Relationships:
Properties - ScheduleProperty
ScheduleProperty
Table: sch_schedule_p
Fields:

ScheduleSeq (schedule_seq) - LONG
should be 0 or 1.
SecurityLog
Table: sec_activity_log
Fields:

ActivityType (activity_typcode) - STRING
Success (success_flag) - BOOLEAN
OverridingEmployeeId (overriding_employee_id) - STRING
SystemDateTime (system_datetime) - DATE
SendCheckTenderLineItem
Table: ttr_send_check_tndr_lineitm
Fields:
Address1 (payable_to_address) - STRING
Address2 (payable_to_address2) - STRING
Apartment (payable_to_apt) - STRING
City (payable_to_city) - STRING
Country (payable_to_country) - STRING
PayableToName (payable_to_name) - STRING
PostalCode (payable_to_postal_code) - STRING
State (payable_to_state) - STRING
SendCheckReasonCode (reascode) - STRING
Neighborhood (payable_to_neighborhood) - STRING
County (payable_to_county) - STRING
Sequence
Table: com_sequence
Fields:

SequenceId (sequence_id) - STRING
SequenceMode (sequence_mode) - STRING
SequenceNumber (sequence_nbr) - LONG
Relationships:
Properties - SequenceProperty
SequencePart
Table: com_sequence_part
Fields:

Prefix (prefix) - STRING
Encode (encode_flag) - BOOLEAN
CheckDigitAlgorithm (check_digit_algo) - STRING
Numeric (numeric_flag) - BOOLEAN
PadLength (pad_length) - LONG
PadCharacter (pad_character) - STRING
InitialValue (initial_value) - LONG
MaxValue (max_value) - LONG
ValueIncrement (value_increment) - LONG
IncludeStoreId (include_store_id) - BOOLEAN
StorePadLength (store_pad_length) - LONG
IncludeWorkstationId (include_wkstn_id) - BOOLEAN
WorkstationPadLength (wkstn_pad_length) - LONG
Relationships:
Properties - SequencePartProperty
SequencePartProperty
Table: com_sequence_part_p
Fields:

should be 0 or 1.
SequenceProperty
Table: com_sequence_p
Fields:

SequenceMode (sequence_mode) - STRING
should be 0 or 1.
SerializedStockLedger
Table: inv_serialized_stock_ledger
Fields:

InvLocationId (inv_location_id) - STRING
Relationships:
Properties - SerializedStockLedgerProperty
SerializedStockLedgerProperty
Table: inv_serialized_stock_ledger_p
Fields:
should be 0 or 1.
ServiceCredential
Table: sec_service_credentials
Fields:

ServiceId (service_id) - STRING
UserName (user_name) - STRING
Password (password) - STRING
Relationships:
Properties - ServiceCredentialProperty
ServiceCredentialProperty
Table: sec_service_credentials_p
Fields:
should be 0 or 1.
ServiceLocation
Table: cwo_service_loc
Fields:

ServiceLocDescription (description) - STRING
Relationships:
Address - Address
Properties - ServiceLocationProperty
ServiceLocationProperty
Table: cwo_service_loc_p
Fields:

should be 0 or 1.
ServiceRetry
Table: ctl_service_retry_queue
Fields:

RetryId (retry_id) - STRING
ServiceType (service_type) - STRING
RetryType (retry_type) - STRING
ProcessingWorkstationId (processing_wkstn_id) - LONG
EntryDateTime (entry_date_time) - DATE
LastAttemptTime (last_attempt_time) - LONG
RetryCount (retry_count) - INTEGER
ContextInfo (context_info) - STRING
RequestData (request_data) - STRING
Relationships:
Properties - ServiceRetryProperty
ServiceRetryProperty
Table: ctl_service_retry_queue_p
Fields:
RetryId (retry_id) - STRING
ServiceType (service_type) - STRING
should be 0 or 1.
Session
Table: tsn_session
Fields:

BeginDatetimestamp (begin_datetime) - DATE
EndDatetimestamp (end_datetime) - DATE
StatusCode (statcode) - STRING
EmployeePartyId (employee_party_id) - LONG
TenderRepositoryId (tndr_repository_id) - STRING
Relationships:
Party - Party
TenderRepository - TenderRepository
SessionTenders - SessionTender
SessionWorkstations - SessionWorkstation
Properties - SessionProperty
SessionControlTransaction
Table: tsn_session_control_trans
Fields:

SessionWorkstationSequence (session_wkstn_seq) - INTEGER
Relationships:
Session - Session
SessionWorkstation - SessionWorkstation
SessionProperty
Table: tsn_session_p
Fields:

should be 0 or 1.
SessionTender
Table: tsn_session_tndr
Fields:

MediaAmount (actual_media_amt) - DECIMAL
MediaCount (actual_media_count) - INTEGER
Relationships:
Properties - SessionTenderProperty
SessionTenderProperty
Table: tsn_session_tndr_p
Fields:

should be 0 or 1.
SessionWorkstation
Table: tsn_session_wkstn
Fields:

SessionWorkstationSequenceNbr (session_wkstn_seq) - INTEGER
Attached (attached_flag) - BOOLEAN
Relationships:
Properties - SessionWorkstationProperty
SessionWorkstationProperty
Table: tsn_session_wkstn_p
Fields:

SessionWorkstationSequenceNbr (session_wkstn_seq) - INTEGER
should be 0 or 1.
Shift
Table: sch_shift
Fields:

ShiftId (shift_id) - LONG
WorkCode (work_code) - STRING
BreakDuration (break_duration) - LONG
Relationships:
Properties - ShiftProperty
ShiftProperty
Table: sch_shift_p
Fields:

ShiftId (shift_id) - LONG
should be 0 or 1.
Shipment
Table: inv_shipment
Fields:

ShipmentSequence (shipment_seq) - INTEGER
ExpectedDeliveryDate (expected_delivery_date) - DATE
ActualDeliveryDate (actual_delivery_date) - DATE
ExpectedShipDate (expected_ship_date) - DATE
ActualShipDate (actual_ship_date) - DATE
DestinationName (destination_name) - STRING
ShippingCarrier (shipping_carrier) - STRING
TrackingNumber (tracking_nbr) - STRING
ShipmentStatusCode (shipment_statcode) - STRING
DestinationPartyId (destination_party_id) - LONG
DestinationRetailLocationId (destination_rtl_loc_id) - LONG
ShippingMethod (shipping_method) - STRING
ShippingLabel (shipping_label) - STRING
DestinationType (destination_type) - STRING
DestinationServiceLocationId (destination_service_loc_id) - STRING
Relationships:
DestinationParty - Party
DestinationRetailLocation - RetailLocation
Address - ShipmentAddress
ShipmentLineItems - ShipmentLineItem
Properties - ShipmentProperty
ShipmentAddress
Table: inv_shipment_address
Fields:

Relationships:
Properties - ShipmentAddressProperty
ShipmentAddressProperty
Table: inv_shipment_address_p
Fields:

should be 0 or 1.
ShipmentLineItem
Table: inv_shipment_lines
Fields:
LineItemSequence (lineitm_seq) - INTEGER
ShipQuantity (ship_qty) - DECIMAL
Relationships:
Properties - ShipmentLineItemProperty
ShipmentLineItemProperty
Table: inv_shipment_lines_p
Fields:

LineItemSequence (lineitm_seq) - INTEGER
should be 0 or 1.
ShipmentProperty
Table: inv_shipment_p
Fields:

should be 0 or 1.
Shipper
Table: inv_shipper
Fields:

ShipperId (shipper_id) - STRING
ShipperDesc (shipper_desc) - STRING
TrackingNumberEnabled (tracking_number_flag) - BOOLEAN
Relationships:
Properties - ShipperProperty
ShipperMethod
Table: inv_shipper_method
Fields:

ShipperMethodId (shipper_method_id) - STRING
ShipperMethodDesc (shipper_method_desc) - STRING
DomesticServiceCode (domestic_service_code) - STRING
IntlServiceCode (intl_service_code) - STRING
Priority (priority) - INTEGER
Relationships:
Properties - ShipperMethodProperty
ShipperMethodProperty
Table: inv_shipper_method_p
Fields:

ShipperMethodId (shipper_method_id) - STRING
should be 0 or 1.
ShipperProperty
Table: inv_shipper_p
Fields:

should be 0 or 1.
ShippingCost
Table: com_shipping_cost
Fields:

BeginRange (begin_range) - DECIMAL
EndRange (end_range) - DECIMAL
MinimumCost (minimum_cost) - DECIMAL
MaximumCost (maximum_cost) - DECIMAL
Relationships:
Properties - ShippingCostProperty
ShippingCostProperty
Table: com_shipping_cost_p
Fields:

BeginRange (begin_range) - DECIMAL
EndRange (end_range) - DECIMAL
should be 0 or 1.
ShippingFee
Table: com_shipping_fee
Fields:
RuleName (rule_name) - STRING

Priority (priority) - LONG
ShipItemID (ship_item_id) - STRING
AggregationType (aggregation_type) - STRING
RuleType (rule_type) - STRING
Param1 (param1) - STRING
Relationships:
TieredFees - ShippingFeeTier
Properties - ShippingFeeProperty
ShippingFeeProperty
Table: com_shipping_fee_p
Fields:

should be 0 or 1.
ShippingFeeTier
Table: com_shipping_fee_tier
Fields:

ParentRuleName (parent_rule_name) - STRING
Priority (priority) - LONG
FeeType (fee_type) - STRING
FeeValue (fee_value) - DECIMAL
ShipMethod (ship_method) - STRING
MinPrice (min_price) - DECIMAL
MaxPrice (max_price) - DECIMAL
Relationships:
Properties - ShippingFeeTierProperty
ShippingFeeTierProperty
Table: com_shipping_fee_tier_p
Fields:

ParentRuleName (parent_rule_name) - STRING
should be 0 or 1.
SourceModifier
Table: xom_source_mod
Fields:

LocationId (loc_id) - STRING
LocationType (loc_type) - STRING
Telephone1 (telephone) - STRING
Relationships:
Properties - SourceModifierProperty
SourceModifierProperty
Table: xom_source_mod_p
Fields:

should be 0 or 1.
StateJournal
Table: loc_state_journal
Fields:

StatusTypcode (status_typcode) - STRING
StateJournalId (state_journal_id) - STRING
TimeStamp (time_stamp) - DATE
Relationships:
Properties - StateJournalProperty
StateJournalProperty
Table: loc_state_journal_p
Fields:

StatusTypcode (status_typcode) - STRING
StateJournalId (state_journal_id) - STRING
should be 0 or 1.
StockLedger
Table: inv_stock_ledger_acct
Fields:

Unitcount (unitcount) - DECIMAL
InventoryValue (inventory_value) - DECIMAL
Relationships:
Properties - StockLedgerProperty
StockLedgerProperty
Table: inv_stock_ledger_acct_p
Fields:

should be 0 or 1.
SubstituteItems
Table: itm_substitute_items
Fields:

PrimaryItemId (primary_item_id) - STRING
SubstituteItemId (substitute_item_id) - STRING
Relationships:
Properties - SubstituteItemsProperty
SubstituteItemsProperty
Table: itm_substitute_items_p
Fields:

PrimaryItemId (primary_item_id) - STRING
SubstituteItemId (substitute_item_id) - STRING
should be 0 or 1.
Task
Table: cwo_task
Extends: NonPhysicalItem
Fields:

PriceType (price_type_enum) - STRING
TaxAuthority
Table: tax_tax_authority
Fields:

TaxAuthorityId (tax_authority_id) - STRING
RoundingCode (rounding_code) - STRING
RoundingDigitsQuantity (rounding_digits_quantity) - INTEGER
Relationships:
Properties - TaxAuthorityProperty
TaxAuthorityProperty
Table: tax_tax_authority_p
Fields:

should be 0 or 1.
TaxBracket
Table: tax_tax_bracket
Fields:

TaxBracketId (tax_bracket_id) - STRING
TaxBracketSequence (tax_bracket_seq_nbr) - INTEGER
TaxBreakpoint (tax_breakpoint) - DECIMAL
Relationships:
Properties - TaxBracketProperty
TaxBracketProperty
Table: tax_tax_bracket_p
Fields:

TaxBracketSequence (tax_bracket_seq_nbr) - INTEGER
should be 0 or 1.
TaxExemption
Table: tax_tax_exemption
Fields:

CertificateHolderName (cert_holder_name) - STRING
CertificateNbr (cert_nbr) - STRING
CertificateCountry (cert_country) - STRING
CertificateState (cert_state) - STRING
PhoneNumber (phone_number) - STRING
Region (region) - STRING
DiplomaticTitle (diplomatic_title) - STRING
CertHolderFirstName (cert_holder_first_name) - STRING
CertHolderLastName (cert_holder_last_name) - STRING
Relationships:
Address - Address
Properties - TaxExemptionProperty
TaxExemptionProperty
Table: tax_tax_exemption_p
Fields:

should be 0 or 1.
TaxGroup
Table: tax_tax_group
Fields:

Relationships:
Properties - TaxGroupProperty
TaxGroupProperty
Table: tax_tax_group_p
Fields:

should be 0 or 1.
TaxGroupRule
Table: tax_tax_group_rule
Fields:

Compound (compound_flag) - BOOLEAN
CompoundSequence (compound_seq_nbr) - INTEGER
TaxTypeCode (tax_typcode) - STRING
TaxedAtTransLevel (taxed_at_trans_level_flag) - BOOLEAN
FiscalTaxId (fiscal_tax_id) - STRING
Relationships:
TaxAuthority - TaxAuthority
TaxRateRules - TaxRateRule
Properties - TaxGroupRuleProperty
TaxGroupRuleProperty
Table: tax_tax_group_rule_p
Fields:

should be 0 or 1.
TaxLineItem
Table: trl_tax_lineitm
Fields:

TaxPercentage (tax_percentage) - DECIMAL
RawTaxAmount (raw_tax_amount) - DECIMAL
RawTaxPercentage (raw_tax_percentage) - DECIMAL
TaxOverrideAmount (tax_override_amt) - DECIMAL
TaxOverride (tax_override_flag) - BOOLEAN
TaxOverridePercentage (tax_override_percentage) - DECIMAL
TaxOverrideReasonCode (tax_override_reascode) - STRING
TaxableAmount (taxable_amt) - DECIMAL
AuthorityId (authority_id) - STRING
AuthorityName (authority_name) - STRING
AuthorityTypeCode (authority_type_code) - STRING
Relationships:
SaleTaxGroupRule - TaxGroupRule
TaxLocation
Table: tax_tax_loc
Fields:

Relationships:
Properties - TaxLocationProperty
TaxLocationProperty
Table: tax_tax_loc_p
Fields:

should be 0 or 1.
TaxRateRule
Table: tax_tax_rate_rule
Fields:

TaxRateRuleSequence (tax_rate_rule_seq) - INTEGER
BreakPointTypeCode (breakpoint_typcode) - STRING
DailyEndTimeDao (daily_end_time) - DATE
DailyStartTimeDao (daily_start_time) - DATE
EffectiveDatetimestamp (effective_datetime) - DATE
ExpirationDatetimestamp (expr_datetime) - DATE
TaxRateMaxTaxableAmount (tax_rate_max_taxable_amt) - DECIMAL
TaxRateMinTaxableAmount (tax_rate_min_taxable_amt) - DECIMAL
Relationships:
Properties - TaxRateRuleProperty
TaxRateRuleOverride
Table: tax_tax_rate_rule_override
Fields:

BreakPointTypeCode (breakpoint_typcode) - STRING
DailyEndTimeDao (daily_end_time) - DATE
DailyStartTimeDao (daily_start_time) - DATE
EffectiveDatetimestamp (effective_datetime) - DATE
TaxRateMaxTaxableAmount (tax_rate_max_taxable_amt) - DECIMAL
TaxRateMinTaxableAmount (tax_rate_min_taxable_amt) - DECIMAL
Relationships:
Properties - TaxRateRuleOverrideProperty
TaxRateRuleOverrideProperty
Table: tax_tax_rate_rule_override_p
Fields:

should be 0 or 1.
TaxRateRuleProperty
Table: tax_tax_rate_rule_p
Fields:

should be 0 or 1.
TaxTaxGroupMapping
Table: tax_tax_group_mapping
Fields:

CustomerGroup (customer_group_id) - STRING
RtlLocId (rtl_loc_id) - INTEGER
Priority (priority) - INTEGER
NewTaxGroupId (new_tax_group_id) - STRING
Relationships:
Properties - TaxTaxGroupMappingProperty
TaxTaxGroupMappingProperty
Table: tax_tax_group_mapping_p
Fields:

CustomerGroup (customer_group_id) - STRING
RtlLocId (rtl_loc_id) - INTEGER
should be 0 or 1.
Tender
Table: tnd_tndr
Fields:

FlashSalesDisplayOrder (flash_sales_display_order) - INTEGER
TenderTypecode (tndr_typcode) - STRING
Disabled (disabled_flag) - BOOLEAN
Relationships:
TenderOptions - TenderOptions
TenderAvailabilityCodes - TenderAvailability
TenderDenominations - TenderDenomination
TenderType - TenderType
Properties - TenderProperty
TenderAuthLog
Table: ttr_tndr_auth_log
Fields:

AttemptSequence (attempt_seq) - INTEGER
ResponseCode (response_code) - STRING
ApprovalCode (approval_code) - STRING
AuthType (auth_type) - STRING
CustomerName (customer_name) - STRING
ReferenceNumber (reference_nbr) - STRING
ErrorCode (error_code) - STRING
ErrorText (error_text) - STRING
StartTimestamp (start_timestamp) - DATE
EndTimestamp (end_timestamp) - DATE
Relationships:
Properties - TenderAuthLogProperty
TenderAuthLogProperty
Table: ttr_tndr_auth_log_p
Fields:

AttemptSequence (attempt_seq) - INTEGER
should be 0 or 1.
TenderAvailability
Table: tnd_tndr_availability
Fields:

Relationships:
Properties - TenderAvailabilityProperty
TenderAvailabilityProperty
Table: tnd_tndr_availability_p
Fields:

should be 0 or 1.
TenderControlTransaction
Table: tsn_tndr_control_trans
Fields:

DepositDate (deposit_date) - DATE
FundsReceiptPartyId (funds_receipt_party_id) - LONG
InboundSessionId (inbound_session_id) - LONG
InboundTenderRepositoryId (inbound_tndr_repository_id) - STRING
OutboundSessionId (outbound_session_id) - LONG
OutboundTenderRepositoryId (outbound_tndr_repository_id) - STRING
Relationships:
FundsReceiptParty - Party
InboundSession - Session
InboundTenderRepository - TenderRepository
OutboundSession - Session
OutboundTenderRepository - TenderRepository
ReasonCodeObject - ReasonCode
TenderTypeCounts - TenderTypeCount
TenderCount
Table: tsn_tndr_tndr_count
Fields:
BusinessDayDate (business_date) - DATE

TenderTypeCode (tndr_typcode) - STRING
DifferenceAmount (difference_amt) - DECIMAL
DifferenceMediaCount (difference_media_count) - INTEGER
MediaCount (media_count) - INTEGER
DepositAmount (deposit_amt) - DECIMAL
LocalCurrencyAmount (local_currency_amt) - DECIMAL
Relationships:
TenderDenominationCounts - TenderDenominationCount
Properties - TenderCountProperty
TenderCountProperty
Table: tsn_tndr_tndr_count_p
Fields:
should be 0 or 1.
TenderDenomination
Table: tnd_tndr_denomination
Fields:
DenominationId (denomination_id) - STRING

Value (value) - DECIMAL
Relationships:
Properties - TenderDenominationProperty
TenderDenominationCount
Table: tsn_tndr_denomination_count
Fields:
Relationships:
TenderDenomination - TenderDenomination
Properties - TenderDenominationCountProperty
TenderDenominationCountProperty
Table: tsn_tndr_denomination_count_p
Fields:

should be 0 or 1.
TenderDenominationProperty
Table: tnd_tndr_denomination_p
Fields:

should be 0 or 1.
TenderExchangeRate
Table: tnd_exchange_rate
Fields:

ExchangeRate (rate) - DECIMAL
Relationships:
Properties - TenderExchangeRateProperty
TenderExchangeRateProperty
Table: tnd_exchange_rate_p
Fields:

should be 0 or 1.
TenderLineItem
Table: ttr_tndr_lineitm
Fields:

Change (change_flag) - BOOLEAN
HostValidation (host_validation_flag) - BOOLEAN
TenderStatusCode (tndr_statcode) - STRING
ExchangeRate (exchange_rate) - DECIMAL
ForeignAmount (foreign_amt) - DECIMAL
Relationships:
IdentityVerifications - IdentityVerification
TenderOptions
Table: tnd_tndr_options
Fields:

AuthExpirationDateRequired (auth_expr_date_req_flag) - BOOLEAN
AuthMethodCode (auth_mthd_code) - STRING
AuthRequired (auth_req_flag) - BOOLEAN
CustAssociation (cust_association_flag) - BOOLEAN
CustIdReqCode (cust_id_req_code) - STRING
CustomerSignatureRequired (cust_sig_req_flag) - BOOLEAN
DfltToAmountDue (dflt_to_amt_due_flag) - BOOLEAN
EndorsementRequired (endorsement_req_flag) - BOOLEAN
IncludeInTypeCount (include_in_type_count_flag) - BOOLEAN
MagneticSwipeReaderRequired (mag_swipe_reader_req_flag) - BOOLEAN
MaxDaysForReturn (max_days_for_return) - INTEGER
MinDaysForReturn (min_days_for_return) - INTEGER
MinimumDenominationAmount (min_denomination_amt) - DECIMAL
OpenCashDrawerRequired (open_cash_drawer_req_flag) - BOOLEAN
PinRequired (pin_req_flag) - BOOLEAN
PopulateSystemCount (populate_system_count_flag) - BOOLEAN
SerialIdentificationNbrRequired (serial_id_nbr_req_flag) - BOOLEAN
UnitCountCode (unit_count_req_code) - STRING
SuggestDeposit (suggest_deposit_flag) - BOOLEAN
SuggestedDepositThreshold (suggested_deposit_threshold) - DECIMAL
CashChangeLimit (cash_change_limit) - DECIMAL
ChangeTenderId (change_tndr_id) - STRING
OvertenderOverridable (over_tender_overridable_flag) - BOOLEAN
NonVoidable (non_voidable_flag) - BOOLEAN
CloseCountDiscrepancyThreshold (close_count_disc_threshold) - DECIMAL
CidMsrRequired (cid_msr_req_flag) - BOOLEAN
CidKeyedRequired (cid_keyed_req_flag) - BOOLEAN
PostalRequired (postal_code_req_flag) - BOOLEAN
DisallowSplitTender (disallow_split_tndr_flag) - BOOLEAN
PostVoidOpenCashDrawerRequired (post_void_open_drawer_flag) - BOOLEAN
ReportingGroup (reporting_group) - STRING
ChangeAllowedWhenForeign (change_allowed_when_foreign) - BOOLEAN
FiscalTenderId (fiscal_tndr_id) - STRING
RoundingMode (rounding_mode) - STRING
AssignCashDrawerRequired (assign_cash_drawer_req_flag) - BOOLEAN
PostVoidAssignCashDrawerRequired (post_void_assign_drawer_flag) - BOOLEAN
Relationships:
Properties - TenderOptionsProperty
TenderOptionsProperty
Table: tnd_tndr_options_p
Fields:

should be 0 or 1.
TenderProperty
Table: tnd_tndr_p
Fields:

should be 0 or 1.
TenderRepository
Table: tsn_tndr_repository
Fields:

NotIssuable (not_issuable_flag) - BOOLEAN
DefaultWorkstationId (dflt_wkstn_id) - LONG
Relationships:
TenderRepositoryFloat - TenderRepositoryFloat
TenderRepositoryStatus - TenderRepositoryStatus
Properties - TenderRepositoryProperty
TenderRepositoryFloat
Table: tsn_tndr_repository_float
Fields:

DefaultCashFloat (default_cash_float) - DECIMAL
LastClosingCashAmt (last_closing_amount) - DECIMAL
Relationships:
Properties - TenderRepositoryFloatProperty
TenderRepositoryFloatProperty
Table: tsn_tndr_repository_float_p
Fields:

should be 0 or 1.
TenderRepositoryProperty
Table: tsn_tndr_repository_p
Fields:

should be 0 or 1.
TenderRepositoryStatus
Table: tsn_tndr_repository_status
Fields:

Issued (issued_flag) - BOOLEAN
ActiveSessionId (active_session_id) - LONG
Relationships:
Properties - TenderRepositoryStatusProperty
TenderRepositoryStatusProperty
Table: tsn_tndr_repository_status_p
Fields:

should be 0 or 1.
TenderSerializedCount
Table: tsn_serialized_tndr_count
Fields:

SerializedCountSequence (serialized_tndr_count_seq) - INTEGER
Relationships:
Tender - Tender
Properties - TenderSerializedCountProperty
TenderSerializedCountProperty
Table: tsn_serialized_tndr_count_p
Fields:

SerializedCountSequence (serialized_tndr_count_seq) - INTEGER
should be 0 or 1.
TenderSignature
Table: ttr_signature
Fields:

Signature (signature) - CLOB
Relationships:
Properties - TenderSignatureProperty
TenderSignatureProperty
Table: ttr_signature_p
Fields:

should be 0 or 1.
TenderType
Table: tnd_tndr_typcode
Fields:

UnitCountCode (unit_count_req_code) - STRING
CloseCountDiscrepancyThreshold (close_count_disc_threshold) - DECIMAL
Relationships:
Properties - TenderTypeProperty
TenderTypeCount
Table: tsn_tndr_typcode_count
Fields:

Relationships:
TenderCounts - TenderCount
TenderSerializedCounts - TenderSerializedCount
Properties - TenderTypeCountProperty
TenderTypeCountProperty
Table: tsn_tndr_typcode_count_p
Fields:

should be 0 or 1.
TenderTypeProperty
Table: tnd_tndr_typcode_p
Fields:

should be 0 or 1.
TenderUserSettings
Table: tnd_tndr_user_settings
Fields:

UsageCode (usage_code) - STRING
MaximumAcceptAmount (max_accept_amt) - DECIMAL
MinimumAcceptAmount (min_accept_amt) - DECIMAL
OfflineCeilingApprovalAmount (offline_ceiling_approval_amt) - DECIMAL
OfflineFloorApprovalAmount (offline_floor_approval_amt) - DECIMAL
OnlineCeilingApprovalAmount (online_ceiling_approval_amt) - DECIMAL
OnlineFloorApprovalAmount (online_floor_approval_amt) - DECIMAL
OverTenderLimit (over_tndr_limit) - DECIMAL
MaximumRefundWithReceiptAmount (max_refund_with_receipt) - DECIMAL
MaximumRefundWithoutReceiptAmount (max_refund_wo_receipt) - DECIMAL
Relationships:
Properties - TenderUserSettingsProperty
TenderUserSettingsProperty
Table: tnd_tndr_user_settings_p
Fields:

UsageCode (usage_code) - STRING
should be 0 or 1.
TillControlTransaction
Table: tsn_till_control_trans
Fields:

Relationships:
TillControlTransactionDetails - TillControlTransactionDetail
ReasonCodeObject - ReasonCode
TillControlTransactionDetail
Table: tsn_till_ctrl_trans_detail
Fields:

AffectedTenderRepositoryId (affected_tndr_repository_id) - STRING
AffectedWorkstationId (affected_wkstn_id) - LONG
OldAmount (old_amount) - DECIMAL
NewAmount (new_amount) - DECIMAL
Relationships:
AffectedTenderRepository - TenderRepository
Properties - TillControlTransactionDetailProperty
TillControlTransactionDetailProperty
Table: tsn_till_ctrl_trans_detail_p
Fields:

should be 0 or 1.
TimecardEntry
Table: thr_timecard_entry
Fields:
TimecardEntryId (timecard_entry_id) - LONG
ClockInDateTime (clock_in_timestamp) - DATE
ClockOutDateTime (clock_out_timestamp) - DATE
EntryType (entry_type_enum) - STRING
OpenRecord (open_record_flag) - BOOLEAN
Duration (duration) - LONG
PayrollUpdateRequired (payroll_update_required) - BOOLEAN
Relationships:
Properties - TimecardEntryProperty
TimecardEntryComment
Table: thr_timecard_entry_comment
Fields:

CommentSeq (comment_seq) - LONG
CommentDateTime (comment_timestamp) - DATE
CommentText (comment_text) - CLOB
CreatorId (creator_id) - STRING
Relationships:
Properties - TimecardEntryCommentProperty
TimecardEntryCommentProperty
Table: thr_timecard_entry_comment_p
Fields:

CommentSeq (comment_seq) - LONG
should be 0 or 1.
TimecardEntryProperty
Table: thr_timecard_entry_p
Fields:

should be 0 or 1.
TimecardJournal
Table: thr_timecard_journal
Fields:

TimecardEntrySeq (timecard_entry_seq) - LONG
ClockInDateTime (clock_in_timestamp) - DATE
ClockOutDateTime (clock_out_timestamp) - DATE
EntryType (entry_type_enum) - STRING
Relationships:
Properties - TimecardJournalProperty
TimecardJournalProperty
Table: thr_timecard_journal_p
Fields:

should be 0 or 1.
TimeclockTransaction
Table: thr_timeclk_trans
Fields:

TimeclockEntryCodes (timeclk_entry_code) - STRING
TimecardEntryBusinessDate (timecard_entry_business_date) - DATE
TimecardEntryWorkstationId (timecard_entry_wkstn_id) - LONG
Relationships:
TransactionNotes
Table: trn_trans_notes
Fields:

NoteSequence (note_seq) - INTEGER
Note (note) - CLOB
NoteDatetimestamp (note_datetime) - DATE
Relationships:
Properties - TransactionNotesProperty
TransactionNotesProperty
Table: trn_trans_notes_p
Fields:

NoteSequence (note_seq) - INTEGER
should be 0 or 1.
TransactionPropertyPrompt
Table: com_trans_prompt_properties
Fields:

PromptPropertyCode (trans_prompt_property_code) - STRING
PromptMethodCode (prompt_mthd_code) - STRING
CodeCategory (code_category) - STRING
PromptTitleKey (prompt_title_key) - STRING
PromptMessageKey (prompt_msg_key) - STRING
Required (required_flag) - BOOLEAN
PromptEditPattern (prompt_edit_pattern) - STRING
ValidationRuleKey (validation_rule_key) - STRING
PromptKey (prompt_key) - STRING
ChainKey (chain_key) - STRING
TransactionState (transaction_state) - STRING
Relationships:
Properties - TransactionPropertyPromptProperty
TransactionPropertyPromptProperty
Table: com_trans_prompt_properties_p
Fields:

PromptPropertyCode (trans_prompt_property_code) - STRING
should be 0 or 1.
TransactionReportData
Table: trn_report_data
Fields:

ReportBytes (report_data) - OBJECT
LuxuryReprint (luxury_reprint_flag) - BOOLEAN
InternalData (internal_data_flag) - BOOLEAN
Relationships:
Properties - TransactionReportDataProperty
TransactionReportDataProperty
Table: trn_report_data_p
Fields:

should be 0 or 1.
TransactionVersion
Table: trn_trans_version
Fields:

BaseAppVersion (base_app_version) - STRING
BaseAppDate (base_app_date) - DATE
BaseSchemaVersion (base_schema_version) - STRING
BaseSchemaDate (base_schema_date) - DATE
CustomerAppVersion (customer_app_version) - STRING
CustomerSchemaVersion (customer_schema_version) - STRING
CustomerSchemaDate (customer_schema_date) - DATE
Relationships:
Properties - TransactionVersionProperty
TransactionVersionProperty
Table: trn_trans_version_p
Fields:

should be 0 or 1.
UserPassword
Table: sec_user_password
Fields:

User (username) - STRING
Sequence (password_seq) - LONG
Hash (password) - STRING
FailedAttempts (failed_attempts) - INTEGER
LockedOutTimeStamp (locked_out_timestamp) - DATE
Relationships:
RoleObjects - UserRole
Properties - UserPasswordProperty
UserPasswordProperty
Table: sec_user_password_p
Fields:

Sequence (password_seq) - LONG
should be 0 or 1.
UserRole
Table: sec_user_role
Fields:

UserRoleId (user_role_id) - INTEGER
RoleCode (role_code) - STRING
Relationships:
Properties - UserRoleProperty
UserRoleProperty
Table: sec_user_role_p
Fields:

UserRoleId (user_role_id) - INTEGER
should be 0 or 1.
Vendor
Table: itm_vendor
Fields:

Telephone (telephone) - STRING
Fax (fax) - STRING
Contact (contact) - STRING
ContactTelephone (contact_telephone) - STRING
Buyer (buyer) - STRING
Relationships:
Address - Address
Properties - VendorProperty
VendorProperty
Table: itm_vendor_p
Fields:

should be 0 or 1.
Version
Table: ctl_version_history
Fields:

BaseSchemaVersion (base_schema_version) - STRING
CustomerSchemaVersion (customer_schema_version) - STRING
Customer (customer) - STRING
BaseSchemaDate (base_schema_date) - DATE
CustomerSchemaDate (customer_schema_date) - DATE
Relationships:
Properties - VersionProperty
VersionProperty
Table: ctl_version_history_p
Fields:

should be 0 or 1.
Voucher
Table: ttr_voucher
Fields:

VoucherTypeCode (voucher_typcode) - STRING
FaceValueAmount (face_value_amt) - DECIMAL
IssueDatetimestamp (issue_datetime) - DATE
IssueTypeCode (issue_typcode) - STRING
UnspentBalanceAmount (unspent_balance_amt) - DECIMAL
VoucherStatusCode (voucher_status_code) - STRING
Relationships:
Properties - VoucherProperty
VoucherDiscountLineItem
Table: trl_voucher_discount_lineitm
Extends: DiscountLineItem
Fields:

Relationships:
Voucher - Voucher
VoucherHistory
Table: ttr_voucher_history
Fields:

HistorySequence (history_seq) - LONG
Relationships:
Properties - VoucherHistoryProperty
VoucherHistoryProperty
Table: ttr_voucher_history_p
Fields:

HistorySequence (history_seq) - LONG
should be 0 or 1.
VoucherProperty
Table: ttr_voucher_p
Fields:

should be 0 or 1.
VoucherSaleLineItem
Table: trl_voucher_sale_lineitm
Fields:

Relationships:
Voucher - Voucher
VoucherTenderLineItem
Table: ttr_voucher_tndr_lineitm
Fields:

Relationships:
Voucher - Voucher
Warranty
Table: itm_warranty
Fields:

WarrantyNbr (warranty_nbr) - STRING
WarrantyTypeCode (warranty_typcode) - STRING
WarrantyPlanId (warranty_plan_id) - STRING
WarrantyIssueDate (warranty_issue_date) - DATE
WarrantyExpirationDate (warranty_expiration_date) - DATE
PurchasePrice (purchase_price) - DECIMAL
CertificateNbr (certificate_nbr) - STRING
CertificateCompanyName (certificate_company_name) - STRING
WarrantyItemId (warranty_item_id) - STRING
WarrantyLineBusinessDate (warranty_line_business_date) - DATE
WarrantyLineRtlLocId (warranty_line_rtl_loc_id) - LONG
WarrantyLineWkstnId (warranty_line_wkstn_id) - LONG
WarrantyLineTransSeq (warranty_line_trans_seq) - LONG
WarrantyLineTransLineItemSeq (warranty_rtrans_lineitm_seq) - INTEGER
CoveredItemId (covered_item_id) - STRING
CoveredLineBusinessDate (covered_line_business_date) - DATE
CoveredLineRtlLocId (covered_line_rtl_loc_id) - LONG
CoveredLineWkstnId (covered_line_wkstn_id) - LONG
CoveredLineTransSeq (covered_line_trans_seq) - LONG
CoveredLineTransLineItemSeq (covered_rtrans_lineitm_seq) - INTEGER
CoveredItemPurchaseDate (covered_item_purchase_date) - DATE
CoveredItemPurchasePrice (covered_item_purchase_price) - DECIMAL
CoveredItemPurchaseLocation (covered_item_purchase_location) - STRING
Relationships:
Properties - WarrantyProperty
WarrantyItem
Table: itm_warranty_item
Extends: NonPhysicalItem
Fields:

PricingMethodCode (pricing_mthd_code) - STRING
WarrantyPriceAmt (warranty_price_amt) - DECIMAL
WarrantyPricePercentage (warranty_price_percentage) - DECIMAL
WarrantyMinPriceAmt (warranty_min_price_amt) - DECIMAL
ExpirationDays (expiration_days) - LONG
ServiceDays (service_days) - LONG
Renewable (renewable_flag) - BOOLEAN
Relationships:
WarrantyItemPrices - WarrantyItemPrice
WarrantyItemCrossReference
Table: itm_warranty_item_xref
Fields:

SortOrder (sort_order) - LONG
Relationships:
WarrantyItem - WarrantyItem
Properties - WarrantyItemCrossReferenceProperty
WarrantyItemCrossReferenceProperty
Table: itm_warranty_item_xref_p
Fields:

should be 0 or 1.
WarrantyItemPrice
Table: itm_warranty_item_price
Fields:

WarrantyPriceSeq (warranty_price_seq) - LONG
MinItemPriceAmt (min_item_price_amt) - DECIMAL
MaxItemPriceAmt (max_item_price_amt) - DECIMAL
PriceAmt (price_amt) - DECIMAL
PricePercentage (price_percentage) - DECIMAL
MinPriceAmt (min_price_amt) - DECIMAL
RefItemId (ref_item_id) - STRING
Relationships:
Properties - WarrantyItemPriceProperty
WarrantyItemPriceProperty
Table: itm_warranty_item_price_p
Fields:

WarrantyPriceSeq (warranty_price_seq) - LONG
should be 0 or 1.
WarrantyJournal
Table: itm_warranty_journal
Fields:

TransRtlLocId (trans_rtl_loc_id) - LONG
TransWkstnId (trans_wkstn_id) - LONG
TransTransSeq (trans_trans_seq) - LONG
WarrantyPlanId (warranty_plan_id) - STRING
WarrantyIssueDate (warranty_issue_date) - DATE
WarrantyExpirationDate (warranty_expiration_date) - DATE
PurchasePrice (purchase_price) - DECIMAL
CertificateNbr (certificate_nbr) - STRING
CertificateCompanyName (certificate_company_name) - STRING
WarrantyLineBusinessDate (warranty_line_business_date) - DATE
WarrantyLineRtlLocId (warranty_line_rtl_loc_id) - LONG
WarrantyLineWkstnId (warranty_line_wkstn_id) - LONG
WarrantyLineTransSeq (warranty_line_trans_seq) - LONG
WarrantyLineTransLineItemSeq (warranty_rtrans_lineitm_seq) - INTEGER
CoveredItemId (covered_item_id) - STRING
CoveredLineBusinessDate (covered_line_business_date) - DATE
CoveredLineRtlLocId (covered_line_rtl_loc_id) - LONG
CoveredLineWkstnId (covered_line_wkstn_id) - LONG
CoveredLineTransSeq (covered_line_trans_seq) - LONG
CoveredLineTransLineItemSeq (covered_rtrans_lineitm_seq) - INTEGER
Relationships:
Properties - WarrantyJournalProperty
WarrantyJournalProperty
Table: itm_warranty_journal_p
Fields:

should be 0 or 1.
WarrantyLineItem
Table: trl_sale_lineitm
Fields:

Relationships:
WarrantyModifiers - WarrantyModifier
WarrantyModifier
Table: trl_warranty_modifier
Fields:

WarrantyModifierSequence (warranty_modifier_seq) - INTEGER
Relationships:
Properties - WarrantyModifierProperty
WarrantyModifierProperty
Table: trl_warranty_modifier_p
Fields:

WarrantyModifierSequence (warranty_modifier_seq) - INTEGER
should be 0 or 1.
WarrantyProperty
Table: itm_warranty_p
Fields:

should be 0 or 1.
WorkCodes
Table: hrs_work_codes
Fields:
Selling (selling_flag) - BOOLEAN
Privilege (privilege) - STRING
PayrollCategoryString (payroll_category) - STRING
MinimumClockInDuration (min_clock_in_duration) - INTEGER
The minimum number of minutes that a user must be clocked in for this work code before they may
either clock out or change to a different work code. A common business case for specifying a value
for this field is "employees must 'clock-in' for lunch for 45 minutes before changing their work code'.
This restriction is unenforced if this value is NULL or a non-positive value.
MinimumClockOutDuration (min_clock_out_duration) - INTEGER
The minimum number of minutes that must have elapsed with a user in a "clocked out" state before
that user is permitted to clock back in with this work code. A common business case for specifying
a value for this field is "employees must clock out at least 45 minutes for lunch before clocking back
in". This restriction is unenforced if either this value is NULL or a non-positive value, or in any case
where the user has not yet clocked in for the current business date.
Relationships:
PayrollCategory - PayrollCategory
Properties - WorkCodesProperty
WorkCodesProperty
Table: hrs_work_codes_p
Fields:

should be 0 or 1.
WorkItem
Table: cwo_work_item
Fields:

WorkItemSequence (work_item_seq) - INTEGER
ValueAmount (value_amt) - DECIMAL
WarrantyNumber (warranty_number) - STRING
WorkItemSerialNumber (work_item_serial_nbr) - STRING
Relationships:
Properties - WorkItemProperty
WorkItemProperty
Table: cwo_work_item_p
Fields:

WorkItemSequence (work_item_seq) - INTEGER
should be 0 or 1.
WorkOrderAccount
Table: cwo_work_order_acct
Extends: CustomerItemAccount
Fields:

TotalValueDao (total_value) - DECIMAL
EstimatedCompletionDate (estimated_completion_date) - DATE
ApprovedWorkAmount (approved_work_amt) - DECIMAL
ApprovedWorkDate (approved_work_date) - DATE
LastCustomerNoticeDate (last_cust_notice) - DATE
ContactMethodCode (contact_method_code) - STRING
PriorityCode (priority_code) - STRING
PriceCodeString (price_code) - STRING
Relationships:
WorkItemsRelationship - WorkItem
WorkOrderAccountServiceLocation - ServiceLocation
WorkOrderAccountCategory - WorkOrderCategory
WorkOrderAccountPriceCode - WorkOrderPriceCode
WorkOrderAccountJournal
Table: cwo_work_order_acct_journal
Extends: CustomerItemAccountJournal
Fields:

TotalValue (total_value) - DECIMAL
EstimatedCompletionDate (estimated_completion_date) - DATE
ApprovedWorkAmount (approved_work_amt) - DECIMAL
ApprovedWorkDate (approved_work_date) - DATE
PriorityCode (priority_code) - STRING
ContactMethod (contact_method) - STRING
LastCustomerNoticeDate (last_cust_notice) - DATE
PriceCodeString (price_code) - STRING
Relationships:
WorkOrderAccountJournalPriceCode - WorkOrderPriceCode
WorkOrderAccountJournalCategory - WorkOrderCategory
WorkOrderAccountJournalServiceLocation - ServiceLocation
WorkOrderCategory
Table: cwo_work_order_category
Fields:

PromptForPriceCode (prompt_for_price_code_flag) - BOOLEAN
MaxItemCount (max_item_count) - DECIMAL
Relationships:
Properties - WorkOrderCategoryProperty
WorkOrderCategoryProperty
Table: cwo_work_order_category_p
Fields:

should be 0 or 1.
WorkOrderInvoiceGlAccount
Table: cwo_invoice_gl
Fields:

GlAccount (gl_account_id) - STRING
NoCostWithWarranty (no_cost_with_warranty_flag) - BOOLEAN
NoCostWithoutWarranty (no_cost_without_warranty_flag) - BOOLEAN
Relationships:
Properties - WorkOrderInvoiceGlAccountProperty
WorkOrderInvoiceGlAccountProperty
Table: cwo_invoice_gl_p
Fields:

GlAccount (gl_account_id) - STRING
should be 0 or 1.
WorkOrderLineItem
Table: cwo_work_order_line_item
Fields:

PriceStatus (price_status_enum) - STRING
Instructions (instructions) - STRING
WorkOrderPriceCode
Table: cwo_price_code
Fields:

PriceCode (price_code) - STRING
PromptForWarrantyNumber (prompt_for_warranty_nbr_flag) - BOOLEAN
Relationships:
Properties - WorkOrderPriceCodeProperty
WorkOrderPriceCodeProperty
Table: cwo_price_code_p
Fields:

should be 0 or 1.
WorkOrderPricing
Table: cwo_work_order_pricing
Fields:

Price (price) - DECIMAL
Relationships:
Properties - WorkOrderPricingProperty
WorkOrderPricingProperty
Table: cwo_work_order_pricing_p
Fields:

should be 0 or 1.
Workstation
Table: loc_wkstn
Fields:

Relationships:
Properties - WorkstationProperty
WorkstationConfigData
Table: loc_wkstn_config_data
Fields:

FieldName (field_name) - STRING
CreateTimestamp (create_timestamp) - DATE
FieldValue (field_value) - STRING
Relationships:
Properties - WorkstationConfigDataProperty
WorkstationConfigDataProperty
Table: loc_wkstn_config_data_p
Fields:

FieldName (field_name) - STRING
CreateTimestamp (create_timestamp) - DATE
should be 0 or 1.
WorkstationProperty
Table: loc_wkstn_p
Fields:
should be 0 or 1.
XadminUser
Table: cfg_user
Fields:

RoleId (role_id) - STRING
DirectoryType (directory_type) - STRING
Relationships:
OrgScopes - XadminUserNode
XadminUserNode
Table: cfg_user_node
Fields:

OrgScope (org_scope) - STRING
XunitResult
Table: xunit_result
Fields:

ResultTimestamp (result_timestamp) - LONG
XstoreVersion (xstore_version) - STRING
TotalCount (total_count) - LONG
CompletedCount (completed_count) - LONG
FailedCount (failed_count) - LONG
Relationships:
ResultItems - XunitResultItem
Properties - XunitResultProperty
XunitResultItem
Table: xunit_result_item
Fields:

ResultItemSequence (result_item_seq) - LONG
TestCaseName (test_case_name) - STRING
TestNumber (test_nbr) - LONG
TestIteration (test_iteration) - LONG
ResultItemStatus (result_item_status) - STRING
ResultItemDatetimestamp (result_item_datetime) - DATE
FailureReason (failure_reason) - STRING
LogData (log_data) - STRING
Relationships:
Properties - XunitResultItemProperty
XunitResultItemProperty
Table: xunit_result_item_p
Fields:

ResultItemSequence (result_item_seq) - LONG
should be 0 or 1.
XunitResultProperty
Table: xunit_result_p
Fields:

should be 0 or 1.
DailyReportDetail
Table: crpt_daily_detail
Fields:

RefWorkstationId (ref_wkstn_id) - LONG
RecordType (record_type) - STRING
Count01 (count01) - LONG
Count02 (count02) - LONG
Text01 (txt01) - STRING
Number01 (num01) - DECIMAL
Relationships:
Properties - DailyReportDetailProperty
DailyReportDetailProperty
Table: crpt_daily_detail_p
Fields:

RefWorkstationId (ref_wkstn_id) - LONG
RecordType (record_type) - STRING
should be 0 or 1.
DailyReportHeader
Table: crpt_daily_header
Fields:

ReportId (dailyreport_id) - LONG
Relationships:
Properties - DailyReportHeaderProperty
DailyReportHeaderProperty
Table: crpt_daily_header_p
Fields:

should be 0 or 1.
FrRcptDuplicate
Table: cfra_rcpt_dup
Fields:

ReprintId (reprint_id) - STRING
DocNumber (doc_number) - STRING
ReprintNumber (reprint_number) - LONG
OperatorCode (operator_code) - STRING
AmountLines (amount_lines) - LONG
ReprintDate (reprint_date) - DATE
TransTransactionSequence (trans_trans_seq) - LONG
PostponementFlag (postponement_flag) - BOOLEAN
Signature (signature) - STRING
Relationships:
Properties - FrRcptDuplicateProperty
FrRcptDuplicateProperty
Table: cfra_rcpt_dup_p
Fields:

ReprintId (reprint_id) - STRING
DocNumber (doc_number) - STRING
should be 0 or 1.
FrSalesTaxTotal
Table: cfra_sales_tax_total
Fields:

FiscalYear (fiscal_year) - LONG
ReferenceYear (reference_year) - LONG
ReferenceMonth (reference_month) - LONG
ReferenceDay (reference_day) - LONG
TaxRate (tax_rate) - LONG
SalesTotal (sales_total) - DECIMAL
GrandTotal (grand_total) - DECIMAL
SalesOnlyTotal (sales_only_total) - DECIMAL
ReturnsOnlyTotal (returns_only_total) - DECIMAL
Relationships:
Properties - FrSalesTaxTotalProperty
FrSalesTaxTotalProperty
Table: cfra_sales_tax_total_p
Fields:

should be 0 or 1.
FrSalesTotal
Table: cfra_sales_total
Fields:
FiscalMonth (fiscal_month) - LONG
SalesTotal (sales_total) - DECIMAL
GrandTotal (grand_total) - DECIMAL
PerpetualGrandTotal (perpetual_grand_total) - DECIMAL
RealPerpetualGrandTotal (real_perpetual_grand_total) - DECIMAL
TimeStamp (total_timestamp) - DATE
SignatureVersion (signature_version) - LONG
TotalsFile (totals_file) - CLOB
TotalsFileSignature (totals_file_sign) - CLOB
Relationships:
SalesTaxTotal - FrSalesTaxTotal
Properties - FrSalesTotalProperty
FrSalesTotalProperty
Table: cfra_sales_total_p
Fields:

should be 0 or 1.
FrSalesTransTaxTotal
Table: cfra_sales_trn_tax_total
Fields:

DocumentNumber (document_number) - STRING
Relationships:
Properties - FrSalesTransTaxTotalProperty
FrSalesTransTaxTotalProperty
Table: cfra_sales_trn_tax_total_p
Fields:

should be 0 or 1.
FrSalesTransTotal
Table: cfra_sales_trn_total
Fields:

DailySalesTotal (daily_sales_total) - DECIMAL
PerpetualGrandTotal (perpetual_grand_total) - DECIMAL
RealPerpetualGrandTotal (real_perpetual_grand_total) - DECIMAL
TransTransactionSequence (trans_trans_seq) - LONG
TimeStamp (total_timestamp) - DATE
SignatureVersion (signature_version) - LONG
Relationships:
SalesTransTaxTotal - FrSalesTransTaxTotal
Properties - FrSalesTransTotalProperty
FrSalesTransTotalProperty
Table: cfra_sales_trn_total_p
Fields:

should be 0 or 1.
FrTechnicalEventLog
Table: cfra_technical_event_log
Fields:

EventNumber (event_number) - LONG
UniqueId (unique_id) - STRING
EventCode (event_code) - LONG
OperatorCode (operator_code) - STRING
TimeStamp (event_timestamp) - DATE
Informations (informations) - STRING
Relationships:
Properties - FrTechnicalEventLogProperty
FrTechnicalEventLogProperty
Table: cfra_technical_event_log_p
Fields:

EventNumber (event_number) - LONG
should be 0 or 1.
PafAddressMunicipality
Table: cpaf_address_muni
Fields:

MunicipalityId (municipality_id) - LONG
Uf (uf) - STRING
IbgeCityCode (ibge_code) - STRING
PostalCodeStart (postal_code_start) - STRING
PostalCodeEnd (postal_code_end) - STRING
ParentMunicipalityId (parent_municipality_id) - LONG
LocInSit (loc_in_sit) - STRING
LocInTipoLoc (loc_in_tipo_loc) - STRING
Relationships:
ParentMunicipality - PafAddressMunicipality
Properties - PafAddressMunicipalityProperty
PafAddressMunicipalityProperty
Table: cpaf_address_muni_p
Fields:

MunicipalityId (municipality_id) - LONG
should be 0 or 1.
PafCardNetwork
Table: cpaf_card_network
Fields:

NetworkName (network_name) - STRING
NetworkId (network_id) - STRING
TaxId (tax_id) - STRING
Relationships:
Properties - PafCardNetworkProperty
PafCardNetworkProperty
Table: cpaf_card_network_p
Fields:

NetworkName (network_name) - STRING
should be 0 or 1.
PafNfe
Table: cpaf_nfe
Fields:

EnvironmentId (environment_id) - INTEGER
TpNf (tp_nf) - INTEGER
SeriesId (series_id) - INTEGER
Nnf (nnf) - INTEGER
Model (model) - STRING
Cuf (cuf) - INTEGER
Cnf (cnf) - INTEGER
TransTypeCode (trans_typcode) - STRING
Natop (natop) - STRING
IndPag (indpag) - INTEGER
SaiEntDatetime (sai_ent_datetime) - DATE
CmunFG (cmun_fg) - STRING
TpImp (tp_imp) - INTEGER
TpEmis (tp_emis) - INTEGER
FinNfe (fin_nfe) - INTEGER
ProcEmi (proc_emi) - INTEGER
VerProc (ver_proc) - STRING
ContDatetime (cont_datetime) - DATE
ContJustification (cont_xjust) - STRING
ProductAmount (product_amount) - DECIMAL
ServiceAmount (service_amount) - DECIMAL
IcmsBasis (icms_basis) - DECIMAL
IcmsAmount (icms_amount) - DECIMAL
IcmsStBasis (icms_st_basis) - DECIMAL
IcmsStAmount (icms_st_amount) - DECIMAL
FcpAmount (fcp_amount) - DECIMAL
FcpSTAmount (fcp_st_amount) - DECIMAL
FcpSTRetAmount (fcp_st_ret_amount) - DECIMAL
IssBasis (iss_basis) - DECIMAL
IssAmount (iss_amount) - DECIMAL
IiAmount (ii_amount) - DECIMAL
PisAmount (pis_amount) - DECIMAL
CofinsAmount (cofins_amount) - DECIMAL
IssPisAmount (iss_pis_amount) - DECIMAL
IssCofinsAmount (iss_cofins_amount) - DECIMAL
DiscountAmount (discount_amount) - DECIMAL
FreightAmount (freight_amount) - DECIMAL
InsuranceAmount (insurance_amount) - DECIMAL
OtherAmount (other_amount) - DECIMAL
TotalAmount (total_amount) - DECIMAL
InfCpl (inf_cpl) - STRING
Protocolo (protocolo) - STRING
CancelationProtocolo (canc_protocolo) - STRING
ChaveNfe (chave_nfe) - STRING
OldchaveNfe (old_chave_nfe) - STRING
Recibo (recibo) - STRING
StatusCode (stat_code) - STRING
Xml (xml) - STRING
DigVal (dig_val) - STRING
IssServiceDate (iss_service_date) - STRING
VTroco (v_troco_amount) - DECIMAL
Relationships:
Details - PafNfeItem
Tenders - PafNfeTender
Transactions - PafNfeTrans
Issuer - PafNfeIssuer
Destination - PafNfeDestination
Properties - PafNfeProperty
PafNfeDestination
Table: cpaf_nfe_dest
Fields:

Nnf (nnf) - INTEGER
FederalTaxId (federal_tax_id) - STRING
StateTaxId (state_tax_id) - STRING
StreetName (street_name) - STRING
StreetNumber (street_num) - STRING
Complemento (complemento) - STRING
CityCode (city_code) - STRING
EmailAddress (email) - STRING
Relationships:
Properties - PafNfeDestinationProperty
PafNfeDestinationProperty
Table: cpaf_nfe_dest_p
Fields:

Nnf (nnf) - INTEGER
should be 0 or 1.
PafNfeIssuer
Table: cpaf_nfe_issuer
Fields:

Nnf (nnf) - INTEGER
FantasyName (fantasy_name) - STRING
CityTaxId (city_tax_id) - STRING
Crt (crt) - STRING
Relationships:
Properties - PafNfeIssuerProperty
PafNfeIssuerProperty
Table: cpaf_nfe_issuer_p
Fields:

Nnf (nnf) - INTEGER
should be 0 or 1.
PafNfeItem
Table: cpaf_nfe_item
Fields:

Nnf (nnf) - INTEGER
ItemDescription (item_description) - STRING
Ean (ean) - STRING
Ncm (ncm) - STRING
Cest (cest) - STRING
ExTipi (ex_tipi) - STRING
TaxableEan (taxable_ean) - STRING
TaxableUnitOfMeasureCode (taxable_unit_of_measure_code) - STRING
Iat (iat) - STRING
Ippt (ippt) - STRING
ExtendedAmount (extended_amount) - DECIMAL
TaxableQuantity (taxable_quantity) - DECIMAL
UnitTaxableAmount (unit_taxable_amount) - DECIMAL
Cfop (cfop) - STRING
InfAdProd (inf_ad_prod) - STRING
IcmsCst (icms_cst) - STRING
IcmsRate (icms_rate) - DECIMAL
FcpBasis (fcp_basis) - DECIMAL
FcpRate (fcp_rate) - DECIMAL
IcmsStRate (icms_st_rate) - DECIMAL
RedBcEfetRate (red_bc_efet_rate) - DECIMAL
BcEfetAmount (bc_efet_amount) - DECIMAL
IcmsEfetRate (icms_efet_rate) - DECIMAL
IcmsEfetAmount (icms_efet_amount) - DECIMAL
StRate (st_rate) - DECIMAL
FcpSTBasis (fcp_st_basis) - DECIMAL
FcpSTRate (fcp_st_rate) - DECIMAL
FcpSTRetBasis (fcp_st_ret_basis) - DECIMAL
FcpSTRetRate (fcp_st_ret_rate) - DECIMAL
IssRate (iss_rate) - DECIMAL
IpiAmount (ipi_amount) - DECIMAL
IpiRate (ipi_rate) - DECIMAL
PisBasis (pis_basis) - DECIMAL
PisRate (pis_rate) - DECIMAL
CofinsBasis (cofins_basis) - DECIMAL
CofinsRate (cofins_rate) - DECIMAL
TaxSituationCode (tax_situation_code) - STRING
LogSequence (log_sequence) - INTEGER
RefNfe (ref_nfe) - STRING
IssCityCode (iis_city_code) - STRING
IssServiceCode (iis_service_code) - STRING
IssEligibleIndicator (iis_eligible_indicator) - STRING
IssIncentiveIndicator (iis_incentive_indicator) - STRING
Relationships:
Properties - PafNfeItemProperty
PafNfeItemProperty
Table: cpaf_nfe_item_p
Fields:

Nnf (nnf) - INTEGER
should be 0 or 1.
PafNfeProperty
Table: cpaf_nfe_p
Fields:

Nnf (nnf) - INTEGER
should be 0 or 1.
PafNfeQueue
Table: cpaf_nfe_queue
Fields:

QueueSequence (queue_seq) - LONG
Nnf (nnf) - INTEGER
Cuf (cuf) - INTEGER
Cnf (cnf) - INTEGER
UsageTypeCode (usage_type) - STRING
Natop (natop) - STRING
IndPag (indpag) - INTEGER
SaiEntDatetime (sai_ent_datetime) - DATE
CmunFG (cmun_fg) - STRING
TpImp (tp_imp) - INTEGER
TpEmis (tp_emis) - INTEGER
ProcEmi (proc_emi) - INTEGER
VerProc (ver_proc) - STRING
ContDatetime (cont_datetime) - DATE
ContJustification (cont_xjust) - STRING
ProductAmount (product_amount) - DECIMAL
ServiceAmount (service_amount) - DECIMAL
IssPisAmount (iss_pis_amount) - DECIMAL
IssCofinsAmount (iss_cofins_amount) - DECIMAL
InfCpl (inf_cpl) - STRING
Protocolo (protocolo) - STRING
CancelationProtocolo (canc_protocolo) - STRING
ChaveNfe (chave_nfe) - STRING
OldchaveNfe (old_chave_nfe) - STRING
Recibo (recibo) - STRING
Xml (xml) - STRING
ResponseText (response_text) - STRING
DigVal (dig_val) - STRING
IssServiceDate (iss_service_date) - STRING
VTroco (v_troco_amount) - DECIMAL
Relationships:
Details - PafNfeQueueItem
LogEntries - PafNfeQueueLog
TransactionRefs - PafNfeQueueTrans
Issuer - PafNfeQueueIssuer
Destination - PafNfeQueueDestination
TransType - PafNfeTransType
Tenders - PafNfeQueueTender
SatResponse - PafSatResponse
Properties - PafNfeQueueProperty
PafNfeQueueDestination
Table: cpaf_nfe_queue_dest
Fields:

EmailAddress (email) - STRING
Relationships:
Properties - PafNfeQueueDestinationProperty
PafNfeQueueDestinationProperty
Table: cpaf_nfe_queue_dest_p
Fields:

should be 0 or 1.
PafNfeQueueIssuer
Table: cpaf_nfe_queue_issuer
Fields:

FantasyName (fantasy_name) - STRING
CityTaxId (city_tax_id) - STRING
Crt (crt) - STRING
Relationships:
Properties - PafNfeQueueIssuerProperty
PafNfeQueueIssuerProperty
Table: cpaf_nfe_queue_issuer_p
Fields:

should be 0 or 1.
PafNfeQueueItem
Table: cpaf_nfe_queue_item
Fields:

ItemDescription (item_description) - STRING
Ean (ean) - STRING
Ncm (ncm) - STRING
Cest (cest) - STRING
ExTipi (ex_tipi) - STRING
TaxableEan (taxable_ean) - STRING
TaxableUnitOfMeasureCode (taxable_unit_of_measure_code) - STRING
Iat (iat) - STRING
Ippt (ippt) - STRING
ExtendedAmount (extended_amount) - DECIMAL
TaxableQuantity (taxable_quantity) - DECIMAL
UnitTaxableAmount (unit_taxable_amount) - DECIMAL
Cfop (cfop) - STRING
InfAdProd (inf_ad_prod) - STRING
IcmsCst (icms_cst) - STRING
IcmsRate (icms_rate) - DECIMAL
FcpBasis (fcp_basis) - DECIMAL
FcpRate (fcp_rate) - DECIMAL
IcmsStRate (icms_st_rate) - DECIMAL
RedBcEfetRate (red_bc_efet_rate) - DECIMAL
BcEfetAmount (bc_efet_amount) - DECIMAL
IcmsEfetRate (icms_efet_rate) - DECIMAL
IcmsEfetAmount (icms_efet_amount) - DECIMAL
StRate (st_rate) - DECIMAL
FcpSTBasis (fcp_st_basis) - DECIMAL
FcpSTRate (fcp_st_rate) - DECIMAL
FcpSTRetBasis (fcp_st_ret_basis) - DECIMAL
FcpSTRetRate (fcp_st_ret_rate) - DECIMAL
IssRate (iss_rate) - DECIMAL
IpiAmount (ipi_amount) - DECIMAL
IpiRate (ipi_rate) - DECIMAL
PisBasis (pis_basis) - DECIMAL
PisRate (pis_rate) - DECIMAL
CofinsBasis (cofins_basis) - DECIMAL
CofinsRate (cofins_rate) - DECIMAL
TaxSituationCode (tax_situation_code) - STRING
LogSequence (log_sequence) - INTEGER
RefNfe (ref_nfe) - STRING
IssCityCode (iis_city_code) - STRING
IssServiceCode (iis_service_code) - STRING
IssEligibleIndicator (iis_eligible_indicator) - STRING
IssIncentiveIndicator (iis_incentive_indicator) - STRING
Relationships:
Properties - PafNfeQueueItemProperty
PafNfeQueueItemProperty
Table: cpaf_nfe_queue_item_p
Fields:

should be 0 or 1.
PafNfeQueueLog
Table: cpaf_nfe_queue_log
Fields:

ResponseText (response_text) - STRING
Source (source) - STRING
Relationships:
Properties - PafNfeQueueLogProperty
PafNfeQueueLogProperty
Table: cpaf_nfe_queue_log_p
Fields:

should be 0 or 1.
PafNfeQueueProperty
Table: cpaf_nfe_queue_p
Fields:

should be 0 or 1.
PafNfeQueueTender
Table: cpaf_nfe_queue_tender
Fields:

FiscalTenderId (fiscal_tender_id) - STRING
CardNetworkId (card_network_id) - STRING
CardTaxId (card_tax_id) - STRING
CardAuthNumber (card_auth_number) - STRING
CardType (card_type) - STRING
CardTraceNumber (card_trace_number) - STRING
CardIntegrationMode (card_integration_mode) - STRING
CardInstallments (card_installments) - INTEGER
Relationships:
Properties - PafNfeQueueTenderProperty
PafNfeQueueTenderProperty
Table: cpaf_nfe_queue_tender_p
Fields:

should be 0 or 1.
PafNfeQueueTrans
Table: cpaf_nfe_queue_trans
Fields:

TransactionWorkstationId (trans_wkstn_id) - LONG
Inactive (inactive_flag) - BOOLEAN
Relationships:
Properties - PafNfeQueueTransProperty
PafNfeQueueTransProperty
Table: cpaf_nfe_queue_trans_p
Fields:

should be 0 or 1.
PafNfeTaxCst
Table: cpaf_nfe_tax_cst
Fields:

Cst (cst) - STRING
Relationships:
Properties - PafNfeTaxCstProperty
PafNfeTaxCstProperty
Table: cpaf_nfe_tax_cst_p
Fields:

should be 0 or 1.
PafNfeTender
Table: cpaf_nfe_tender
Fields:

Nnf (nnf) - INTEGER
FiscalTenderId (fiscal_tender_id) - STRING
CardNetworkId (card_network_id) - STRING
CardTaxId (card_tax_id) - STRING
CardAuthNumber (card_auth_number) - STRING
CardTraceNumber (card_trace_number) - STRING
CardIntegrationMode (card_integration_mode) - STRING
CardInstallments (card_installments) - INTEGER
Relationships:
Properties - PafNfeTenderProperty
PafNfeTenderProperty
Table: cpaf_nfe_tender_p
Fields:
Nnf (nnf) - INTEGER
should be 0 or 1.
PafNfeTrans
Table: cpaf_nfe_trans
Fields:

Nnf (nnf) - INTEGER
Relationships:
Properties - PafNfeTransProperty
PafNfeTransProperty
Table: cpaf_nfe_trans_p
Fields:

Nnf (nnf) - INTEGER
should be 0 or 1.
PafNfeTransTax
Table: cpaf_nfe_trans_tax
Fields:

Uf (uf) - STRING
DestUf (dest_uf) - STRING
NewTaxGroupId (new_tax_group_id) - STRING
Relationships:
Properties - PafNfeTransTaxProperty
PafNfeTransTaxProperty
Table: cpaf_nfe_trans_tax_p
Fields:

Uf (uf) - STRING
DestUf (dest_uf) - STRING
should be 0 or 1.
PafNfeTransType
Table: cpaf_nfe_trans_type
Fields:

CfopSameUf (cfop_same_uf) - STRING
CfopOtherUf (cfop_other_uf) - STRING
CfopForeign (cfop_foreign) - STRING
CommentRequiredFlag (comment_req_flag) - BOOLEAN
DisallowCancelFlag (disallow_cancel_flag) - BOOLEAN
PricingType (pricing_type) - STRING
InitialComment (initial_comment) - STRING
Relationships:
Properties - PafNfeTransTypeProperty
PafNfeTransTypeProperty
Table: cpaf_nfe_trans_type_p
Fields:

should be 0 or 1.
PafNfeTransTypeUsage
Table: cpaf_nfe_trans_type_use
Fields:

UsageTypeCode (usage_typcode) - STRING
Uf (uf) - STRING
Relationships:
Properties - PafNfeTransTypeUsageProperty
PafNfeTransTypeUsageProperty
Table: cpaf_nfe_trans_type_use_p
Fields:

UsageTypeCode (usage_typcode) - STRING
Uf (uf) - STRING
should be 0 or 1.
PafSatResponse
Table: cpaf_sat_response
Fields:

SessionId (session_id) - INTEGER
CodeSate (code_sate) - STRING
MessageSate (message_sate) - STRING
CodeAlert (code_alert) - STRING
MessageAlert (message_alert) - STRING
XmlString (xml_string) - STRING
Chave (chave) - STRING
CpfCnpjValue (cpf_cnpj_value) - STRING
SignatureQRCODE (signature_QR_code) - STRING
Success (success) - BOOLEAN
Timeout (timeout) - BOOLEAN
Relationships:
Properties - PafSatResponseProperty
PafSatResponseProperty
Table: cpaf_sat_response_p
Fields:

SessionId (session_id) - INTEGER
should be 0 or 1.
SaleInvoice
Table: civc_invoice
Fields:

BusinessYear (business_year) - LONG
InvoiceType (invoice_type) - STRING
VoidFlag (void_flag) - BOOLEAN
ExternalInvoiceId (ext_invoice_id) - STRING
ExternalInvoiceBarcode (ext_invoice_barcode) - STRING
GrossAmount (gross_amt) - DECIMAL
RefundAmount (refund_amt) - DECIMAL
InvoicePrefix (invoice_prefix) - STRING
ReturnFlag (return_flag) - BOOLEAN
ConfirmFlag (confirm_flag) - BOOLEAN
VoidPendingFlag (void_pending_flag) - BOOLEAN
ConfirmSentFlag (confirm_sent_flag) - BOOLEAN
ConfirmResult (confirm_result) - STRING
InvoiceTransactionSequence (invoice_trans_seq) - LONG
InvoiceData (invoice_data) - OBJECT
InvoiceExportDate (invoice_export_date) - DATE
Relationships:
InvoiceTransactionsLines - SaleInvoiceCrossReference
Properties - SaleInvoiceProperty
SaleInvoiceCrossReference
Table: civc_invoice_xref
Fields:

TransactionSequence (trans_trans_seq) - LONG
TransactionLineItemSequence (trans_trans_lineitm_seq) - LONG
Relationships:
Properties - SaleInvoiceCrossReferenceProperty
SaleInvoiceCrossReferenceProperty
Table: civc_invoice_xref_p
Fields:

TransactionSequence (trans_trans_seq) - LONG
TransactionLineItemSequence (trans_trans_lineitm_seq) - LONG
should be 0 or 1.
SaleInvoiceProperty
Table: civc_invoice_p
Fields:

should be 0 or 1.
TaxFreeCardRange
Table: civc_taxfree_card_range
Fields:

RangeType (range_type) - STRING
RangeStart (range_start) - STRING
RangeEnd (range_end) - STRING
MaxLen (max_len) - LONG
CardSchemaName (card_schema_name) - STRING
MinLen (min_len) - LONG
Relationships:
Properties - TaxFreeCardRangeProperty
TaxFreeCardRangeProperty
Table: civc_taxfree_card_range_p
Fields:

RangeType (range_type) - STRING
RangeStart (range_start) - STRING
RangeEnd (range_end) - STRING
MaxLen (max_len) - LONG
should be 0 or 1.
TaxFreeCountry
Table: civc_taxfree_country
Fields:

Iso3NumCode (iso3num_code) - STRING
Iso2AlphaCode (iso2alp_code) - STRING
PhonePrefix (phone_prefix) - STRING
PassportCode (passport_code) - STRING
BlockedFlag (blocked_flag) - BOOLEAN
VoidFlag (void_flag) - BOOLEAN
Relationships:
Properties - TaxFreeCountryProperty
TaxFreeCountryProperty
Table: civc_taxfree_country_p
Fields:

Iso3NumCode (iso3num_code) - STRING
should be 0 or 1.
B
Revision History
Version 21.0 Revision 01

The following changes have been made:
Chapter Method/Class Description
Chapter 12 - Inventory GetVarianceReport added CountCycle field

Count
Chapter 13 -Items checkProductAvailabilit removed fulfillmentType field.

y mehtods MinimumItemQty field is removed and
ItemQty field is introduced.
Chapter 25 - OrderSaleAccount class Removed fields fulfillmentType,

Transaction shippingFeeItemId, pickupRetailLocation
and sourceStoreInfo. Introduced a new
field orderType.
Chapter 27 added Endpoint - Pay by Link

Notification Resource

Chapter 27 added note about tenancy ID
B-1

Chapter 27 RTLog:
• added healthcheck (Cloud Only)
endpoint
Xcenter:
• updated DTX endpoints
• updated cancelleddeployments
endpoint
• added broadcaster status endpoint
endpoint
Xadmin:
endpoint
Version 20.0.1 Revision 01

Chapter 13 -Items LocateInventory deleted methods LocateInventory and

LocateOrderItems
LocateOrderItems
checkProductAvailability - removed
checkProductAvailabilit
fulfillemntType from method and
y mehtods
variables lis
Chapter 15 - Order DiscoverLocations deleted methods

SubmitOrderPickup
SubmitOrderRetailPick
up
SubmitOderDelivery
Chapter 25 - OrderSaleAccount class modify fulfillment type to orderType

Transaction

Chapter 27 marked enrollstore and enrollclient as

Cloud only
B-2 Services Guide


Chapter 27 added RTLogFormatConfig

Chapter 27 added tempstore and

cancelleddeployments

Chapter 27 marked ShowStatus endpoint as on-

premise only

Chapter 27 updated whole chapter

Chapter 2 Address decodePostalCode "added decodePostalCode method

method
"added postalCodeListResponse class
postalCodeListRespons
e class
Chapter 26 and 27 updated MyMerchCode /mine to default

updated v1 to 19

Xstore Office Services added receipt viewer service
Services Guide B-3


all chapters PI and CI cleanup

Xstore Office Services added endpoint enrollstore and

enrollclient (only for 18.1)

Xstore Office Services updated endpoint

added broadcaster service

Restful WebServices added chapter
Xstore Office Services added chapter
Appendix: Database added chapter

Tables

Shipping Added a note that Carton ID is not used

in the Shipping functions.

Item locateOrderItems Corrected name of Locate to Order

Broker.
B-4 Services Guide

Version 17.0
Version 17.0
General proofreading and corrections were performed throughout the document.
Configuration checkFirmwareUpdate Added
checkForFirmwareUpdate Added
Response
checkForEncryptionKey Added
Update
encryptionKeyUpdate Added
Response
Customer taxExemption Added certificateCountry element.
Inventory All New chapter.

Adjustment
Order All New chapter.
Tender All Removed chapter.
Timeclock timeClockResponse Added failureMessage element.
Transaction reprintReceipt Removed
Version 16.0.0.1
Send Us Your N/A Changed name of Xstore Point of Sale for Grocery
Comments User Guide to Oracle Retail Xstore Point‐of‐Service,
Lane Checkout User Interface User Guide.
Services Guide B-5

Version 16.0
Version 16.0
Configuration checkFirmwareUpdate Removed.
checkForAppUpdate Removed.
checkForEncryptionKey Removed.
Update
checkForFirmwareUpdate Removed.
Response
checkForUpdates Removed.
Response
encryptionKeyUpdate Removed.
Response
TimeclockPD All Removed chapter.
Transaction isBounceBackCouponInR New method.

ange
Version 15.0
Updated document to Oracle format.
Version 7.0
Clienteling All New chapter, including all methods and classes.
Configuration encryptionKey Added encryptionKeyCert,

UpdateResponse encryptionKeyCertHash,
encryptionKeyIdCert,
encryptionKeyIdCertHash,
encryptionUpdateBundle,
encryptionUpdateBundleHash elements.
House adaptedHouse Changed name of element from

Account AccountSearch houseAccountSearchResult.
Result
houseAccountSearch Changed type of accounts element to

Response adaptedHouseAccountSearchResult from
houseAccountSearchResult.
Item checkProduct New method.

Availability
B-6 Services Guide

Version 6.5
Shipping getShippingMethods New method.
orderShipping New element.

MethodResponse
shippingMethod New element.
Transaction orderSaleAccount Added sourceStoreInfo variable.
sourceStoreInfo New element.
Version 6.5
Introduction serviceContext Added employeeId element.
codeValueObject Moved codeValueObject element definitions from

different chapters into the “Introduction”.
Address country Changed name of countryDescr to

countryDesc.
Customer customerParty Added emailRcpt element.
Added federalTaxId element.
Added gender element.
Item item Added itemClassDesc and itemClassId.
Inventory All New chapter, including all methods and classes.

Count
Receiving createNewDocument Added DocumentId variable.
inventoryDocument Added expectedDate element.
Shipping createNewDocument Added DocumentId variable.
Timeclock employeeClockIn Added ReceiptPrinter variable.
Transaction bounceBackCoupon Removed seriesId element.
posTrans Changed name of totalItemsSold to

totalItemSold.
suspendRetail Added ReceiptPrinter variable.

Transaction
Version 6.0
Services Guide B-7

Version 6.0
In addition, the following changes were made to the Services Guide manual.
Introduction statusService Added class definition to the “Common Data

Response Types” section.
Address Changed URL for the Address Services WSDL to:

https://<hostname>:8443/ws/AddressServices?wsdl
address New element.
addressValidation New element.

Response
country New element.
countryListResponse New element.
getAvailableCountries New method.
validateAddress New method.
Configuration Changed URL for the Configuration Services WSDL to:

https://<hostname>:8443/ws/
ConfigurationServices?wsdl
checkFirmwareUpdate New method.
checkForEncryption New method.

KeyUpdate
serviceResponse Changed name of operationConfig element to

opChainConfigs.
Changed name of systemConfig element to
systemConfigs.
operationConfig Change name of operationConfig element to

operations.
Customer Changed URL for the Customer Services WSDL to:

https://<hostname>:8443/ws/CustomerServices?wsdl
customer Added lastContactDate, lastPurchaseDate,

and totalPurchaseAmt elements.
customerParty Added active and stateTaxId elements.
Discount Changed URL for the Discount Services WSDL to:

https://<hostname>:8443/ws/DiscountServices?wsdl
B-8 Services Guide

Version 6.0
Employee Changed URL for the Employee Services WSDL to:

https://<hostname>:8443/ws/EmployeeServices?wsdl
authResponse Removed.
authenticate Changed return type to employeeAuthResponse

from authResponse.
changePassword New method.
employeeMessage Added messageURL element.
House Changed URL for the House Account Services WSDL to:
Account
https://<hostname>:8443/ws/HouseAccountServices?wsdl
houseAccountSearch Renamed AccountId variable to accountId.

Result
Input Changed URL for the Input Services WSDL to:

https://<hostname>:8443/ws/InputServices?wsdl
Inventory Changed URL for the Inventory Services WSDL to:

https://<hostname>:8443/ws/InventoryServices?wsdl
Item Changed URL for the Item Services WSDL to:

https://<hostname>:8443/ws/ItemServices?wsdl
catalog New element.
catalogListResponse New element.
catalogPage New element.
catalogPageItem New element.
catalogPageResponse New element.
catalogResponse New element.
getCatalog New method.
getCatalogList New method.
getItemPriceHistory New method.
getItemsForCategory New method.
getNonPhysicalItems Added Type and Subtype variables.
getProductCategories New method.
getSimilarItems New method.
Services Guide B-9

Version 6.0
Item (Cont’d) item Added departmentId, departmentDesc,

itemSubClassDesc, itemSubClassId,
subdepartmentDesc, and subdepartmentId
elements.
itemPriceHistory New element.

Response
itemPriceHistory New element.
locateOrderItems New method.
printItemLabel New method.
productCategories New element.

Response
productCategory New element.
searchCatalogForItem New method.
statusService New element.

Response
Logging Changed URL for the Logging Services WSDL to:

https://<hostname>:8443/ws/LoggingServices?wsdl
Ping Changed URL for the Ping Services WSDL to:

https://<hostname>:8443/ws/PingServices?wsdl
Printing Changed URL for the Printing Services WSDL to:

https://<hostname>:8443/ws/PrintingServices?wsdl
getAvailablePrinters Added Type variable.
printTestReceipt New method.
Reason Code Changed URL for the Reason Code Services WSDL to:
https://<hostname>:8443/ws/ReasonCodeServices?wsdl
reasonCodePrompt New element.

Properties
reasonCode Added actionCode and promptProperties

elements.
B-10 Services Guide

Version 6.0
Receiving Changed URL for the Receiving Services WSDL to:

https://<hostname>:8443/ws/ReceivingServices?wsdl
addToExpress Added PONumber variable.

Removed SessionId variable.
cancelExpress Removed SessionId variable.
expressReceiving Removed SessionId.

Response
inventoryDocType Removed.
inventoryDocument Added cartonShipping and invoiceNumber

elements.
receivingConfiguration Removed ReceivingDocTypes element.
saveDocument Removed EmployeeId variable.
saveExpress Removed EmployeeId and SessionId variables.
updatePONumber Added CartonId variable.
voidFromExpress Removed SessionId.
Register Changed URL for the Register Services WSDL to:

https://<hostname>:8443/ws/RegisterServices?wsdl
closeRegister Removed EmployeeId variable.
getRegisterStore New method.

Status
openRegister Removed EmployeeId variable.
Retail Location Changed URL for the Retail Location Services WSDL to:
https://<hostname>:8443/ws/
RetailLocationServices?wsdl
closeStore New method.
getRetailLocationWith New method.

Id
locateSendSaleStores New method.
openStore New method.
validateStoreClosed New method.
Services Guide B-11

Version 6.0
Shipping Changed URL for the Receiving Services WSDL to:

https://<hostname>:8443/ws/ShippingServices?wsdl
addLine Added CartonId variable.
getCarton New method.
saveDocument Removed EmployeeId variable.
shippingBundle New element.

Response
shippingConfiguration Removed ReceivingDocTypes element.
updatePONumber New method.
validateOrAddCarton New method.
Tax Changed URL for the Tax Services WSDL to:

https://<hostname>:8443/ws/TaxServices?wsdl
Tender Changed URL for the Tender Services WSDL to:

https://<hostname>:8443/ws/TenderServices?wsdl
authResponse Added lineItemToken element.
authorizeCredit Added LineItemToken, Pin, and

DeviceSecurityInfo variables.
Removed AccountNumber, Track1, Track2, and
Track3 variables.
authorizeCreditWith Added LineItemToken variable.

MoreInfo
authorizeVoidCredit Added LineItemToken variable.
authorizeVoucher Added LineItemToken variable.

Tender
Track3 variables.
authorizeVoucherWith Added LineItemToken variable.

ManualCode
Track3 variables.
creditCardInputEvent Added debitAllowed, debitOnly, and

secondaryInputType elements.
creditCardValidation Added lineItemToken and secondaryTender

Response elements.
generateVoucher New method.

BalanceReceipt
Tender getVoucherBalance Added TrackSet, EncryptedTrackSet, and

(Cont’d) HardwareId variables.
Removed Track1, Track2, and Track3 variables.
B-12 Services Guide

Version 6.0
validateCreditCard Added AccountNumber, TrackSet,

Number EncryptedTrackSet, and HardwareId
variables.
Removed AccountInput variable.
validateVoucherTender Added AccountNumber, TrackSet,

EncryptedTrackSet, and HardwareId
variables.
Removed AccountInput variable.
voucherValidation Added lineItemToken element.

Response
Timeclock Changed URL for the Timeclock Services WSDL to:

https://<hostname>:8443/ws/TimeclockServices?wsdl
employeeAuth Name changed from authResponse.

Response
Timeclock PD Changed URL for the Timeclock PD Services WSDL to:

https://<hostname>:8443/ws/TimeclockPDServices?wsdl
validateEmployee Changed return type from

ClockOutPD validateTimeClockResponse to
validateTimeClockPDResponse.
Transaction Changed URL for the Transaction Services WSDL to:

https://<hostname>:8443/ws/TransServices?wsdl
addCreditDebitTender Name changed from

LineItem addCreditCardTenderLineItem.
Added LineItemToken, PinBlock, and
PinSerial variables.
Track3 variables.
addVoucherSaleLine Added LineItemToken variable.

Item
Track3 variables.
applyLineItemTax New method.

Exemption
authResponse Added lineItemToken element.
authorizeVoucherSale Added LineItemData variable.

Track3 variables.
Transaction addVoucherTenderLine Added LineItemToken variable.

(cont’d) Item
Track3 variables.
bounceBackCoupon New element.
Services Guide B-13

Version 6.0
bounceBackCoupon New element.

Response
cancelRetail Added ReasonCodePromptProperties

Transaction variable.
changeLineItemPrice Added ReasonCodePromptProperties

variable.
changeLineItemTax Added ReasonCodePromptProperties

variable.
changeLineItemTax Added ReasonCodePromptProperties

Location variable.
changeTransactionTax New method.
changeTransactionTax New method.

Location
codeValueObject Added category element.
commitRetail Added EmailAddress, PrintReceipt, and

Transaction ReceiptPrinter variables.
createNewRetail Removed EmployeeId variable.

Transaction
createOrderSale New method.
discountGroupLine New method.

Item
discountLineItem Added lineItemToken element.
discountTransaction Added ReasonCodePromptProperties

variable.
getBounceBack New method.

Coupon
getSuspended New method.

Transactions
issueRedeemBounce New method.

BackCoupon
orderSaleAccount New element.
orderSaleTrans New element.

Response
Transaction posConfiguration Added taxDisplayRule element.

(cont’d)
posTenderLine Removed authorizationToken element.

Added lineItemToken element.
posTransSaleLine Added lineItemToken element.
B-14 Services Guide

Version 6.0
regenerateTransaction New method.

Documents
resumeTransaction New method.
searchTrans Added LineItemToken variable.

Removed CreditCardAccountNumber and
CreditCardTrack1Data variables.
sendSaleAccount Added posTrans element.

Response
setTaxExemption New method.

Account
suspendedTrans New element.
suspendedTransResult New element.

Response
validateCreditCard New method.

Tender
validateGroupDiscount New method.
validateTransaction New method.

Discount
validateVoucherSale Added voucherNumber, TrackSet,

EncryptedTrackSet, HardwareId, and
EntryMethodCode variables.
validateVoucherTender New method.
voidTenderLineItem Added LineItemToken and

ReasonCodePromptProperties variables.
Services Guide B-15

Version 5.5
Version 5.5
Variable descriptions were added for all procedures throughout the document.
In addition, the following changes were made to the Services Guide manual.
Customer customerParty Added address3 element.

Added address4 element.
Added apartment element.
Added emails element.
Added telephones element.
customer Added addressType element.

Added employeeId element.
emails New object.
telephones New object.
customerHistory Added ItemUrl element.

Item
House Account All New chapter, including all methods and

classes.
Timeclock PD validateEmployee Message removed in Xstore Point of

ClockInWithout Service 5.5.
AuthPD
validateEmployee Message removed in Xstore Point of

IsClockedInPD Service 5.5.
B-16 Services Guide

Xstorepos 210 SG

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Xstorepos 210 SG

Uploaded by

Copyright:

Available Formats

Oracle® Retail Xstore Suite

12 Inventory Count .............................................................................12-1

21 Retail Location ...............................................................................21-1

26 ReSTful Web Services...................................................................26-1

27 Xstore Office Services...................................................................27-1

Oracle Retail Xstore Suite Services Guide 1-20

1-21 Oracle Retail Xstore Suite Services Guide

Oracle Retail Xstore Suite Services Guide 1-22

1-23 Oracle Retail Xstore Suite Services Guide

Oracle Retail Xstore Suite Services Guide 1-24

A Appendix: DTX Names and Database Tables .............................. A-1

B Revision History ............................................................................. B-1

1-25 Oracle Retail Xstore Suite Services Guide

Oracle Retail Xstore Suite Services Guide 1-26

Oracle Retail Xstore Suite Services Guide, Release 21.0

Send your comments to us using the electronic mail address: retail-doc_us@oracle.com

Access to Oracle Support

Review Patch Documentation

Oracle Retail Documentation on the Oracle Help Center

Note: Communication with Xstore Point of Service Services is

About This Chapter

Type Element Description

decimal simpleElement An element with a simple data type. See

string[] simpleElementArray An array of values using a simple data

subClass definedType A complex type described in the XSD for

1-2 Oracle Retail Xstore Suite Services Guide

Table 1-1: classExample Elements (continued)

Type Element Description

subClass[] definedTypeArray An array of complex types. This array can

Type Element Description

????? elements Each subclass can include any number of

Simple Data Types

Common Data Types

Type Element Description

string category Code category.

string code Code value.

string description Description of the code.

int sortOrder Number used to sort the code.

Type Element Description

string employeeId ID for the employee.

string localeId ID for the store locale.

long organizationId ID for the organization.

long retailLocationId ID for the retail location.

long workstationId ID for the workstation.

Type Element Description

string failureCode ID code for the failure, if any.

string failureMessage Message text of the failure, if any.

string promptMessage Message displayed in the

1-4 Oracle Retail Xstore Suite Services Guide

Type Element Description

string status Status.

About this Manual

• Chapter 2, “Address” • Chapter 16, “Ping”

• Chapter 3, “Clienteling” • Chapter 17, “Printing”

• Chapter 4, “Configuration” • Chapter 18, “Reason Code”

• Chapter 5, “Customer” • Chapter 19, “Receiving”

• Chapter 6, “Discount” • Chapter 20, “Register”

• Chapter 7, “Employee” • Chapter 21, “Retail Location”

• Chapter 8, “House Account” • Chapter 22, “Shipping”

• Chapter 9, “Input” • Chapter 23, “Tax”

• Chapter 10, “Inventory” • Chapter 22, “Tender”

• Chapter 12, “Inventory Count” • Chapter 24, “Timeclock”

• Chapter 13, “Item” • Chapter 24, “Timeclock PD”