Prism JSON Data Objects

COPYRIGHT © 2021 by Retail Pro International, LLC All Rights Reserved.

This document is proprietary and confidential to RETAIL PRO and is restricted to review by
designated individuals only for purposes authorized by RETAIL PRO.
You may not copy any part of this document. Your possession of this document is permitted only
if:
(1) you have been designated by RETAIL PRO as an authorized recipient; and
(2) you agree to these restrictions. Any other use or any disclosure to any other person
whatsoever is not permitted and is a violation of RETAIL PRO’s legal rights.

If you are in possession of an unauthorized copy of this document, you should immediately
destroy or return it to RETAIL PRO at the address specified below.

Retail Pro International, LLC

400 PLAZA DRIVE
SUITE 200
FOLSOM, CA 95630 USA.
Retail Pro - Prism JSON Data Objects

Document Revision History

Date Description

3/12/2021 Initial release

9/21/2021 Updated with Proprietary and Confidential notice

10/14/2021 Added Debugging Tips appendix

i
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Table of Contents
Document Revision History .................................................................................................................................................. i
Introduction ........................................................................................................................................................................ 1
Prism Data Objects described in this document ..................................................................................................................... 1
PDO Examples ......................................................................................................................................................................... 1
Versioning................................................................................................................................................................................ 1
Information Origin ................................................................................................................................................................... 1
Adjustment.......................................................................................................................................................................... 2
AdjComment list ...................................................................................................................................................................... 5
AdjItem list .............................................................................................................................................................................. 5
AdjQty list ................................................................................................................................................................................ 8
AdjSerial list ............................................................................................................................................................................. 9
AdjLot list ................................................................................................................................................................................. 9
AdjGiftCard list ...................................................................................................................................................................... 10
Insert new Adjustment Memo Price Payload Example. ........................................................................................................ 11
Customer ........................................................................................................................................................................... 12
Insert New Customer Payload Example. ............................................................................................................................... 16
CustAddress list ..................................................................................................................................................................... 17
CustEmail list ......................................................................................................................................................................... 18
CustPhone list ........................................................................................................................................................................ 19
Insert New Customer with Address, Email and Phone Payload example.............................................................................. 20
DCS .................................................................................................................................................................................... 21
Insert New DCS Payload Example. ......................................................................................................................................... 22
Document .......................................................................................................................................................................... 23
DocCoupon list ...................................................................................................................................................................... 39
DocDeposit list....................................................................................................................................................................... 40
DocDiscount list ..................................................................................................................................................................... 41
DocExtended list .................................................................................................................................................................... 42
[Link] ........................................................................................................................................................................... 42
DocItemDiscount list ............................................................................................................................................................. 52
DocTender list ....................................................................................................................................................................... 53
TenderCentralGiftCard list..................................................................................................................................................... 54
TenderCentralStoreCredit list................................................................................................................................................ 55
TenderCharge list .................................................................................................................................................................. 55
TenderCheck list .................................................................................................................................................................... 56
TenderCreditCard list ............................................................................................................................................................ 57
[Link] ............................................................................................................................................................. 60
[Link] ........................................................................................................................................................ 62
Insert New Document Payload Example. .............................................................................................................................. 62
Inventory ........................................................................................................................................................................... 67
Insert New Inventory Payload example: ............................................................................................................................... 70
InvnPrice list .......................................................................................................................................................................... 71
Insert New Inventory with Price Payload Example: .............................................................................................................. 71

ii
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects
InvnQuantity list .................................................................................................................................................................... 72
Purchase Order .................................................................................................................................................................. 74
POItem list ............................................................................................................................................................................. 78
POQuantity list ...................................................................................................................................................................... 80
POFee list ............................................................................................................................................................................... 80
POTerm list ............................................................................................................................................................................ 80
POApproval list ...................................................................................................................................................................... 80
Insert New Purchase Order Payload Example ....................................................................................................................... 82
Receiving (voucher) ........................................................................................................................................................... 84
RecvApproval list ................................................................................................................................................................... 89
RecvComment list.................................................................................................................................................................. 89
RecvTerm list ......................................................................................................................................................................... 90
RecvItem list .......................................................................................................................................................................... 90
RecvPackage list .................................................................................................................................................................... 92
Insert New Voucher Payload Example: ................................................................................................................................. 93
Vendor .............................................................................................................................................................................. 94
VendorAddress list ................................................................................................................................................................ 95
VendorContact list ................................................................................................................................................................. 96
Insert New Vendor Payload Example: ................................................................................................................................... 96
Appendix: Tips for Debugging Import Issues ...................................................................................................................... 97

iii
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Introduction

This document describes some of the Prism Data Objects (PDO) and their format used by Retail Pro Prism during
the replication process. It does not describe all of the PDO’s, it only describes the most commonly used PDO’s
for Import and Export with third party systems.

The PDO’s used with Prism replication, format the data in the JSON (JavaScript Object Notation) format.
Since the same PDO is used for the JSON data returned by the Prism REST API, this also describes the JSON data
returned by the REST API.

Prism Data Objects described in this document

The PDO’s described are:

• Adjustment
• Customer
• DCS
• Document
• Inventory
• Purchase Order
• Receiving (Voucher)
• Vendor

In addition, some PDO’s will have optional sub-PDO’s as a child PDO (or collection). These will be described in
the same section as their parent PDO.

PDO Examples
With each top level PDO description, a JSON example will be provided.

Versioning
This document describes the PDO’s starting with as they exist in Prism 1.14.7.

If a PDO is added or removed in a certain version, that will be documented in the description of the PDO.

As a PDO itself may change over time, any additions, changes, or deletions of the attributes of a PDO will be
documented in that attributes DESCRIPTION column.
If no version information is specified in the attribute description, then you should consider the attribute to have
existed as of the version of when the PDO was added to this document and continues to exist in the PDO as of
the latest revision of this document.

Information Origin
The information in this document was derived from the REST API Metadata.
If you need information on PDO’s not contained in the document, please use the Prism API Explorer available on
your Prism Server at: [Link] Server Name or IP Address>/api-explorer/#/services

1
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Adjustment
The Adjustment JSON contains information related to adjustment memos.
Added to this document: 1.14.7

Data
Attribute Size ID Required Description
Type
Sid INTEGER 19 YES YES Adjustment unique identifier.
SbsSid INTEGER 19 NO Reference to subsidiary.
StoreSid INTEGER 19 NO Reference to store.
AdjNo INTEGER 10 YES Adjustment memo number.
0-Qty
1-Price
AdjType INTEGER 1 YES 2-Cost
Creating document number. (If
generated from another Prism
CreatingDocNo INTEGER 5 NO document).
0-None
1-PI
2-CostOverwrite
3-Markdown
4-Cleanup
5-PlannedPricing
6-PlannedMarkdown
7-Inventory
8-Manual
9-Reversing
10-CostLeave
11-Audit
12-Corporate
13-Kit
CreatingDocType INTEGER 2 YES 14-UnverifiedSlip
Represents the sid of the document
for which the adjustment was
CreatingDocSid INTEGER 19 NO created automatically (e.g. reverse).
OrigStoreSid INTEGER 19 NO Original store sid.
OrigStation STRING 1 NO Original station.
ClerkSid INTEGER 19 NO Reference to the employee.
SublocSid INTEGER 19 NO Sid of a sublocation.
PriceLvlSid INTEGER 19 NO Reference to the Price level Sid.
WorkstationSid INTEGER 19 NO Reference to the workstation.
0-None
1-Changed
2-Cancelled
3-Normal
Status INTEGER 1 YES 4-Completed
AdjReasonSid INTEGER 19 NO Reference to the pref_reason.
TaxAreaSid INTEGER 19 NO Tax area Sid.
UseVat BOOLEAN NO Use VAT?
Audited BOOLEAN NO Audited status flag.

2
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

CMS status flag

false = Imported from subsidiary
Cms BOOLEAN NO true = Made at Corporate
Verified BOOLEAN NO Verified status flag.
Workstation document sequence
number (when using separate
document sequence numbers for
WsSeqNo INTEGER 9 NO each workstation)
Held BOOLEAN NO Holding status.
The controller that created or last
Controller INTEGER 4 NO edited the document.
The originating controller for the
OrigController INTEGER 4 NO document.
Reference to the employee sid of the
CreatedbySid INTEGER 19 NO person who created the document.
Reference to the employee sid of the
ModifiedbySid INTEGER 19 NO person who modified the document.
Used to externally identify a
document prior to that document
DocRefNo INTEGER 9 NO being updated or saved/held.
Refernce to the tax area assigned to
TaxArea2Sid INTEGER 19 NO the document.
DocReasonSid INTEGER 19 NO Document reason Sid.
SeasonSid INTEGER 19 NO Sid of season(s).
Used to identify Sub Location
quantities related adjustments.
0=None
1=Movement Only
SublocMoveType INTEGER 1 NO 2=Movement/Adjustment
Note STRING 255 NO Note.
GLFlag BOOLEAN NO GL Flag.
CopiedFlag BOOLEAN NO Copied Flag.
ReversedFlag INTEGER 1 NO Reversed Flag.
TotOrigQty DECIMAL 10,3 NO Total original quantity.
TotAdjQty DECIMAL 10,3 NO Total quantity.
TotOrigExtCost DECIMAL 16,4 NO Total original extended cost.
TotAdjExtCost DECIMAL 16,4 NO Total extended cost.
TotOrigExtPrice DECIMAL 16,4 NO Total original extended price.
TotAdjExtPrice DECIMAL 16,4 NO Total extended price.
Total extended price without tax for
TotOrigExtPriceWOTax DECIMAL 16,4 NO original value.
Total extended price without tax for
TotAdjExtPriceWOTax DECIMAL 16,4 NO adjusted value.
Total extended price with tax for
TotOrigExtPriceWTax DECIMAL 16,4 NO original value.
Total extended price with tax for
TotAdjExtPriceWTax DECIMAL 16,4 NO adjusted value.
AdjItem LIST NO AdjItem list.
AdjComment LIST NO AdjComment list.
Empl ID of the person who modified
ModifiedByEmployee INTEGER 9 NO the document.

3
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

The tax area name assigned to the

TaxArea STRING 11 NO document.
In multi-tax environments, the
TaxArea2 STRING 11 NO second tax area name used.
PriceLevel INTEGER 5 NO Price level.
Code of the employee who modified
ModifiedByEmplName STRING 8 NO the document.
Code of the employee who created
CreatedByEmplName STRING 8 NO the document.
SeasonCode STRING 5 NO Season code.
SeasonName STRING 30 NO Season name.
ReasonName STRING 80 NO Reason definition.
Document Type.
1=Sales
2=TO
3=PO
4=SO
5=Adj
6=Slip
7=Vouchers
8=Return Reasons
9=Void Reasons
10=Discount
11=Paid Out
12=Paid In
13=ASN
14=Check in
15=Check out
16=Cash Drop
ReasonType INTEGER 2 NO 17=Misc Draw
Clerk INTEGER 10 NO Employee ID.
ClerkName STRING 8 NO Employee code.
SbsNo INTEGER 4 YES Subsidiary number.
StoreNo INTEGER 4 NO Store number.
WorkstationNo INTEGER 5 NO Workstation number.
OrigStoreNo INTEGER 4 NO Original store number.
StoreCode STRING 5 NO Store code.
StoreName STRING 40 NO Store name.
OriginTimeZone STRING 8 NO Origin time zone.
Original subsidiary number of the
ClerkOrigSbsNo INTEGER 4 NO clerk.
Original subsidiary number of the
employee who created the
CreatedByOrigSbsNo INTEGER 4 NO document.
Original subsidiary number of the
employee who modified the
ModifiedByOrigSbsNo INTEGER 4 NO document.
SublocationId INTEGER 9 NO Sublocation Id.

4
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

AdjComment list
The AdjComment list contains information about the comments on the adjustment memos.
Data
Attribute Size ID Required Description
Type
AdjSid INTEGER 19 YES NO Adjustment unique identifier.
CommentNo INTEGER 4 YES YES Comment number.
Comments STRING 60 YES Comments.

AdjItem list
The AdjItem list contains information about the items on the adjustment memos.
Data
Attribute Size ID Required Description
Type
AdjSid INTEGER 19 YES NO Adjustment unique identifier.
ItemPos INTEGER 4 YES YES Item position.
ItemSid INTEGER 19 NO Item SID (unique identifier).
OrigValue DECIMAL 16,4 NO Original value.
AdjValue DECIMAL 16,4 NO Adjusted value.
Cost DECIMAL 16,4 NO Cost.
Price DECIMAL 16,4 NO Price.
TaxPerc DECIMAL 16,4 NO Tax percentage.
TaxArea2Sid INTEGER 19 NO Reference to tax area.
TaxCodeSid INTEGER 19 NO Reference to tax code.
TaxCode2Sid INTEGER 19 NO Reference to tax code.
TaxPerc2 DECIMAL 16,4 NO Tax percentage 2.
ScanUpc INTEGER 18 NO Scan UPC.
This column is obsolete and has
SerialNo STRING 50 NO been replaced by ADJ_SERIAL.
Used to record a UDF value that
existed at the time the document
was created. This field does not
necessarily correspond to
inventory UDF number 1.
Extended with more char spaces
to hold proper translation when
UdfValue1 STRING 50 NO necessary.
Used to record a UDF value that
existed at the time the document
was created. This field does not
necessarily correspond to
inventory UDF number 2.
Extended with more char spaces
to hold proper translation when
UdfValue2 STRING 50 NO necessary.

5
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Used to record a UDF value that

existed at the time the document
was created. This field does not
necessarily correspond to
inventory UDF number 3.
Extended with more char spaces
to hold proper translation when
UdfValue3 STRING 50 NO necessary.
Used to record a UDF value that
existed at the time the document
was created. This field does not
necessarily correspond to
inventory UDF number 4.
Extended with more char spaces
to hold proper translation when
UdfValue4 STRING 50 NO necessary.
Corresponds to base item cost in
v8. Stock Ledger combines cost
and quantity adjustments on qty
adj memos in v8. When the qty
adj memo is brought into v9 the
cost adj info was being lost.
Orig_Cost is used to capture the
OrigCost DECIMAL 16,4 NO base item cost from v8.
If we ever need more than 10
notes, then break notes out into
ItemNote1 STRING 350 NO their own table.
If we ever need more than 10
notes, then break notes out into
ItemNote2 STRING 350 NO their own table.
If we ever need more than 10
notes, then break notes out into
ItemNote3 STRING 350 NO their own table.
If we ever need more than 10
notes, then break notes out into
ItemNote4 STRING 350 NO their own table.
If we ever need more than 10
notes, then break notes out into
ItemNote5 STRING 350 NO their own table.
If we ever need more than 10
notes, then break notes out into
ItemNote6 STRING 350 NO their own table.
If we ever need more than 10
notes, then break notes out into
ItemNote7 STRING 350 NO their own table.
If we ever need more than 10
notes, then break notes out into
ItemNote8 STRING 350 NO their own table.

6
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

If we ever need more than 10

notes, then break notes out into
ItemNote9 STRING 350 NO their own table.
If we ever need more than 10
notes, then break notes out into
ItemNote10 STRING 350 NO their own table.
AltUpc INTEGER 18 NO UPC with alternate vendor.
AltAlu STRING 20 NO Alternate lookup code.
Cost of the item with alternate
AltCost DECIMAL 16,4 NO vendor.
AltVendCode STRING 6 NO Alternate vendor's code.
Used to identify Sub Location
quantities related adjustments.
0=None,
1=Movement Only,
SublocMoveType INTEGER 1 NO 2=Movement/Adjustment.
CMPQty DECIMAL 10,3 NO Company quantity.
AdjQty LIST NO AdjQty list
AdjSerial LIST NO AdjSerial list
AdjLotQty LIST NO AdjLotQty list
AdjGiftCard LIST NO AdjGiftCard list
TaxCode STRING 5 NO Tax Code
TaxCode2 STRING 5 NO Tax Code 2
DiffValue DECIMAL 16,4 NO Calculated. Difference Value.
Tax amount calculated for
OrigTax DECIMAL 16,4 NO original value.
Tax amount calculated for
AdjTax DECIMAL 16,4 NO adjusted value.
PriceWTax DECIMAL 16,4 NO Calculated. Price with tax.
PriceWOTax DECIMAL 16,4 NO Calculated. Price without tax.
Calculated. Adjusted price with
AdjPriceWTax DECIMAL 16,4 NO tax.
Calculated. Adjusted price
AdjPriceWOTax DECIMAL 16,4 NO without tax.
Description1 STRING 30 NO Description1
Description2 STRING 30 NO Description2
Attr STRING 8 NO Attribute
Size STRING 8 NO Item Size
VendorCode STRING 6 NO Vend Code
DcsCode STRING 9 NO Dcs Code
Upc INTEGER 18 NO Upc
Alu STRING 20 NO Alu
ItemUID INTEGER 19 YES Item Unique ID
TaxArea2 STRING 11 NO Tax area name.
UseQtyDecimals INTEGER 1 NO Use quantity decimals.

7
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

0-Qty
1-Price
AdjustmentType INTEGER 1 NO 2-Cost
TaxName STRING 12 NO Tax code name.
TaxName2 STRING 12 NO Tax code name.
Serial-type from V9
invn_sbs.ext_flag. (V9 ext-flag
contains serial-type and lot-type).
0-None
1-Partial
SerialType INTEGER 1 NO 2-Full.
lot-type from V9
invn_sbs.ext_flag. (V9 ext-flag
LotType INTEGER 1 NO contains serial-type and lot-type).
0-NoEntry
1-Kit
2-Package
3-GiftCardStoredValue
4-GiftCardPrePaid
5-GiftCertificate
6-Fee
KitType INTEGER 1 NO 7-GiftCardCentral

AdjQty list
The AdjQty list contains information about the quantities for the items on the adjustment memos.
Data
Attribute Size ID Required Description
Type
Reference to the Adjustment
AdjItemSid INTEGER 19 YES NO Item Sid.
SbsSid INTEGER 19 NO Reference to the subsidiary.
StoreSid INTEGER 19 YES NO Reference to the store.
Qty DECIMAL 10,3 YES Quantity.
StoreNo INTEGER 4 YES Store number.
SbsNo INTEGER 4 YES Subsidiary number.

8
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

AdjSerial list
The AdjSerial list contains information about the serialized items on the adjustment memos.
Data
Attribute Size ID Required Description
Type
Reference to the Adjustment
AdjItemSid INTEGER 19 YES NO Item Sid.
SerialNo STRING 50 YES YES Serial Number.
OrigQty DECIMAL 10,3 NO Original Quantity.
AdjQty DECIMAL 10,3 NO Adjustment Quantity.
Notes STRING 255 NO 0-None, 1-Insert, 2-Remove
Used to mark a serial number for
insertion or deletion.
Allowed values:
0=None
1=Insert
ActionType INTEGER 1 NO 2=Deactivate

AdjLot list
The AdjLot list contains information about the item lots on the adjustment memos.
Data
Attribute Size ID Required Description
Type
Reference to the Adjustment
AdjItemSid INTEGER 19 YES NO Item Sid.
LotNumber STRING 25 YES YES Lot Number.
Original qty assigned to the lot
OrigQty DECIMAL 10,3 NO number
New lot number quantity. This
value will be updated in the
LOT_QTY table. It is retained
AdjQty DECIMAL 10,3 NO here for history purposes only.
SublocSid INTEGER 19 YES ID of a sublocation.

9
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

AdjGiftCard list
The AdjGiftCard list contains information about the gift cards on the adjustment memos.
Data
Attribute Size ID Required Description
Type
Unique identifier of the adjusted
item referenced in the adj_item
AdjItemSid INTEGER 19 YES NO table.
This is the older non-central gift
GiftCardNo STRING 25 YES YES card numbers.
The original qty of the gift card
item (older non-central gift card
OrigQty DECIMAL 10,3 NO numbers).
the adjusted qty made to the gift
card (older non-central gift card
numbers) via qty adjustment
AdjQty DECIMAL 10,3 NO memos.

10
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Insert new Adjustment Memo Price Payload Example.

{
"sid": "582654366000104382",
"adjno": 10,
"adjtype": 1,
"creatingdoctype": 8,
"status": 4,
"controller": 1,
"origcontroller": 1,
"adjitem": [{
"itempos": 1,
"origvalue": 9.99,
"adjvalue": 11.99,
"itemuid": "578536303000120436"
}],
"taxarea": "ILLINOIS",
"pricelevel": 1,
"createdbyemplname": "SYSADMIN",
"seasoncode": "None",
"reasonname": "MANUALLY",
"reasontype": 5,
"clerk": 1,
"clerkname": "SYSADMIN",
"sbsno": 1,
"storeno": null,
"origstoreno": 1,
"clerkorigsbsno": 1,
"createdbyorigsbsno": 1,
"modifiedbyorigsbsno": 1
}

11
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Customer
The customer JSON contains information about the customer records.
Added to this document: 1.14.7

Attribute Data Type Size ID Required Description

Customer unique identifying
Sid INTEGER 19 YES YES value.
Reference to customers home
SbsSid INTEGER 19 NO subsidiary.
Reference to customers home
RegionSid INTEGER 19 NO region.
TenantSid INTEGER 19 NO Reference to tenant description.
Reference to customers home
DistrictSid INTEGER 19 NO district.
Reference to customers home
StoreSid INTEGER 19 NO store.
Reference to company customer
CompanySid INTEGER 19 NO works for.
CustId INTEGER 9 NO Customer ID.
Indicates the customer record is
shared;
0 = Local,
1 = Global,
2 = Regional,
3 = Non-Share.
ShareType INTEGER 1 NO Defaults to Global.
LastName STRING 30 YES Customers last Name.
FirstName STRING 30 YES Customers First Name.
Indicates whether customer
Active BOOLEAN NO record is active. Default: Active.
MarketingFlag INTEGER 9 NO Marketing flag.
BirthDay INTEGER 2 NO Day of customer’s birth.
BirthMonth INTEGER 2 NO Month of customer’s birth.
BirthYear INTEGER 4 NO Year of customer’s birth.
Indicates Type Of Customer,
0 = Customeronly
CustType INTEGER 1 NO 1 = Employee
Reference to Customer Class
CustClassSid INTEGER 19 NO Description Record.
TitleSid INTEGER 19 NO Reference to Person Title Record.
Reference to Person Suffix
SuffixSid INTEGER 19 NO Record, Eg. Jr., Phd., Etc..
Gender INTEGER 1 NO 0=Male, 1=Female.
If Populated, Overrides
PriceLvlSid INTEGER 19 NO Subsidiary/Store Price Level.
TaxAreaSid INTEGER 19 NO Reference to Tax Area Record.
TaxArea2Sid INTEGER 19 NO Reference to Tax Area Record.

12
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

CreditLimit DECIMAL 16,4 NO Maximum Credit Level.

CreditUsed DECIMAL 16,4 NO Credit Balance Customer Owes.
Credit Balance Owed to
StoreCredit DECIMAL 16,4 NO Customer.
True Is Customer Can Tender
AcceptChecks BOOLEAN NO Using Personal Checks.
Maximum Amount Than Can Be
Accepted from Customer In
CheckLimit DECIMAL 16,4 NO Personal Checks. Null=Unlimited.
Determine if the customer is
exempt of taxes. True = Detax;
Detax BOOLEAN NO false = tax
Suggested Discount Available to
SuggestedDiscPerc DECIMAL 16,4 NO This Customer.
Maximum Percentage that a
customer purchase can be
discounted.
Values: 0 -100.
MaxDiscPerc DECIMAL 16,4 NO Defaults to 0.
HouseholdCode INTEGER 9 NO Additional filter used for lookups.
Mark1 STRING 4 NO Accounting System Flag.
Mark2 STRING 4 NO Accounting System Flag.
SecurityLvl INTEGER 5 NO Security Level.
Indicates status of last attempt to
process customer information
into accounting system. 1-Yes, 2-
ArFlag INTEGER 1 NO No, 3-Export.
Reference to Associated
RelatedCustSid INTEGER 19 NO Customer Record.
ShippingPriority INTEGER 4 NO Shipping Priority.
PrimaryClerkSid INTEGER 19 NO Reference to Employee Record.
FirstSaleDate DATETIME NO Date of First Purchase.
LastSaleDate DATETIME NO Date of Last Purchase.
LastSaleAmt DECIMAL 16,4 NO Amount of Last Purchase.
Encrypted Username Value for
Authenticating Webstoreconnect
WscUsername STRING 20 NO Login.
Encrypted Password Value for
Authenticating Webstoreconnect
WscPassword STRING 20 NO Login.
Reference to Payment Terms
PaymentTermsSid INTEGER 0 NO Description.
String Tag Identifying This
Customer Within the Accounting
AccountingSystemId STRING 40 NO System.
Udf1String STRING 50 NO User Defined Field.
Udf2String STRING 50 NO User Defined Field.

13
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Udf3String STRING 50 NO User Defined Field.

Udf4String STRING 50 NO User Defined Field.
Udf5String STRING 50 NO User Defined Field.
Udf1Date DATETIME NO Udf1Date.
Udf2Date DATETIME NO Udf2Date.
Used to Keep The Customer
Email STRING 100 NO Primary Email.
Udf1Clob STRING 2001 NO User Defined Field.
Udf2Clob STRING 2001 NO User Defined Field.
Notes STRING 2001 NO Free Text.
Image BLOB NO Customers Image.
Info1 STRING 20 NO Legacy Data Entry Field.
Info2 STRING 20 NO Legacy Data Entry Field.
Indicates if a customer record is
QbLink BOOLEAN NO being exported to Qb Via Qblink.
Used to determine where the
customer may have been created
8 Series, 9 Series or Aruba
Cms INTEGER 1 NO System.
The last date in which an item on
any given transaction was
marked as a return item for the
LastReturnDate DATETIME NO given customer.
A sum of transactions against a
given customer sid regardless of
the types of items placed on that
TotalTransactions INTEGER 9 NO transaction.
A count of all items on a
transaction that are marked as
sale items. (note - this will
exclude any sale items that were
SaleItemCount INTEGER 9 NO voided as their qty should be 0).
A count of all items on a
transaction that are marked as
ReturnItemCount INTEGER 9 NO return items.
true - Segment Rules Completed;
false - Segment Rules Not
Segmented BOOLEAN NO Completed.
Indicates employee is a customer
or not. Determine if an employee
can be used as a customer at
EmployeeAsCustomer BOOLEAN NO POS.
LastOrderDate DATETIME NO last order date.
A count of all items on a
transaction that are marked as
OrderItemCount INTEGER 9 NO order items.
Station STRING 1 NO Station Code.

14
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Year to date sale. This total will

be calculated at the time the
document is committed and
YtdSale DECIMAL 16,4 NO stored on the customer record.
Array of t/f flags used to indicate
the tender types this customer
can tender with.
AllowedTenders STRING 15 NO Default: all tenders types.
CountrySid INTEGER 19 NO Reference to the country sid.
Promotions: customer pricing list
PromoCustlistname STRING 255 NO name.
AlternateId1 STRING 20 NO Alternateid1.
AlternateId2 STRING 20 NO Alternateid2.
false = customer opts out of the
customer loyalty program.
true = customer opts in for the
LtyOptIn BOOLEAN NO customer loyalty program.
The date the customer enrolls in
LtyEnrollDate DATETIME NO the custom loyalty program.
The balance the customer has on
the custom loyalty program as
LtyBalance DECIMAL 24,8 NO updated by the central server.
The accumulated points accrued
for either ytd from the enroll
LtyAccumulated DECIMAL 24,8 NO date or total lifetime.
Unique identifier of the customer
LtyLvlSid INTEGER 19 NO loyalty levels.
To indicate whether the loyalty
level for the customer can be
changed or not. false = unlocked;
true = loyalty level locked in this
LtyLvlLocked BOOLEAN NO customer.
LtyOptInManual BOOLEAN NO Loyalty opt in manual.
CustAddress LIST NO CustAddress list
CustEmail LIST NO CustEmail list
CustPhone LIST NO CustPhone list
CustExtend LIST NO CustExtend list
Person Title, E.g.: Mr., Mrs., Dr.,
Title STRING 15 NO Etc..
Region STRING 12 NO Corporate region name.
TaxArea STRING 11 NO Tax area name.
TaxArea2 STRING 11 NO Tax area name.
PriceLevel INTEGER 5 NO Price level.
Company STRING 70 NO Company name.
FullName STRING NO Calculated.
CustImage STRING 0 NO Customer image field.
SbsName STRING 15 NO Subsidiary name.

15
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Uniquely identifying subsidiary

SbsNo INTEGER 4 YES number.
StoreName STRING 40 NO Store name.
StoreNo INTEGER 4 NO Number.
Short descriptive name for
CustClass STRING 30 NO customer class.
PrimaryClerk STRING 8 NO Employee code
Customer loyalty level
description i.e., gold, silver or
LtyLvlName STRING 50 NO bronze.
ImagePath STRING 0 NO The path to the image file.
StoreCode STRING 5 NO Store code.
Subsidiary number of the primary
PrimaryClerkOrigSbsNo INTEGER 4 NO clerk.
PriceLevelName STRING 6 NO Price level name.
OriginTimeZone STRING NO Calculated. Time zone.
CentralCredit DECIMAL 16,4 NO Offline central credit value.

Insert New Customer Payload Example.

{
"sid": "578857804000154827",
"custid": 100000004,
"lastname": "Nicolaus",
"firstname": "Copernicus",
"maxdiscperc": 100,
"sbsno": 1,
"storeno": 1
}

16
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

CustAddress list
The custaddress list contains information about the customer address records.
Attribute Data Type Size ID Required Description
Sid INTEGER 19 NO Address unique identifying value.
CustSid INTEGER 19 NO Reference to customer record.
Indicates that this is the
customer’s primary address.
PrimaryFlag BOOLEAN NO Default: false.
Indicates this address can be
used in workflow.
Active BOOLEAN NO Default: True
Descriptive name of address as it
AddressName STRING 30 NO relates to the customer.
Optional name of company at
CompanyName STRING 100 NO this address.
Address line 1 - number and
Address1 STRING 40 NO street
Address2 STRING 40 NO Address line 2 - suite
Address3 STRING 40 NO Address line 3 - c/o
City STRING 40 NO Address city
State STRING 5 NO Address state or province
PostalCode STRING 10 NO Postal (zip) code
PostalCodeExtension STRING 5 NO Postal code extension (zip+4)
CountrySid INTEGER 19 NO Reference to country record.
Date customer began using or
BeginDate DATETIME NO living at this address.
Date customer stopped using or
EndDate DATETIME NO living at this address.
If the customer uses this address
seasonally, month and day (year
is ignored) that customer begins
SeasonalBeginDate DATETIME NO using this address.
If the customer uses this address
seasonally, month and day (year
is ignored) that customer stops
SeasonalEndDate DATETIME NO using this address.
Reference to address type
AddressTypeSid INTEGER 19 NO record.
Short descriptive code for this
AddressCode STRING 10 NO address, e.g., Home, work, etc.
BillShip INTEGER 1 NO 0-Billing and 1-Shipping.
Reference to phone record.
PhoneSid INTEGER 19 NO Phone number at location.
Reference to phone record.
AltPhoneSid INTEGER 19 NO Alternate phone number.

17
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Indicates customer has opted out

of being contacted at this
AddressAllowContact BOOLEAN YES address.
Address4 STRING 40 NO Extended address detail.
Address5 STRING 40 NO Extended address detail.
Address6 STRING 40 NO Extended address detail.
Each address that is created can
have a specific tax area
TaxAreaSid INTEGER 19 NO associated with it.
Each address that is created can
have a specific tax area
TaxArea2Sid INTEGER 19 NO associated with it.
AddressLine1 STRING 40 NO Address line1.
SeqNo INTEGER 4 YES YES Sequence number.
TaxArea STRING 11 NO Tax area name.
TaxArea2 STRING 11 NO Tax area name2.
Address type name, eg. Home2,
AddressType STRING 30 YES work1 etc.
CountryCode STRING 3 NO Country code.
CustEmail list
The custemail list contains information about the customer email records.
Attribute Data Type Size ID Required Description
Customer email unique
Sid INTEGER 19 NO identifying value.
CustSid INTEGER 19 NO Reference to customer record.
EmailAddress STRING 100 YES Email address.
Short text description of email
Description STRING 60 NO number as it relates to customer.
Indicates customer has opted out
of being contacted at this email
EmailAllowContact BOOLEAN NO address.
Date customer began using this
BeginDate DATETIME NO email address.
Date customer stopped using this
EndDate DATETIME NO email address.
Extension may include
information such as .com, .net,
Extension STRING 20 NO .org etc.
Indicates that this is the
PrimaryFlag BOOLEAN NO customers primary email address
SeqNo INTEGER 4 YES YES Email sequence number.
EmailTypeSid INTEGER 19 NO Reference to email_type record.
EmailType STRING 20 NO Email type name.

18
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

CustPhone list
The custphone list contains information about the customer email records.
Attribute Data Type Size ID Required Description
Sid INTEGER 19 NO Unique identifying value.
CustSid INTEGER 19 YES NO Reference to customer record.
PhoneNo STRING 30 YES Phone number.
Extension STRING 10 NO Phone extension.
Short text description of phone
Description STRING 60 NO number as it relates to customer.
Indicates customer has opted out
PhoneAllowContact BOOLEAN NO of being contacted at this phone.
Date customer began using this
BeginDate DATETIME NO phone number.
Date customer stopped using this
EndDate DATETIME NO phone number.
Indicates that this is the vendors
PrimaryFlag BOOLEAN NO primary phone number
SeqNo INTEGER 4 YES YES Phone sequence number.
PhoneTypeSid INTEGER 19 NO Reference to phone type record.
Phone type name, e.g., "home2",
PhoneType STRING 20 NO "work1", "cell", etc.

19
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Insert New Customer with Address, Email and Phone Payload example.
{
"sid": "579138538000178074",
"custid": 100000005,
"lastname": "Isaac",
"firstname": "Newton",
"maxdiscperc": 100,
"custaddress": [{
"primaryflag": true,
"active": true,
"address1": "4516 Moon St",
"address2": "Sacramento",
"address3": "California",
"postalcode": "95789",
"seqno": 1,
"addresstype": "Home"
}],
"custemail": [{
"emailaddress": "inewton@[Link]",
"primaryflag": true,
"seqno": 1,
"emailtype": "Office"
}],
"custphone": [{
"phoneno": "9160101011",
"primaryflag": true,
"seqno": 1,
"phonetype": "Home"
}],
"sbsno": 1,
"storeno": 1
}

20
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

DCS
The DCS JSON contains information about departments.
Added to this document: 1.14.7

DCS Code include 3 characters for

department code, 3 characters
for class code and 3 character for
subclass code.
E.g., “MENACCHAT”
Where:
“MEN” = Department code
“ACC” = Class code
DcsCode STRING 9 YES YES “HAT” = Subclass code
SbsSid INTEGER 19 NO Reference to subsidiary.
Use quantity decimals?
UseQtyDecimals INTEGER 1 NO 1 = yes; 0 = no.
TaxCodeSid INTEGER 19 NO References to tax code.
0 = margin
1 = mark up
MarginType INTEGER 1 NO 2 = pricing coefficient.
true = Active; false = Inactive
Active BOOLEAN NO Default: true
MarginValue DECIMAL 16,4 NO Margin Value.
References the allocation pattern
PatternSid INTEGER 19 NO associated with the department.
DName STRING 20 NO Department Name.
CName STRING 20 NO Class Name.
SName STRING 20 NO Subclass Name.
DLongName STRING 60 NO Department Long Name.
CLongName STRING 60 NO Class Long Name.
SLongName STRING 60 NO Subclass Long Name.
TagCodeSid INTEGER 19 NO References to a printing tag.
true = regional; false = not
Regional BOOLEAN NO regional
Image BLOB NO Image
0=Published
1=WIP
PublishStatus INTEGER 1 NO 2=ReadyToPublish
TaxCode STRING 5 YES Tax Code
Uniquely identifying subsidiary
SbsNo INTEGER 4 YES YES number.
PatternName STRING 20 NO Unique name of the pattern.

21
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Insert New DCS Payload Example.

{
"dcscode": "MENTE6TE6",
"active": true,
"dname": "Mens",
"cname": "test6",
"sname": "test6",
"taxcode": "0",
"sbsno": 1
}

22
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Document
The Document JSON contains information related to receipts recording the sale and return of
merchandise.
Added to this document: 1.14.7

Data
Attribute Size ID Required Description
Type
Sid INTEGER 19 YES YES Unique identifying value.
Employee id of row creator using
CreatedBy STRING 30 NO application ui.
Employee id of last modifier
ModifiedBy STRING 30 NO using application ui.
DATETIM
ModifiedDatetime E NO Datetime row was last modified
Reference to controller record for
ControllerSid INTEGER 19 NO database where that owns row.
Indicates application used to
create row. V9 and v8 are
reserved for rpro versions 8 and
9, respectively. This is the same
value that will be used in
OriginApplication STRING 20 NO licensing applications.
RowVersion INTEGER 1 NO Optimistic locking value.
0 = None
1 = changed
2 = cancelled
3 = normal
Status INTEGER 1 YES 4 = Completed
BOOLEA Flag to indicate that document
UseVat N YES uses vat
BOOLEA
WasAudited N YES Indicates document was audited.
Indicates document is in a held
state pending future changes.
Business rules for completion of a
document do not apply to a held
document, and totals from a held
BOOLEA document are not included in
IsHeld N YES daily totals reports.
Indicates the receipt detax
status.
BOOLEA 0 = No detax
DetaxFlag N YES 1 = Detaxed
Indicates record has been
Archived INTEGER 1 YES archived.

23
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

0-Cash,
1-Check,
2-creditcard,
3-COD,
4-Charge,
5-storecredit,
6-Split,
7-Deposit,
8-Payments,
9-giftcertificate,
10-giftcard,
11-debitcard,
12-foreigncurrency,
13-travelercheck,
14-foreigncheck,
15-centralgiftcard,
16-centralgiftcertificate,
17-centralcustomercredit,
TenderType INTEGER 4 YES 18-CustomerLoyalty
SbsNo INTEGER 4 YES Subsidiary number.
StoreNo INTEGER 4 YES Store number.
BOOLEA
BtPrimary N YES
BOOLEA
StPrimary N YES
TenantSid INTEGER 19 NO Reference to tenant description
Document identifying number,
assigned when document is
DocNo INTEGER 9 NO posted or held
Document identifying number,
used to reference document
DocRefNo INTEGER 9 NO before it is posted or held
TrackingNo STRING 24 NO Shipping tracking number.
Bitmask controlling application of
VatOptions INTEGER 9 NO vat rules
Customer purchase order
CustPoNo STRING 10 NO number.
Document level discount
percentage. If not null,
DiscPerc DECIMAL 16,4 NO supersedes disc_amt.
Document level discount
DiscAmt DECIMAL 16,4 NO amount. Used if disc_perc is null.
Tax rebate percentage. If not
TaxRebatePerc DECIMAL 17,5 NO null, supersedes tax_reb_amt.
Tax rebate amount used if
TaxRebateAmt DECIMAL 16,4 NO tax_reb_perc is null.
The percentage of extra tax
OverTaxPerc DECIMAL 16,4 NO applied.

24
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

The percentage of extra tax

OverTaxPerc2 DECIMAL 16,4 NO applied to the Tax 2% field.
Number used as offset when
RoundingOffset DECIMAL 16,4 NO rounding is performed.
Sequence number assigned by
the workstation associated
WsSeqNo INTEGER 10 NO processing this document.
Customization data. Legacy from
CustField STRING 47 NO v9.
The drawer number of the cash
drawer where the receipt was
DrawerNo INTEGER 4 NO created.
Number of seconds elapsed from
time invoice was begun to the
time it was posted. Does not
include amount of time
ElapsedTime INTEGER 9 NO document was on hold.
Percentage of work done on this
transaction by employee
ActivityPerc DECIMAL 16,4 NO referenced by clerk_sid.
Percentage of work done on this
transaction by employee
Activity2Perc DECIMAL 16,4 NO referenced by clerk2_sid.
Percentage of work done on this
transaction by employee
Activity3Perc DECIMAL 16,4 NO referenced by clerk3_sid.
Percentage of work done on this
transaction by employee
Activity4Perc DECIMAL 16,4 NO referenced by clerk4_sid.
Percentage of work done on this
transaction by employee
Activity5Perc DECIMAL 16,4 NO referenced by clerk5_sid.
Invoice number generated to
satisfy eft processor
EftInvcNo INTEGER 9 NO requirements.
ShippingPerc DECIMAL 16,4 NO Shipping percentage.
DiscPercSpread DECIMAL 16,4 NO Discount percentage spread.
Number returned by fiscal printer
as the reference number
assigned to the document in the
FiscalDocNo INTEGER 9 NO fiscal printer memory.
Udf1String STRING 50 NO User defined field.
Udf2String STRING 50 NO User defined field.
Udf3String STRING 50 NO User defined field.
Udf4String STRING 50 NO User defined field.
Udf5String STRING 50 NO User defined field.
Udf1Float DECIMAL 16,4 NO User defined numeric field.

25
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Udf2Float DECIMAL 16,4 NO User defined numeric field.

Udf3Float DECIMAL 16,4 NO User defined numeric field.
Udf4Float DECIMAL 16,4 NO User defined numeric field.
Udf5Float DECIMAL 16,4 NO User defined numeric field.
UdfClob STRING 50 NO User defined clob field.
TotalFeeAmt DECIMAL 16,4 NO Total Fee amount
TotalDiscountAmt DECIMAL 16,4 NO Total discount amount.
Stores total tax amount for the
SaleTotalTaxAmt DECIMAL 17,5 NO sale items in the transaction.
Stores total amount for the sale
SaleTotalAmt DECIMAL 16,4 NO items in the transaction.
Stores subtotal amount for the
SaleSubtotal DECIMAL 16,4 NO sale items in the transaction.
DepositAmtRequired DECIMAL 16,4 NO Amount required as a deposit.
DueAmt DECIMAL 16,4 NO Balance due.
SoldQty DECIMAL 10,3 NO Total sold qty.
ReturnQty DECIMAL 10,3 NO Total return qty.
OrderQty DECIMAL 10,3 NO Total order qty.
Quantity of an order document
OrderQuantityFilled DECIMAL 10,3 NO that has already been filled.
Needs to be recalculated
whenever there is a
TakenAmt DECIMAL 16,4 NO POST/PUT/DELETE to a tender
StoreCode STRING 5 NO Store code.
OrigStoreNo INTEGER 4 NO Original store number.
OrigStoreCode STRING 5 NO Original store code
TaxAreaName STRING 11 NO Tax area name.
TaxArea2Name STRING 11 NO Tax area2 name.
DiscountReasonName STRING 80 NO Discount reason name.
DisbursementReasonName STRING 80 NO Disbursement reason name
Keeps the number of the
workstation the document was
WorkstationNo INTEGER 4 NO created at.
Keeps the login name of cashier
CashierLoginName STRING 30 NO who created the document.
Keeps the full name of cashier
CashierFullName STRING 60 NO who created the document.
Keeps the login name of clerk 2
Employee1LoginName STRING 20 NO who created the document.
Keeps the full name of clerk 2
Employee1FullName STRING 60 NO who created the document.
Keeps the login name of clerk 3
Employee2LoginName STRING 20 NO who created the document.
Keeps the full name of clerk 3
Employee2FullName STRING 60 NO who created the document.
Keeps the login name of clerk 4
Employee3LoginName STRING 20 NO who created the document.

26
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Keeps the full name of clerk 4

Employee3FullName STRING 60 NO who created the document.
Keeps the login name of clerk 5
Employee4LoginName STRING 20 NO who created the document.
Keeps the full name of clerk 5
Employee4FullName STRING 60 NO who created the document.
Keeps the login name of clerk 6
Employee5LoginName STRING 20 NO who created the document.
Keeps the full name of clerk 6
Employee5FullName STRING 60 NO who created the document.
Keeps the bill to customer unique
BtCuid INTEGER 19 NO identifier on the document.
BtId INTEGER 9 NO Bill to customer Id.
BtLastName STRING 30 NO Bill to customer last name.
BtFirstName STRING 30 NO Bill to customer first name.
BtCompanyName STRING 100 NO Bill to customer company name.
BtTitle STRING 15 NO Bill to customer title.
BtTaxAreaName STRING 11 NO Bill to customer tax area name.
BtTaxArea2Name STRING 11 NO Bill to customer tax area2 name.
BOOLEA
BtDetaxFlag N NO Bill to customer detax Flag.
Bill to customer price Level
BtPriceLvlName STRING 6 NO name.
BtPriceLvl INTEGER 4 NO Bill to customer price level.
BtSecurityLvl INTEGER 4 NO Bill to customer security Level.
Bill to customer primary phone
BtPrimaryPhoneNo STRING 30 NO number.
BtAddressLine1 STRING 40 NO Bill to customer address line1
BtAddressLine2 STRING 40 NO Bill to customer address line2
BtAddressLine3 STRING 40 NO Bill to customer address line3
BtAddressLine4 STRING 40 NO Bill to customer address line4
BtAddressLine5 STRING 40 NO Bill to customer address line5
BtAddressLine6 STRING 40 NO Bill to customer address line6
BtCountry STRING 35 NO Bill to customer country.
BtPostalCode STRING 10 NO Bill to customer postal code.
Bill to customer postal code
BtPostalCodeExtension STRING 5 NO extension.
StAddressLine1 STRING 40 NO Store address line 1.
StAddressLine2 STRING 40 NO Store address line 2.
StAddressLine3 STRING 40 NO Store address line 3.
StAddressLine4 STRING 40 NO Store address line 4.
StAddressLine5 STRING 40 NO Store address line 5.
StAddressLine6 STRING 40 NO Store address line 6.
StCountry STRING 35 NO Store country.
StPostalCode STRING 10 NO Store postal code.
StPostalCodeExtension STRING 5 NO Store postal code extension.

27
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Keeps the ship to customer

unique identifier on the
StCuid INTEGER 19 NO document.
StId INTEGER 9 NO Ship to customer Id.
StLastName STRING 30 NO Ship to customer last name.
StFirstName STRING 30 NO Ship to customer first name.
StTitle STRING 15 NO Ship to customer title.
StTaxAreaName STRING 11 NO Ship to customer tax area name.
StTaxArea2Name STRING 11 NO Ship to customer tax area2 name.
BOOLEA
StDetaxFlag N NO Ship to customer detax flag.
Ship to customer price level
StPriceLvlName STRING 6 NO name.
StPriceLvl INTEGER 4 NO Ship to price level.
StSecurityLvl INTEGER 4 NO Ship to customer security level.
Ship to customer primary phone
StPrimaryPhoneNo STRING 30 NO number.
StCompanyName STRING 100 NO Ship to customer company name.
Keeps the type of the fee the
FeeType1 INTEGER 4 NO document might have.
Keeps the name of the fee the
FeeName1 STRING 25 NO document might have.
Keeps the type of the fee the
FeeType2 INTEGER 4 NO document might have.
Keeps the name of the fee the
FeeName2 STRING 25 NO document might have.
Keeps the type of the fee the
FeeType3 INTEGER 4 NO document might have.
Keeps the name of the fee the
FeeName3 STRING 25 NO document might have.
Keeps the type of the fee the
FeeType4 INTEGER 4 NO document might have.
Keeps the name of the fee the
FeeName4 STRING 25 NO document might have.
Keeps the type of the fee the
FeeType5 INTEGER 4 NO document might have.
Keeps the name of the fee the
FeeName5 STRING 25 NO document might have.
Keeps the name of the tender the
TenderName STRING 25 NO document was tendered with.
Keeps the name of the currency
CurrencyName STRING 30 NO the document was created with.
Keeps the till name the
TillName STRING 40 NO document was generated at.
BtEmail STRING 100 NO Bill to customer email.
StEmail STRING 100 NO Ship to customer email
HistDiscAmt1 DECIMAL 16,4 NO Histdiscamt1

28
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

HistDiscPerc1 DECIMAL 16,4 NO Histdiscperc1

HistDiscReason1 STRING 80 NO Histdiscreason1
HistDiscAmt2 DECIMAL 16,4 NO Histdiscamt2
HistDiscPerc2 DECIMAL 16,4 NO Histdiscperc2
HistDiscReason2 STRING 80 NO Histdiscreason2
HistDiscAmt3 DECIMAL 16,4 NO Histdiscamt3
HistDiscPerc3 DECIMAL 16,4 NO Histdiscperc3
HistDiscReason3 STRING 80 NO Histdiscreason3
HistDiscAmt4 DECIMAL 16,4 NO Histdiscamt4
HistDiscPerc4 DECIMAL 16,4 NO Histdiscperc4
HistDiscReason4 STRING 80 NO Histdiscreason4
HistDiscAmt5 DECIMAL 16,4 NO Histdiscamt5
HistDiscPerc5 DECIMAL 16,4 NO Histdiscperc5
HistDiscReason5 STRING 80 NO Histdiscreason5
DATETIM
CreatedDatetime E YES Datetime row was created
Date and time the row was
created/last modified in this
DATETIM system. May not be the same as
PostDate E NO created/modified datetime.
DATETIM
Udf1Date E NO User defined date field.
DATETIM
Udf2Date E NO User defined date field.
DATETIM
Udf3Date E NO User defined date field.
Date the invoice was posted.
Note that this is not the same as
DATETIM the post_date in the standard
InvcPostDate E YES header
BOOLEA
FeeTaxIncluded1 N NO Fee tax included 1 flag.
FeeTaxPerc1 DECIMAL 16,4 NO Fee tax percentage 1.
BOOLEA
FeeTaxIncluded2 N NO Fee tax included 2.
FeeTaxPerc2 DECIMAL 16,4 NO Fee tax percentage 2.
BOOLEA
FeeTaxIncluded3 N NO Flag fee tax included 3.
FeeTaxPerc3 DECIMAL 0 NO Fee tax percentage 3.
BOOLEA
FeeTaxIncluded4 N NO Flag fee tax included 4.
FeeTaxPerc4 DECIMAL 16,4 NO Fee tax percentage 4.
BOOLEA
FeeTaxIncluded5 N NO Flag fee tax included 5.
FeeTaxPerc5 DECIMAL 16,4 NO Fee tax percentage 5.
PriceLvl INTEGER 4 NO Price level.
PriceLvlName STRING 6 NO Price level name.

29
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

ShippingAmt DECIMAL 16,4 NO Stores the shipping amount.

Stores the tax percent of the
ShippingTaxPerc DECIMAL 16,4 NO shipping amount.
ShippingTaxAmt DECIMAL 16,4 NO Stores shipping tax amount.
Stores total tax amount for the
OrderTotalTaxAmt DECIMAL 17,5 NO order items in the transaction.
Stores total tax amount for the
TransactionTotalTaxAmt DECIMAL 17,5 NO transaction.
Stores tax1 amount for the sale
SaleTax1Amt DECIMAL 17,5 NO items in the transaction.
Stores tax1 amount for the order
OrderTax1Amt DECIMAL 17,5 NO items in the transaction.
Stores tax1 amount for the
TransactionTax1Amt DECIMAL 17,5 NO transaction.
Stores tax2 amount for the sale
SaleTax2Amt DECIMAL 17,5 NO items in the transaction.
Stores tax2 amount for the order
OrderTax2Amt DECIMAL 17,5 NO items in the transaction.
Stores tax2 amount for the
TransactionTax2Amt DECIMAL 17,5 NO transaction.
Stores total amount for the order
OrderTotalAmt DECIMAL 16,4 NO items in the transaction.
Stores total amount for the
TransactionTotalAmt DECIMAL 16,4 NO transaction.
Stores subtotal amount for the
OrderSubtotal DECIMAL 16,4 NO order items in the transaction.
Stores subtotal with tax for the
SaleSubtotalWithTax DECIMAL 16,4 NO sale items in the transaction.
Stores subtotal with tax for the
OrderSubtotalWithTax DECIMAL 16,4 NO order items in the transaction.
Stores subtotal with tax for the
TransactionSubtotalWithTax DECIMAL 16,4 NO transaction.
SoDepositAmt DECIMAL 16,4 NO Obsolete.
Stores deposit amount that is
SoDepositAmtPaid DECIMAL 16,4 NO paid for the transaction
Stores the number of line items
TotalLineItem INTEGER 9 NO for the transaction
Stores the total item count for
TotalItemCount INTEGER 9 NO the transaction
Stores subtotal amount for the
TransactionSubtotal DECIMAL 16,4 NO transaction
Keeps the given amount for the
document. Needs to be
recalculated whenever there is a
GivenAmt DECIMAL 16,4 NO POST/PUT/DELETE to a tender
FeeAmt1 DECIMAL 16,4 NO Stores the fee amount
FeeTaxAmt1 DECIMAL 16,4 NO Stores the fee tax amount

30
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

FeeAmt2 DECIMAL 16,4 NO Stores the fee amount

FeeTaxAmt2 DECIMAL 16,4 NO Stores the fee tax amount
FeeAmt3 DECIMAL 16,4 NO Stores the fee amount
FeeTaxAmt3 DECIMAL 16,4 NO Stores the fee tax amount
FeeAmt4 DECIMAL 16,4 NO Stores the fee amount
FeeTaxAmt4 DECIMAL 16,4 NO Stores the fee tax amount
FeeAmt5 DECIMAL 16,4 NO Stores the fee amount
FeeTaxAmt5 DECIMAL 16,4 NO Stores the fee tax amount
BOOLEA Indicates if shipping tax should be
ShippingTaxIncluded N NO included it the document
Keeps the workstation unique
WorkstationUid INTEGER 19 NO identifier on the document
Keeps the name of the
workstation the document was
WorkstationName STRING 64 NO created at
Used to preserve the store name
StoreName STRING 40 NO on the document.
Used to store tax area 1 % on the
TaxAreaPerc DECIMAL 16,4 NO document.
Used to store tax area 2 % on the
TaxArea2Perc DECIMAL 16,4 NO document.
Used to store tax area 1 amount
TaxAreaAmt DECIMAL 16,4 NO on the document.
Used to store tax area 2 amount
TaxArea2Amt DECIMAL 16,4 NO on the document.
Used to store tax area sale tax
TaxAreaSalesTaxAmt DECIMAL 16,4 NO amount on the document.
Used to store tax area2 sale tax
TaxArea2SalesTaxAmt DECIMAL 16,4 NO amount on the document.
Used to store tax area order tax
TaxAreaOrderTaxAmt DECIMAL 16,4 NO amount on the document.
Used to store tax area2 sale tax
TaxArea2OrderTaxAmt DECIMAL 16,4 NO amount on the document.
Used to store predefined reason
ReasonCode STRING 80 NO code on a document.
Used to store predefined reason
ReasonDescription STRING 80 NO description on a document.
Used to store predefined
PosFlag1 STRING 60 NO pos_flag1 on a document.
Used to store predefined
PosFlag2 STRING 60 NO pos_flag2 on a document.

31
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Used to store predefined

PosFlag3 STRING 60 NO pos_flag3 on a document.
Used to store predefined
Comment1 STRING 60 NO comment about a document.
Used to store predefined
Comment2 STRING 60 NO comment about a document.
Free formed by the user, used to
store user entered notes on a
Notes STRING 255 NO document
DepositAmtTaken DECIMAL 16,4 NO Obsolete
Used to indicate the source
DepositRefDocSid INTEGER 19 NO document for additional deposit
Reflects the total of the deposits
TotalDepositTaken DECIMAL 16,4 NO taken for all documents
Used to indicate the sid of the
subsidiary the document was
SubsidiarySid INTEGER 19 NO created in.
Used to indicate the sid of the
store the document was created
StoreSid INTEGER 19 NO in.
NotesGeneral STRING 255 NO General notes for the document
NotesOrder STRING 255 NO Order notes for the document
NotesSale STRING 255 NO Sale notes for the document
NotesReturn STRING 255 NO Return notes for the document
NotesLostdoc STRING 255 NO Lost sale notes for the document
The date that is reported as the
OrderedDate DATETIME NO ordered date for order items
The date after which order items
ShipDate DATETIME NO can no longer be fulfilled
CancelDate DATETIME NO Cancel date.
Flag to determine if the items
can be split across multiple
ShipPartial BOOLEAN NO shipments
The priority assigned to the
ShipPriority INTEGER 4 NO order 0=Low, 1=Medium, 2=High
TillSid INTEGER 19 NO Reference to the till sid.
CashierSid INTEGER 19 NO Reference to the cashier sid.
Employee1Sid INTEGER 19 NO Reference to the employee Sid.
Employee2Sid INTEGER 19 NO Reference to the employee Sid.
Employee3Sid INTEGER 19 NO Reference to the employee Sid.
Employee4Sid INTEGER 19 NO Reference to the employee Sid.
Employee5Sid INTEGER 19 NO Reference to the employee Sid.
ExchangeQty DECIMAL 10,3 NO Total exchange qty
Indicates what type of Discount
was applied to Sale/return part
of the Document: 0-initial value,
DiscountType INTEGER 1 NO 1-Discount Amt, 2-discount %

32
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Keeps the reference to the

RefOrderSid INTEGER 19 NO document to fulfill.
Document level discount
percentage for order items.
When not null, supersedes
OrderDiscPerc DECIMAL 16,4 NO disc_amt.
Document level discount
amount for order items. Used if
OrderDiscAmt DECIMAL 16,4 NO disc_perc is null.
OrderDiscountReasonName STRING 80 NO Discount reason for order items.
Indicates what type of Discount
was applied to order part of the
Document: 0-initial value, 1-
OrderDiscountType INTEGER 1 NO Discount Amt, 2-discount %
Flag to indicate that the
remaining amount of the due SO
SoCancelFlag BOOLEAN NO items are canceled
Total of the deposits used to
fulfill the order (the opposite to
TotalDepositUsed DECIMAL 16,4 NO total_deposit_taken)
OrderFeeAmt1 DECIMAL 16,4 NO Order fee amount
OrderFeeType1 INTEGER 4 NO Type of the order fee
OrderFeeName1 STRING 25 NO Name of the order fee
OrderFeeTaxPerc1 DECIMAL 16,4 NO Order fee tax %
Indicates if order fee tax is
OrderFeeTaxIncluded1 BOOLEAN NO included in fee amount
OrderFeeTaxAmt1 DECIMAL 16,4 NO Order fee tax amount
OrderShippingAmt DECIMAL 16,4 NO Order shipping amount
OrderShippingTaxPerc DECIMAL 16,4 NO Tax percentage of order shipping
Indicates if order shipping tax is
OrderShippingTaxIncluded BOOLEAN NO included in the shipping amount
OrderShippingTaxAmt DECIMAL 16,4 NO Order shipping tax amount
FeeType1Sid INTEGER 19 NO SID of fee type1 of the sale
SID of shipping (FEE_TYPE=9) of
ShippingSid INTEGER 19 NO the sale
OrderFeeType1Sid INTEGER 19 NO SID of fee type1 of the order
SID of shipping (FEE_TYPE=9) of
OrderShippingSid INTEGER 19 NO the order
OrderShippingPerc DECIMAL 16,4 NO Order shipping percentage
OrderDocNo INTEGER 9 NO Sales Order number
Amount of SO discount that has
UsedDiscAmt DECIMAL 16,4 NO been recorded on sale
Amount of SO subtotal that has
UsedSubtotal DECIMAL 16,4 NO been recorded on sales
Amount of SO tax that has been
UsedTax DECIMAL 17,5 NO recorded on sales

33
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Amount of SO Fee Amt 1 that

UsedFeeAmt1 DECIMAL 16,4 NO has been recorded on sales
Amount of SO Shipping that has
UsedShippingAmt DECIMAL 16,4 NO been recorded on sales
Flag to indicate if conditions
(price/qty/discounts/fee) Of the
order have changed. Default is
OrderChangedFlag BOOLEAN NO false.
Promotions: Global Discount was
PromoGdmandisc BOOLEAN NO modified manually
Indicates the store the
document was created at. This
differs from Store_SID as the
OriginalStoreSid INTEGER 19 NO store_SID can change over time.
ReceiptType INTEGER 2 NO 0-sale, 1-return, 2-deposit
0-customer order,
1-special order,
2-layaway,
3-store registry,
4-company registry,
5-web so,
OrderType INTEGER 2 NO 6-send sale
HasSale BOOLEAN NO Document has sale items
HasReturn BOOLEAN NO Document has return items
HasDeposit BOOLEAN NO Document has deposit
Text field describing the specific
OrderShipMethod STRING 20 NO shipping method
Stores the shipping method SID
OrderShipMethodSid INTEGER 19 NO from the SHIP_METHOD table
The ID of the specific shipping
method and backward
OrderShipMethodId INTEGER 4 NO compatible with V9
Stores description of how items
ShipMethod STRING 20 NO are shipped
Stores the shipping method SID
ShipMethodSid INTEGER 19 NO from the SHIP_METHOD table
The ID of the specific shipping
method and backward
ShipMethodId INTEGER 4 NO compatible with V9
SsCopy INTEGER 1 NO Send sales copy.
SsStatus INTEGER 3 NO Send sales status.
SsLastEvent DATETIME NO Send sales last event.
SsLastError STRING 500 NO Send sales last error.
Indicates that this document
SsFulfillment BOOLEAN NO fulfills send sale order.
DetaxAmt DECIMAL 17,5 NO Detax amount.

34
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Manually entered shipping

OrderShippingAmtManual DECIMAL 16,4 NO amount on document level
Manually entered shipping
ShippingAmtManual DECIMAL 16,4 NO amount on document level
Used to accumulate partial order
OrderShippingAmtManualUsed DECIMAL 16,4 NO shipping fulfillment
OrderTrackingNo STRING 24 NO Used to track shipping for orders
Indicates the Order Status: 0 =
Pending, 1 = Partial, 2 =
OrderStatus INTEGER 1 NO Complete
For recalculating or not
recalculating tax rebate when
you add/remove items from
document if tax rebate already
has been applied. {0/1/2}.
0=no tax rebate applied,
1=tax rebate applied,
TaxRebatePersisted INTEGER 1 YES 2=persisted tax rebate applied
ReturnSubtotal DECIMAL 16,4 NO Return subtotal.
ReturnSubtotalWithTax DECIMAL 17,5 NO Return subtotal with tax.
ReturnTax1Amt DECIMAL 17,5 NO Return tax1 amount.
ReturnTax2Amt DECIMAL 17,5 NO Return tax2 amount.
ReturnTotalTaxAmt DECIMAL 17,5 NO Return total tax amt.
Manually entered sale shipping
ShippingAmtManualBdt DECIMAL 16,4 NO amount before detaxation.
Manually entered order shipping
OrderShippingAmtManualBdt DECIMAL 16,4 NO amount before detaxation.
Sale fee amount before
FeeAmt1Bdt DECIMAL 16,4 NO detaxation.
Order fee amount before
OrderFeeAmt1Bdt DECIMAL 16,4 NO detaxation
Reference to the refund
RefundDocumentSid INTEGER 19 NO document Sid.
Order balance due from
RefOrderBalanceDue DECIMAL 16,4 NO reference document.
Order document number from
RefOrderOrderDocNo INTEGER 9 NO reference document.
Reference to the loyalty level
LtyLvlSid INTEGER 19 NO sid.
Loyalty program name used on
LtyPgmName STRING 40 NO the document.
Unique identifier of a Customer
Loyalty program applied towards
LtyPgmSid INTEGER 19 NO the Total Based Redeem type.
LtyStartBalance DECIMAL 24,8 NO Loyalty start balance.
LtyEndBalance DECIMAL 24,8 NO Loyalty end balance.
LtyRedeemAmt DECIMAL 16,4 NO Loyalty redeem amount.

35
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

LtyGiftAmt DECIMAL 16,4 NO Loyalty gift amount.

Loyalty percentage reward.
LtyPercRewardDiscPerc DECIMAL 16,4 NO (discount percentage).
Loyalty percentage reward
LtyPercRewardDiscAmt DECIMAL 16,4 NO discount amount.
0-notcommunicated,
1-Ok,
2-Failed,
3-resiliencyfailed,
4-tobereversed,
LtyCentralStatus INTEGER 1 NO 5-replicatedcopy
Unique identifier of a Customer
Loyalty program applied towards
the Percentage Reward redeem
LtyPgmSid2 INTEGER 19 NO type.
LtyPgmName2 STRING 40 NO Loyalty program name2.
Unique identifier of a Customer
Loyalty program applied towards
LtyPgmSid3 INTEGER 19 NO the Total Based Earn program.
LtyPgmName3 STRING 40 NO Loyalty program name 3.
LtyItemEarnPgmSid INTEGER 19 NO Loyalty Item earn program sid.
Loyalty items earn program
LtyItemEarnPgmName STRING 40 NO name.
Loyalty items redeem program
LtyItemRedeemPgmSid INTEGER 19 NO sid.
Loyalty items redeem program
LtyItemRedeemPgmName STRING 40 NO name.
LtyItemGiftPgmSid INTEGER 19 NO Loyalty item gift program sid.
LtyItemGiftPgmName STRING 40 NO Loyalty item gift program name.
Multiplier for Total based
LtyTotalRedeemMultiplier DECIMAL 16,8 NO redeem program.
Multiplier for Total based earn
LtyTotalEarnMultiplier DECIMAL 16,8 NO program.
Multiplier for Item based
LtyItemRedeemMultiplier DECIMAL 16,8 NO redeem program
Multiplier for Item based earn
LtyItemEarnMultiplier DECIMAL 16,8 NO program
To track precise sale discount
amounts without affecting total
tax calculations. Note that this
field is not spreadable, does not
affect calculation of total tax or
shipping amount, and is
independent from global
SaleTransDiscAmt DECIMAL 16,4 NO discount amount.

36
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

To track precise order discount

amounts without affecting total
tax calculations. Note that this
field is not spreadable, does not
affect calculation of total tax or
shipping amount, and is
independent from global
OrderTransDiscAmt DECIMAL 16,4 NO discount amount.
Amount of order transactional
discount that has been recorded
OrderTransDiscAmtUsed DECIMAL 16,4 NO on a sale.
The discount amount in base
currency applied by the Total
Based program to sale part of
LtySaleTotalBasedDisc DECIMAL 16,4 NO the document.
The discount amount in base
currency applied by the Total
Based program to order part of
LtyOrderTotalBasedDisc DECIMAL 16,4 NO the document.
The total of positive points
earned on the sale part of the
document either from the item
LtySaleEarnedPointsP DECIMAL 16,4 NO based or total based program.
The total of negative points
earned on the sale part of the
document either from the item
LtySaleEarnedPointsN DECIMAL 16,4 NO based or total based program.
The total of positive points
earned on the order part of the
document either from the item
LtyOrderEarnedPointsP DECIMAL 16,4 NO based or total based program.
The total of negative points
earned on the order part of the
document either from the item
LtyOrderEarnedPointsN DECIMAL 16,4 NO based or total based program.
The total of positive points used
to redeem items or applied to a
total based redeem program on
LtySaleUsedPointsP DECIMAL 16,4 NO the sale part of the document.
The total of negative points used
to redeem items or applied to a
total based redeem program on
LtySaleUsedPointsN DECIMAL 16,4 NO the sale part of the document.
The total of positive points used
to redeem items or applied to a
total based redeem program on
LtyOrderUsedPointsP DECIMAL 16,4 NO the order part of the document.

37
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

The total of negative points used

to redeem items or applied to a
total based redeem program on
LtyOrderUsedPointsN DECIMAL 16,4 NO the order part of the document.
FeeAmtReturned1 DECIMAL 16,4 NO Returned fee amount
Returned shipping amount
ShippingAmtManualReturned DECIMAL 16,4 NO (document level)
Referenced sale document
identifier (to return fee and
RefSaleSid INTEGER 19 NO shipping)
GiftReceiptType STRING 40 NO Gift receipt preferences
OrderDueDate DATETIME NO Due date for sales order
DocItem LIST NO DocItem list
DocTender LIST NO DocTender list
DocDeposit LIST NO DocDeposit list
DocDiscount LIST NO DocDiscount list
DocExtend LIST NO DocExtended list
DocCoupon LIST NO DocCoupon list
Unique employee identifier in
Rpro9. Used for reverse lookup
of the employee SID for data
Employee1Id INTEGER 9 NO coming from Rpro9
Unique employee identifier in
Rpro9. Used for reverse lookup
of the employee SID for data
Employee2Id INTEGER 9 NO coming from Rpro9
Unique employee identifier in
Rpro9. Used for reverse lookup
of the employee SID for data
Employee3Id INTEGER 9 NO coming from Rpro9
Unique employee identifier in
Rpro9. Used for reverse lookup
of the employee SID for data
Employee4Id INTEGER 9 NO coming from Rpro9
Unique employee identifier in
Rpro9. Used for reverse lookup
of the employee SID for data
Employee5Id INTEGER 9 NO coming from Rpro9
Unique employee identifier in
Rpro9. Used for reverse lookup
of the employee SID for data
CashierId INTEGER 9 NO coming from Rpro9
ControllerNo INTEGER 4 NO User defined database number.
CashierName STRING 8 NO Employee code.
Original cashier subsidiary
CashierOrigSbsNo INTEGER 4 NO number.
Employee1Name STRING 8 NO Employee code.

38
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Original employee 1 subsidiary

Employee1OrigSbsNo INTEGER 4 NO number.
Employee2Name STRING 8 NO Employee code.
Original employee 1 subsidiary
Employee2OrigSbsNo INTEGER 4 NO number.
Employee3Name STRING 8 NO Employee code.
Original employee 1 subsidiary
Employee3OrigSbsNo INTEGER 0 NO number.
Employee4Name STRING 8 NO Employee code.
Original employee 1 subsidiary
Employee4OrigSbsNo INTEGER 4 NO number.
Employee5Name STRING 8 NO Employee code.
Original employee 1 subsidiary
Employee5OrigSbsNo INTEGER 4 NO number.

DocCoupon list
The DocCoupon list file contains information related to the coupon used on the documents.
Data
Attribute Size ID Required Description
Type
DocSid INTEGER 19 YES Document Sid.
InOrOut INTEGER 1 NO 1 = In; 0 = Out; Default: 1
CouponCode STRING 75 YES Coupon code.
Applied BOOLEAN NO Applied
PromoSid INTEGER 19 NO Reference to the promotion Sid.
PromoName STRING 50 NO Promotion Name.
Coupon type
0 = Normal coupon
PromoCouponType INTEGER 1 NO 1 = Serialized coupon
PromoCouponSetID INTEGER 10 NO Serilized coupon set id.

39
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

DocDeposit list
The DocDeposit list contains information related to the deposit on sales orders.
Attribute Data Type Size ID Required Description
CreatedDatetime DATETIME YES Created date time.
PostDate DATETIME NO Postdate.
The document the deposit was
OrigDocSid INTEGER 19 YES added.
The document the deposit or
InvoiceDocSid INTEGER 19 YES part of the deposit was used
UsedDepositAmnt DECIMAL 16,4 NO The amount of the deposit used
Flags that this is a document that
affects the deposit balance (if =
1) and not the document that
DocDepositFlag BOOLEAN YES simply affects so items (if = 0)
Flags that the deposit amount on
the document was increased (if
DocDepositTaken BOOLEAN YES = 1) or decreased (if = 0).
UsedSubtotal DECIMAL 16,4 NO Stores the used subtotal amount
UsedTaxAmt DECIMAL 17,5 NO Stores used tax amount
UsedDiscAmt DECIMAL 16,4 NO Stores used discount amount
Stores used transfer discount
UsedTransDiscAmt DECIMAL 16,4 NO amount
UsedFeeAmt DECIMAL 16,4 NO Stores used fee amount.
UsedFeeTaxAmt DECIMAL 16,4 NO Stores used fee tax amount.
Stores used shipping fee
UsedShippingAmt DECIMAL 16,4 NO amount.
Stores used shipping tax
UsedShippingTaxAmt DECIMAL 16,4 NO amount.
TakenDepositAmt DECIMAL 16,4 NO Taken deposit amount.

40
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

DocDiscount list
The DocDiscount list contains information related to the discount on the document level.
Data
Attribute Size ID Required Description
Type
DocSid INTEGER 19 YES YES Reference to document Sid.
0-anypos,
1-Sale,
2-Order,
DiscCategory INTEGER 4 YES YES 3-Other
30-manual,
DiscSource INTEGER 4 YES YES 40-promotion
DiscPos INTEGER 4 YES YES Position among similar discounts
0-Price,
1-discperc,
2-discamt,
DiscType INTEGER 4 YES 3-forceprice
DiscValue DECIMAL 16,4 YES Discount value.
DiscReason STRING 80 NO Discount reason.
PrevSubtotalWDisc DECIMAL 16,4 YES Previous subtotal with discount.
NewSubtotalWDisc DECIMAL 16,4 NO New subtotal with discount.
NewDiscAmt DECIMAL 16,4 NO New discount amount.
NewDiscPerc DECIMAL 16,4 NO New discount percentage.
Uncapped value entered
DiscOrigValue DECIMAL 16,4 YES originally.
DiscPromoName STRING 50 NO Discount promo name.
DiscPromoGroup STRING 50 NO Discount promo group.

41
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

DocExtended list
The DocExtended list contains information related to the additional user define values on a document.
Attribute Data Type Size ID Required Description
DocSid INTEGER 19 YES YES Reference to document record
Udf6String STRING 50 NO User defined value
Udf7String STRING 50 NO User defined value
Udf8String STRING 50 NO User defined value
Udf9String STRING 50 NO User defined value
Udf10String STRING 50 NO User defined value
Udf6Float DECIMAL 16,4 NO User defined numeric value
Udf7Float DECIMAL 16,4 NO User defined numeric value
Udf8Float DECIMAL 16,4 NO User defined numeric value
Udf9Float DECIMAL 16,4 NO User defined numeric value
Udf10Float DECIMAL 16,4 NO User defined numeric value
Udf4Date DATETIME NO User defined date value
Udf5Date DATETIME NO User defined date value
Udf6Date DATETIME NO User defined date value
Udf2Clob STRING 50 NO User defined clob value
Note1 STRING 350 NO Note1
Note2 STRING 350 NO Note2
Note3 STRING 350 NO Note3

[Link]
The DocItem list contains information related to the items on the document.
Attribute Data Type Len. ID Req. Description
DocSid INTEGER 19 YES DocSid
ItemPos INTEGER 4 YES YES ItemPos
References to INVN_SBS_ITEM
InvnSbsItemSid INTEGER 19 YES table SID
DetaxFlag BOOLEAN YES DetaxFlag
The commit state of central
returns:0=NotCommunicated, 1-
RegisteredWithCentrals,
2=CommitedWhenDocFinalized,
3=CommitedByResiliency,
KitFlag INTEGER 1 YES 4=AReplicatedCopy
PromotionFlag BOOLEAN YES PromotionFlag
GiftAddValue BOOLEAN YES GiftAddValue
Archived INTEGER 1 YES Archived
StPrimary BOOLEAN YES StPrimary
StoreNo INTEGER 4 YES StoreNo
CommCode INTEGER 4 NO CommCode
StPriceLvl INTEGER 4 NO StPriceLvl
Qty DECIMAL 10,3 NO Qty
OrigPrice DECIMAL 16,4 NO OrigPrice
OrigTaxAmt DECIMAL 16,4 NO OrigTaxAmt

42
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Price DECIMAL 16,4 NO Price

TaxPerc DECIMAL 16,4 NO TaxPerc
TaxAmt DECIMAL 17,5 NO TaxAmt
Tax2Perc DECIMAL 16,4 NO Tax2Perc
Tax2Amt DECIMAL 17,5 NO Tax2Amt
PriceBeforeDetax DECIMAL 16,4 NO PriceBeforeDetax
OrigPriceBeforeDetax DECIMAL 16,4 NO OrigPriceBeforeDetax
Cost DECIMAL 16,4 NO Cost
Spif DECIMAL 16,4 NO Spif
ScheduleNo INTEGER 4 NO ScheduleNo
ScanUpc INTEGER 18 NO ScanUpc
SerialNo STRING 25 NO SerialNo
References to INVN_SBS_ITEM
PackageInvnSbsItemSid INTEGER 19 NO table SID
References to INVN_SBS_ITEM
OrigCmpntInvnSbsItemSid INTEGER 19 NO table SID
UserDiscPerc DECIMAL 16,4 NO UserDiscPerc
PackageSequenceNo INTEGER 4 NO PackageSequenceNo
LotNo STRING 25 NO LotNo
ActivityPerc DECIMAL 16,4 NO ActivityPerc
Activity2Perc DECIMAL 16,4 NO Activity2Perc
Activity3Perc DECIMAL 16,4 NO Activity3Perc
Activity4Perc DECIMAL 16,4 NO Activity4Perc
Activity5Perc DECIMAL 16,4 NO Activity5Perc
CommAmt DECIMAL 16,4 NO CommAmt
Comm2Amt DECIMAL 16,4 NO Comm2Amt
Comm3Amt DECIMAL 16,4 NO Comm3Amt
Comm4Amt DECIMAL 16,4 NO Comm4Amt
Comm5Amt DECIMAL 16,4 NO Comm5Amt
ItemOrigin INTEGER 1 NO ItemOrigin
PackageNo STRING 20 NO PackageNo
ShipId INTEGER 9 NO ShipId
OrigCost DECIMAL 16,4 NO OrigCost
GiftActivationCode STRING 26 NO GiftActivationCode
GiftTransactionId STRING 26 NO GiftTransactionId
CustField STRING 47 NO CustField
Udf1String STRING 50 NO Udf1String
Udf2String STRING 50 NO Udf2String
Udf3String STRING 50 NO Udf3String
Udf4String STRING 50 NO Udf4String
Udf5String STRING 50 NO Udf5String
Udf1Float DECIMAL 16,4 NO Udf1Float
Udf2Float DECIMAL 16,4 NO Udf2Float
Udf3Float DECIMAL 16,4 NO Udf3Float
DiscPerc DECIMAL 16,4 NO DiscPerc
Used in Item note mapping
Note1 STRING 350 NO document preference

43
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Used in Item note mapping

Note2 STRING 350 NO document preference
Used in Item note mapping
Note3 STRING 350 NO document preference
Used in Item note mapping
Note4 STRING 350 NO document preference
Used in Item note mapping
Note5 STRING 350 NO document preference
Used in Item note mapping
Note6 STRING 350 NO document preference
Used in Item note mapping
Note7 STRING 350 NO document preference
Used in Item note mapping
Note8 STRING 350 NO document preference
Used in Item note mapping
Note9 STRING 350 NO document preference
Used in Item note mapping
Note10 STRING 350 NO document preference
Item level discount amount.
DiscAmt DECIMAL 16,4 NO Used if disc_perc is null.
Item type placed on the
document. A single document
can carry items from sale, return
or orders1-Sale,2-Return,3-
ItemType INTEGER 1 NO Order,4-Exchange
Used for historical purposes
only. Records original DCS Code
for the item at the time the
DcsCode STRING 9 NO document was created.
Used for historical purposes
only. Records original Vendor
Code for the item at the time the
VendCode STRING 6 NO document was created.
Used for historical purposes
only. Records original
Description1 for the item at the
Description1 STRING 30 NO time the document was created.
Used for historical purposes
only. Records original
Description2 for the item at the
Description2 STRING 30 NO time the document was created.
Used for historical purposes
only. Records original
Description3 for the item at the
Description3 STRING 30 NO time the document was created.

44
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Used for historical purposes

only. Records original
Description4 for the item at the
Description4 STRING 30 NO time the document was created.
Used for historical purposes
only. Records original Attribute
for the item at the time the
Attribute STRING 8 NO document was created.
Used for historical purposes
only. Records original Item Size
for the item at the time the
ItemSize STRING 8 NO document was created.
Used for historical purposes
only. Records original ALU for
the item at the time the
Alu STRING 20 NO document was created.
TaxCode STRING 5 NO TaxCode
TaxCode2 STRING 5 NO TaxCode2
CommLvl STRING 1 NO CommLvl
CommPerc DECIMAL 16,4 NO CommPerc
StAddressLine1 STRING 40 NO StAddressLine1
StAddressLine2 STRING 40 NO StAddressLine2
StAddressLine3 STRING 40 NO StAddressLine3
StAddressLine4 STRING 40 NO StAddressLine4
StAddressLine5 STRING 40 NO StAddressLine5
StAddressLine6 STRING 40 NO StAddressLine6
StCountry STRING 35 NO StCountry
StPostalCode STRING 10 NO StPostalCode
StPostalCodeExtension STRING 5 NO StPostalCodeExtension
keeps the login name of clerk 2
Employee1LoginName STRING 20 NO who created the document
keeps the full name of clerk 2
Employee1FullName STRING 60 NO who created the document
keeps the login name of clerk 3
Employee2LoginName STRING 20 NO who created the document
keeps the full name of clerk 3
Employee2FullName STRING 60 NO who created the document
keeps the login name of clerk 4
Employee3LoginName STRING 20 NO who created the document
keeps the full name of clerk 4
Employee3FullName STRING 60 NO who created the document
keeps the login name of clerk 5
Employee4LoginName STRING 20 NO who created the document
keeps the full name of clerk 5
Employee4FullName STRING 60 NO who created the document
keeps the login name of clerk 6
Employee5LoginName STRING 20 NO who created the document

45
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

keeps the full name of clerk 6

Employee5FullName STRING 60 NO who created the document
keeps the ship to customer
StCuid INTEGER 19 NO unique identifier for the item
StId INTEGER 9 NO StId
StCompanyName STRING 100 NO StCompanyName
StLastName STRING 30 NO StLastName
StFirstName STRING 30 NO StFirstName
StTitle STRING 15 NO StTitle
StTaxAreaName STRING 11 NO StTaxAreaName
StTaxArea2Name STRING 11 NO StTaxArea2Name
StPriceLvlName STRING 6 NO StPriceLvlName
StDetaxFlag BOOLEAN NO StDetaxFlag
StPrimaryPhoneNo STRING 30 NO StPrimaryPhoneNo
DiscountReason STRING 80 NO DiscountReason
0-CustomerOrder,1-
SpecialOrder,2-LayAway,3-
StoreRegistry,4-
CompanyRegistry,5-
OrderType INTEGER 4 NO WebOrder,6-SendSale
StEmail STRING 100 NO StEmail
SoNumber INTEGER 14 NO SoNumber
stores description of how the
ShipMethod STRING 20 NO item is shipped
ShipAmt DECIMAL 16,4 NO ShipAmt
HistDiscAmt1 DECIMAL 16,4 NO HistDiscAmt1
HistDiscPerc1 DECIMAL 16,4 NO HistDiscPerc1
HistDiscReason1 STRING 80 NO HistDiscReason1
HistDiscAmt2 DECIMAL 16,4 NO HistDiscAmt2
HistDiscPerc2 DECIMAL 16,4 NO HistDiscPerc2
HistDiscReason2 STRING 80 NO HistDiscReason2
HistDiscAmt3 DECIMAL 16,4 NO HistDiscAmt3
HistDiscPerc3 DECIMAL 16,4 NO HistDiscPerc3
HistDiscReason3 STRING 80 NO HistDiscReason3
HistDiscAmt4 DECIMAL 16,4 NO HistDiscAmt4
HistDiscPerc4 DECIMAL 16,4 NO HistDiscPerc4
HistDiscReason4 STRING 80 NO HistDiscReason4
HistDiscAmt5 DECIMAL 16,4 NO HistDiscAmt5
HistDiscPerc5 DECIMAL 16,4 NO HistDiscPerc5
HistDiscReason5 STRING 80 NO HistDiscReason5
date and time row was
created/last modified in this
system. may not be the same as
PostDate DATETIME NO created/modified datetime.
Udf1Date DATETIME NO Udf1Date
PriceLvl INTEGER 4 NO PriceLvl
PriceLvlName STRING 6 NO PriceLvlName

46
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

StSecurityLvl INTEGER 4 NO StSecurityLvl

stores a tracking number of the
TrackingNo STRING 24 NO item shipment
Used to record inventory Item
InventoryItemType INTEGER 1 NO type Kit, Package etc.
Used to record OH qty at the
InventoryOhQty DECIMAL 10,3 NO time the document is created
InventoryQtyPerCase DECIMAL 10,3 NO InventoryQtyPerCase
SbsNo INTEGER 4 YES SbsNo
Quantity returned by customer
ReturnedItemQty DECIMAL 10,3 NO against original receipt
Refers to the invoice sid from
ReturnedItemInvoiceSid INTEGER 19 NO the original receipt
reason the item is being
ReturnReason STRING 80 NO returned
PriceLvlSid INTEGER 19 NO Reference to the price level
quantity of an order item that
OrderQuantityFilled DECIMAL 10,3 NO has already been filled
GiftQuantity DECIMAL 10,3 NO Quantity for gift receipt
stores calculated minimum
deposit amount for the item
based on the item price, so item
SoDepositAmt DECIMAL 16,4 NO type and preferences.
keeps the reference to the item
RefOrderItemSid INTEGER 19 NO on ref. document to fulfill.
TaxAreaName STRING 11 NO TaxAreaName
TaxArea2Name STRING 11 NO TaxArea2Name
serial-type from V9
invn_sbs.ext_flag.(V9 ext-flag
contains serial-type and lot-
SerialType INTEGER 1 NO type).0-None,1-Partial,2-Full.
lot-type from V9
invn_sbs.ext_flag.(V9 ext-flag
contains serial-type and lot-
LotType INTEGER 1 NO type).
Flag to indicate this item will be
SendSaleFlag BOOLEAN NO fulfilled at an alternate location.
The sbs no of the store that will
FulfillStoreNo INTEGER 4 NO fulfill a send sale request.
The SID of the store that will
FulfillStoreSid INTEGER 19 NO fulfill a send sale request.
the sbs no for the store that will
FulfillSbsNo INTEGER 4 NO fulfill a send sale request.
Flag to indicate that the
remaining amount of the due SO
SoCancelFlag BOOLEAN NO items are canceled

47
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

a reference to the central

CentralDocumentSid INTEGER 19 NO document this item relates to
the position of this item on a
CentralItemPos INTEGER 4 NO central document
Employee1Sid INTEGER 19 NO Employee1Sid
Employee2Sid INTEGER 19 NO Employee2Sid
Employee3Sid INTEGER 19 NO Employee3Sid
Employee4Sid INTEGER 19 NO Employee4Sid
Employee5Sid INTEGER 19 NO Employee5Sid
DipPrice DECIMAL 16,4 NO Final virtual price of the item
DipDiscAmt DECIMAL 16,4 NO Final virtual discount of the item
Final virtual tax amount of the
DipTaxAmt DECIMAL 17,5 NO item
Final virtual tax2 amount of the
DipTax2Amt DECIMAL 17,5 NO item
ItemStatus INTEGER 1 YES 1 = incomplete package, 0 = valid
Logical sort order in which
items/Pkgs/Components etc. are
to be displayed, so that pkg
components appear right after
EnhancedItemPos INTEGER 9 NO pkg header.
0 ?package component is not
competing, 1 - package
IsCompetingComponent BOOLEAN NO component is competing.
Promotions: Discount was
PromoMandisc BOOLEAN NO modified manually
Stores the shipping method SID
ShipMethodSid INTEGER 19 NO from the SHIP_METHOD table
The ID of the specific shipping
method and backward
ShipMethodId INTEGER 19 NO compatible with V9
Stores the shipping method SID
OrderShipMethodSid INTEGER 19 NO from the SHIP_METHOD table
The ID of the specific shipping
method and backward
OrderShipMethodId INTEGER 4 NO compatible with V9
Text field describing the specific
OrderShipMethod STRING 20 NO shipping method
lock tax percentage (1=Enable,
TaxPercLock BOOLEAN NO 0=Disable)
quantity of referenced sale item
QtyAvailableForReturn DECIMAL 10,3 NO that still available for return

48
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

The commit state of central

returns:
0=NotCommunicated,
1-RegisteredWithCentrals,
2=CommitedWhenDocFinalized,
3=CommitedByResiliency,
CentralReturnCommitState INTEGER 1 NO 4=AReplicatedCopy
InvnUseQtyDecimals INTEGER 1 NO InvnUseQtyDecimals
shipping amount before
ShipAmtBdt DECIMAL 16,4 NO detaxation
TaxCodeRuleSid INTEGER 19 NO TaxCodeRuleSid
TaxCodeRule2Sid INTEGER 19 NO TaxCodeRule2Sid
refers to customer address that
is used for shipping, not
StAddressUid INTEGER 19 NO enforced at database
original sale price of returned
OrigSalePrice DECIMAL 16,4 NO item
LtyPgmSid INTEGER 19 NO LtyPgmSid
LtyPgmName STRING 40 NO LtyPgmName
LtyPointsEarned DECIMAL 24,8 NO LtyPointsEarned
LtyOrigPointsEarned DECIMAL 24,8 NO LtyOrigPointsEarned
LtyPriceInPoints DECIMAL 24,8 NO LtyPriceInPoints
LtyOrigPriceInPoints DECIMAL 24,8 NO LtyOrigPriceInPoints
LtyType INTEGER 1 NO 1 - earn, 2 - redeem, 3 - reward.
Virtual value: proportional piece
of loyalty points earned by Total
LtyPieceOfTbePoints DECIMAL 16,4 NO Base Earn program.
Virtual value: proportional piece
of loyalty points redeemed by
LtyPieceOfTbrPoints DECIMAL 16,4 NO Total Base Redeem program.
Virtual value: proportional piece
of transaction discount received
by applying Total Base Redeem
LtyPieceOfTbrDiscAmt DECIMAL 16,4 NO program.
additional data that is needed
Eftdata1 STRING 32 NO for printing on the invoice
additional data that is needed
Eftdata2 STRING 32 NO for printing on the invoice
additional data that is needed
Eftdata3 STRING 32 NO for printing on the invoice
additional data that is needed
Eftdata4 STRING 32 NO for printing on the invoice
additional data that is needed
Eftdata5 STRING 32 NO for printing on the invoice
additional data that is needed
Eftdata6 STRING 32 NO for printing on the invoice

49
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

additional data that is needed

Eftdata7 STRING 32 NO for printing on the invoice
additional data that is needed
Eftdata8 STRING 32 NO for printing on the invoice
additional data that is needed
Eftdata9 STRING 32 NO for printing on the invoice
additional data that is needed
Eftdata0 STRING 2001 NO for printing on the invoice
additional data that is needed
Eftdata11 STRING 32 NO for printing on the invoice
additional data that is needed
Eftdata12 STRING 32 NO for printing on the invoice
additional data that is needed
Eftdata13 STRING 32 NO for printing on the invoice
additional data that is needed
Eftdata14 STRING 32 NO for printing on the invoice
additional data that is needed
Eftdata15 STRING 32 NO for printing on the invoice
additional data that is needed
Eftdata16 STRING 32 NO for printing on the invoice
additional data that is needed
Eftdata17 STRING 32 NO for printing on the invoice
additional data that is needed
Eftdata18 STRING 32 NO for printing on the invoice
additional data that is needed
Eftdata19 STRING 32 NO for printing on the invoice
additional data that is needed
Eftdata10 STRING 2001 NO for printing on the invoice
EftdataBSMer STRING 2001 NO Merchant Receipt text
EftdataBSCust STRING 2001 NO Customer Receipt text
pre-auth will provide this if card
ActivationSid INTEGER 19 NO was previously activated
last time card action was
authorized (can check if request
AuthorizeDate DATETIME NO is stale/old)
GiftExpireDate DATETIME NO Expire date of Central Gift Card
PromoGiftItem INTEGER 1 YES Item is used for promo gift item
DocItemDiscount LIST NO
Unique employee identifier in
Rpro9. Used for reverse lookup
of the employee SID for data
Employee1Id INTEGER 9 NO coming from Rpro9
Unique employee identifier in
Rpro9. Used for reverse lookup
of the employee SID for data
Employee2Id INTEGER 9 NO coming from Rpro9

50
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Unique employee identifier in

Rpro9. Used for reverse lookup
of the employee SID for data
Employee3Id INTEGER 9 NO coming from Rpro9
Unique employee identifier in
Rpro9. Used for reverse lookup
of the employee SID for data
Employee4Id INTEGER 9 NO coming from Rpro9
Unique employee identifier in
Rpro9. Used for reverse lookup
of the employee SID for data
Employee5Id INTEGER 9 NO coming from Rpro9
Reference to the inventory Item
InvnSbsItemUID INTEGER 19 NO SID.
OrigCmpntInvnSbsItemUID INTEGER 19 NO ItemUID
Reference to the package
PackageInvnSbsItemUID INTEGER 19 NO inventory item SID.
StAddressSeqNo INTEGER 4 NO SeqNo
RefOrderItemDocSid INTEGER 19 NO DocSid
RefOrderInternalItemPos INTEGER 4 NO DocSid
ReturnedItemInvoiceDocSid INTEGER 0 NO DocSid
ReturnedItemInvoiceItemPos INTEGER 0 NO ItemPos
Employee1Name STRING 8 NO employee code.
Employee original subsidiary
Employee1OrigSbsNo INTEGER 4 NO Number.
Employee2Name STRING 8 NO Employee code.
Employee original subsidiary
Employee2OrigSbsNo INTEGER 4 NO Number.
Employee3Name STRING 8 NO Employee code.
Employee original subsidiary
Employee3OrigSbsNo INTEGER 4 NO Number.
Employee4Name STRING 8 NO Employee code.
Employee original subsidiary
Employee4OrigSbsNo INTEGER 4 NO Number.
Employee5Name STRING 8 NO Employee code.
Employee original subsidiary
Employee5OrigSbsNo INTEGER 4 NO Number.
InternalItemPos INTEGER 4 NO InternalItemPos
ReturnedItemInvoice
InternalItemPos INTEGER 4 NO InternalItemPos

51
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

DocItemDiscount list
The DocItemDiscount list contains information related to the discounts on the item level.
Data
Attribute Size ID Required Description
Type
DocItemSid INTEGER 19 YES YES Reference to document item
SpreadDocDiscSid INTEGER 19 NO Ref to spread GD
0 - native item discount
Spread INTEGER 1 YES 1 - from GD.
0-pl,
10-qty pricing,
20-customer,
30-manual,
40-promotion,
DiscSource INTEGER 4 YES 50-package
DiscPos INTEGER 4 YES YES Position among similar discounts.
0 - price.
1 - disc perc.
2 - disc amt.
DiscType INTEGER 4 YES 3 - force price
DiscValue DECIMAL 16,4 YES Discount value.
0 - not locked,
1 - locked for fulfilling item, 2 -
LockType INTEGER 4 YES locked for return item
DiscReason STRING 80 NO Discount reason.
PrevPrice DECIMAL 16,4 YES Previous price.
NewPrice DECIMAL 16,4 NO New price.
NewDiscAmt DECIMAL 16,4 NO New unit discount.
NewDiscPerc DECIMAL 16,4 NO New discount percentage.
NewTaxPerc DECIMAL 16,4 NO New tax percentage.
Uncapped value entered
DiscOrigValue DECIMAL 16,4 YES originally.
DiscPromoName STRING 50 NO Discount promo name.
DiscPromoGroup STRING 50 NO Discount promo group.

52
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

DocTender list
The DocTender list contains information related to the tenders on the document.
Data
Attribute Size ID Required Description
Type
DocSid INTEGER 19 YES YES Reference to document record
Type of tender, as defined in v9.
0-Cash,
1-Check,
2-creditcard,
3-COD,
4-Charge,
5-storecredit,
6-Split,
7-Deposit,
8-Payments,
9-giftcertificate,
10-giftcard,
11-debitcard,
12-foreigncurrency,
13-travelercheck,
14-foreigncheck,
15-centralgiftcard,
TenderType INTEGER 2 YES YES 16-centralgiftcertific
TenderPos INTEGER 4 YES YES Position within this tender type.
Amount of this tender. Must be
Amount DECIMAL 16,4 YES difference of taken and given
Taken DECIMAL 16,4 YES Amount taken from customer.
Amount given back to customer
Given DECIMAL 16,4 YES as change.
Used by the xzout application to
mark an invoice tender record as
being matched to tender in the
workstation/drawer being
Matched BOOLEAN YES counted.
Contains the current state of
each tender in relation to eft
resiliency. It will be populated
with one of the following
values.0 = tender processed
online normal1 = manual offline
pending processing2 = auto
offline pending processing3 =
EftResTenderState INTEGER 4 NO performing process
Can be used to store
ManualName STRING 80 NO customization text
Override comment. Also used to
ManualRemark STRING 40 NO store customization free text.

53
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Base currency. Reference to

CurrencySid INTEGER 19 YES currency record
Used for historical purposes only.
Records original currency name
of the currency_sid at the time
CurrencyName STRING 30 NO the record was created.
Keeps the tender name, cannot
TenderName STRING 25 NO be modified by the end user
Foreign currency taken exchange
TakeRate DECIMAL 16,4 NO rate.
Foreign currency given exchange
GiveRate DECIMAL 16,4 NO rate.
TenderCentralGiftCard LIST NO TenderCentralGiftCard list
TenderCentralStoreCredit LIST NO TenderCentralStoreCredit list
TenderCharge LIST NO TenderCharge list
TenderCheck LIST NO TenderCheck list
TenderCreditCard LIST NO TenderCreditCard list
TenderDebitCard LIST NO TenderDebitCard list
TenderForeignCheck LIST NO TenderForeignCheck list
TenderForeignCurrency LIST NO TenderForeignCurrency list
TenderGiftCard LIST NO TenderGiftCard list
TenderGiftCertificate LIST NO TenderGiftCertificate list
TenderStoreCredit LIST NO TenderStoreCredit list
TenderPayments LIST NO TenderPayments list
TenderTravelerCheck LIST NO TenderTravelerCheck list
3 letter alphabetic currency code
CurrencyAlphaCode STRING 3 NO as defined by ISO 4217
CurrencyDictName STRING 30 NO Currency name.

TenderCentralGiftCard list
The TenderCentralGisftCard list contains information related to the central gift cards used to tender a
document.
Data
Attribute Size ID Required Description
Type
TenderSid INTEGER 19 YES YES Tender Sid
CentralPaymentId STRING 30 NO Central transaction ID
CentralActivationId STRING 30 NO Central Card Activation ID
The identifying portion of the
CentralCardNumber STRING 30 NO card for reference
CentralCreditBalance DECIMAL 16,4 NO New Card Balance
Used to indicate that the
transaction was performed
offline and that it will need to be
committed after it is transmitted.
0= false,
CentralCommitState INTEGER 1 NO anything else is true

54
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

TenderCentralStoreCredit list
The TenderCentralStoreCredit list contains information related to the central store credits used to tender a
document.
Data
Attribute Size ID Required Description
Type
TenderSid INTEGER 19 YES YES Tender Sid
CentralPaymentId STRING 30 NO Central transaction ID
CentralCreditBalance DECIMAL 16,4 NO Store Credit balance remaining
Used to indicate that the
transaction was performed
offline and that it will need to be
committed after it is transmitted.
0= false,
CentralCommitState INTEGER 1 NO Anything else is true
RedeemCreditId STRING 30 NO Id of credit redeemed by id
Id of credit created in during this
NewCreditId STRING 30 NO operation
Value of credit created in during
NewCreditValue DECIMAL 16,4 NO this operation

TenderCharge list
The TenderCharge list contains information related to charges used to tender a document.
Data
Attribute Size ID Required Description
Type
TenderSid INTEGER 19 YES YES Reference to tender record
ChargeNetDays INTEGER 9 NO Terms of charge, net days
ChargeDiscDays INTEGER 9 NO Terms of charge, discount days
Terms of charge, amount
discounted if paid before end of
ChargeDiscPerc DECIMAL 16,4 NO discount days.

55
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

TenderCheck list
The TenderCheck list contains information related to the checks used to tender a document.
Attribute Data Type Size ID Required Description
Reference to document tender
TenderSid INTEGER 19 YES YES record
0 = personal,
CheckType INTEGER 1 NO 1 = commercial
CheckNo STRING 10 NO Check number
If a business check, then the
Company STRING 25 NO company name is placed here
FirstName STRING 30 NO First name as it appears on check
LastName STRING 30 NO Last name as it appears on check
WorkPhone STRING 30 NO Customer work phone
HomePhone STRING 30 NO Customer home phone
State STRING 5 NO State of issue
Customer Driver License
DriversLicense STRING 30 NO number.
Expiration of customer? Driver?
DriversLicenseExpiration DATETIME NO License
DateOfBirth DATETIME NO Customer Date of birth
For eft tenders, this is the
authorization value returned by
the eft processor for successful
authorizations. Included here
AuthCode STRING 20 NO for lookup purposes.
The record id returned from gate
EftTransactionId STRING 32 NO for eft transaction.
AVS response code from
AvsResponseCode STRING 4 NO processor.
Error message returned for
FailureMessage STRING 64 NO failed transactions.
Additional data that is needed
Eftdata1 STRING 32 NO for printing on the invoice
Additional data that is needed
Eftdata2 STRING 32 NO for printing on the invoice.
Additional data that is needed
Eftdata3 STRING 32 NO for printing on the invoice.
Additional data that is needed
Eftdata4 STRING 32 NO for printing on the invoice.
Additional data that is needed
Eftdata5 STRING 32 NO for printing on the invoice.
Additional data that is needed
Eftdata6 STRING 32 NO for printing on the invoice.
Additional data that is needed
Eftdata7 STRING 32 NO for printing on the invoice.
Additional data that is needed
Eftdata8 STRING 32 NO for printing on the invoice

56
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Additional data that is needed

Eftdata9 STRING 32 NO for printing on the invoice
Additional data that is needed
Eftdata0 STRING 2001 NO for printing on the invoice
The method the user wishes to
run the card in, 0-EFT Device,1-
EntryMethod INTEGER 0 NO Inline MSR,2-Keyed Entry
Additional data that is needed
Eftdata11 STRING 32 NO for printing on the invoice
Additional data that is needed
Eftdata12 STRING 32 NO for printing on the invoice
Additional data that is needed
Eftdata13 STRING 32 NO for printing on the invoice
Additional data that is needed
Eftdata14 STRING 32 NO for printing on the invoice
Additional data that is needed
Eftdata15 STRING 32 NO for printing on the invoice
Additional data that is needed
Eftdata16 STRING 32 NO for printing on the invoice
Additional data that is needed
Eftdata17 STRING 32 NO for printing on the invoice
Additional data that is needed
Eftdata18 STRING 32 NO for printing on the invoice
Additional data that is needed
Eftdata19 STRING 32 NO for printing on the invoice
Additional data that is needed
Eftdata10 STRING 2001 NO for printing on the invoice
EftdataBSMer STRING 2001 NO Merchant Receipt text
EftdataBSCust STRING 2001 NO Customer Receipt text

TenderCreditCard list
The TenderCreditCard list contains information related to the credit cards used to tender a document.
Data
Attribute Size ID Required Description
Type
Reference to document tender
TenderSid INTEGER 19 YES YES record
CardNo STRING 30 NO Credit card number
Reference to credit_card_type
CardTypeSid INTEGER 19 NO record
CardHolderName STRING 32 NO Name on credit card
CardExpMonth INTEGER 4 NO Month portion of expiration date.
CardExpYear INTEGER 9 NO Year portion of expiration date
Indicates this is a normal sale.
This value can be altered by plug-
ins to reflect exceptions in
IsNormalSale BOOLEAN YES processing tenders.

57
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Was the card present or was the

number communicated without
IsPresent BOOLEAN YES the card?
CardPostalCode STRING 10 NO Billing zip code.
For eft tenders, this is the
authorization value returned by
the eft processor for successful
authorizations. Included here for
AuthCode STRING 20 NO lookup purposes.
The record id returned from gate
EftTransactionId STRING 32 NO for eft transaction.
AVS response code from
AvsResponseCode STRING 4 NO processor.
Result code for commercial card
L2ResultCode STRING 1 NO processing.
Error message returned for failed
FailureMessage STRING 64 NO transactions.
Additional data that is needed for
Eftdata1 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata2 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata3 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata4 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata5 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata6 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata7 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata8 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata9 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata0 STRING 2001 NO printing on the invoice
Additional fee assessed by
CardProcessingFee DECIMAL 16,4 NO processor.
Point array information returned
from Sigcap device. Stored as an
SignatureMap BLOB NO array of integer tuples.
The method the user wishes to
run the card in,
0-EFT Device,
1-Inline MSR,
EntryMethod INTEGER 1 NO 2-Keyed Entry

58
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Whether it is Visa, mastercard,

CardTypeName STRING 30 NO Discover, etc.
EmvAiAid STRING 200 NO Emvaiaid
EmvAiApplabel STRING 200 NO Emvaiapplabel
EmvCiCardexpirydate STRING 200 NO Emvcicardexpirydate
EmvCryptoCryptogramtype STRING 200 NO Emvcryptocryptogramtype
EmvCryptoCryptogram STRING 200 NO Emvcryptocryptogram
EmvPinstatement STRING 200 NO Emvpinstatement
Additional data that is needed for
Eftdata11 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata12 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata13 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata14 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata15 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata16 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata17 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata18 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata19 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata10 STRING 2001 NO printing on the invoice
EftdataBSMer STRING 2001 NO Merchant Receipt text
EftdataBSCust STRING 2001 NO Customer Receipt text

59
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

[Link]
The TenderDebitCard list contains information related to the debit cards used to tender a document.

Data
Attribute Size ID Required Description
Type
Reference to document tender
TenderSid INTEGER 19 YES YES record
CardNo STRING 30 NO Debit card number
Was the card present or was the
number communicated without
IsCardPresent BOOLEAN YES the card?
For eft tenders, this is the
authorization value returned by
the eft processor for successful
authorizations. Included here for
AuthCode STRING 20 NO lookup purposes.
The record id returned from gate
EftTransactionId STRING 32 NO for eft transaction.
Avs response code from
AvsResponseCode STRING 4 NO processor
Result code for commercial card
L2ResultCode STRING 1 NO processing
Error message returned for failed
FailureMessage STRING 64 NO transactions.
Additional data that is needed for
Eftdata1 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata2 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata3 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata4 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata5 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata6 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata7 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata8 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata9 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata0 STRING 2001 NO printing on the invoice
The method the user wishes to
run the card in, 0-EFT Device,1-
EntryMethod INTEGER 0 NO Inline MSR,2-Keyed Entry

60
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

EmvAiAid STRING 200 NO Emvaiaid

EmvAiApplabel STRING 200 NO Emvaiapplabel
EmvCiCardexpirydate STRING 200 NO Emvcicardexpirydate
EmvCryptoCryptogramtype STRING 200 NO Emvcryptocryptogramtype
EmvCryptoCryptogram STRING 200 NO Emvcryptocryptogram
EmvPinstatement STRING 200 NO Emvpinstatement
Additional data that is needed for
Eftdata11 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata12 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata13 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata14 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata15 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata16 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata17 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata18 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata19 STRING 32 NO printing on the invoice
Additional data that is needed for
Eftdata10 STRING 2001 NO printing on the invoice
EftdataBSMer STRING 2001 NO Merchant Receipt text
EftdataBSCust STRING 2001 NO Customer Receipt text

61
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

[Link]
The TenderForeingCheck list contains information related to the foreign checks used to tender a document.
Data
Attribute Size ID Required Description
Type
Reference to document tender
TenderSid INTEGER 19 YES YES record
ForeignCurrencySid INTEGER 19 NO Reference to currency record
BaseTaken DECIMAL 16,4 NO Taken in base currency
BaseGiven DECIMAL 16,4 NO Given in base currency
CheckNo STRING 30 NO Foreign check number
AuthCode STRING 20 NO Processor authorization code
Foreign currency taken exchange
TakeRate DECIMAL 20,8 NO rate
Foreign currency given exchange
GiveRate DECIMAL 20,8 NO rate
3 letter alphabetic currency code
CurrencyAlphaCode STRING 3 NO as defined by ISO 4217
CurrencyDictName STRING 30 NO Currency name.

Insert New Document Payload Example.

{
"sid": "579937930000164255",
"invcpostdate": "2020-11-11T[Link].000-08:00",
"status": 4,
"tendertype": 6,
"sbsno": 1,
"storeno": 1,
"docno": 5,
"vatoptions": 0,
"discperc": 0,
"discamt": 0,
"roundingoffset": 0,
"drawerno": 1,
"activityperc": 100,
"eftinvcno": 17,
"totalfeeamt": 0,
"totaldiscountamt": 0,
"saletotaltaxamt": 0.62,
"saletotalamt": 10.61,
"salesubtotal": 9.99,
"depositamtrequired": 0,
"dueamt": 0,
"soldqty": 1,
"returnqty": 0,
"orderqty": 0,
"orderquantityfilled": null,

62
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

"takenamt": 11,
"storecode": "ORD",
"origstoreno": 1,
"origstorecode": "ORD",
"taxareaname": "ILLINOIS",
"taxarea2name": null,
"discountreasonname": null,
"disbursementreasonname": null,
"workstationno": 0,
"cashierloginname": "sysadmin",
"cashierfullname": "Sysadmin Sysadmin",
"employee1loginname": "sysadmin",
"employee1fullname": "Sysadmin Sysadmin",
"btid": 100000002,
"stdetaxflag": false,
"tendername": "Cash",
"pricelvl": 1,
"pricelvlname": "Retail",
"ordertotaltaxamt": 0,
"transactiontotaltaxamt": 0.62,
"saletax1amt": 0.62,
"ordertax1amt": 0,
"transactiontax1amt": 0.62,
"ordertotalamt": 0,
"transactiontotalamt": 10.61,
"ordersubtotal": 0,
"salesubtotalwithtax": 10.6144,
"ordersubtotalwithtax": 0,
"transactionsubtotalwithtax": 10.6144,
"totallineitem": 1,
"totalitemcount": 1,
"transactionsubtotal": 9.99,
"givenamt": 0.39,
"shippingtaxincluded": false,
"workstationuid": "557344984000138001",
"workstationname": "ad-vmw10hq_8080",
"taxareaperc": 6.25,
"taxarea2perc": 0,
"cashiersid": "557343002000164260",
"employee1sid": "557343002000164260",
"exchangeqty": 0,
"discounttype": 0,
"orderdiscperc": 0,
"orderdiscamt": 0,
"orderdiscounttype": 0,
"socancelflag": false,
"orderfeetaxincluded1": false,
"ordershippingtaxincluded": false,

63
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

"orderchangedflag": false,
"promogdmandisc": false,
"receipttype": 0,
"ordertype": null,
"hassale": true,
"hasreturn": false,
"hasdeposit": false,
"ssfulfillment": false,
"detaxamt": 0,
"taxrebatepersisted": 0,
"returnsubtotal": 0,
"returnsubtotalwithtax": 0,
"returntax1amt": 0,
"returntotaltaxamt": 0,
"docitem": [{
"itempos": 1,
"invnsbsitemsid": "578537713000162456",
"detaxflag": false,
"kitflag": 0,
"promotionflag": false,
"giftaddvalue": false,
"archived": 0,
"stprimary": false,
"storeno": 1,
"qty": 1,
"origprice": 9.99,
"origtaxamt": 0.6244,
"price": 9.99,
"taxperc": 6.25,
"taxamt": 0.62438,
"tax2perc": 0,
"tax2amt": 0,
"cost": 3.99,
"spif": 0,
"scanupc": "2669",
"activityperc": 100,
"itemorigin": 0,
"origcost": 3.99,
"udf2float": 0,
"udf3float": 0,
"discperc": 0,
"discamt": 0,
"itemtype": 1,
"dcscode": "MENTE1TE1",
"vendcode": "ADA",
"description1": "Item 09",
"attribute": "BLUE",
"itemsize": null,

64
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

"alu": "000078",
"taxcode": "0",
"employee1loginname": "sysadmin",
"employee1fullname": "Sysadmin Sysadmin",
"stdetaxflag": false,
"shipamt": 0,
"pricelvl": 1,
"pricelvlname": "Retail",
"inventoryohqty": 15,
"sbsno": 1,
"pricelvlsid": "557343042000115499",
"orderquantityfilled": 0,
"giftquantity": 0,
"sodepositamt": 0,
"taxareaname": "ILLINOIS",
"serialtype": 0,
"lottype": 0,
"sendsaleflag": false,
"fulfillstoreno": 1,
"fulfillstoresid": "557343002000166261",
"fulfillsbsno": 1,
"socancelflag": false,
"employee1sid": "557343002000164260",
"dipprice": 9.99,
"dipdiscamt": 0,
"diptaxamt": 0.62438,
"diptax2amt": 0,
"itemstatus": 0,
"enhanceditempos": 10000,
"iscompetingcomponent": false,
"promomandisc": false,
"taxperclock": false,
"invnuseqtydecimals": 0,
"taxcoderulesid": "557572206220081001",
"ltyorigpointsearned": 0,
"ltyorigpriceinpoints": 0,
"promogiftitem": 0,
"employee1id": 1,
"invnsbsitemuid": "578537446000139454",
"internalitempos": 1
}],
"doctender": [{
"tendertype": 0,
"tenderpos": 1,
"amount": 11,
"taken": 11,
"given": 0,
"matched": false,

65
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

"currencysid": "557343036000118670",
"currencyname": "DOLLARS",
"tendername": "Cash",
"currencyalphacode": "USD",
"currencydictname": "DOLLARS"
}, {
"tendertype": 0,
"tenderpos": 2,
"amount": -0.39,
"taken": 0,
"given": 0.39,
"matched": false,
"eftrestenderstate": null,
"manualname": null,
"manualremark": null,
"currencysid": "557343036000118670",
"currencyname": "DOLLARS",
"tendername": "Cash",
"currencyalphacode": "USD",
"currencydictname": "DOLLARS"
}],
"shippingfeetype": 9,
"employee1id": 1,
"cashierid": 1,
"controllerno": 1,
"cashiername": "SYSADMIN",
"cashierorigsbsno": 1,
"employee1name": "SYSADMIN",
"employee1origsbsno": 1,
"origintimezone": "-08:00"
}

66
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Inventory
The Inventory JSON contains information about items, including price, cost, quantity and
descriptive information.
Added to this document: 1.14.7

Attribute Data Type Size ID Required Description

InvnItemUid INTEGER 19 YES YES Inventory item unique ID.
SbsSid INTEGER 19 NO Reference to subsidiary sid.
Alu STRING 20 NO Alternate lookup code.
StyleSid INTEGER 19 YES Reference to invn_style sid.
DcsSid INTEGER 19 NO Reference to department.
VendSid INTEGER 19 NO Reference to vendor.
Description1 STRING 30 NO Description1.
Description2 STRING 30 NO Description2.
Description3 STRING 30 NO Description3.
Description4 STRING 30 NO Description4.
LongDescription STRING 2000 NO Long description.
Text1 STRING 255 NO Text1.
Text2 STRING 255 NO Text2.
Text3 STRING 255 NO Text3.
Text4 STRING 255 NO Text4.
Text5 STRING 255 NO Text5.
Text6 STRING 255 NO Text6.
Text7 STRING 255 NO Text7.
Text8 STRING 255 NO Text8.
Text9 STRING 255 NO Text9.
Text10 STRING 255 NO Text10.
Attribute STRING 8 NO Attribute.
Cost FLOAT 16,4 NO Cost of last order of item.
Spif FLOAT 16,4 NO Salesperson incentive fee.
Reference to currency record for
CurrencySid INTEGER 19 NO foreign currency cost.
LastSoldDate DATETIME NO Last sold date.
MarkdownDate DATETIME NO Date of last markdown.
Date sales of item were
DiscontinuedDate DATETIME NO discontinued.
TaxCodeSid INTEGER 19 NO Reference to tax_code record.
Udf1Float INTEGER 10 NO User defined numeric field.
Udf2Float INTEGER 10 NO User defined numeric field.
Udf3Float INTEGER 10 NO User defined numeric field.
Udf1Date DATETIME NO User defined date field.
Udf2Date DATETIME NO User defined date field.
Udf3Date DATETIME NO User defined date field.
ItemSize STRING 8 NO Item size.
Cost of last order of item in
FcCost FLOAT 16,4 NO foreign currency.

67
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Price for the item when it was

FstPrice FLOAT 16,4 NO received first time.
FirstRcvdDate DATETIME NO First received date.
LastRcvdDate DATETIME NO Last received date.
Last received cost. It will be
updated by voucher for primary
LastRcvdCost FLOAT 16,4 NO vendor.
CommSid INTEGER 19 NO Reference to commission record.
Reference to promotional pricing
DiscScheduleSid INTEGER 19 NO schedule (discount_schedule).
Udf1String STRING 100 NO User defined field.
Udf2String STRING 100 NO User defined field.
Udf3String STRING 100 NO User defined field.
Udf4String STRING 100 NO User defined field.
Udf5String STRING 100 NO User defined field.
Item cannot be sold until this
SellableDate DATETIME NO date.
Item cannot be ordered until this
OrderableDate DATETIME NO date.
Orderable BOOLEAN NO Orderable
Use quantity decimals?
UseQtyDecimals INTEGER 1 NO 1 = yes; 0 = no.
Description STRING 30 NO Description
True = Regional.
Regional BOOLEAN NO false = Not Regional.
True = Active
false = Inactive
Active BOOLEAN NO Default: true
Used to record number of items
QtyPerCase FLOAT 10,3 NO per case.
Upc INTEGER 18 NO UPC.
Used to record maximum
MaxDiscPerc1 FLOAT 16,4 NO discount % allowed for item.
Used to record maximum
MaxDiscPerc2 FLOAT 16,4 NO discount % allowed for item.
Item number as used in V8
ItemNo INTEGER 10 NO systems.
Serial type:
0-None,
1-Partial,
SerialType INTEGER 1 NO 2-Full.
LotType INTEGER 1 NO Lot type flag.

68
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

0-noentry,
1-Kit,
2-Package,
3-GiftcardStoredValue,
4-GiftcardPrepaid,
5-GiftCertificate,
6-Fee,
KitType INTEGER 1 NO 7-GiftcardCentral
ScaleSid INTEGER 19 NO Reference to the Scale sid.
PromoQtyDiscWeight FLOAT 10,3 NO Promotions: qty disc weight.
PromoInvenExclude BOOLEAN NO Promotions: Excluding item flag.
NonInventory BOOLEAN NO Noninventory flag.
NonCommitted BOOLEAN NO Noncommitted flag.
Item State:
0=normal,
ItemState INTEGER 5 NO 1=proposed item
Publish State:
0=published,
PublishStatus INTEGER 1 NO 1=WIP
Cost of item in Customer Loyalty
LtyPriceInPoints FLOAT 24,8 NO points.
Customer Loyalty points earned
LtyPointsEarned FLOAT 24,8 NO on purchase.
MinOrdQty FLOAT 10,3 NO Minimum order quantity.
Cost for order item using trade
VendorlistCost FLOAT 16,4 NO discount.
Disc percent for an item when
TradeDiscPercent FLOAT 16,4 NO ordering using trade discount.
Indicate whether tax should be
calculated based on original price
or discounted price. 0 or null =
Calculate taxes based on current
line-item price, 1=Calculate taxes
ForceOrigTax BOOLEAN NO based on non-discounted price.
InvnQuantity LIST NO Invnquantity list
InvnPrice LIST NO Invnprice list
InvnMedia LIST NO Invnmedia list
InvnVendor LIST NO Invnvendor list
InvnKit LIST NO Invnkit list
InvnLty LIST NO Invnlty list
InvnExtend LIST NO Invnextend list
TaxCode STRING 5 NO Tax code.
DcsCode STRING 9 YES Dcs code.
Uniquely identifying subsidiary
SbsNo INTEGER 4 YES NO number.
User defined name for the
SbsName STRING 15 NO subsidiary.

69
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

ScaleNo INTEGER 9 NO Scale number.

ScaleName STRING 12 NO Scale name.
VendorCode STRING 6 YES Vendor code.
VendorName STRING 25 NO Name of the vendor business.
Legacy information will be
VendorId INTEGER 9 NO stamped with a vendor ID.
TaxName STRING 12 NO Tax name.
3 letter alphabetic currency code
CurrencyAlphaCode STRING 3 NO as defined by ISO 4217.
CName STRING 20 NO Class name.
DName STRING 20 NO Department name.
SName STRING 20 NO Subclass name.
Height FLOAT 7,2 NO Height of item
Length FLOAT 7,2 NO Length of item
Width FLOAT 7,2 NO Width of item
SpecialOrder BOOLEAN NO Special Order flag.

Insert New Inventory Payload example:

{
"invnitemuid": "2665",
"alu": "000007",
"stylesid": "578445167000118165",
"description1": "Item 06",
"description2": null,
"attribute": null,
"itemsize": null,
"cost": 8.5,
"active": true,
"upc": "2665",
"maxdiscperc1": 100,
"maxdiscperc2": 100,
"taxcode": "0",
"dcscode": "MENTE6TE6",
"sbsno": 1,
"sbsname": "001",
"vendorcode": "ADA",
"currencyalphacode": "USD"
}

70
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

InvnPrice list
The InvnPrice list contains information about items price.
Data
Attribute Size ID Required Description
Type
InvnItemUid INTEGER 19 YES YES Inventory item unique ID.
SbsSid INTEGER 19 NO Reference to subsidiary.
SeasonSid INTEGER 19 NO Reference to season.
PriceLvlSid INTEGER 19 NO Reference to Price_level.
Price DECIMAL 16,4 YES Item price.
Quantity required to qualify for
QtyRequired DECIMAL 10,3 NO this price level.
InvnSbsItemSid INTEGER 19 NO Foreign key to invn_sbs_item.
Uniquely identifying subsidiary
SbsNo INTEGER 4 YES YES number
PriceLvl INTEGER 5 YES YES Price level number.
SeasonCode STRING 5 YES YES Season code.
PriceLvlName STRING 6 NO Price level name.
SeasonName STRING 30 NO Season name.

Insert New Inventory with Price Payload Example:

{
"invnitemuid": "578537446000139454",
"alu": "000078",
"stylesid": "578536303000117433",
"description1": "Item 09",
"description2": null,
"attribute": "BLUE",
"cost": 3.99,
"itemsize": null,
"active": true,
"qtypercase": null,
"upc": "2669",
"maxdiscperc1": 100,
"maxdiscperc2": 100,
"taxcode": "0",
"invnprice": [{
"invnitemuid": "578537446000139454",
"price": 9.99,
"sbsno": 1,
"pricelvl": 1,
"seasoncode": "None"
}],
"dcscode": "MENTE1TE1",
"sbsno": 1,
"vendorcode": "ADA",
"currencyalphacode": "USD"
}

71
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

InvnQuantity list
The InvnQuantity list contains information about items quantities.
Attribute Data Type Size ID Required Description
SbsSid INTEGER 19 NO Reference to subsidiary.
StoreSid INTEGER 19 NO Reference to store.
Qty DECIMAL 10,3 YES Quantity.
MinQty DECIMAL 10,3 NO Minimum quantity
MaxQty DECIMAL 10,3 NO Maximum quantity
NewMinQty DECIMAL 10,3 NO New minimum quantity.
NewMaxQty DECIMAL 10,3 NO New maximum quantity.
TransferInQty DECIMAL 10,3 NO Transfer in quantity.
TransferOutQty DECIMAL 10,3 NO Transfer out quantity.
MinmaxBeginDate DATETIME NO Min/max begin date.
MinmaxEndDate DATETIME NO Min/max end date.
Used to record the sold quantity
SoldQty DECIMAL 10,3 NO of an item.
Used to record the received
RcvdQty DECIMAL 10,3 NO quantity of an item.
Used to record the on-order
OnOrderedQty DECIMAL 10,3 NO quantity of an item.
Committed: planned transfer
order to move item qty into
inventory from another
inventory. updated when
ToInOrderedQty DECIMAL 10,3 NO transfer order is updated.
Committed: item qty transferred
into inventory from another
inventory. updated when
ToInSentQty DECIMAL 10,3 NO transfer order is updated.
Committed: planned transfer
order to move item qty out of
inventory into another inventory.
updated when transfer order is
ToOutOrderedQty DECIMAL 10,3 NO updated.
Committed: item qty transferred
out of inventory into another
inventory. updated when
ToOutSentQty DECIMAL 10,3 NO transfer order is updated.
Committed: item qty on order
from vendor. updated when
PoOrderedQty DECIMAL 10,3 NO purchase order is updated.
Committed: item qty received to
date from vendor. updated when
PoRcvdQty DECIMAL 10,3 NO purchase order is updated.
Committed: item qty on order for
a customer. updated when sales
SoOrderedQty DECIMAL 10,3 NO order is updated.

72
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Committed: item qty sent to a

customer. updated when sales
SoSentQty DECIMAL 10,3 NO order is updated.
Used to record the in-transit net
qty in regular (receive/return)
AsnInTransitQty DECIMAL 10,3 NO ASN.
Used to record the date when
the quantity changed to zero last
LastOnHandQtyDate DATETIME NO time.
Used by to navigate to
InvnSbsItemSid INTEGER 19 NO invn_sbs_item resource
Uniquely identifying subsidiary
SbsNo INTEGER 4 YES YES number.
User defined name for the
SbsName STRING 15 NO subsidiary.
StoreName STRING 40 NO Store name.
StoreNo INTEGER 4 YES YES Store number.
StoreCode STRING 5 NO Store code.

73
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Purchase Order
The Purchase Order JSON includes information related to purchase orders.
Added to this document: 1.14.7

Attribute Data Type Size ID Required Description

Purshase order unique
Sid INTEGER 19 YES YES Identifying Value.
Reference to subsidiary where
SbsSid INTEGER 19 NO the PO was created.
Reference to the store where
StoreSid INTEGER 19 NO the PO was created.
BillToStoreSid INTEGER 19 NO Reference to Bill To Store.
ShipToStoreSid INTEGER 19 NO Refence to Ship To Store.
MarkedForStoreSid INTEGER 19 NO Reference to Marked For Store.
PoNo STRING 20 NO Po Number.
PO type
0 = Single Sub Drop Ship
1 = Single Sub Marked For
2 = Multi Sub Drop Ship
PoType INTEGER 4 YES 3 = Multi Sub Marked For
ClerkSid INTEGER 19 NO Reference to the employee.
VendorSid INTEGER 19 NO Reference to the Vendor.
VendAcctNo STRING 200 NO Vendor Account Number.
Station STRING 1 NO Station
DiscAmt DECIMAL 16,4 NO Discount amount.
DiscPerc DECIMAL 16,4 NO Discount percentange.
Discount Type
0 = Use Percentage
DiscType INTEGER 1 NO 1 = Use Amount
Status
0 = Pending
Status INTEGER 4 NO 1 = Completed
FromSo BOOLEAN NO true = Generated from SO.
SoSid INTEGER 19 NO Reference to the SO.
Created Date.
Default: Current system date
CreatedDate DATETIME NO and time.
ModifiedDate DATETIME NO Modified Date
ShippingDate DATETIME NO Expected Ship Date.
CancelDate DATETIME NO Cancel Date.
LstActivityDate DATETIME NO Last Activity Date.
SentDate DATETIME NO Sent Date.
Customization data (populated
when using a custom DLL with
CustFld STRING 47 NO Retail Pro 9)
SeasonSid INTEGER 19 NO Reference to the Season.
TaxAreaSid INTEGER 19 NO Reference to the Tax Area.

74
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Use VAT? true/false

UseVat BOOLEAN NO Default = false
Corporate/store document
true = Made at corporate
false = Imported from subsidiary
Cms BOOLEAN NO Default = false
Active BOOLEAN NO Document active? true/false
Verified BOOLEAN NO Document verified? true/false
Held BOOLEAN NO Document held?
Date document posted to
database.
Default = Current system date
CmsPostDate DATETIME NO time.
EdiFlag INTEGER 4 NO Edi Flag.
EdiDate DATETIME NO Edi Date.
ApprovbySid INTEGER 19 NO Reference to Approval.
ApprovDate DATETIME NO Approval Date.
Unverified BOOLEAN NO Unverified
Rate DECIMAL 20,8 NO Rate
Instruction1 STRING 60 NO Instruction1
Instruction2 STRING 60 NO Instruction2
Instruction3 STRING 60 NO Instruction3
Instruction4 STRING 60 NO Instruction4
Instruction5 STRING 60 NO Instruction5
SubmittedDate DATETIME NO Submitted Date.
Controller INTEGER 4 NO Controller.
OrigController INTEGER 4 NO Original Controller.
Modified by, reference to the
ModifiedbySid INTEGER 19 NO employee.
Created by, reference to the
CreatedbySid INTEGER 19 NO employee.
RefPoSid INTEGER 19 NO Refererece to PO
DocRefNo INTEGER 9 NO Reference to the PO Number.
PO pending status can be:
false = not pending
PendingPo BOOLEAN NO true = Pending
ApprovNotes STRING 255 NO Approve Notes
ApprovStatus INTEGER 4 NO Approve Status
PendingOverride BOOLEAN NO Pending Override.
Diagnose STRING 60 NO Diagnose.
Archived INTEGER 4 NO Archived.
Points to a row in pref-reason
POReasonSid INTEGER 19 NO table
Note STRING 255 NO Note
Total ordered quantity for whole
OrdQty DECIMAL 10,3 NO PO.

75
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Total received quantity for

RcvdQty DECIMAL 10,3 NO whole PO.
Will hold sum of all qty"s
POSubtotal DECIMAL 16,4 NO multiplied by cost.
Will hold po_subtotal plus all
POTotal DECIMAL 16,4 NO fees.
TotExtPriceWTax DECIMAL 16,4 NO Total Exteded Price With Tax.
Total Extended Price Without
TotExtPriceWOTax DECIMAL 16,4 NO Tax.
POItem LIST NO
POFee LIST NO
POTerm LIST NO
POApproval LIST NO
TaxArea STRING 11 NO Tax are name.
Employee ID of the person who
ModifiedByEmployee INTEGER 9 NO last edited the PO.
Employee code who created the
CreatedByEmplName STRING 8 NO PO
Employee code who aproved the
ApprovedByEmplName STRING 8 NO PO
Uniquely identifying subsidiary
SbsNo INTEGER 4 YES number
StoreNo INTEGER 4 YES Store Number.
StoreName STRING 40 NO Store name.
BillToStoreNo INTEGER 4 NO Bill to Store Number.
VendorCode STRING 6 NO Vendor Code.
Address1 STRING 40 NO Store Address1.
Address2 STRING 40 NO Store Address2.
Address3 STRING 40 NO Store Address3.
Address4 STRING 40 NO Store Address4.
Address5 STRING 40 NO Store Address5.
Zip STRING 10 NO Store Zip.
BillToStoreName STRING 40 NO Bill to Store name.
BillToAddress1 STRING 40 NO Bill to Store Address1.
BillToAddress2 STRING 40 NO Bill to Store Address2.
BillToAddress3 STRING 40 NO Bill to Store Address3.
BillToAddress4 STRING 40 NO Bill to Store Address4.
BillToAddress5 STRING 40 NO Bill to Store Address5.
BillToZip STRING 10 NO Bill to Store Zip.
ShipToStoreName STRING 40 NO Ship to Store name.
ShipToAddress1 STRING 40 NO Ship to Store Address1.
ShipToAddress2 STRING 40 NO Ship to Store Address2.
ShipToAddress3 STRING 40 NO Ship to Store Address3.
ShipToAddress4 STRING 40 NO Ship to Store Address4.
ShipToAddress5 STRING 40 NO Ship to Store Address5.
ShipToZip STRING 10 NO Ship to Store Zip.
ShiptoStoreNo INTEGER 4 NO Ship to Store Number.

76
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

MarkedforStoreNo INTEGER 4 NO Marked for Store Number.

MarkedforStoreName STRING 40 NO Marked for Store name
MarkedforAddress1 STRING 40 NO Marked for Store Address1
MarkedforAddress2 STRING 40 NO Marked for Store Address2
MarkedforAddress3 STRING 40 NO Marked for Store Address3.
MarkedforAddress4 STRING 40 NO Marked for Store Address4.
MarkedforAddress5 STRING 40 NO Marked for Store Address5.
MarkedforZip STRING 10 NO Marked for Store Zip.
Clerk INTEGER 9 NO Employee ID.
SeasonCode STRING 5 NO Season code.
SeasonName STRING 30 NO Season name.
Document Type
1=Sales, 2=TO, 3=PO, 4=SO,
5=Adj, 6=Slip, 7=Vouchers,
8=Return Reasons, 9=Void
Reasons, 10=Discount, 11=Paid
Out, 12=Paid In, 13=ASN,
14=Check in, 15=Check out,
ReasonType INTEGER 4 NO 16=Cash Drop, 17=Misc Draw
ReasonName STRING 80 NO Reason definition
ClerkName STRING 8 NO Employee code.
StoreUdf1String STRING 50 NO Store Udf1 String
StoreUdf2String STRING 50 NO Store Udf2 String
StoreUdf3String STRING 50 NO Store Udf3String
StoreUdf4String STRING 50 NO Store Udf4String
StoreUdf5String STRING 50 NO Store Udf5 String.
ShipToUdf1String STRING 50 NO Ship to Store Udf1 String
ShipToUdf2String STRING 50 NO Ship to Store Udf2 String
ShipToUdf3String STRING 50 NO Ship to Store Udf3String
ShipToUdf4String STRING 50 NO Ship to Store Udf4String.
ShipToUdf5String STRING 50 NO Ship to Store Udf5 String
MarkedforUdf1String STRING 50 NO Marked for Store Udf1 String
MarkedforUdf2String STRING 50 NO Marked for Store Udf2 String
MarkedforUdf3String STRING 50 NO Marked for Store Udf3 String
MarkedforUdf4String STRING 50 NO Marked for Store Udf4 String
MarkedforUdf5String STRING 50 NO Marked for Store Udf5 String
VendorName STRING 25 NO Name of the vendor business
Original Subsidiary Number
ApprovedByOrigSbsNo INTEGER 4 NO where the PO was approved.
Original Subsidiary Number
CreatedByOrigSbsNo INTEGER 4 NO where the PO was created.
ModifiedByEmplName STRING 8 NO Employee code.
Original Subsidiary Number
ModifiedByOrigSbsNo INTEGER 4 NO where the PO was modified.
VendorUdf1Date DATETIME NO Vendor UDF date value.
VendorUdf1String STRING 100 NO Vendor UDF1 string value.
VendorUdf2Date DATETIME NO Vendor UDF2 date value.

77
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

VendorUdf2String STRING 100 NO Vendor UDF3 string value value.

VendorUdf3String STRING 100 NO Vendor UDF3 string value.
VendorUdf4String STRING 100 NO Vendor UDF4 string value.
VendorUdf5String STRING 100 NO Vendor UDF5 string value.
VendorUdf6String STRING 100 NO Vendor UDF1 string value.
ClerkOrigSbsNo INTEGER 4 NO OrigSbsNo
BillToUdf1String STRING 50 NO Bill to Store Udf1 String.
BillToUdf2String STRING 50 NO Bill to Store Udf2 String.
BillToUdf3String STRING 50 NO Bill to Store Udf3 String.
BillToUdf4String STRING 50 NO Bill to Store Udf4 String.
BillToUdf5String STRING 50 NO Bill to Store Udf5 String.
StoreCode STRING 5 NO Store Code
BillToStoreCode STRING 5 NO Bill To Store Code.
ShipToStoreCode STRING 5 NO Ship to store code
MarkedForStoreCode STRING 5 NO MarkedFor Store Code.

POItem list
Data
Attribute Size ID Required Description
Type
PoSid INTEGER 19 YES NO PO unique identifiying value.
ItemPos INTEGER 4 YES YES Item position number.
ItemSid INTEGER 19 YES NO Item unique identifiying value.
Price DECIMAL 16,4 NO Item price.
Cost DECIMAL 16,4 NO Item cost.
FcCost DECIMAL 16,4 NO Foreign currency cost.
CurrencySid INTEGER 19 NO Currency Sid.
TaxPerc DECIMAL 16,4 NO Tax percentage.
TaxArea2Sid INTEGER 19 NO Tax area2 Sid.
TaxCodeSid INTEGER 19 NO Tax Code Sid.
TaxCode2Sid INTEGER 19 NO Tax Code2 Sid.
TaxPerc2 DECIMAL 16,4 NO Tax Percentage 2.
TaxAmount DECIMAL 17,5 NO Tax Amount
SrcSbsNo INTEGER 4 NO Source subsidary number.
UdfValue1 STRING 50 NO Udf Value1
UdfValue2 STRING 50 NO Udf Value2
UdfValue3 STRING 50 NO Udf Value3
UdfValue4 STRING 50 NO Udf Value4
ItemNote1 STRING 350 NO Item Note1
ItemNote2 STRING 350 NO Item Note2
ItemNote3 STRING 350 NO Item Note3
ItemNote4 STRING 350 NO Item Note4
ItemNote5 STRING 350 NO Item Note5
ItemNote6 STRING 350 NO Item Note6
ItemNote7 STRING 350 NO Item Note7
ItemNote8 STRING 350 NO Item Note8
ItemNote9 STRING 350 NO Item Note9

78
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

ItemNote10 STRING 350 NO Item Note10

AltUpc INTEGER 18 NO Upc with alternate vendor.
AltAlu STRING 20 NO Alu with alternate vendor.
Cost of the item with alternate
AltCost DECIMAL 16,4 NO vendor.
AltVendCode STRING 6 NO Alternate vendor's code.
will hold sum of all ord quantities
OrdQty DECIMAL 10,3 NO for all stores
combined rcvd_qty value from
RcvdQty DECIMAL 10,3 NO po_qty table for that po_item
Archived INTEGER 1 NO Archived
InvnSbsVendorSid INTEGER 19 NO SID of alternate vendor info
unique identifier uses to identify
record from allocation_pattern
AllocationPatternSid INTEGER 19 NO table
POQuantity LIST NO See POQuantity list.
TaxArea2 STRING 11 NO Tax are name 2.
TaxCode STRING 5 NO Tax code.
TaxCode2 STRING 5 NO Tax code 2.
StoreSid INTEGER 19 NO Reference to store.
Alu STRING 20 NO Alu
Disc percent for an item when
TradeDiscPercent DECIMAL 16,4 NO ordering using trade discount.
Cost for order item using trade
VendorlistCost DECIMAL 16,4 NO discount.
MinOrdQty DECIMAL 10,3 NO Minimum Order Quantity
Attribute STRING 8 NO Attribute
Description1 STRING 30 NO Description1
Description2 STRING 30 NO Description2
Description3 STRING 30 NO Description3
Description4 STRING 30 NO Description4
ItemSize STRING 8 NO Item Size
Upc INTEGER 18 NO Upc
DcsCode STRING 9 NO Dcs Code.
VendorCode STRING 6 NO Vend Code.
ItemUID INTEGER 19 YES Item UID
3 letter alphabetic currency code
CurrencyCode STRING 3 NO as defined by ISO 4217
UseQtyDecimals INTEGER 1 NO Use Quantity Decimals.
StyleSID INTEGER 19 NO Reference to invn_style.sid
PatternName STRING 20 NO Unique name of the pattern
OrigCost DECIMAL 16,4 NO Original Cost.
CostDisc DECIMAL 16,4 NO Cost Discount.
CostDiscPerc DECIMAL 16,4 NO Cost Discount Percentage.
OrigFcCost DECIMAL 16,4 NO Original Foreign Currency Cost.
FcCostDisc DECIMAL 16,4 NO Foreign Currency Cost Discount.
OrdCaseQty DECIMAL 10,3 NO Ordered Case Quantity

79
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

POQuantity list
Data
Attribute Size ID Required Description
Type
PoItemSid INTEGER 19 YES NO PO unique identifiying value.
SbsSid INTEGER 19 YES NO Reference to subsidiary.
StoreSid INTEGER 19 YES NO Reference to Store.
OrdQty DECIMAL 10,3 NO Ordered Quantity
RcvdQty DECIMAL 10,3 NO Received Quantity.
Archived INTEGER 4 NO Archived
StoreMinQty DECIMAL 10,3 NO Store minimum quantity.
StoreMaxQty DECIMAL 10,3 NO Store maximum quantity.
DueQty DECIMAL 10,3 NO Due quantity.
Uniquely identifying subsidiary
SbsNo INTEGER 4 YES number
StoreNo INTEGER 4 YES Store Number.
StoreCode STRING 5 NO Store Code.
StoreName STRING 40 NO Store Name.
InvnItemSid INTEGER 19 NO Reference to Item Sid.

POFee list
Data
Attribute Size ID Required Description
Type
PoSid INTEGER 19 YES NO PO unique identifiying value.
Amt DECIMAL 16,4 YES Fee amount.
Points to the corresponding
PurchFeeTypeSid INTEGER 19 NO purch_fee_type record.
FeeType INTEGER 4 YES Fee Type Number.
FeeName STRING 6 NO Fee Name.

POTerm list
Attribute Data Type Size ID Required Description
PoSid INTTEGER 19 YES NO PO unique identifiying value.
0-term_days, 1-term_cod, 2-
term_credit, 3-term_replace, 4-
term_prepaid, 5-term_due, 6-
TermType INTEGER 4 YES YES term_pays, 7-term_eom
TermNo INTEGER 4 YES YES Term Number.
Days INTEGER 9 NO Days
DiscPerc DECIMAL 16,4 NO Discount Percentage.
TermDate DATETIME NO Term Date.
Archived INTEGER 1 NO Archived

POApproval list
Attribute Data Type Size ID Required Description

80
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

PoSid INTEGER 19 YES NO PO unique identifiying value.

ApprovLevel INTEGER 4 YES YES Approve Level
ApprovbySid INTEGER 19 NO Approve by Sid
ApprovDate DATETIME NO Approve Date
ApprovNotes STRING 255 NO Approve Notes
ApprovStatus INTEGER 4 NO Approve Status
Archived INTEGER 4 NO Archived
ApprovBy INTEGER 9 NO Employee ID.
ApprovByName STRING 8 NO Employee Name.
ApprovByOrigSbsNo INTEGER 4 NO Original Subsidiary Number.

81
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Insert New Purchase Order Payload Example

{
"sid": "581255841000152700",
"pono": "18",
"potype": 0,
"discamt": 0,
"discperc": 0,
"status": 1,
"fromso": false,
"shippingdate": "2020-11-30T[Link].000-08:00",
"lstactivitydate": "2020-11-30T[Link].000-08:00",
"active": true,
"verified": false,
"held": false,
"unverified": false,
"controller": 1,
"origcontroller": 1,
"note": "Test PO",
"totextpricewtax": 63.6863,
"totextpricewotax": 59.94,
"poitem": [{
"itempos": 1,
"price": 9.99,
"cost": 3.99,
"fccost": 3.99,
"taxperc": 6.25,
"taxperc2": 0,
"taxamount": 0.62438,
"srcsbsno": 1,
"ordqty": 6,
"rcvdqty": 0,
"poquantity": [{
"ordqty": 6,
"rcvdqty": 0,
"dueqty": 0,
"sbsno": 1,
"storeno": 1
}],
"taxcode": "0",
"taxcode2": "0",
"dueqty": 0,
"itemuid": "578536660000124445",
"currencycode": "USD",
"origcost": 3.99,
"costdisc": 0,
"costdiscperc": 0,
"origfccost": 3.99,
"fccostdisc": 0

82
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

}],
"pofee": [{
"amt": 0,
"feetype": 9,
"feename": "Shipng"
}],
"taxarea": "ILLINOIS",
"sbsno": 1,
"storeno": 1,
"billtostoreno": 1,
"vendorcode": "ADA",
"shiptostoreno": 1,
"clerk": 1,
"seasoncode": "None",
"reasontype": 3,
"clerkname": "SYSADMIN",
"clerkorigsbsno": 1,
"markedforstorecode": null
}

83
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Receiving (voucher)
The Receiving JSON contains information about the vouchers and descriptive information.
Added to this document: 1.14.7

Attribute Data Type Size ID Required Description

Sid INTEGER 19 YES YES Voucher unique identifier.
SbsSid INTEGER 19 NO Refecence to the subsidiary.
StoreSid INTEGER 19 NO StoreSid
VouNo INTEGER 10 YES VouNo
VouType INTEGER 1 YES 0-Regular; 1-Return
0-Voucher; 1-Pending Voucher;
VouClass INTEGER 1 YES 2-ASN
VendSid INTEGER 19 NO Refernce to the Vendor sid.
PayeeSid INTEGER 19 NO Refernce to the Payee sid.
VendAcctNo STRING 200 NO Vend Account Number.
VendorInvoiceSid INTEGER 19 NO VendorInvoiceSid
ClerkSid INTEGER 19 NO Reference to the employee Sid.
Station STRING 1 NO Station
Workstation INTEGER 4 NO Workstation
OrigStoreSid INTEGER 19 NO Original Store Sid.
OrigStation STRING 1 NO Original Station.
0-None,1-Changed,2-Cancelled,3-
Status INTEGER 1 YES Normal,4-Completed
0-Normal, 16-Reversed, 32-
Reversal, 48 - Not reversed, not
ProcStatus INTEGER 2 NO reversal
PoNo STRING 20 NO Purshase order number.
ToNo STRING 8 NO Transfer order number.
PkgNo STRING 20 NO Package number.
ShipmentNo STRING 16 NO Shipment number.
0-Undefined,1-Average,2-
CostHandlingCode INTEGER 1 NO Overwrite,3-Leave
UpdatePriceFlag BOOLEAN NO Update price flag.
UseVat BOOLEAN NO Use VAT flag.
DiscPerc DECIMAL 16,4 NO Discount percentage.
DiscAmt DECIMAL 16,4 NO Discount amount.
TaxPercIncl DECIMAL 16,4 NO Tax percentage include.
TaxAmtIncl DECIMAL 16,4 NO Tax amount include.
TaxPercExcl DECIMAL 16,4 NO Tax percentage exclude.
TaxAmtExcl DECIMAL 16,4 NO Tax amount exclude.
ArrivedDate DATETIME NO Arrived date.
Customization data
populated when using a custom
CustFld STRING 47 NO DLL with Retail Pro.
SeasonSid INTEGER 19 NO reference to the Season Sid.
RefVouSid INTEGER 19 NO Reference voucher SID.

84
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Audited BOOLEAN NO Audited flag.

Corporate/store flag
0 = Imported from subsidiary
Cms BOOLEAN NO 1 = Made at corporate
Verified BOOLEAN NO Verified flag.
Purchase clearing amount for
PurchClearAmt DECIMAL 16,4 NO account link.
CmsPostDate DATETIME NO Corporate post date.
Reference to the employee SID
ReviewbySid INTEGER 19 NO who reviewed the document.
ReviewDate DATETIME NO Review Date.
ReviewNote STRING 30 NO Review Note.
Approved By Sid. For RIL
Document Approval Feature (PO
ApprovbySid INTEGER 19 NO and Voucher Only) compitability
Approval Date. For RIL Document
Approval Feature (PO and
ApprovDate DATETIME NO Voucher Only) compitability
WsSeqNo INTEGER 9 NO Workstation sequence number.
Held BOOLEAN NO Hold flag.
Active BOOLEAN NO Active flag.
Rate DECIMAL 20,8 NO The exchange rate being used.
CarrierId INTEGER 9 NO CarrierId
Controller INTEGER 4 NO Controller
OrigController INTEGER 4 NO OrigController
CreatedbySid INTEGER 19 NO CreatedbySid
ModifiedbySid INTEGER 19 NO ModifiedbySid
AlExtractDate DATETIME NO AlExtractDate
AlPostDate DATETIME NO AlPostDate
DocRefNo INTEGER 9 NO DocRefNo
SlipFlag - 1=Transfer voucher, 0
SlipFlag INTEGER 1 NO or NULL, otherwise
Approval Notes. For RIL
Document Approval Feature (PO
ApprovNotes STRING 255 NO and Voucher Only) compitability
Approval Status. 0=None,
1=Pending, 2=Approved,
3=Rejected, 4=OnHold. For RIL
Document Approval Feature (PO
ApprovStatus INTEGER 1 NO and Voucher Only) compitability
Pending Override. For RIL
Document Approval Feature (PO
PendingOverride BOOLEAN NO and Voucher Only) compitability
TrackingNo STRING 40 NO TrackingNo
TransReasonId - Reason code to
TransReasonId INTEGER 9 NO Slips, ASN, and TO.

85
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Points to a row in pref-reason

VouReasonSid INTEGER 19 NO table
ContractDate DATETIME NO Contract Date.
AsnNo INTEGER 9 NO Asn Number.
Archived INTEGER 1 NO Archived
TaxAreaSid INTEGER 19 NO Reference to the Tax Area Sid.
TaxArea2Sid INTEGER 19 NO Reference to the TaxArea 2 Sid.
ResolvStatus - Flag to indicate
transfer verification status.
0 or null - None,
1 - original doc,
ResolvStatus INTEGER 1 NO 2 - replacement doc
ResolvSid INTEGER 19 NO
Note STRING 255 NO Note
NoOfPkgs INTEGER 3 NO Number of pakages.
PoSid INTEGER 19 NO Referece to the PO Sid.
ToSid INTEGER 19 NO Reference to the TO Sid.
AsnSid INTEGER 19 NO Reference to the ASN Sid.
RefDocSid INTEGER 19 NO Reference to the document Sid.
Will hold sum of all qtys
VouSubtotal DECIMAL 16,4 NO multiplied by cost.
Will hold vou_subtotal plus all
VouTotal DECIMAL 16,4 NO fees.
Discount type: 0 = Pctg 1 =
DiscType INTEGER 1 NO Amount
Tax included type: 0 = Pctg 1 =
TaxInclType INTEGER 1 NO Amount
Tax excluded type: 0 = Pctg 1 =
TaxExclType INTEGER 1 NO Amount
1=Mark else Unmark.
Used to set the Batch Receive
BrMarked BOOLEAN NO status of an ASN.
0=Published,
1=WIP,
PublishStatus INTEGER 1 NO 2=ReadyToPublish
NULL or 0 - normal, 1 - reversed,
ReversedFlag INTEGER 1 NO 2 - reversal
Subsidiary sid indicating the
outgoing susbsidiary for transfer
SlipSbsSid INTEGER 19 NO voucher
Store sid indicating the outgoing
SlipStoreSid INTEGER 19 NO store for transfer voucher
RecvItem LIST NO RecvItem list
RecvFee LIST NO RecvFee list
RecvTerm LIST NO RecvTerm list
RecvComment LIST NO RecvComment list
RecvApproval LIST NO RecvApproval list

86
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

RecvPackage LIST NO RecvPackage list

TaxArea STRING 11 NO Tax area name
TaxArea2 STRING 11 NO Tax area name 2
OrigStoreNo INTEGER 4 NO Original store number.
OrigAddress1 STRING 40 NO Original store Address1
OrigAddress2 STRING 40 NO Original store Address2
OrigAddress3 STRING 40 NO Original store Address3
OrigAddress4 STRING 40 NO Original store Address4
OrigAddress5 STRING 40 NO Original store Address5
OrigStoreName STRING 40 NO Original store name
OrigStoreUdf1String STRING 50 NO Original store Udf1String
OrigStoreUdf2String STRING 50 NO Original store Udf2String
OrigStoreUdf3String STRING 50 NO Original store Udf3String
OrigStoreUdf4String STRING 50 NO Original store Udf4String
OrigStoreUdf5String STRING 50 NO Original store Udf5String
OrigZip STRING 10 NO Original store Zip
OrderDate DATETIME NO Order Date.
CancelDate DATETIME NO Cancel Date.
VendCode STRING 6 NO Vendor Code.
VendName STRING 25 NO Name of the vendor business.
Legacy information will be
VendId INTEGER 9 NO stamped with a vendor ID.
PayeeCode STRING 6 NO Vendor code.
Uniquely identifying subsidiary
SbsNo INTEGER 4 NO number.
StoreNo INTEGER 4 NO Store number.
ClerkName STRING 8 NO Employee code.
ModifiedByEmplID INTEGER 9 NO Modified by Employee ID.
ModifiedByEmplName STRING 8 NO Modified by employee code.
CreatedByEmplName STRING 8 NO Created by employee code.
ApprovedByEmplName STRING 8 NO Aproved by employee code.
VendInvcId INTEGER 10 NO Vendor Invoice ID.
VendInvcNo STRING 15 NO Vendor Invoice Number.
VendInvcDate DATETIME NO Vendor Invoice Date.
Address1 STRING 40 NO Store Address1.
Address2 STRING 40 NO Store Address2
Address3 STRING 40 NO Store Address3
Address4 STRING 40 NO Store Address4
Address5 STRING 40 NO Store Address5
StoreName STRING 40 NO Store name.
Zip STRING 10 NO Store Zip.
VendorUdf1String STRING 100 NO Vendor user defined string value.
VendorUdf2String STRING 100 NO Vendor user defined string value.
VendorUdf3String STRING 100 NO Vendor user defined string value.
VendorUdf4String STRING 100 NO Vendor user defined string value.
VendorUdf5String STRING 100 NO Vendor user defined string value.
VendorUdf6String STRING 100 NO Vendor user defined string value.

87
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

VendorUdf1Date DATETIME NO Vendor user defined date value.

VendorUdf2Date DATETIME NO Vendor user defined date value.
StoreUdf1String STRING 50 NO Store Udf1 String.
StoreUdf2String STRING 50 NO Store Udf2 String
StoreUdf3String STRING 50 NO Store Udf3 String
StoreUdf4String STRING 50 NO Store Udf4 String
StoreUdf5String STRING 50 NO Store Udf5 String.
ReasonName STRING 80 NO Reason definition.
Document Type.
1=Sales,
2=TO,
3=PO,
4=SO,
5=Adj,
6=Slip,
7=Vouchers,
8=Return Reasons,
9=Void Reasons,
10=Discount,
11=Paid Out,
12=Paid In,
13=ASN,
14=Check in,
15=Check out,
16=Cash Drop,
ReasonType INTEGER 4 NO 17=Misc Draw
SeasonCode STRING 5 NO Season code
ClerkOrigSbsNo INTEGER 4 NO Clerk original subsidiary number.
Aproved by original subsidiary
ApprovedByOrigSbsNo INTEGER 4 NO number.
Created by original subsidiary
CreatedByOrigSbsNo INTEGER 4 NO number.
Modified by original subsidiary
ModifiedByOrigSbsNo INTEGER 4 NO number.
Subsidiary number indicating the
outgoing susbsidiary for transfer
SlipSbsNo INTEGER 4 NO voucher
Store number indicating the
outgoing store for transfer
SlipStoreNo INTEGER 4 NO voucher.
Linked slip sid number with this
SlipSid INTEGER 19 NO voucher.
Linked slip number with this
SlipNo INTEGER 9 NO voucher.
Linked slip number with this
SlipReversedFlag INTEGER 1 NO voucher.
StoreCode STRING 5 NO Store Code
OrigStoreCode STRING 5 NO Original Store Code.

88
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

SlipStoreCode STRING 5 NO Slip Store Code

RecvApproval list
The RecvApproval list contains information about approvals on the voucher.
Attribute Data Type Size ID Required Description
Voucher unique identifiying
VouSid INTEGER 19 YES NO value.
ApprovLevel INTEGER 4 YES YES Approve Level.
ApprovbyId INTEGER 19 NO Approved by ID.
ApprovDate DATETIME NO Approved Date.
ApprovNotes STRING 255 NO Approved Notes.
ApprovStatus INTEGER 4 NO Approved Status.
Archived INTEGER 4 NO Archived
ApprovbySid INTEGER 19 NO Approved By Sid.
ApprovedByEmplName STRING 8 NO Aproved by employee code.
ApprovedByOrigSbsNo INTEGER 4 NO Original subsidiary number.

RecvComment list
The RecvComment list contains information about comments on the voucher.
Data
Attribute Size ID Required Description
Type
Voucher unique identifiying
VouSid INTEGER 19 YES NO value.
CommentNo INTEGER 4 YES YES Comment Number.
Comments STRING 60 NO Comments

89
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

RecvTerm list
The RecvTerm list contains information about terms on the voucher.
Attribute Data Type Size ID Required Description
Voucher unique identifiying
VouSid INTEGER 19 YES NO value.
0-term_days,
1-term_cod,
2-term_credit,
3-term_replace,
4-term_prepaid,
5-term_due,
6-term_pays,
TermType INTEGER 4 YES YES 7-term_eom
TermNo INTEGER 4 YES YES Term number.
Days INTEGER 9 NO Days
DiscPmtPerc DECIMAL 16,4 NO Discount Percentage
TermDate DATETIME NO Term Date
Amt DECIMAL 16,4 NO Amount
Archived INTEGER 1 NO Archived

RecvItem list
The RecvItem list contains information about items on the voucher.

Attribute Data Type Size ID Required Description

VouSid INTEGER 19 YES YES Reference to the voucher SID.
ItemPos INTEGER 4 YES YES Item Position
ItemSid INTEGER 19 NO Rereference to the Item Sid.
Qty DECIMAL 10,3 NO Quantity
OrigQty DECIMAL 10,3 NO Original Quantity
Price DECIMAL 16,4 NO Price
Cost DECIMAL 16,4 NO Cost
FcCost DECIMAL 16,4 NO Foreing cost.
CurrencySid INTEGER 19 NO Reference to the Currency Sid.
TaxCodeSid INTEGER 19 NO Reference to the Tax Code Sid.
TaxPerc DECIMAL 16,4 NO Tax Percentage.
TaxArea2Sid INTEGER 19 NO Reference to the Tax Area Sid.
TaxCode2Sid INTEGER 19 NO Reference to the Tax Code Sid.
TaxPerc2 DECIMAL 16,4 NO Tax Percentage 2.
TaxAmtExcl DECIMAL 17,5 NO Tax Amout Excluded.
TaxAmtIncl DECIMAL 17,5 NO Tax Amout Included.
ShippingAmt DECIMAL 16,4 NO Shipping Amout.
DiscAmt DECIMAL 16,4 NO Discount Amout.
CartonNo STRING 20 NO Carton Number.
CartonStatus INTEGER 10 NO Carton Status.
CustFld STRING 4 NO Custom field.
ScanUpc INTEGER 18 NO Scan UPC.

90
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

SerialNo STRING 50 NO Serial number.

LotNumber STRING 25 NO Lot Number.
UdfValue1 STRING 50 NO User-defined field Value 1.
UdfValue2 STRING 50 NO User-defined field Value 2.
UdfValue3 STRING 50 NO User-defined field Value 3.
UdfValue4 STRING 50 NO User-defined field Value 4.
OrigCost DECIMAL 16,4 NO Original Cost.
ItemNote1 STRING 350 NO Item Note 1
ItemNote2 STRING 350 NO Item Note 2
ItemNote3 STRING 350 NO Item Note 3
ItemNote4 STRING 350 NO Item Note 4
ItemNote5 STRING 350 NO Item Note 5
ItemNote6 STRING 350 NO Item Note 6
ItemNote7 STRING 350 NO Item Note 7
ItemNote8 STRING 350 NO Item Note 8
ItemNote9 STRING 350 NO Item Note 9
ItemNote10 STRING 350 NO Item Note 10
SpreadFeeAmt DECIMAL 16,4 NO Spread Fee Amout.
AltUPC INTEGER 18 NO Alternate vendor's Upc.
AltALU STRING 20 NO Alternate vendor's Alu
AltCost DECIMAL 16,4 NO Alternate vendor's Cost
AltVendCode STRING 6 NO Alternate vendor's vendor code.
Archived INTEGER 4 NO Archived
FromASN INTEGER 1 NO From ASN flag.
SublocSid INTEGER 19 NO Reference to the Sublocation Sid.
SNQty DECIMAL 10,3 NO Serial number quantity.
SNActive BOOLEAN NO Serial number Active
SNReceived BOOLEAN NO Serial number Received
SNSold BOOLEAN NO Serial number Sold
SNTransferred BOOLEAN NO Serial number Transferred
SNSoReserved BOOLEAN NO Serial number SoReserved
SNReturned BOOLEAN NO Serial number Returned
Serial number returned to
SNReturnedToVnd BOOLEAN NO vendor.
SNAdjusted BOOLEAN NO Serial number adjusted.
InvnSbsVendorSid INTEGER 19 NO SID of alternate vendor info.
TaxArea2 STRING 11 NO Tax area name.
TaxCode STRING 5 NO Tax Code
TaxCode2 STRING 5 NO Tax Code2
Description1 STRING 30 NO Description 1
Description2 STRING 30 NO Description 2
Description3 STRING 30 NO Description 3
Description4 STRING 30 NO Description 4
Attr STRING 8 NO Attribute
Size STRING 8 NO Item size.
UPC INTEGER 18 NO UPC
VendSid INTEGER 19 NO Reference to vendor.

91
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

LastRcvdDate DATETIME NO Last received date.

3 letter alphabetic currency code
CurrencyAlphaCode STRING 3 NO as defined by ISO 4217
ItemUID INTEGER 19 YES Item UID.
VendCode STRING 6 NO Vend code.
DCSCode STRING 9 NO DCS Code
UseQtyDecimals INTEGER 1 NO Use Quantity Decimals
serial-type from V9
invn_sbs.ext_flag.(V9 ext-flag
contains serial-type and lot-type).
0-None,
1-Partial,
SerialType INTEGER 1 NO 2-Full.
lot-type from V9
invn_sbs.ext_flag.(V9 ext-flag
LotType INTEGER 1 NO contains serial-type and lot-type).
0-NoEntry,
1-Kit,
2-Package,
3-GiftCardStoredValue,
4-GiftCardPrePaid,
5-GiftCertificate,
6-Fee,
KitType INTEGER 1 NO 7-GiftCardCentral
ALU STRING 20 NO ALU

RecvPackage list
The RecvPackage list contains information about packages on the voucher.
Data
Attribute Size ID Required Description
Type
VouSid INTEGER 19 YES NO Voucher unique identifying value.
PkgNo STRING 20 YES YES Package number.
Received BOOLEAN YES Received.
AsnNo INTEGER 10 NO ASN number.
VouClass INTEGER 4 NO Voucher class.
VouHeld BOOLEAN NO Voucher held.
VouStatus INTEGER 1 NO Voucher status.
VouActive BOOLEAN NO Voucher active.

92
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Insert New Voucher Payload Example:

{
"sid": "579236747000192282",
"vouno": 4,
"status": 4,
"voutype": 0,
"vouclass": 0,
"costhandlingcode": 1,
"held": false,
"active": true,
"origcontroller": 1,
"slipflag": 0,
"approvstatus": 2,
"vousubtotal": 4,
"voutotal": 4,
"recvitem": [{
"itempos": 1,
"qty": 2,
"origqty": 0,
"price": 0,
"cost": 2,
"fccost": 0,
"taxperc": 6.25,
"origcost": 0,
"taxcode": "0",
"currencyalphacode": "USD",
"itemuid": "2661"
}],
"recvfee": [{
"amt": 0,
"feetype": 9
}],
"taxarea": "ILLINOIS",
"origstoreno": 1,
"clerkname": "SYSADMIN",
"vendcode": "ADA",
"payeecode": "ADA",
"sbsno": 1,
"storeno": 1,
"reasontype": 7
}

93
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Vendor
The Vendor JSON contains information about vendor records.
Added to this document: 1.14.7

Attribute Data Type Size ID Required Description

VendCode STRING 6 YES YES Vendor Code.
true = Active; false = Inactive
Active BOOLEAN YES Default: true
VendName STRING 25 NO Name of the vendor business.
Info1 STRING 20 NO Free form data entry field.
Info2 STRING 20 NO Free form data entry field.
0-term_days,
1-term_cod,
2-term_credit,
3-term_replace,
4-term_prepaid,
5-term_due,
6-term_pays,
TermType INTEGER 1 NO 7-term_eom
AccountNo STRING 200 NO Account number with vendor.
TradeDiscPerc DECIMAL 12,6 NO A discount given by a vendor
days of lead time required to fill
5
VendLeadTime INTEGER NO order.
Accounts payable flag.
Derivation and purpose are
dependent upon the account
10
system link
[Link] 3 - Export,
ApFlag INTEGER NO 2 - Yes, 1 - No
CurrencySid INTEGER 19 NO Reference to currency record.
1 = regional; 0 = not regional.
Indicates whether the vendor
Regional BOOLEAN NO serves an entire region.
CountrySid INTEGER 19 NO Reference to country record.
QbId STRING 40 NO Quickbooks id number.
Udf1String STRING 100 NO User defined string value.
Udf2String STRING 100 NO User defined string value.
Udf3String STRING 100 NO User defined string value.
Udf4String STRING 100 NO User defined string value.
Udf5String STRING 100 NO User defined string value.
Udf6String STRING 100 NO User defined string value.
Udf1Date DATETIME NO User defined date value.
Udf2Date DATETIME NO User defined date value.
Notes STRING 2001 NO Notes.
Vendor image, probably the
Image BLOB NO business logo

94
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Legacy information will be

10
VendId INTEGER NO stamped with a vendor ID.
Subsidiary the vendor is created
19
SbsSid INTEGER YES in
Reference to Language record.
Default value from the
19
subsidiary from which vendor
LanguageSid INTEGER NO was created.
0=Published, 1=WIP,
1
PublishStatus INTEGER NO 2=ReadyToPublish
MinCost DECIMAL 16,4 NO Minimum ordered cost.
MinQty DECIMAL 10,3 NO Minimum ordered qty.
VendorTerm LIST NO VendorTerm list
VendorAddress LIST NO VendorAddress list
VendorContact LIST NO
Uniquely identifying subsidiary
4 YES
SbsNo INTEGER YES number.
CountryCode STRING 3 NO Country code.
3 letter alphabetic currency code
CurrencyCode STRING 3 NO as defined by ISO 4217.
LanguageName STRING 30 NO Language name.

VendorAddress list
Data
Attribute Name Type Size ID Required Comment
VendSid INTEGER 19 YES YES Pointer to vendor record.
YES if this is the vendor? primary
PrimaryFlag BOOLEAN YES YES address
YES if this contact is currently in
Active BOOLEAN YES use
CompanyName STRING 100 NO Optional company name.
Address1 STRING 40 NO First address line
Address2 STRING 40 NO Second address line
Address3 STRING 40 NO Third address line
Address4 STRING 40 NO Extended address detail
Address5 STRING 40 NO Extended address detail
Address6 STRING 40 NO Extended address detail
City STRING 40 NO City
State STRING 40 NO State
PostalCode STRING 10 NO Postal code/zip code
PostalCodeExtension STRING 5 NO Postal code extension (eg. zip+4)
CountrySid INTEGER 19 NO Reference to country record
SeqNo INTEGER 4 YES Sequence number.
AddressTypeSid INTEGER 19 NO Address Type Sid
CountryCode STRING 3 NO Country code
Address type name, eg. home2,
AddressTypeName STRING 30 NO work1 etc.

95
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

VendorContact list
Data
Attribute Name Type Size ID Required Comment
VendSid DECIMAL 19 YES NO Vendor unique identifier.
FirstName STRING 30 NO First Name
LastName STRING 30 NO Last Name
TitleSid DECIMAL 19 NO Reference Title Sid
ContactTypeSid DECIMAL 19 NO Contact Type Sid
PrimaryFlag BOOLEAN NO Primary Flag
EmailTypeSid DECIMAL 19 NO Email Type Sid
EmailAddress STRING 100 NO Email Address
Phone1TypeSid DECIMAL 19 NO Refence Phone1 Type Sid
Phone1No STRING 30 NO Phone1 Number
Phone2TypeSid DECIMAL 19 NO Reference Phone2 Type Sid
Phone2No STRING 30 NO Phone2 Number
Active BOOLEAN NO Active
SeqNo DECIMAL 4 YES YES Sequence Number
Person title, eg. mr., mrs., dr.,
Title STRING 15 NO etc.
Phone type name, eg. home2,
PhoneType1 STRING 20 NO work1, cell, etc.
Phone type name, eg. home2,
PhoneType2 STRING 20 NO work1, cell, etc.
Email type such as home,
EMailType STRING 20 NO business, other.
Helps in identifying a title entry in
V9. Used in prism to identify
TitleId DECIMAL 10 NO modifications

Insert New Vendor Payload Example:

{
"vendcode": "ADA",
"sbsno": 1,
"countrycode": "USA",
"currencycode": "USD",
"languagename": "NATIVE"
}

96
Proprietary and Confidential property of Retail Pro International, LLC
Retail Pro - Prism JSON Data Objects

Appendix: Tips for Debugging Import Issues

Importing data using this method does not provide direct error feedback for easy troubleshooting.

Here are some recommendations:

1. Check the rps.consumer_cache table to make sure the record isn’t just sitting there.
If it is still in the cache, try restarting the prism MQ service.
2. Check the rps.consumer_cache_error table to see if it had errors.
3. Set Prism services (PrismMQ, BackOffice, and Common) logging to log level=3.
4. Set Log BUFFERSIZE=0.
E.g.

5. Check the PrismMQServiceAsService_XXXX.log, PrismBackOfficeAsService_XXXX.log and

PrismCommonAsService_XXXX.log files for errors.
It is recommended to clear the logs out first then import.
Log files are located in: C:\ProgramData\RetailPro\Server\Logs

Review the Prism User guide for how to set the log levels for your version of Prism.

97
Proprietary and Confidential property of Retail Pro International, LLC