Entity schema - Connector API

Column names in upload payloads (columns in POST /uploading/{upload_uuid}/{entity_name}) must match the Field names below. Required fields are marked with a red asterisk (*). Field types and required flags reflect the API validation schema. Descriptions are provided where available. Upload priority (per domain, before field tables): Mandatory — required for the solution; Recommended — strongly advised; Optional — useful when available; — — not applicable. The list of entities enabled for your client is configured by support. See also Entity upload and Entity dependencies.

Stores

Entity	BI	PlanoHero	StoreManager	DataMonetization
Store	Mandatory	Mandatory	Mandatory	Mandatory
StoreGroup	Recommended	Recommended	Recommended	Recommended
StoreMarker	Optional	Optional	Optional	Optional
StoreMarkerM2M	Optional	Optional	Optional	Optional
Terminal	Mandatory	Recommended	Mandatory	Mandatory
TerminalMarker	Optional	—	—	—
TerminalMarkerM2M	Optional	—	—	—

Store

entity_name: store store master data

Field	Type	Description
`id` *	string (max 100)	Store identifier
`name` *	string (max 200)	Store name
`group_id`	string (max 100)	Stores group identifier
`place`	string (max 200)	City
`address`	string (max 200)	Store address
`trade_area`	decimal	Store area

StoreGroup

entity_name: storegroup store group master data primary store hierarchy (geography)

Field	Type	Description
`id` *	string (max 100)	Stores group identifier
`parent_id`	string (max 100)	Parent stores group identifier
`name` *	string (max 200)	Stores group name

StoreMarker

entity_name: storemarker store tag reference additional structures / formats (can be created manually via DataConsole)

Field	Type	Description
`id` *	string (max 100)	Stores marker identifier
`parent_id`	string (max 100)	Stores parent marker іdentifier
`name` *	string (max 200)	Stores marker name

StoreMarkerM2M

entity_name: storemarkerm2m store-to-tag mapping

Field	Type	Description
`store_id` *	string (max 100)	Store identifier
`marker_id` *	string (max 100)	Stores marker identifier

Terminal

entity_name: terminal POS terminal master data

Field	Type	Description
`id` *	string (max 100)	Terminal identifier
`name` *	string (max 200)	Terminal name
`store_id` *	string (max 100)	Store identifier

TerminalMarker

entity_name: terminalmarker POS terminal type reference

Field	Type	Description
`id` *	string (max 100)	Cash register type identifier
`parent_id`	string (max 100)	Identifier of the parent type of cash registers
`name` *	string (max 200)	Name of cash register type

TerminalMarkerM2M

entity_name: terminalmarkerm2m terminal-to-type mapping

Field	Type	Description
`terminal_id` *	string (max 100)	Cash register identifier
`marker_id` *	string (max 100)	Identifier of cash register type

Assortment

Entity	BI	PlanoHero	StoreManager	DataMonetization
Assortment	Recommended	Recommended	Recommended	—
AssortmentType	Recommended	Recommended	Recommended	—
Brand	Recommended	Recommended	Optional	Mandatory
Category	Mandatory	Mandatory	Mandatory	Mandatory
MasterPosition	—	Optional	—	—
MasterPositionProductM2M	—	Optional	—	—
Producer	Optional	—	—	Optional
Product	Mandatory	Mandatory	Mandatory	Mandatory
ProductImage	—	—	—	—
ProductMarker	Recommended	Recommended	—	—
ProductMarkerM2M	Recommended	Recommended	—	—
ProductSize	—	—	—	—
ProductStatus	Optional	Optional	—	—
RecommendedFaces	—	Optional	—	—
Status	Optional	Optional	—	—
Unit	Optional	—	—	Optional

Assortment

entity_name: assortment assortment change log

Field	Type	Description
`product_id` *	string (max 100)	Product identifier
`type_id` *	string (max 100)	Assortment type identifier
`store_id`	string (max 100)	Store identifier If the field is not filled in, then the assortment type applies to all stores.
`modified_at` *	date (`YYYY-MM-DD`)	Date of assortment change

AssortmentType

entity_name: assortmenttype assortment type reference

Field	Type	Description
`id` *	string (max 100)	Assortment type identifier
`name` *	string (max 200)	Assortment type name
`is_active` *	boolean	Is this an active assortment? Default always = 0, if = 1, then the assortment type is active

Brand

entity_name: brand brand master data

Field	Type	Description
`id` *	string (max 100)	Brand identifier
`name` *	string (max 200)	Brand name

Field	Type	Description
`id` *	string (max 100)	Category identifier
`parent_id`	string (max 100)	Parent category identifier
`name` *	string (max 200)	Category name

MasterPosition

entity_name: masterposition master position product reference

Field	Type	Description
`id` *	string (max 100)	Master position identifier
`name` *	string (max 200)	Master position name
`code` *	string (max 100)	Internal code/article of master position
`height`	decimal (min 0.001)	Master position height in m or inches
`width`	decimal (min 0.001)	Master position width in m or inches
`depth`	decimal (min 0.001)	Master position depth in m or inches
`height_compression_coef`	decimal (min 0, max 90)	Master position compression coefficient in height [0; 0.9]
`width_compression_coef`	decimal (min 0, max 90)	Master position compression coefficient in width [0; 0.9]
`depth_compression_coef`	decimal (min 0, max 90)	Master position compression coefficient in depth [0; 0.9]
`is_bulk`	boolean	Weight master position Default is always 0, if = 1, then the product is weight.
`note`	string (max 500)	Master position description

MasterPositionProductM2M

entity_name: masterpositionproductm2m product-to-master-position mapping

Field	Type	Description
`product_id` *	string (max 100)	Product identifier
`masterposition_id` *	string (max 100)	Master position identifier
`priority` *	integer	Product priority in master position

Producer

entity_name: producer manufacturer master data

Field	Type	Description
`id` *	string (max 100)	Producer identifier
`name` *	string (max 200)	Producer name

Product

entity_name: product product master data

Field	Type	Description
`id` *	string (max 100)	Product identifier
`name` *	string (max 200)	Product name
`code` *	string (max 200)	Internal code/product article
`barcode` *	string (max 500)	Barcode (or multiple barcodes separated by commas)
`category_id` *	string (max 100)	Category identifier
`brand_id`	string (max 100)	Brand identifier
`producer_id`	string (max 100)	Producer identifier
`unit_id`	string (max 100)	Unit identifier

ProductImage

entity_name: productimage

Field	Type	Description
`product_id` *	string (max 100)	—
`image` *	string	—

ProductMarker

entity_name: productmarker product tag reference additional product hierarchies / attributes (can be created manually via DataConsole)

Field	Type	Description
`id` *	string (max 100)	Products marker identifier
`parent_id`	string (max 100)	Parent products marker identifier
`name` *	string (max 200)	Products marker name

ProductMarkerM2M

entity_name: productmarkerm2m product-to-tag mapping

Field	Type	Description
`product_id` *	string (max 100)	Product identifier
`marker_id` *	string (max 100)	Product marker identifier

ProductSize

entity_name: productsize

Field	Type	Description
`product_id` *	string (max 100)	—
`width`	decimal (min 0.001)	—
`height`	decimal (min 0.001)	—
`depth`	decimal (min 0.001)	—
`height_compression_coef`	decimal (min 0, max 90)	—
`width_compression_coef`	decimal (min 0, max 90)	—
`depth_compression_coef`	decimal (min 0, max 90)	—
`is_bulk`	boolean	—
`weight`	decimal (min 0.01)	—

ProductStatus

entity_name: productstatus product-to-status mapping per store

Field	Type	Description
`product_id` *	string (max 100)	Product identifier
`store_id` *	string (max 100)	Store identifier
`status_id` *	string (max 100)	Product status identifier

RecommendedFaces

entity_name: recommendedfaces recommended facings per product

Field	Type	Description
`store_id` *	string (max 100)	Store identifier
`product_id` *	string (max 100)	Product identifier
`qty` *	decimal	Recommended faces qty

Status

entity_name: status product status reference

Field	Type	Description
`id` *	string (max 100)	Identifier of the status of products
`name` *	string (max 200)	Product status name

Unit

entity_name: unit unit of measure reference

Field	Type	Description
`id` *	string (max 100)	Unit identifier
`name` *	string (max 200)	Unit title

Sales

Entity	BI	PlanoHero	StoreManager	DataMonetization
Receipt	Mandatory	Recommended	Mandatory	Mandatory
ReceiptItem	Mandatory	Recommended	Mandatory	Mandatory
ReceiptMarker	Recommended	—	—	Optional
ReceiptMarkerM2M	Recommended	—	—	Optional

Receipt

entity_name: receipt transaction receipts

Field	Type	Description
`id` *	string (max 100)	Receipt identifier
`store_id` *	string (max 100)	Store identifier in receipt
`terminal_id` *	string (max 100)	Terminal identifier in receipt
`opened_at` *	datetime (`YYYY-MM-DD HH:MM:SS`)	Receipt opening date and time
`closed_at` *	datetime (`YYYY-MM-DD HH:MM:SS`)	Receipt closing date and time
`loyalty_id`	string (max 100)	LP client identifier in receipt
`staff_id`	string (max 100)	Сashier identifier in receipt
`is_refund`	boolean	Is it a return? Refunds not included in the average receipt. If 1 - it is a refund, if 0 - it is not (default value is 0)
`original_receipt_id`	string (max 100)	Binding to the original receipt, provided that is_refund = 1. Default value is NULL
`is_regular`	boolean	Is it a regular sale? If it is 1 - this receipt will be taken into account in the calculation of the average receipt metric (default value is 1) Must be 0 if is_refund = 1 or is_excluded = 1
`is_excluded`	boolean	Exclude this receipt from the analysis? Receipts with is_excluded = 1 will be completely excluded from any calculations and analysis. The data on these checks can be viewed only if you use the “Receipt markers” filter and select “Undefined”

ReceiptItem

entity_name: receiptitem receipt line items

Field	Type	Description
`id` *	string (max 100)	Receipt product identifier
`receipt_id` *	string (max 100)	Receipt identifier
`product_id` *	string (max 100)	Product identifier
`scanned_at`	datetime (`YYYY-MM-DD HH:MM:SS`)	Scan of the product in receipt date and time
`receipt_closed_at` *	datetime (`YYYY-MM-DD HH:MM:SS`)	Receipt closing date and time (from the Receipt entity)
`supplier_id`	string (max 100)	Product supplier identifier
`price` *	decimal	Unit selling price
`qty` *	decimal	Sales qty If is_refund = 1 (refund receipt), then the value of qty must be negative.
`discount`	decimal	Discount amount (discount*products qty)
`turnover` *	decimal	The final price of the product paid by the customer (sales) Cannot be empty. It must match the following condition turnover = qtyprice-discount* If is_refund = 1 (refund receipt), then the value of turnover must be negative.
`cost_price` *	decimal	Unit cost price of product
`profit`	decimal	Profit If profit is not transmitted, then by default profit = (price-cost_price)qty- discount* If is_refund = 1 (refund receipt), then the value of profit must be negative.
`total_vat`	decimal	Tax amount (VAT*products qty)
`total_excise`	decimal	Amount of excise duty (excise*products qty)
`advisor_id`	string (max 100)	Sales consultant identifier in receiptitem
`commission`	decimal	Commission amount per unit of product If is_refund = 1 (refund receipt), the commission value must be negative or equal to 0.

ReceiptMarker

entity_name: receiptmarker receipt tag reference transaction types: wholesale, online, cash, etc.

Field	Type	Description
`id` *	string (max 100)	Receipts marker identifier
`name` *	string (max 200)	Receipts marker name

ReceiptMarkerM2M

entity_name: receiptmarkerm2m receipt-to-tag mapping

Field	Type	Description
`receipt_id` *	string (max 100)	Receipt identifier
`marker_id` *	string (max 100)	Receipt marker identifier
`receipt_date` *	datetime (`YYYY-MM-DD HH:MM:SS`)	Date of the receipt this record belongs to.

Promotions

Entity	BI	PlanoHero	StoreManager	DataMonetization
Promotion	Recommended	Recommended	Recommended	Recommended
PromotionProductM2M	Recommended	Recommended	Recommended	Recommended
PromotionReceiptitemM2M	Recommended	Recommended	Recommended	Recommended
PromotionType	Optional	—	—	Optional

Promotion

entity_name: promotion promotion master data can be created manually via DataConsole

Field	Type	Description
`id` *	string (max 100)	Promo identifier
`name` *	string (max 200)	Promo name
`code`	string (max 200)	Internal promo code (comming soon…)
`type_id`	string (max 100)	Promo type identifier
`is_demo`	boolean	Is this a demo promo? 1 is a demo promo, 0 is a regular promo. By default 0
`note`	string (max 500)	Note on the promotion
`adv_cost`	decimal	Marketing expenses
`date_from` *	date (`YYYY-MM-DD`)	Promo start date
`date_to`	date (`YYYY-MM-DD`)	Promo end date
`is_hidden_sm`	boolean	—
`is_receiptitem`	boolean	—

PromotionProductM2M

entity_name: promotionproductm2m promotional products

Field	Type	Description
`promo_id` *	string (max 100)	Promo identifier
`store_id`	string (max 100)	Store identifier If no store is specified, then it acts on the chain.
`product_id` *	string (max 100)	Promo product identifier
`promo_price`	decimal	Promo product price

PromotionReceiptitemM2M

entity_name: promotionreceiptitemm2m promotional receipt line items

Field	Type	Description
`promo_id` *	string (max 100)	Promo identifier
`receiptitem_id` *	string (max 100)	Promo product identifier in receipt
`receipt_date` *	date (`YYYY-MM-DD`)	Date of the receipt this record belongs to.
`discount`	decimal	Discount amount (discount*products qty)

PromotionType

entity_name: promotiontype promotion type reference can be created manually via DataConsole

Field	Type	Description
`id` *	string (max 100)	Promo type identifier
`name` *	string (max 200)	Promo type name

Logistics

Entity	BI	PlanoHero	StoreManager	DataMonetization
Posting	Optional	—	Optional	—
PostingProduct	Optional	—	Optional	—
PurchaseOrder	Recommended	—	Recommended	Recommended
PurchaseOrderProduct	Recommended	—	Recommended	Recommended
Receive	Recommended	—	Recommended	Recommended
ReceiveProduct	Recommended	—	Recommended	Recommended
Relocate	Optional	—	Optional	—
RelocateProduct	Optional	—	Optional	—
Stock	Mandatory	Recommended	Mandatory	Mandatory
Writeoff	Recommended	—	Recommended	Optional
WriteoffProduct	Recommended	—	Recommended	Optional
WriteoffType	Optional	—	Optional	Optional

Posting

entity_name: posting inventory adjustment documents (stock count results)

Field	Type	Description
`id` *	string (max 100)	Posting document identifier
`code` *	string (max 200)	External posting document code
`created_at` *	datetime (`YYYY-MM-DD HH:MM:SS`)	Posting document date and time
`store_id` *	string (max 100)	Store or warehouse identifier
`staff_id`	string (max 100)	Responsible employee identifier (author of the document)

PostingProduct

entity_name: postingproduct inventory adjustment line items

Field	Type	Description
`document_id` *	string (max 100)	Posting document identifier
`product_id` *	string (max 100)	Product identifier
`posting_date` *	date (`YYYY-MM-DD`)	Date of the posting document this line belongs to.
`qty` *	decimal	Posting products qty
`cost_price` *	decimal	Unit cost price of product
`value`	decimal	Total cost price of the posting By default, auto-filled by the formula:

PurchaseOrder

entity_name: purchaseorder purchase order documents

Field	Type	Description
`id` *	string (max 100)	Order document identifier
`code` *	string (max 200)	External order document code
`created_at` *	datetime (`YYYY-MM-DD HH:MM:SS`)	Order document date and time
`store_id` *	string (max 100)	Store identifier
`supplier_id` *	string (max 100)	Supplier identifier
`staff_id`	string (max 100)	Responsible employee identifier (author of the document)

PurchaseOrderProduct

entity_name: purchaseorderproduct purchase order line items

Field	Type	Description
`document_id` *	string (max 100)	Order document identifier
`product_id` *	string (max 100)	Product identifier in order document
`purchaseorder_date` *	date (`YYYY-MM-DD`)	Date of the purchase order document this line belongs to.
`qty` *	decimal	Ordered product qty
`cost_price` *	decimal	Unit cost price of product
`value`	decimal	Total cost price of the ordered products If the field is not filled in, the field is auto- filled by the formula PurchaseOrderProduct.qtyPurchaseOrderProduct.cost_price*

Receive

entity_name: receive goods receipt documents

Field	Type	Description
`id` *	string (max 100)	Receiving document identifier
`code` *	string (max 200)	External receiving document code
`created_at` *	datetime (`YYYY-MM-DD HH:MM:SS`)	Receiving document date and time
`supplier_id` *	string (max 100)	Supplier identifier
`store_id` *	string (max 100)	Store identifier
`purchaseorder_id`	string (max 100)	Order document identifier
`staff_id`	string (max 100)	Responsible employee identifier (author of the document)

ReceiveProduct

entity_name: receiveproduct goods receipt line items

Field	Type	Description
`document_id` *	string (max 100)	Receiving document identifier
`product_id` *	string (max 100)	Product identifier in receiving document
`receive_date` *	date (`YYYY-MM-DD`)	Date of the receive document this line belongs to.
`qty` *	decimal	Received product qty
`cost_price` *	decimal	Unit cost price of product
`value`	decimal	Total cost price of the received products By default, auto-filled by the formula:
`deferment`	integer	Payment delay in days
`produced_at`	date (`YYYY-MM-DD`)	Product produced date
`sell_by_date`	date (`YYYY-MM-DD`)	Best used before the `date`

Relocate

entity_name: relocate inter-store transfer documents

Field	Type	Description
`id` *	string (max 100)	Relocation document identifier
`code` *	string (max 200)	External relocation document code
`created_at` *	datetime (`YYYY-MM-DD HH:MM:SS`)	Relocation document date and time
`store_sender_id` *	string (max 100)	Sender store identifier
`store_receiver_id` *	string (max 100)	Receiver store identifier
`staff_id`	string (max 100)	Responsible employee identifier (author of the document)

RelocateProduct

entity_name: relocateproduct transfer document line items

Field	Type	Description
`document_id` *	string (max 100)	Relocation document identifier
`product_id` *	string (max 100)	Product identifier in relocation document
`relocate_date` *	date (`YYYY-MM-DD`)	Date of the relocate document this line belongs to.
`supplier_id`	string (max 100)	Supplier identifier
`qty` *	decimal	Relocated products qty
`cost_price` *	decimal	Unit cost price of product
`value`	decimal	Total cost price of the relocated products By default, auto-filled by the formula:

Stock

entity_name: stock inventory stock levels

Field	Type	Description
`store_id` *	string (max 100)	Store identifier
`product_id` *	string (max 100)	Product identifier
`supplier_id`	string (max 100)	Supplier identifier
`dt` *	date (`YYYY-MM-DD`)	Date of stocks availability
`qty` *	decimal	Stock qty
`value` *	decimal	Stock total cost

Writeoff

entity_name: writeoff write-off documents

Field	Type	Description
`id` *	string (max 100)	Write-off document identifier
`code` *	string (max 200)	External write-off document code
`created_at` *	datetime (`YYYY-MM-DD HH:MM:SS`)	Write-off document date and time
`type_id` *	string (max 100)	Write-off type identifier
`store_id` *	string (max 100)	Store or warehouse identifier
`staff_id`	string (max 100)	Responsible employee identifier (author of the document)

WriteoffProduct

entity_name: writeoffproduct write-off document line items

Field	Type	Description
`document_id` *	string (max 100)	Write-off document identifier
`product_id` *	string (max 100)	Writte-off product identifier
`writeoff_date` *	date (`YYYY-MM-DD`)	Date of the write-off document this line belongs to.
`supplier_id` *	string (max 100)	Supplier identifier
`qty` *	decimal	Write-off products qty
`cost_price` *	decimal	Unit cost price of product
`value`	decimal	Total cost price of the writen off products By default, auto-filled by the formula:

WriteoffType

entity_name: writeofftype shrinkage / write-off type reference

Field	Type	Description
`id` *	string (max 100)	Write-off type identifier
`name` *	string (max 200)	Write-off type name

Supplier

Entity	BI	PlanoHero	StoreManager	DataMonetization
Supplier	Recommended	Recommended	Optional	Mandatory
SupplierBonus	Optional	—	—	Optional
SupplierBonusType	Optional	—	—	Optional
SupplierMarker	Optional	—	—	Optional
SupplierMarkerM2M	Optional	—	—	Optional
SupplierPercentBonus	—	—	—	—
SupplierProductM2M	Recommended	Recommended	Optional	Mandatory
SupplierRefund	Optional	—	Optional	Optional
SupplierRefundProduct	Optional	—	Optional	Optional

Supplier

entity_name: supplier supplier master data

Field	Type	Description
`id` *	string (max 100)	Supplier identifier
`name` *	string (max 200)	Supplier name
`code`	string (max 200)	Internal supplier code

SupplierBonus

entity_name: supplierbonus supplier bonuses / trade terms

Field	Type	Description
`id` *	string (max 100)	Bonus identifier
`type_id` *	string (max 100)	Bonus type identifier
`store_id`	string (max 100)	Store identifier If the field is not filled in, then bonuses are divided into all stores
`supplier_id` *	string (max 100)	Supplier identifier
`product_id`	string (max 100)	Product identifier
`date_from` *	datetime (`YYYY-MM-DD HH:MM:SS`)	Bonus start date
`date_to` *	datetime (`YYYY-MM-DD HH:MM:SS`)	Bonus end date
`bonus` *	decimal	The amount of money received from suppliers as a bonus from the sale of products for the selected period

SupplierBonusType

entity_name: supplierbonustype supplier bonus type reference

Field	Type	Description
`id` *	string (max 100)	Bonus type identifier
`name` *	string (max 200)	Bonus type name

SupplierMarker

entity_name: suppliermarker supplier tag reference can be created manually via DataConsole

Field	Type	Description
`id` *	string (max 100)	Suppliers marker identifier
`parent_id`	string (max 100)	Suppliers parent marker identifier
`name` *	string (max 200)	Suppliers marker name

SupplierMarkerM2M

entity_name: suppliermarkerm2m supplier-to-tag mapping

Field	Type	Description
`supplier_id` *	string (max 100)	Supplier identifier
`marker_id` *	string (max 100)	Suppliers marker identifier

SupplierPercentBonus

entity_name: supplierpercentbonus

Field	Type	Description
`id` *	string (max 100)	—
`type_id` *	string (max 100)	—
`store_id`	string (max 100)	—
`supplier_id` *	string (max 100)	—
`product_id`	string (max 100)	—
`date_from` *	datetime (`YYYY-MM-DD HH:MM:SS`)	—
`date_to` *	datetime (`YYYY-MM-DD HH:MM:SS`)	—
`bonus_percent` *	decimal	—

SupplierProductM2M

entity_name: supplierproductm2m supplier product assortment

Field	Type	Description
`supplier_id` *	string (max 100)	Supplier identifier
`store_id`	string (max 100)	Store identifier If no store is specified, then it acts on the chain
`product_id` *	string (max 100)	Product identifier
`date_from` *	date (`YYYY-MM-DD`)	Contract start date
`date_to`	date (`YYYY-MM-DD`)	Contract end date

SupplierRefund

entity_name: supplierrefund supplier return documents

Field	Type	Description
`id` *	string (max 100)	Return document identifier
`code` *	string (max 200)	External return document code
`created_at` *	datetime (`YYYY-MM-DD HH:MM:SS`)	Return document date and time
`supplier_id` *	string (max 100)	Supplier identifier (who received a return)
`store_id` *	string (max 100)	Store identifier
`staff_id`	string (max 100)	Responsible employee identifier (author of the document)

SupplierRefundProduct

entity_name: supplierrefundproduct supplier return line items

Field	Type	Description
`document_id` *	string (max 100)	Return document identifier
`product_id` *	string (max 100)	Product identifier
`refund_date` *	date (`YYYY-MM-DD`)	Date of the supplier refund document this line belongs to.
`qty` *	decimal	Returned products qty
`cost_price` *	decimal	Unit cost price of product
`value`	decimal	Total cost price of the returned products to the supplier By default, auto-filled by the formula SupplierRefundProduct.qtySupplierRefundProduct.cost_price*

Price Reference

Entity	BI	PlanoHero	StoreManager	DataMonetization
PriceDocument	Optional	Recommended	Recommended	—
PriceProduct	Optional	Recommended	Recommended	—
PriceStore	Optional	Recommended	Recommended	—
PriceType	Optional	Recommended	Recommended	—

PriceDocument

entity_name: pricedocument price update documents

Field	Type	Description
`id` *	string (max 100)	Price document identifier
`type_id` *	string (max 100)	Price type identifier
`date_from` *	datetime (`YYYY-MM-DD HH:MM:SS`)	Price start date
`date_to`	date (`YYYY-MM-DD`)	Price end date

PriceProduct

entity_name: priceproduct product price assignments

Field	Type	Description
`document_id` *	string (max 100)	Price document identifier
`product_id` *	string (max 100)	Product identifier
`price_date` *	datetime (`YYYY-MM-DD HH:MM:SS`)	Date of the price document this line belongs to.
`a_price` *	decimal	Product price

PriceStore

entity_name: pricestore store-level price assignments

Field	Type	Description
`document_id` *	string (max 100)	Price document identifier
`store_id` *	string (max 100)	Store identifier
`price_date` *	datetime (`YYYY-MM-DD HH:MM:SS`)	Date of the price document this line belongs to.

PriceType

entity_name: pricetype price type reference

Field	Type	Description
`id` *	string (max 100)	Price type identifier
`name` *	string (max 200)	Price type name
`is_actual`	boolean	Is this the current price? By default always = 0, if it is = 1, then it’s current

Staff

Entity	BI	PlanoHero	StoreManager	DataMonetization
CategoryManagerCategoryM2M	Optional	—	—	—
CategoryManagerProductM2M	Optional	—	—	—
Staff	Recommended	—	—	—
StaffGroup	Recommended	—	—	—

CategoryManagerCategoryM2M

entity_name: categorymanagercategorym2m category manager scope — category assignments

Field	Type	Description
`staff_id` *	string (max 100)	Category manager identifier
`store_id`	string (max 100)	Store identifier ( if the manager has access to all stores, do not fill it in)
`category_id` *	string (max 100)	Category identifier
`date_from` *	date (`YYYY-MM-DD`)	Start date of work with the category If the field is not filled in, then the date of the first reporting period is automatically entered.
`date_to`	date (`YYYY-MM-DD`)	End date of work with the category

CategoryManagerProductM2M

entity_name: categorymanagerproductm2m category manager scope — product assignments

Field	Type	Description
`staff_id` *	string (max 100)	Category manager identifier
`store_id`	string (max 100)	Store identifier ( if the manager has access to all stores, do not fill it in)
`product_id` *	string (max 100)	Product identifier
`date_from` *	date (`YYYY-MM-DD`)	Start date of work with the product If the field is not filled in, then the date of the first reporting period is automatically entered.
`date_to`	date (`YYYY-MM-DD`)	End date of work with the product

Staff

entity_name: staff employee master data cashiers, category managers, sales advisors

Field	Type	Description
`id` *	string (max 100)	Employee identifier
`name` *	string (max 200)	Name of the employee
`group_id`	string (max 100)	Employee group identifier

StaffGroup

entity_name: staffgroup employee group reference

Field	Type	Description
`id` *	string (max 100)	Staff group identifier
`parent_id`	string (max 100)	Staff parent group identifier
`name` *	string (max 200)	Staff group name
`is_categorymanager`	boolean	Default is set to “0”, if set to “1”, the employee of this group is identified as a category manager
`is_cashier`	boolean	Default is set to “0”, if set to “1”, the employee of this group is identified as a cashier
`is_advisor`	boolean	Default is set to “0”, if set to “1”, the employee of this group is identified as a sales consultant

Loyalty

Entity	BI	PlanoHero	StoreManager	DataMonetization
Loyalty	Optional	—	—	Optional
LoyaltyBonus	Optional	—	—	—
LoyaltyGroup	Optional	—	—	Optional
LoyaltyMarker	Optional	—	—	Optional
LoyaltyMarkerM2M	Optional	—	—	Optional

Loyalty

entity_name: loyalty loyalty programme customer master data

Field	Type	Description
`id` *	string (max 100)	LP client identifier
`cardno` *	string (max 20)	LP client’s discount card number
`group_id`	string (max 100)	LP client group identifier
`birthday`	date (`YYYY-MM-DD`)	Date of birth LP client
`registration_date`	date (`YYYY-MM-DD`)	Date of registration of the client LP
`gender`	boolean	Gender (male/female) If 1 - male, 0 - female, Null - not defined

LoyaltyBonus

entity_name: loyaltybonus loyalty customer bonus register

Field	Type	Description
`id` *	string (max 100)	Bonus identifier
`record_type` *	integer	Is it bonuses write-off? (0 - accumulation, 1 - write-off)
`loyalty_id` *	string (max 100)	LP client identifier
`receipt_id`	string (max 100)	Receipt identifier
`product_id`	string (max 100)	Product identifier
`created_at` *	datetime (`YYYY-MM-DD HH:MM:SS`)	Date of bonus accrual
`bonus` *	decimal	Bonus amount in monetary units (if it is a write-off, the bonus amount should be negative)

LoyaltyGroup

entity_name: loyaltygroup loyalty customer group reference primary hierarchy

Field	Type	Description
`id` *	string (max 100)	LP clients group identifier
`parent_id`	string (max 100)	LP clients parent group identifier
`name` *	string (max 200)	LP clients group name

LoyaltyMarker

entity_name: loyaltymarker loyalty customer tag reference additional structure (can be created manually via DataConsole)

Field	Type	Description
`id` *	string (max 100)	LP clients marker identifier
`parent_id`	string (max 100)	LP clients parent marker identifier
`name` *	string (max 200)	LP clients marker name

LoyaltyMarkerM2M

entity_name: loyaltymarkerm2m loyalty customer-to-tag mapping

Field	Type	Description
`loyalty_id` *	string (max 100)	LP client identifier
`marker_id` *	string (max 100)	LP client marker identifier

​Stores

​Store

​StoreGroup

​StoreMarker

​StoreMarkerM2M

​Terminal

​TerminalMarker

​TerminalMarkerM2M

​Assortment

​Assortment

​AssortmentType

​Brand

​Category

​MasterPosition

​MasterPositionProductM2M

​Producer

​Product

​ProductImage

​ProductMarker

​ProductMarkerM2M

​ProductSize

​ProductStatus

​RecommendedFaces

​Status

​Unit

​Sales

​Receipt

​ReceiptItem

​ReceiptMarker

​ReceiptMarkerM2M

​Promotions

​Promotion

​PromotionProductM2M

​PromotionReceiptitemM2M

​PromotionType

​Logistics

​Posting

​PostingProduct

​PurchaseOrder

​PurchaseOrderProduct

​Receive

​ReceiveProduct

​Relocate

​RelocateProduct

​Stock

​Writeoff

​WriteoffProduct

​WriteoffType

​Supplier

​Supplier

​SupplierBonus

​SupplierBonusType

​SupplierMarker

​SupplierMarkerM2M

​SupplierPercentBonus

​SupplierProductM2M

​SupplierRefund

​SupplierRefundProduct

​Price Reference

​PriceDocument

​PriceProduct

​PriceStore

​PriceType

​Staff

​CategoryManagerCategoryM2M

​CategoryManagerProductM2M

​Staff

​StaffGroup

​Loyalty

​Loyalty

​LoyaltyBonus

​LoyaltyGroup

​LoyaltyMarker

​LoyaltyMarkerM2M

Stores

Store

StoreGroup

StoreMarker

StoreMarkerM2M

Terminal

TerminalMarker

TerminalMarkerM2M

Assortment

Assortment

AssortmentType

Brand

Category

MasterPosition

MasterPositionProductM2M

Producer

Product

ProductImage

ProductMarker

ProductMarkerM2M

ProductSize

ProductStatus

RecommendedFaces

Status

Unit

Sales

Receipt

ReceiptItem

ReceiptMarker

ReceiptMarkerM2M

Promotions

Promotion

PromotionProductM2M

PromotionReceiptitemM2M

PromotionType

Logistics

Posting

PostingProduct

PurchaseOrder

PurchaseOrderProduct

Receive

ReceiveProduct

Relocate

RelocateProduct

Stock

Writeoff

WriteoffProduct

WriteoffType

Supplier

Supplier

SupplierBonus

SupplierBonusType

SupplierMarker

SupplierMarkerM2M

SupplierPercentBonus

SupplierProductM2M

SupplierRefund

SupplierRefundProduct

Price Reference

PriceDocument

PriceProduct

PriceStore

PriceType

Staff

CategoryManagerCategoryM2M

CategoryManagerProductM2M

Staff

StaffGroup

Loyalty

Loyalty

LoyaltyBonus

LoyaltyGroup

LoyaltyMarker

LoyaltyMarkerM2M