Sales Audit Services

The following services are included in this functional area:

Data Privacy
- Sales Audit Data Privacy Download Service
  - Get Personally Identifiable Information
- Sales Audit Data Privacy Upload Service
  - Delete Personally Identifiable Information
Store Day Summary
- Mobile Workflow Store Day Download Service
Transactions

Data Privacy

The following services are included in this functional area:

Sales Audit Data Privacy Download Service
- Get Personally Identifiable Information
Sales Audit Data Privacy Upload Service
- Delete Personally Identifiable Information

Sales Audit Data Privacy Download Service

The following services are included in this functional area:

Get Personally Identifiable Information

Get Personally Identifiable Information

The Get Personally Identifiable Information service is the same service used in the Merchandising solution. For Sales Audit, this service can be used to obtain personally identifiable information for the Customer and Employee entities For more details on this service, see the Data Privacy Download Service under Merchandising Services > Administration > Data Privacy.

Sales Audit Data Privacy Upload Service

The following services are included in this functional area:

Delete Personally Identifiable Information

Delete Personally Identifiable Information

The Delete Personally Identifiable Information service is the same service used in the Merchandising solution. For Sales Audit, this service can be used to delete personally identifiable information for the Customer and Employee entities. For more details on this service, see the Data Privacy Upload Service under Merchandising Services > Administration > Data Privacy.

Store Day Summary

The following services are included in this functional area:

Mobile Workflow Store Day Download Service

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.

Service Type

Get

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	`ALL`, `OLDER`
stores	No	Comma-separated values for stores	NA
sortAttrib	No	Sort Attribute	`STORENAME`, `AUDITOR`, `OSVALUE`, `ERRORCNT`, `DATASTATUS`, `OPENDAYS`, `OSDAYS` and `OSSUMS`
sortDirection	No	Sort Direction	`ASC`, `DESC`
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
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
V_CHAIN	Yes	No	No	No
V_STORE	Yes	No	No	No

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.

Service Type

Get

ReST URL

/summaryOpenStoreDay

Input Parameters

No input.

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

Open Store Count

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
LOC_TRAITS_MATRIX	Yes	No	No	No
SA_STORE_DAY	Yes	No	No	No
SA_USER_LOC_TRAITS	Yes	No	No	No

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.

Service Type

Get

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	`ALL`, `OLDER`, `DATE`
recordDate	No	Record Date, required when recordType is DATE	NA
store	No	Store ID	NA
sortAttrib	No	Sort Attribute	`STORENAME`, `AUDITOR`, `OSVALUE`, `ERRORCNT`, `DATASTATUS`, `OPENDAYS`, `OSDAYS`, and `OSSUMS`
sortDirection	No	Sort Direction	`ASC`, `DESC`
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.

Service Type

Get

ReST URL

/summaryError

Input Parameters

No input.

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

Error Count

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
LOC_TRAITS_MATRIX	Yes	No	No	No
SA_ERROR	Yes	No	No	No
SA_STORE_DAY	Yes	No	No	No
SA_USER_LOC_TRAITS	Yes	No	No	No

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.

Service Type

Get

ReST URL

/summaryOverShortAmount

Input Parameters

No input.

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

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
LOC_TRAITS_MATRIX	Yes	No	No	No
MV_CURRENCY_CONVERSION_RATES	Yes	No	No	No
SA_HQ_VALUE	Yes	No	No	No
SA_POS_VALUE	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_USER_LOC_TRAITS	Yes	No	No	No
STORE	Yes	No	No	No

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.

Service Type

Get

ReST URL

/summaryOverShortCount

Input Parameters

No input.

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

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
LOC_TRAITS_MATRIX	Yes	No	No	No
SA_HQ_VALUE	Yes	No	No	No
SA_POS_VALUE	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_USER_LOC_TRAITS	Yes	No	No	No
STORE	Yes	No	No	No

Get Open Store Days

Business Overview

This web service allows the user to find which store days have records that needs attention.

Service Type

Get

ReST URL

/getStoreDateInd?store={store}

Input Parameters

Parameter Name	Required	Description	Valid values
store	Yes	Store ID	NA

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

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
SA_STORE_DAY	Yes	No	No	No
V_STORE	Yes	No	No	No

Get Store Errors

Business Overview

Retrieves summary of store day errors.

Service Type

Get

ReST URL

/getStoreErrors?store={store}&recordType={recordType}&recordDate={recordDate}

Input Parameters

Parameter Name	Required	Description	Valid values
recordType	Yes	Record Type	`ALL`, `OLDER`, `DATE`
recordDate	No	Record Date, required when `recordType` is `DATE`	NA
store	No	Store ID	NA

Output

Store

Error Code

Error Description

Error Percentage

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
SA_ERROR	Yes	No	No	No
SA_STORE_DAY	Yes	No	No	No
V_SA_ERROR	Yes	No	No	No
V_STORE	Yes	No	No	No

Get Stores with Open Days

Business Overview

This web service enables store search and returns aggregated store information.

Service Type

Get

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	`ALL`, `ASSIGN`
sortAttrib	No	Sort Attribute	`STORENAME`, `AUDITOR`, `OSVALUE`, `ERRORCNT`, `DATASTATUS`, `OPENDAYS`, `OSDAYS`, and `OSSUMS`
sortDirection	No	Sort Direction	`ASC`, `DESC`
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

Functional Area

Financial

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.

Service Type

POST

ReST URL

Resa/consignmentSalesTransactionUpdate

Input Payload Details

Table 5-976 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-977 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-978 UpdateError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
consignmentSalesError	Yes	Collection of Object

Table 5-979 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: 200 (Success)

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-980 UpdateError - Object. See list of elements for detail

Element Name	Required	Data Type	Description
consignmentSalesError	Yes	Collection of Object

Table 5-981 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

Get Rejected Transactions Since Previous Query

Functional Area

Financial

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.

Service Type

Put

ReST URL

Resa/getRejectedTransactions

Input Parameters

Table 5-982 SvcprovRejectedRecRDO

Parameter Name	Data Type
pageSize	Number
pageNumber	Number
readUnreadErrorInd	String
startDate	String (Format :`YYYYMMDD`)
endDate	String (Format :`YYYYMMDD`)
svcprovRejStoreRDOs	List<SvcprovRejStoreRecRDO>
svcprovRejErrorcodeRDOs	List<SvcprovRejErrorcodeRecRDO>
svcprovRejTransactionidRDOs	List<SvcprovRejTransactionidRecRDO>

Table 5-983 SvcprovRejStoreRecRDO

Parameter Name	Data Type
store	String

Table 5-984 SvcprovRejErrorcodeRecRDO

Parameter Name	Data Type
errorCode	String

Table 5-985 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-986 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-987 SvcprovSalesAttrRecRDO

Parameter Name	Data Type
recType	String
attributeType	String
attributeValue	String

Table 5-988 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
email	String
birthdate	Date

Table 5-989 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-990 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-991 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-992 SvcprovSalesTtaxRecRDO

Parameter Name	Data Type
recType	String
taxCode	String
taxAmount	BigDecimal
refNo17	String
refNo18	String
refNo19	String
refNo20	String
transactionTaxAttributeTbl	List<SvcprovSalesAttrRecRDO>

Table 5-993 SvcprovSalesTpymtRecRDO

Parameter Name	Data Type
recType	String
paymentAmount	BigDecimal

Table 5-994 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-995 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": []
    }
  ]
}

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
SVC_RTLOG_DATA_REJECT	Yes	No	Yes	No

Transaction Upload Service

The following services are included in this functional area:

Load Transactions

Load Transactions

Functional Area

Financial

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.

Service Type

Post

ReST URL

Resa/salesService

Input Parameters

Table 5-996 SvcprovSalesServiceRecRDO

Parameter Name	Data Type
recType	String
fileCreateDate	String (Format :`YYYYMMDDHHMMSS`)
businessDate	String(Format: `YYYYMMDD`)
store	Number
referenceNbr	String
rtlogOrgSys	String
transactionHeadTbl	List<SvcprovSalesTheadRecRDO>
salesFtailTbl	List<SvcprovSalesCounterRecRDO>

Table 5-997 SvcprovSalesTheadRecRDO

Parameter Name	Data Type
recType	String
register	String
transactionDate	String (Format :`YYYYMMDDHHMMSS`)
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-998 SvcprovSalesAttrRecRDO

Parameter Name	Data Type
recType	String
attributeType	String
attributeValue	String

Table 5-999 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
email	String
birthdate	String (Format: `YYYYMMDD`)

Table 5-1000 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: `YYYYMMDD`)
dropShipInd	String
uomQty	BigDecimal
catchWeightInd	String
sellingItem	String
custOrdLineNo	Number
mediaId	Number
totalIgtaxAmount	BigDecimal
uniqueId	String
custOrdNo	String
custOrdDate	String(Format: `YYYYMMDDHHMMSS`)
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
inventoryIdentifierType	String
inventoryId	String

Table 5-1001 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-1002 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-1003 SvcprovSalesTtaxRecRDO

Parameter Name	Data Type
recType	String
taxCode	String
taxAmount	BigDecimal
refNo17	String
refNo18	String
refNo19	String
refNo20	String
transactionTaxAttributeTbl	List<SvcprovSalesAttrRecRDO>

Table 5-1004 SvcprovSalesTpymtRecRDO

Parameter Name	Data Type
recType	String
paymentAmount	BigDecimal

Table 5-1005 SvcprovSalesTtendRecRDO

Parameter Name	Data Type
recType	String
tendTypeGroup	String
tendTypeId	Number
tenderAmount	BigDecimal
ccNo	String
ccAuthNo	String
ccAuthSource	String
ccCardholderVerification	String
ccExpirationDate	String(Format: `YYYYMMDD`)
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-1006 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,
                    "inventoryIdentifierType : null,
                    "inventoryId": 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-1007 SVCPROV_SALES_STATUS_REC

Parameter Name	Data Type
statusMsg	String
salesErrTbl	List< SVCPROV_SALES_FAIL_REC >

Table 5-1008 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": []
 	}
}

Table Impact

TABLE	SELECT	INSERT	UPDATE	DELETE
SVC_RTLOG_DATA_LOAD	No	Yes	No	No
ITEM_LOC_SOH	Yes	No	Yes	No
SA_INPROGRESS_SALES	Yes	Yes	Yes	No
SVC_INPROGRESS_SALES	No	Yes	No	No
SVC_PROCESS_TRACKER	No	Yes	No	No