Sales Audit Services
The following services are included in this functional area:
Data Privacy
The following services are included in this functional area:
Sales Audit Data Privacy Download Service
The following services are included in this functional area:
Download Service Get Personally Identifiable Information
This section describes the Data Privacy Access service for Sales Audit.
Business Overview
This query service provides access to data stored in Sales Audit that contain personally identifiable information.
ReSTURL
https://<host:port>/RetailAppsDataPrivServicesRESTApp/rest/privatedata/getPersonalInfo?customer_id={entityName}::{entityType}::{entityId}::{fullName}:: {phone}::{email}
Query Parameters
-
customer_id (required): The customer ID string containing the parameters to be used in looking up data. The format of this string is as follows:
-
{entity name}::{entity type}::{entity id}::{full name}::{phone}::{email}
-
Path Parameters
Parameter | Description |
---|---|
Entity Name |
The query group type for which data is to be retrieved. The available group types for Sales Audit are:
|
Entity Type |
Used if the entity name is CUSTOMER. The value here should indicate the type of customer being queried. Valid values for this input can be found on the Codes table where code type is 'CIDT'. |
Entity ID |
The ID of the entity being queried. For example, the employee ID. |
Full Name |
The full name to be searched for the selected entity. |
Phone |
The phone number to be searched for the selected entity. |
|
The email to be searched for the selected entity. |
Default Response
The response will return all instances of the data being searched that occur in the requested entity. For example, if the entity requested was EMPLOYEE, all instances where the employee, name, phone, and email match the data sent will be returned. If any of these parameters are not sent (e.g. employee), then it will not be used as part of the search. The following data is included in the response:
Parameter | Description |
---|---|
Entity Name |
Valid values are
|
Entity Type |
If the entity name is CUSTOMER, the value here indicates the type of customer being queried. Valid values for this input can be found on the Codes table where code type is 'CIDT'. For other entity types, this will be null. |
Entity ID |
The ID of the entity where the data was found. |
Full Name |
The name associated with the entity. |
Phone |
The phone number associated with the entity. |
Fax |
The fax number associated with the entity. |
Telex |
The telex number associated with the entity. |
Pager |
The pager number associated with the entity. |
|
The email address associated with the entity. |
Sample Response
{ "Personal Information": { "list": [], "Get Personal Information": { "list": [ [ { "ENTITY_NAME": "EMPLOYEE", "ENTITY_TYPE": "null", "ENTITY_ID": "1414", "FULL_NAME": "Harry Adams", "PHONE": "2349989", "FAX": "null", "TELEX": "null", "PAGER": "null", "EMAIL": "hadams@email.com" } ] ] } } } }
Response Codes and Error Messages
-
200 - Success
-
400 - Bad Request - for the following situations:
-
Customer ID does not match the required format
-
Invalid input type
-
Missing customer ID
-
Invalid jsonFormat
-
-
500 - Internal Server Errors - for all other types of errors (for example, configuration errors, SQL errors, and so on)
Sales Audit Data Privacy Upload Service
The following services are included in this functional area:
Delete Personally Identifiable Information
This section describes the Data Privacy Forget service for Sales Audit.
Business Overview
This service supports updating personal information stored in Sales Audit. When the service is invoked with mask strings as inputs, it overwrites the fields with mask strings, which effectively removes the personal information from the system.
ReSTURL
https://<host:port>/RetailAppsDataPrivServicesRESTApp/rest/privatedata/updatePersonalInfo?customer_id={entityName}::{entityType}::{entityId}::{fullName}:: {phone}::{fax}::{telex}::{pager}::{email}::{addr1}::{addr2}::{addr3}::{county}::{city}::{state}::{countryId}::{postalCode}
Query Parameters
-
customer_id (required): The customer ID string containing the parameters to be used in updating data. The format of this string is as follows:
-
{entityName}::{entityType}::{entityId}::{fullName}::{phone}::{fax}::{telex}::{pager}::{email}::{addr1}::{addr2}::{addr3}::{county}::{city}::{state}::{countryId}::{postalCode}
-
Path Parameters
Parameter | Description |
---|---|
Entity Name (required) |
The group type for which data is to be updated. The available group types for Sales Audit are:
|
Entity Type |
Required if the entity name is CUSTOMER. The value here should indicate the type of customer. Valid values for this input can be found on the Codes table where code type is 'CIDT'. |
Entity ID (required) |
The ID of the entity to be updated. For example, the employee ID. |
Full Name |
The value to update the full name with. If a null value is passed to this parameter that is a required field in the table, the field will be updated to 'XXXXX'. |
Phone |
The value to update the phone number with. If a null value is passed to this parameter that is a required field in the table, the field will be updated to 'XXXXX'. |
Fax |
The value to update the fax number with. |
Telex |
The value to update the telex number with. |
Pager |
The value to update the pager number with. |
|
The value to update the email address with. |
Addr1 |
The value to update the address 1 with. |
Addr2 |
The value to update the address 2 with. |
Addr3 |
The value to update the address 3 with. |
County |
The value to update the county with. |
City |
The value to update the city with. |
State |
The value to update the state with. |
Country |
The value to update the country with. |
Postal Code |
The value to update the postal code with. |
Default Response
This service only returns a response code to signify if the request is successful or not. If no record is updated, the service returns an error.
Response Codes and Error Messages
-
200 - Success
-
400 - Bad Request - for the following situations:
-
Customer ID does not match the required format
-
Invalid input type
-
Missing customer ID
-
Invalid jsonFormat
-
-
500 - Internal Server Errors - for all other types of errors (for example, configuration errors, SQL errors, and so on).
Store Day Summary
The following services are included in this functional area:
Mobile Workflow Store Day Download Service
The following services are included in this functional area:
Get Aggregated Open Store Days
Business Overview
Retrieves aggregated store day information for all dates or store days older than vdate -5.
ReST URL
/getStoreAggregations?allOlderInd={allOlderInd}&stores={stores}&sortAttrib={sortAttrib}&sortDirection={sortDirection}&pageSize={pageSize}&pageNumber={pageNumber}
Input Parameters
Parameter Name | Required | Description | Valid values |
---|---|---|---|
AllOlderInd |
Yes |
Search string for locations ID or Name |
|
Stores |
No |
Comma-separated values for stores |
NA |
SortAttrib |
No |
Sort Attribute |
|
SortDirection |
No |
Sort Direction |
|
PageSize |
No |
Maximum number of locations to retrieve per page |
NA |
PageNumber |
No |
Result page to retrieve |
NA |
Get Open Store Day Counts
Business Overview
This service provides, at a glance, the number of open stores for which the sales audit manager is responsible. The stores for which the user is responsible are those associated with the user in Sales Audit's employee maintenance via location traits.
Get Open Store Day Details
Business Overview
The service displays a list of open stores to which the user is assigned, for a single day, for 'OLDER' days, or for 'ALL' days.
ReST URL
/getStoreDays?store={store}&recordType={recordType}&recordDate={recordDate}&sortAttrib={sortAttrib}&sortDirection={sortDirection}&pageSize={pageSize}&pageNumber={pageNumber}
Input Parameters
Parameter Name | Required | Description | Valid Values |
---|---|---|---|
RecordType |
Yes |
Record Type |
|
RecordDate |
No |
Record Date, required when recordType is DATE |
NA |
Store |
No |
Store ID |
NA |
SortAttrib |
No |
Sort Attribute |
|
SortDirection |
No |
Sort Direction |
|
PageSize |
No |
Maximum number of locations to retrieve per page |
NA |
PageNumber |
No |
Result page to retrieve |
NA |
Output
Store
Store Day Seq No
Auditors
Business Date
Store Name
Chain
Chain Name
Data Status
Data Status Description
Audit Status
Audit Status Description
Audit Changed Datetime
Fuel Status
Fuel Status Description
Over Short Amount
Currency Code
Error Count
Transaction Count
Loaded File Count
Expected File Count
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
LOC_TRAITS_MATRIX |
Yes |
No |
No |
No |
SA_ERROR |
Yes |
No |
No |
No |
SA_HQ_VALUE |
Yes |
No |
No |
No |
SA_POS_VALUE |
Yes |
No |
No |
No |
SA_STORE_DATA |
Yes |
No |
No |
No |
SA_STORE_DAY |
Yes |
No |
No |
No |
SA_SYS_VALUE |
Yes |
No |
No |
No |
SA_SYSTEM_OPTIONS |
Yes |
No |
No |
No |
SA_TOTAL |
Yes |
No |
No |
No |
SA_TRAN_HEAD |
Yes |
No |
No |
No |
SA_USER_LOC_TRAITS |
Yes |
No |
No |
No |
V_CHAIN |
Yes |
No |
No |
No |
V_CODE_DETAIL |
Yes |
No |
No |
No |
V_STORE |
Yes |
No |
No |
No |
Get Open Store Day Error Counts
Business Overview
This service provides, at a glance, the number outstanding errors on the specified days for stores for which the sales audit manager is responsible. An outstanding error is defined as an error that exists against a store day that has not been overridden.
Get Open Store Day Over/Short Amounts
Business Overview
This service provides at a glance the sums of all overages and all shortages for all open stores on a given day for which the sales audit manager is responsible. If all locations to which the user is responsible have the same local currency, all monetary values will be displayed in the local currency. Otherwise, all monetary values will be displayed in the retailer's primary currency. If the Over/Short value for the store day is a positive value it is considered an overage, if the Over/Short value for the store day is a negative value it is a shortage.
Output
Record Type --DATE, OLDER, ALL
-
For record type DATE: Five records of type date are displayed for today minus 1 through today minus 5
-
One record type OLDER: is for store days older than today minus 5
-
One record type ALL: for all store days
Record Date --Date of date type rows
Over Amount
Short Amount
Currency Code
Get Open Store Day Over/Short Counts
Business Overview
This service provides, at a glance, the count of overages and the count of shortages for all open stores on a given day for which the sales audit manager is responsible. If the Over/Short value for the store day is a positive value it is considered an overage, if the Over/Short value for the store day is a negative value it is a shortage.
Output
Record Type --DATE, OLDER, ALL
-
For record type DATE: five records of type date are displayed for today minus 1 through today minus 5
-
One record type OLDER: is for store days older than today minus 5
-
One record type ALL: for all store days
Record Date --Date of date type rows
Over Count
Short Count
Get Open Store Days
Business Overview
This web service allows the user to find which store days have records that needs attention.
Output
Record Type --DATE, OLDER, ALL
-
For record type DATE: five records of type date are displayed for today minus 1 through today minus 5
-
One record type OLDER: is for store days older than today minus 5
-
One record type ALL: for all store days
Record Date --Date of date type rows
Store Has Value indicator
Get Store Errors
Get Stores with Open Days
ReST URL
/storeSearch?searchString={searchString}&searchFilter={searchFilter}&sortAttrib={sortAttrib}&sortDirection={sortDirection}&pageSize={pageSize}&pageNumber={pageNumber}
Input Parameters
Parameter Name | Required | Description | Valid values |
---|---|---|---|
SearchString |
Yes |
Search string for locations ID or Name |
NA |
SearchFilter |
Yes |
Search all stores or assigned stores |
|
SortAttrib |
No |
Sort Attribute |
|
SortDirection |
No |
Sort Direction |
|
PageSize |
No |
Maximum number of locations to retrieve per page |
NA |
PageNumber |
No |
Result page to retrieve |
NA |
Output
Store
Store Name
Chain
Chain Name
Auditors
Open Days
Over Days
Short Days
Over Amount
Short Amount
Currency Code
Error Count
Table Impact
TABLE | SELECT | INSERT | UPDATE | DELETE |
---|---|---|---|---|
LOC_TRAITS_MATRIX |
Yes |
No |
No |
No |
SA_ERROR |
Yes |
No |
No |
No |
SA_HQ_VALUE |
Yes |
No |
No |
No |
SA_POS_VALUE |
Yes |
No |
No |
No |
SA_STORE_DATA |
Yes |
No |
No |
No |
SA_STORE_DAY |
Yes |
No |
No |
No |
SA_SYS_VALUE |
Yes |
No |
No |
No |
SA_TOTAL |
Yes |
No |
No |
No |
SA_TRAN_HEAD |
Yes |
No |
No |
No |
SA_USER_LOC_TRAITS |
Yes |
No |
No |
No |
V_CHAIN |
Yes |
No |
No |
No |
V_STORE |
Yes |
No |
No |
No |
Transactions
The following services are included in this functional area:
Consignment Sales Transaction Update
Business Overview
The service provides the ability to accept or provide Adjusted values of Consignment Rate and Consignment unit cost for consignment items staged for Rate Review.
Input Payload Details
Table 5-932 Update - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
collectionSize |
Yes |
Number (4) |
Number of items in the collection. The maximum number of the items allowed in a collection is 9999. |
consignmentSales |
Yes |
Collection of Object |
References a collection of Store, Day, Store Day sequence number, Tran sequence number, Item sequence number. |
Table 5-933 ConsignmentSales - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
store |
Yes |
Number (10) |
The store number to which this transaction belongs. |
day |
Yes |
Number (3) |
Day number on the transaction. |
storeDaySeqNo |
Yes |
Number (20) |
This unique identifier for a store/day combination. |
tranSeqNo |
Yes |
Number (20) |
The sales audit system’s transaction identifier. |
itemSeqNo |
Yes |
Number (4) |
Sequence number of item within a transaction. |
itemStatus |
No |
String (6) |
The status of the item. Valid values are 'S'ALE, 'R'ETURN, 'ORD', 'LCO' |
itemType |
No |
String (6) |
The type of the item. Valid values are ITEM, NMITEM and REF. |
item |
No |
String (25) |
Unique identifier for the item. |
refItem |
No |
String (25) |
Contains a reference item to the item field. |
nonMerchItem |
No |
String (25) |
Contains a non-merchandise item. |
reviewedWithNoUpdates |
Yes |
String (1) |
The review indicator allows for accepting the existing rate/cost detail without any updates when set to Y. Valid values are Y and N. |
adjustedConsignmentRate |
No |
Number (12,4) |
This column holds the preferred adjusted consignment rate. |
adjustedConsignmentUnitCost |
No |
Number (20,4) |
This column holds the preferred adjusted consignment unit cost. |
Table 5-934 UpdateError - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
consignmentSalesError |
Yes |
Collection of Object |
Table 5-935 ConsignmentSalesError - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
store |
Yes |
Number (10) |
The store number to which this transaction belongs. |
day |
Yes |
Number (3) |
Day number on the transaction. |
storeDaySeqNo |
Yes |
Number (20) |
This unique identifier for a store/day combination. |
tranSeqNo |
Yes |
Number (20) |
The sales audit system’s transaction identifier. |
itemSeqNo |
Yes |
Number (4) |
Sequence number of item within a transaction. |
errorMessages |
Yes |
Array of String |
List of errors. |
Sample Input Message
{
"collectionSize": 1000,
"consignmentSales": [
{
"store": 1521,
"day": 15,
"storeDaySeqNo": 29000201,
"tranSeqNo": 102308,
"itemSeqNo": 1000,
"itemStatus": "S",
"itemType": "ITEM",
"item": "102350079",
"refItem": "1234560000081",
"nonMerchItem": "445101",
"reviewedWithNoUpdates": "N",
"adjustedConsignmentRate": 60,
"adjustedConsignmentUnitCost": 20.2131
}
]
}
Response Code: 400 (Error)
In case of error, the following standard error response will be returned. The element validationErrors
is present when input the payload or input parameters are not as per the schema definition of this service. The element businessError
will be present if the payload passes schema validation but an exception is caught while processing
business logic.
Table 5-936 UpdateError - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
consignmentSalesError |
Yes |
Collection of Object |
Table 5-937 ConsignmentSalesError - Object. See list of elements for detail
Element Name | Required | Data Type | Description |
---|---|---|---|
store |
Yes |
Number (10) |
The store number to which this transaction belongs. |
day |
Yes |
Number (3) |
Day number on the transaction. |
storeDaySeqNo |
Yes |
Number (20) |
This unique identifier for a store/day combination. |
tranSeqNo |
Yes |
Number (20) |
The sales audit system’s transaction identifier. |
itemSeqNo |
Yes |
Number (4) |
Sequence number of item within a transaction. |
errorMessages |
Yes |
Array of String |
List of errors. |
Sample Error Message
{
"status": "ERROR",
"message": "Error found in validation of input payload",
"validationErrors": [
{
"error": "must be one of Y, N",
"field": "createRecord.arg0.approveInd",
"inputValue": "X"
}
],
"businessError": [
{
"consignmentSalesError": [
{
"store": 109770,
"day": 100,
"storeDaySeqNo": 293567,
"tranSeqNo": 102308,
"itemSeqNo": 1000,
"errorMessages": [
"String"
]
}
]
}
]
}
Transaction Download Service
The following services are included in this functional area:
Get Rejected Transactions Since Previous Query
Business Overview
The purpose of this service is to return transactions that were rejected during processing to the calling process or application, for use in troubleshooting and error resolution.
Sales Service
This services fetches and returns transactions from the staging table SVC_RTLOG_DATA_REJECT
that meet
the input criteria. Transactions failing validations in the sacreatertlog.ksh
process are inserted into this
staging table during processing.
Input Parameters
Table 5-938 SvcprovRejectedRecRDO
Parameter Name | Data Type |
---|---|
pageSize |
Number |
pageNumber |
Number |
readUnreadErrorInd |
String |
startDate |
String (Format : |
endDate |
String (Format : |
svcprovRejStoreRDOs |
List<SvcprovRejStoreRecRDO> |
svcprovRejErrorcodeRDOs |
List<SvcprovRejErrorcodeRecRDO> |
svcprovRejTransactionidRDOs |
List<SvcprovRejTransactionidRecRDO> |
Table 5-939 SvcprovRejStoreRecRDO
Parameter Name | Data Type |
---|---|
store |
String |
Table 5-940 SvcprovRejErrorcodeRecRDO
Parameter Name | Data Type |
---|---|
errorCode |
String |
Table 5-941 SvcprovRejTransactionidRecRDO
Parameter Name | Data Type |
---|---|
transactionId |
String |
JSON Input Structure:
[
{
"pageSize": null,
"pageNumber": null,
"readUnreadErrorInd": null,
"startDate": null,
"endDate": null,
"svcprovRejStoreRDOs": [
{
"store": null
}
],
"svcprovRejErrorcodeRDOs": [
{
"errorCode": null
}
],
"svcprovRejTransactionidRDOs": [
{
"transactionId": null
}
]
}
]
Output
totalRecordCount | Number |
---|---|
Parameter Name |
Data Type |
results |
Table of SVCPROV_REJ_THEAD_REC |
Table 5-942 SVCPROV_REJ_THEAD_REC
Parameter Name | Data Type |
---|---|
Store |
Number |
businessDate |
Date |
errorCode |
String |
errorDesc |
String |
recType |
String |
register |
String |
transactionDate |
Date |
transactionNo |
Number |
cashier |
String |
salesperson |
String |
transactionType |
String |
subTransactionType |
String |
origSalesNo |
Number |
origRegNo |
String |
reasonCode |
String |
vendorNo |
String |
vendorInvcNo |
String |
paymentRefNo |
String |
prfDlvyNo |
String |
refNo1 |
String |
refNo2 |
String |
refNo3 |
String |
refNo4 |
String |
value |
BigDecimal |
bannerId |
String |
roundedAmt |
BigDecimal |
roundedOffAmt |
BigDecimal |
creditPromoId |
String |
refNo25 |
String |
refNo26 |
String |
refNo27 |
String |
tranProcessSys |
String |
refNo28 |
String |
refNo29 |
String |
refNo30 |
String |
refNo31 |
String |
salesThattTbl |
List<SvcprovSalesAttrRecRDO> |
salesTcustTbl |
List< SvcprovSalesTcustRecRDO> |
salesCattTbl |
List< SvcprovSalesAttrRecRDO> |
salesTitemTbl |
List< SvcprovSalesTitemRecRDO> |
salesTtaxTbl |
List< SvcprovSalesTtaxRecRDO> |
salesTpymtTbl |
List< SvcprovSalesTpymtRecRDO> |
salesTtendTbl |
List<SvcprovSalesTtendRecRDO> |
salesTtailTbl |
List<SvcprovSalesCounterRecRDO> |
Table 5-943 SvcprovSalesAttrRecRDO
Parameter Name | Data Type |
---|---|
recType |
String |
attributeType |
String |
attributeValue |
String |
Table 5-944 SvcprovSalesTcustRecRDO
Parameter Name | Data Type |
---|---|
recType |
String |
customerId |
String |
customerType |
String |
customerName |
String |
address1 |
String |
address2 |
String |
city |
String |
state |
String |
zipCode |
String |
country |
String |
homePhone |
String |
workPhone |
String |
|
String |
birthdate |
Date |
Table 5-945 SvcprovSalesTitemRecRDO
Parameter Name | Data Type |
---|---|
recType |
String |
itemStatus |
String |
itemType |
String |
itemNoType |
String |
formatId |
String |
item |
String |
refItem |
String |
nonMerchItem |
String |
voucherNo |
String |
quantity |
String |
sellingUom |
String |
unitRetail |
BigDecimal |
overrideReason |
String |
originalUnitRetail |
BigDecimal |
taxableIndicator |
String |
pump |
String |
refNo5 |
String |
refNo6 |
String |
refNo7 |
String |
refNo8 |
String |
itemSwipedInd |
String |
returnReasonCode |
String |
salesperson |
String |
expirationDate |
Date |
dropShipInd |
String |
uomQty |
BigDecimal |
catchWeightInd |
String |
sellingItem |
String |
custOrdLineNo |
Number |
mediaId |
Number |
totalIgtaxAmount |
BigDecimal |
uniqueId |
String |
custOrdNo |
String |
custOrdDate |
Date |
fulfillmentOrdNo |
String |
noInventoryReturn |
String |
salesType |
String |
returnWh |
Number |
returnDeposition |
String |
originalStore |
Number |
originalTransactionNo |
Number |
fulfillmentLocType |
String |
fulfillmentLoc |
Number |
postingStore |
String |
salesItattTbl |
List<SvcprovSalesAttrRecRDO> |
salesIdiscTbl |
List<SvcprovSalesIdiscRecRDO> |
salesIgtaxTbl |
List<SvcprovSalesIgtaxRecRDO> |
Table 5-946 SvcprovSalesIdiscRecRDO
Parameter Name | Data Type |
---|---|
recType |
String |
merchPromoNo |
String |
discountRefNo |
String |
discountType |
String |
couponNo |
String |
couponRefNo |
String |
quantity |
BigDecimal |
unitDiscountAmount |
BigDecimal |
refNo13 |
String |
refNo14 |
String |
refNo15 |
String |
refNo16 |
String |
uomQty |
BigDecimal |
catchWeightInd |
String |
promoComponent |
Number |
salesTdattTbl |
List<SvcprovSalesAttrRecRDO> |
Table 5-947 SvcprovSalesIgtaxRecRDO
Parameter Name | Data Type |
---|---|
recType |
String |
taxAuthority |
String |
igtaxCode |
String |
igtaxRate |
BigDecimal |
igtaxAmount |
BigDecimal |
refNo21 |
String |
refNo22 |
String |
refNo23 |
String |
refNo24 |
String |
salesIxattTbl |
List<SvcprovSalesAttrRecRDO> |
Table 5-948 SvcprovSalesTtaxRecRDO
Parameter Name | Data Type |
---|---|
recType |
String |
taxCode |
String |
taxAmount |
BigDecimal |
refNo17 |
String |
refNo18 |
String |
refNo19 |
String |
refNo20 |
String |
transactionTaxAttributeTbl |
List<SvcprovSalesAttrRecRDO> |
Table 5-949 SvcprovSalesTpymtRecRDO
Parameter Name | Data Type |
---|---|
recType |
String |
paymentAmount |
BigDecimal |
Table 5-950 SvcprovSalesTtendRecRDO
Parameter Name | Data Type |
---|---|
recType |
String |
tendTypeGroup |
String |
tendTypeId |
Number |
tenderAmount |
BigDecimal |
ccNo |
String |
ccAuthNo |
String |
ccAuthSource |
String |
ccCardholderVerification |
String |
ccExpirationDate |
Date |
ccEntryMode |
String |
ccTerminalId |
String |
ccSpecialCondition |
String |
ccToken |
String |
voucherNo |
String |
couponNbr |
String |
couponRefNo |
String |
chequeAccNo |
String |
chequeNo |
Number |
identificationMethod |
String |
identificationId |
String |
originalCurrency |
String |
originalCurrencyAmount |
BigDecimal |
refNbr9 |
String |
refNbr10 |
String |
refNbr11 |
String |
refNbr12 |
String |
transactionTenderAttributeTbl |
List<SvcprovSalesAttrRecRDO> |
Table 5-951 SvcprovSalesCounterRecRDO
Parameter Name | Data Type |
---|---|
recType |
String |
recCounter |
Number |
The output will contain the status of the request including validation errors, if any.
JSON Structure:
{
"totalRecordCount": null,
"results": [
{
"store": null,
"businessDateDisplay": null,
"businessDate": null,
"errorCode": null,
"errorDesc": null,
"recType": "THEAD",
"register": null,
"transactionDateDisplay": null,
"transactionDate": null,
"transactionNo": null,
"cashier": null,
"salesperson": null,
"transactionType": null,
"subTransactionType": null,
"origSalesNo": null,
"origRegNo": null,
"reasonCode": null,
"vendorNo": null,
"vendorInvcNo": null,
"paymentRefNo": null,
"prfDlvyNo": null,
"refNo1": null,
"refNo2": null,
"refNo3": null,
"refNo4": null,
"value": null,
"bannerId": null,
"roundedAmt": null,
"roundedOffAmt": null,
"creditPromoId": null,
"refNo25": null,
"refNo26": null,
"refNo27": null,
"tranProcessSys": null,
"refNo28": null,
"refNo29": null,
"refNo30": null,
"refNo31": null,
"salesThattTbl": [
{
"recType": "THATT",
"attributeType": null,
"attributeValue": null
}
],
"salesTcustTbl": [
{
"recType": "TCUST",
"customerId": null,
"customerType": null,
"customerName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"zipCode": null,
"country": null,
"homePhone": null,
"workPhone": null,
"email": null,
"birthdateDisplay": null,
"birthdate": null
},
{
"recType": "TCUST",
"customerId": null,
"customerType": null,
"customerName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"zipCode": null,
"country": null,
"homePhone": null,
"workPhone": null,
"email": null,
"birthdateDisplay": null,
"birthdate": null
}
],
"salesCattTbl": [
{
"recType": "CATT",
"attributeType": null,
"attributeValue": null
}
],
"salesTitemTbl": [
{
"recType": "TITEM",
"itemStatus": null,
"itemType": null,
"itemNoType": null,
"formatId": null,
"item": null,
"refItem": null,
"nonMerchItem": null,
"voucherNo": null,
"quantity": null,
"sellingUom": null,
"unitRetail": null,
"overrideReason": null,
"originalUnitRetail": null,
"taxableIndicator": "Y",
"pump": null,
"refNo5": null,
"refNo6": null,
"refNo7": null,
"refNo8": null,
"itemSwipedInd": null,
"returnReasonCode": null,
"salesperson": null,
"expirationDate": null,
"dropShipInd": null,
"uomQty": null,
"catchWeightInd": null,
"sellingItem": null,
"custOrdLineNo": null,
"mediaId": null,
"totalIgtaxAmount": null,
"uniqueId": null,
"custOrdNo": null,
"custOrdDateDisplay": null,
"custOrdDate": null,
"fulfillmentOrdNo": null,
"noInventoryReturn": null,
"salesType": null,
"returnWh": null,
"returnDeposition": null,
"originalStore": null,
"originalTransactionNo": null,
"fulfillmentLocType": null,
"fulfillmentLoc": null,
"postingStore": null,
"salesItattTbl": [
{
"recType": "ITATT",
"attributeType": null,
"attributeValue": null
},
{
"recType": "ITATT",
"attributeType": null,
"attributeValue": null
}
],
"salesIdiscTbl": [
{
"recType": "IDISC",
"merchPromoNo": null,
"discountRefNo": null,
"discountType": null,
"couponNo": null,
"couponRefNo": null,
"quantity": null,
"unitDiscountAmount": null,
"refNo13": null,
"refNo14": null,
"refNo15": null,
"refNo16": null,
"uomQty": null,
"catchWeightInd": null,
"promoComponent": null,
"salesTdattTbl":
}
],
"salesIgtaxTbl": [
{
"recType": "IGTAX",
"taxAuthority": null,
"igtaxCode": null,
"igtaxRate": null,
"igtaxAmount": null,
"refNo21": null,
"refNo22": null,
"refNo23": null,
"refNo24": null,
"salesIxattTbl": [
{
"recType": "IXATT",
"attributeType": null,
"attributeValue": null
}
]
}
}
],
"salesTtaxTbl": [
{
"recType": "TTAX",
"taxCode": null,
"taxAmount": null,
"refNo17": null,
"refNo18": null,
"refNo19": null,
"refNo20": null,
"salesTxattTbl": [
{
"recType": "TXATT",
"attributeType": null,
"attributeValue": null
}
],
"salesTpymtTbl": [
{
"recType": "TPYMT",
"paymentAmount": null
}
],
"salesTtendTbl": [
{
"recType": "TTEND",
"tendTypeGroup": null,
"tendTypeId": null,
"tenderAmount": null,
"ccNo": null,
"ccAuthNo": null,
"ccAuthSource": null,
"ccCardholderVerification": null,
"ccExpirationDateDisplay": null,
"ccExpirationDate": null,
"ccEntryMode": null,
"ccTerminalId": null,
"ccSpecialCondition": null,
"ccToken": null,
"voucherNo": null,
"couponNbr": null,
"couponRefNo": null,
"chequeAccNo": null,
"chequeNo": null,
"identificationMethod": null,
"identificationId": null,
"originalCurrency": null,
"originalCurrencyAmount": null,
"refNbr9": null,
"refNbr10": null,
"refNbr11": null,
"refNbr12": null,
"salesTtattTbl": [
{
"recType": "TTATT",
"attributeType": null,
"attributeValue": null
}
]
}
],
"salesTtailTbl": []
}
]
}
Transaction Upload Service
The following services are included in this functional area:
Load Transactions
Business Overview
This service accepts transactions from a Point of Sale (POS) or Order Management Solution (OMS) into Sales Audit. This service provides an alternative to transactions processed from an RTLOG file through the Sales Audit sales process documented under the Scheduled Integration section.
This service accepts transactions from a POS or OMS system in a JSON format and loads them into the staging table SVC_RTLOG_DATA_LOAD
for further processing. This service performs minimal data validation as the majority of the
sales data validation remains in the Sales Audit import process. The transactions staged through this service are extracted
into the RTLOG format by the sacreatertlog.ksh
process and processed by the saimptlog
process.
In addition, this service supports a near-real-time update of inventory impacted by sales transactions by recording sales
units in the SA_INPROGRESS_SALES
table. The units record in this table for an item/location can be netted
out of stock-on-hand for a more accurate, real-time view of available inventory. When these sales are processed completely
through auditing, the in-progress units will be negated.
Input Parameters
Table 5-952 SvcprovSalesServiceRecRDO
Parameter Name | Data Type | |
---|---|---|
recType |
String |
|
fileCreateDate |
String (Format : |
|
businessDate |
String(Format: |
|
store |
Number |
|
referenceNbr |
String |
|
rtlogOrgSys |
String |
|
transactionHeadTbl |
List<SvcprovSalesTheadRecRDO> |
|
salesFtailTbl |
List<SvcprovSalesCounterRecRDO> |
Table 5-953 SvcprovSalesTheadRecRDO
Parameter Name | Data Type | |
---|---|---|
recType |
String |
|
register |
String |
|
transactionDate |
String (Format : |
|
transactionNo |
Number |
|
cashier |
String |
|
salesperson |
String |
|
transactionType |
String |
|
subTransactionType |
String |
|
origSalesNo |
Number |
|
origRegNo |
String |
|
reasonCode |
String |
|
vendorNo |
String |
|
vendorInvcNo |
String |
|
paymentRefNo |
String |
|
prfDlvyNo |
String |
|
refNo1 |
String |
|
refNo2 |
String |
|
refNo3 |
String |
|
refNo4 |
String |
|
value |
BigDecimal |
|
bannerId |
String |
|
roundedAmt |
BigDecimal |
|
roundedOffAmt |
BigDecimal |
|
creditPromoId |
String |
|
refNo25 |
String |
|
refNo26 |
String |
|
refNo27 |
String |
|
tranProcessSys |
String |
|
refNo28 |
String |
|
refNo29 |
String |
|
refNo30 |
String |
|
refNo31 |
String |
|
transactionHeadAttributeTbl List<SvcprovSalesAttrRecRDO> |
||
transactionCustomerTbl |
List< SvcprovSalesTcustRecRDO> |
|
customerAttributeTbl |
List< SvcprovSalesAttrRecRDO> |
|
transactionItemTbl |
List< SvcprovSalesTitemRecRDO> |
|
transactionTaxTbl |
List< SvcprovSalesTtaxRecRDO> |
|
transactionPaymentTbl |
List< SvcprovSalesTpymtRecRDO> |
|
transactionTenderTbl |
List<SvcprovSalesTtendRecRDO> |
|
transactionTrailerTbl |
List<SvcprovSalesCounterRecRDO> |
Table 5-954 SvcprovSalesAttrRecRDO
Parameter Name | Data Type | |
---|---|---|
recType |
String |
|
attributeType |
String |
|
attributeValue |
String |
Table 5-955 SvcprovSalesTcustRecRDO
Parameter Name | Data Type | |
---|---|---|
recType |
String |
|
customerId |
String |
|
customerType |
String |
|
customerName |
String |
|
address1 |
String |
|
address2 |
String |
|
city |
String |
|
state |
String |
|
zipCode |
String |
|
country |
String |
|
homePhone |
String |
|
workPhone |
String |
|
|
String |
|
birthdate |
String (Format: |
Table 5-956 SvcprovSalesTitemRecRDO
Parameter Name | Data Type |
---|---|
recType |
String |
itemStatus |
String |
itemType |
String |
itemNoType |
String |
formatId |
String |
item |
String |
refItem |
String |
nonMerchItem |
String |
voucherNo |
String |
quantity |
String |
sellingUom |
String |
unitRetail |
BigDecimal |
overrideReason |
String |
originalUnitRetail |
BigDecimal |
taxableIndicator |
String |
pump |
String |
refNo5 |
String |
refNo6 |
String |
refNo7 |
String |
refNo8 |
String |
itemSwipedInd |
String |
returnReasonCode |
String |
salesperson |
String |
expirationDate |
String(Format: |
dropShipInd |
String |
uomQty |
BigDecimal |
catchWeightInd |
String |
sellingItem |
String |
custOrdLineNo |
Number |
mediaId |
Number |
totalIgtaxAmount |
BigDecimal |
uniqueId |
String |
custOrdNo |
String |
custOrdDate |
String(Format: |
fulfillmentOrdNo |
String |
noInventoryReturn |
String |
salesType |
String |
returnWh |
Number |
returnDeposition |
String |
originalStore |
Number |
originalTransactionNo |
Number |
fulfillmentLocType |
String |
fulfillmentLoc |
Number |
postingStore |
String |
transactionItemAttributeTbl |
List<SvcprovSalesAttrRecRDO> |
transactionItemDiscountTbl |
List<SvcprovSalesIdiscRecRDO> |
transactionItemTaxTbl |
List<SvcprovSalesIgtaxRecRDO> |
consignmentRate |
BigDecimal |
consignmentUnitCost |
BigDecimal |
Table 5-957 SvcprovSalesIdiscRecRDO
Parameter Name | Data Type | |
---|---|---|
recType |
String |
|
merchPromoNo |
String |
|
discountRefNo |
String |
|
discountType |
String |
|
couponNo |
String |
|
couponRefNo |
String |
|
quantity |
BigDecimal |
|
unitDiscountAmount |
BigDecimal |
|
refNo13 |
String |
|
refNo14 |
String |
|
refNo15 |
String |
|
refNo16 |
String |
|
uomQty |
BigDecimal |
|
catchWeightInd |
String |
|
promoComponent |
Number |
|
transactionItemDiscountAtrributeTbl |
List<SvcprovSalesAttrRecRDO> |
Table 5-958 SvcprovSalesIgtaxRecRDO
Parameter Name | Data Type | |
---|---|---|
recType |
String |
|
taxAuthority |
String |
|
igtaxCode |
String |
|
igtaxRate |
BigDecimal |
|
igtaxAmount |
BigDecimal |
|
refNo21 |
String |
|
refNo22 |
String |
|
refNo23 |
String |
|
refNo24 |
String |
|
transactionItemTaxAttributeTbl |
List<SvcprovSalesAttrRecRDO> |
Table 5-959 SvcprovSalesTtaxRecRDO
Parameter Name | Data Type | |
---|---|---|
recType |
String |
|
taxCode |
String |
|
taxAmount |
BigDecimal |
|
refNo17 |
String |
|
refNo18 |
String |
|
refNo19 |
String |
|
refNo20 |
String |
|
transactionTaxAttributeTbl |
List<SvcprovSalesAttrRecRDO> |
Table 5-960 SvcprovSalesTpymtRecRDO
Parameter Name | Data Type | |
---|---|---|
recType |
String |
|
paymentAmount |
BigDecimal |
Table 5-961 SvcprovSalesTtendRecRDO
Parameter Name | Data Type | |
---|---|---|
recType |
String |
|
tendTypeGroup |
String |
|
tendTypeId |
Number |
|
tenderAmount |
BigDecimal |
|
ccNo |
String |
|
ccAuthNo |
String |
|
ccAuthSource |
String |
|
ccCardholderVerification |
String |
|
ccExpirationDate |
String(Format: |
|
ccEntryMode |
String |
|
ccTerminalId |
String |
|
ccSpecialCondition |
String |
|
ccToken |
String |
|
voucherNo |
String |
|
couponNbr |
String |
|
couponRefNo |
String |
|
chequeAccNo |
String |
|
chequeNo |
Number |
|
identificationMethod |
String |
|
identificationId |
String |
|
originalCurrency |
String |
|
originalCurrencyAmount |
BigDecimal |
|
refNbr9 |
String |
|
refNbr10 |
String |
|
refNbr11 |
String |
|
refNbr12 |
String |
|
transactionTenderAttributeTbl |
List<SvcprovSalesAttrRecRDO> |
Table 5-962 SvcprovSalesCounterRecRDO
Parameter Name | Data Type |
---|---|
recType |
String |
recCounter |
Number |
JSON Structure:
[
{
"recType": null,
"fileCreateDate": null,
"businessDate": null,
"store": null,
"referenceNbr": null,
"rtlogOrgSys": null,
"transactionHeadTbl": [
{
"recType": null,
"register": null,
"transactionDate": null,
"transactionNo": null,
"cashier": null,
"salesperson": null,
"transactionType": null,
"subTransactionType": null,
"origSalesNo": null,
"origRegNo": null,
"reasonCode": null,
"vendorNo": null,
"vendorInvcNo": null,
"paymentRefNo": null,
"prfDlvyNo": null,
"refNo1": null,
"refNo2": null,
"refNo3": null,
"refNo4": null,
"value": null,
"bannerId": null,
"roundedAmt": null,
"roundedOffAmt": null,
"creditPromoId": null,
"refNo25": null,
"refNo26": null,
"refNo27": null,
"tranProcessSys": null,
"refNo28": null,
"refNo29": null,
"refNo3null": null,
"refNo31": null,
"transactionHeadAttributeTbl": [
{
"recType": null,
"attributeType": null,
"attributeValue": null
}
],
"transactionCustomerTbl": [
{
"recType": null,
"customerId": null,
"customerType": null,
"customerName": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"zipCode": null,
"country": null,
"homePhone": null,
"workPhone": null,
"email": null,
"birthdate": null
}
],
"customerAttributeTbl": [
{
"recType": null,
"attributeType": null,
"attributeValue": null
}
],
"transactionItemTbl": [
{
"recType": null,
"itemStatus": null,
"itemType": null,
"itemNoType": null,
"formatId": null,
"item": null,
"refItem": null,
"nonMerchItem": null,
"voucherNo": null,
"quantity": null,
"sellingUom": null,
"unitRetail": null,
"overrideReason": null,
"originalUnitRetail": null,
"taxableIndicator": null,
"pump": null,
"refNo5": null,
"refNo6": null,
"refNo7": null,
"refNo8": null,
"itemSwipedInd": null,
"returnReasonCode": null,
"salesperson": null,
"expirationDate": null,
"dropShipInd": null,
"uomQty": null,
"catchWeightInd": null,
"sellingItem": null,
"custOrdLineNo": null,
"mediaId": null,
"totalIgtaxAmount": null,
"uniqueId": null,
"custOrdNo": null,
"custOrdDate": null,
"fulfillmentOrdNo": null,
"noInventoryReturn": null,
"salesType": null,
"returnWh": null,
"returnDeposition": null,
"originalStore": null,
"originalTransactionNo": null,
"fulfillmentLocType": null,
"fulfillmentLoc": null,
"postingStore": null,
"transactionItemAttributeTbl": [
{
"recType": null,
"attributeType": null,
"attributeValue": null
}
],
"transactionItemDiscountTbl": [
{
"recType": null,
"merchPromoNo": null,
"discountRefNo": null,
"discountType": null,
"couponNo": null,
"couponRefNo": null,
"quantity": null,
"unitDiscountAmount": null,
"refNo13": null,
"refNo14": null,
"refNo15": null,
"refNo16": null,
"uomQty": null,
"catchWeightInd": null,
"promoComponent": null,
"transactionItemDiscountAtrributeTbl": [
{
"recType": null,
"attributeType": null,
"attributeValue": null
}
]
}
],
"transactionItemTaxTbl": [
{
"recType": null,
"taxAuthority": null,
"igtaxCode": null,
"igtaxRate": null,
"igtaxAmount": null,
"refNo21": null,
"refNo22": null,
"refNo23": null,
"refNo24": null,
"transactionItemTaxAttributeTbl": [
{
"recType": null,
"attributeType": null,
"attributeValue": null
}
]
}
],
"consignmentRate": null,
"consignmentUnitCost": null
}
],
"transactionTaxTbl": [
{
"recType": null,
"taxCode": null,
"taxAmount": null,
"refNo17": null,
"refNo18": null,
"refNo19": null,
"refNo2null": null,
"transactionTaxAttributeTbl": [
{
"recType": null,
"attributeType": null,
"attributeValue": null
}
]
}
],
"transactionPaymentTbl": [
{
"recType": null,
"paymentAmount": null
}
],
"transactionTenderTbl": [
{
"recType": null,
"tendTypeGroup": null,
"tendTypeId": null,
"tenderAmount": null,
"ccNo": null,
"ccAuthNo": null,
"ccAuthSource": null,
"ccCardholderVerification": null,
"ccExpirationDate": null,
"ccEntryMode": null,
"ccTerminalId": null,
"ccSpecialCondition": null,
"ccToken": null,
"voucherNo": null,
"couponNbr": null,
"couponRefNo": null,
"chequeAccNo": null,
"chequeNo": null,
"identificationMethod": null,
"identificationId": null,
"originalCurrency": null,
"originalCurrencyAmount": null,
"refNbr9": null,
"refNbr1null": null,
"refNbr11": null,
"refNbr12": null,
"transactionTenderAttributeTbl": [
{
"recType": null,
"attributeType": null,
"attributeValue": null
}
]
}
],
"transactionTrailerTbl": [
{
"recType": null,
"recCounter": null
}
]
}
],
"salesFtailTbl": [
{
"recType": null,
"recCounter": null
}
]
}
]
Output
Table 5-963 SVCPROV_SALES_STATUS_REC
Parameter Name | Data Type |
---|---|
statusMsg |
String |
salesErrTbl |
List< SVCPROV_SALES_FAIL_REC > |
Table 5-964 SVCPROV_SALES_FAIL_REC
Parameter Name | Data Type |
---|---|
store |
BigDecimal |
transactionNo |
BigDecimal |
recType |
String |
businessDate |
Date |
errorMsg |
String |
The output will contain the status of the request including validation errors, if any.
JSON Structure:
{
"statusMsg": null,
"salesErrTbl": [
{
"store": null,
"transactionNo": null,
"recType": null,
"businessDateDisplay": null,
"businessDate": null,
"errorMsg": null,
"links": [],
"hyperMediaContent": {
"linkRDO": []
}
}
],
"links": [],
"hyperMediaContent": {
"linkRDO": []
}
}