Required

stockOrderPOLineItemID : string (GUID)

The Unique identifier for this record

Required

active_RevisionID : number (int)

This represents the revision of the configuration data that was being used when this record was generated. This is primarily for use by the PowerEPOS software, however 3rd party integrators can set this too if they
are using our configuration data as a basis for information, otherwise just set this to 0.

Required

sortID : number (int)

For asthetic reasons, the order this line is displayed within the stock invoice

Required

itemType : StockItemStringItemType

Defines the type of item this line is referencing, ie a StockItem (Ingredient, Mix, Redirect, Recipe) or Discount/Adjustment etc

Required MaxLength(50)

itemCommonName : string

The name of the item record, this must always be set and should not be blank.
3rd Party integrations can make up their own names, or they can base them on the existing configuration records if available.
Note: This should be in the organisations "Common Language", ie their overall default neutral language (typically English).
Example: "Garlic Bread" or "10% Discount"

Required MaxLength(50)

itemLocalizedName : string

The localised name of the item record, this must always be set and should not be blank.
3rd Party integrations can make up their own names, or they can base them on the existing MainGroup configuration if available.
Note: This should be in the outlets "Local Language", ie the language used by the POS system on site. This may or may not be the same as the common language.
Example: "Garlic Bread" or "10% Discount"

Required MaxLength(24)

saleModifierCommonName : string

The name of the Sale Modifier applied to this item record (if applicable). Applies to PLU Sale based items only.
For PLU Sale based item types, if no Sales Modifier was applied then set this to "[No Modifier]"
For all other item types, set this to blank (ie empty string)
3rd Party integrations can make up their own sale modifier names if required, or they can base them on the existing configuration records if available.
Note: This should be in the organisations "Common Language", ie their overall default neutral language (typically English).
Example: "Pint" or "Double Shot"

Required MaxLength(24)

saleModifierLocalizedName : string

The localised name of the Sale Modifier applied to this item record (if applicable). Applies to PLU Sale based items only.
For PLU Sale based item types, if no Sales Modifier was applied then set this to "[No Modifier]"
For all other item types, set this to blank (ie empty string)
3rd Party integrations can make up their own sale modifier names if required, or they can base them on the existing configuration records if available.
Note: This should be in the outlets "Local Language", ie the language used by the POS system on site. This may or may not be the same as the common language.
Example: "Pint" or "Double Shot"

Required MaxLength(8)

saleModifierPrefixCommonName : string

The prefix of the Sale Modifier applied to this item record (if applicable). Applies to PLU Sale based items only, prefix is optional for Sales Modifiers. Prefixes are applied to the front of the item name.
For PLU Sale based item types, if no Sales Modifier was applied then this should be blank (ie empty string).
For all other item types, set this to blank (ie empty string).
3rd Party integrations can make up their own sale modifier names if required, or they can base them on the existing configuration records if available.
Note: This should be in the organisations "Common Language", ie their overall default neutral language (typically English).
Example: "PINT" (as in 1 x PINT Carlsberg) or "DBL" (as in 1 x DBL Jack Daniels on ice)

Required MaxLength(8)

saleModifierPrefixLocalizedName : string

The localised prefix of the Sale Modifier applied to this item record (if applicable). Applies to PLU Sale based items only, prefix is optional for Sales Modifiers. Prefixes are applied to the front of the item name.
For PLU Sale based item types, if no Sales Modifier was applied then this should be blank (ie empty string).
For all other item types, set this to blank (ie empty string).
3rd Party integrations can make up their own sale modifier names if required, or they can base them on the existing configuration records if available.
Note: This should be in the outlets "Local Language", ie the language used by the POS system on site. This may or may not be the same as the common language.
Example: "PINT" (as in 1 x PINT Carlsberg) or "DBL" (as in 1 x DBL Jack Daniels on ice)

Required

dateTimeCreated : object

Required MaxLength(32)

createdBy_UserName : string

Nullable

groupID_Stock : string (GUID)

Nullable MaxLength(32)

groupCommonName : string

Nullable MaxLength(32)

groupLocalizedName : string

Nullable

mainGroupID : string (GUID)

Nullable MaxLength(32)

mainGroupCommonName : string

Nullable MaxLength(32)

mainGroupLocalizedName : string

Nullable

itemReferenceID : string (GUID)

The related PLUID or StockInvoiceAdjustmentID

Nullable MaxLength(18)

supplierProductCode : string

The optional product code dictated by the supplier

Nullable MaxLength(128)

supplierProductName : string

The optional product name dictated by the supplier

Nullable MaxLength(18)

plU : string

The PLU number this item was generated from

Nullable decimal(18, 5)

portionUOMConversionFactor : number (decimal)

The UOM Conversion factor from the source PLU's portion UOM

Nullable MaxLength(24)

portionUOMCommonName : string

The UOM common name from the source PLU's portion UOM

Nullable MaxLength(24)

portionUOMLocalizedName : string

The UOM localized name from the source PLU's portion UOM

Nullable MaxLength(8)

portionUOMSuffixCommonName : string

The UOM common suffix from the source PLU's portion UOM

Nullable MaxLength(8)

portionUOMSuffixLocalizedName : string

The UOM localized suffic from the source PLU's portion UOM

Nullable decimal(18, 5)

portionSize : number (decimal)

The PortionSize from the source PLU's configuration, should always be greater than 0

Nullable decimal(18, 5)

qtyProducedPerRecipe : number (decimal)

The QtyProducedPerRecipe factor from the source PLU's configuration (if applicable), otherwise will be 0

Nullable

salesModifierID : string (GUID)

The unique ID of the POS_SalesModifier (configuration) record matching the Sales Modifier that was added to the item (if applicable).
Only applicable for PLU sale items (ie ItemType 1-9), leave NULL for all other line types or where no Sales Modifier was applied.
This may be NULL for 3rd party integrations or where no configuration based service mode was used

Nullable

taxGroupID : string (GUID)

This is the unique TaxGroupID of a record from the POS_TaxGroups (configuration) table representing the Tax Group which was used for tax calculations on this item.
Only applicable for PLU sale items (ie ItemType 1-9), leave NULL for all other line types.
3rd Party integrations would normally set this to be NULL

Nullable MaxLength(32) Truncates

taxGroupCommonName : string

The name of the Tax Group which was used for tax calculations on this item.
Only applicable for PLU sale items (ie ItemType 1-9), leave blank (empty string) for all other line types.
3rd Party integrations can make up their own tax group names if required, or they can base them on the existing configuration records if available.
Note: This should be in the organisations "Common Language", ie their overall default neutral language (typically English).
Example: "VAT" or "GST" or "Tax Free"

Nullable MaxLength(32) Truncates

taxGroupLocalizedName : string

The localised name of the Tax Group which was used for tax calculations on this item.
Only applicable for PLU sale items (ie ItemType 1-9), leave blank (empty string) for all other line types.
3rd Party integrations can make up their own tax group names if required, or they can base them on the existing configuration records if available.
Note: This should be in the outlets "Local Language", ie the language used by the POS system on site. This may or may not be the same as the common language.
Example: "VAT" or "GST" or "Tax Free"

Nullable decimal(18, 5)

uomQty : number (decimal)

Nullable

uomiD : string (GUID)

Nullable decimal(18, 5)

uomConversionFactor : number (decimal)

Nullable

uomType : number (int)

Nullable MaxLength(24)

uomCommonName : string

Nullable MaxLength(24)

uomLocalizedName : string

Nullable MaxLength(8)

uomCommonSuffix : string

Nullable MaxLength(8)

uomLocalizedSuffix : string

Nullable decimal(18, 5)

qty : number (decimal)

The quantity of units being purchased

Nullable decimal(18, 7)

unitPrice : number (decimal)

The unit price of this line item

Nullable decimal(18, 2)

amount : number (decimal)

The total amount the order is listing for this line item (includes inclusive taxes, but excludes addon taxes)

Nullable decimal(18, 7)

taxPurchases1 : number (decimal)

The taxable purchase amount used for the calculations of tax level 1

Nullable decimal(18, 7)

taxPurchases2 : number (decimal)

The taxable purchase amount used for the calculations of tax level 2

Nullable decimal(18, 7)

taxPurchases3 : number (decimal)

The taxable purchase amount used for the calculations of tax level 3

Nullable decimal(18, 7)

taxPurchases4 : number (decimal)

The taxable purchase amount used for the calculations of tax level 4

Nullable decimal(18, 7)

incTax1 : number (decimal)

The total inclusive tax amount for tax level 1

Nullable decimal(18, 7)

incTax2 : number (decimal)

The total inclusive tax amount for tax level 2

Nullable decimal(18, 7)

incTax3 : number (decimal)

The total inclusive tax amount for tax level 3

Nullable decimal(18, 7)

incTax4 : number (decimal)

The total inclusive tax amount for tax level 4

Nullable decimal(18, 7)

exTax1 : number (decimal)

The total exclusive tax amount for tax level 1

Nullable decimal(18, 7)

exTax2 : number (decimal)

The total exclusive tax amount for tax level 2

Nullable decimal(18, 7)

exTax3 : number (decimal)

The total exclusive tax amount for tax level 3

Nullable decimal(18, 7)

exTax4 : number (decimal)

The total exclusive tax amount for tax level 4

Nullable

dateTimeDeleted : object

Nullable

createdBy_EmployeeID : string (GUID)

Nullable

createdBy_UserID : string (GUID)

Nullable

deletedBy_EmployeeID : string (GUID)

Nullable

deletedBy_UserID : string (GUID)

Nullable MaxLength(32)

deletedBy_UserName : string