Skip to content
Client Resources 717.442.3247
Technical Documentation > Entities

INVENTRY

Product

Inherits from EbmsEntity

Properties

    A_PUR_MAXO (Decimal, Decimal)
    Maximum
    Maximum reorder amount
    A_PUR_MINO (Decimal, Decimal)
    Minimum
    Minimum reorder amount
    Accessories (INVENACC, reference, collection)
    Accessories
    AccessoryDetails (INVENACCDET, reference, collection)
    AccessoriesDetails
    ADJ_INVEN (EbmsText, String)
    Adjust cost in item
    APINVDETs (APINVDET, reference, collection)
    Invoice detail
    ARINVDETs (ARINVDET, reference, collection)
    Invoice detail
    ARQTDETs (ARQTDET, reference, collection)
    ARQTDETs
    AUTO_COST (Boolean, Boolean)
    Made to order
    AUTOID (EbmsAutoID, String, read-only)
    Auto ID
    The ID that identifies the record in EBMS
    Barcode (Barcode, String, virtual)
    Barcode
    BarcodeType (Text, String, virtual)
    Barcode type
    BASE (Decimal, Decimal)
    Base price
    BC_ID (EbmsID, String)
    Bc ID
    C_TYPE (SmallPositiveInteger, Int32)
    Classification
    Classification (InventoryClassification, reference, virtual)
    Classification
    cmdAdjustments (INVENTRYCmdAdjustments, Adjustments)
    Adjustments...
    cmdCreateFromText (ICreateFromTextCmdCreateFromText, CreateFromText)
    Create from text
    cmdGetPrice (INVENTRYCmdGetPrice, GetPrice)
    Get price
    cmdUpdateLocked (ILockableCmdUpdateLocked, UpdateLocked)
    Update locked
    read the DBDOCLOCK and check if this entity is locked
    cmdUseBarcode (IBarcodeScannerCmdUseBarcode, UseBarcode)
    Use barcode
    COMP_FLATV (Boolean, Boolean)
    Exclude from Materials List Price Distribution
    ComponentDetails (INCOMPDET, reference, collection)
    Component details
    Components (INVENDET, reference, collection)
    Components
    COST (Decimal, Decimal)
    Cost
    COUNT (ReadOnlyDecimal, Decimal, read-only)
    Processed
    CTO_PROMPT (NeverAlwaysAsk, NeverAlwaysAsk)
    Prompt user to configure components to order
    D_DEM (Decimal, Decimal)
    3rd Dimension
    D_HEIGHT (Decimal, Decimal)
    Default Height
    D_WIDTH (Decimal, Decimal)
    Default Width
    DATE (DateDefaultedToday, Nullable`1, required, read-only)
    Entry date
    DEF_UNIT (EbmsUnit, String)
    Default selling
    DEF_UNIT_Reference (Uom, reference, virtual)
    Default selling
    DEF_UNIT_ReferenceItems (INVENUNT, reference, collection, virtual)
    Default unit items
    DefaultSellingPrices (PricingView, reference, collection, virtual)
    Default selling prices
    DESCR_1 (EbmsDescription, String)
    Description
    DESCR_1PRN (Boolean, Boolean)
    Show description 1 on sales document
    DESCR_1PRP (Boolean, Boolean)
    Show description 1 on purchase document
    DESCR_2 (EbmsDescription, String)
    Description 2
    DESCR_2PRN (Boolean, Boolean)
    Show description 2 on sales document
    DESCR_2PRP (Boolean, Boolean)
    Show description 2 on purchase document
    DESCR_3 (MultilineText, String)
    Description 3
    DESCR_3PRN (Boolean, Boolean)
    Show description 3 on sales document
    DESCR_3PRP (Boolean, Boolean)
    Show description 3 on purchase document
    DESCR1COPY (Boolean, Boolean)
    Description 1 copy
    DESCR2COPY (Boolean, Boolean)
    Description 2 copy
    DESCR3COPY (Boolean, Boolean)
    Description 3 copy
    DocumentsBrowser (ServerFileBrowser, reference, virtual, read-only)
    Documents browser
    DocumentsPath (String, String, virtual, read-only)
    Documents path
    DocumentsStatus (String, String, virtual, read-only)
    Documents status
    EACH_UNIT (EbmsUnit, String)
    Main unit
    EXTERNALID (EbmsText, String)
    External ID
    FIXED_COST (Boolean, Boolean)
    Fixed cost
    FOLDERNAME (ReadOnlyEbmsName, String, read-only)
    Category
    ID (EbmsNaturalKeyCustom, String, required)
    Product
    INACTIVE (Boolean, Boolean)
    Inactive
    INATINVENATTRs (INATINVENATTR, reference, collection)
    INATINVENATTRs
    INATINVENATTRSETs (INATINVENATTRSET, reference, collection)
    INATINVENATTRSETs
    INCOMPDETs (INCOMPDET, reference, collection)
    Component detail
    INREDETs (INREDET, reference, collection)
    INREDETs
    INRGDETDFs (INRGDETDF, reference, collection)
    INRGs (INRG, reference, collection)
    INT_QUAN (Boolean, Boolean)
    All units require integer quantities
    INTRANs (INTRAN, reference, collection)
    INTRANs
    INVENACCDETs (INVENACCDET, reference, collection)
    INVENACCDETs
    INVENACCs (INVENACC, reference, collection)
    INVENACCs
    INVENDETs (INVENDET, reference, collection)
    INVENDETs
    INVENDORs (INVENDOR, reference, collection)
    Vendor
    INVENLOCs (INVENLOC, reference, collection)
    Location
    INVENMFs (INVENMF, reference, collection)
    INVENMFs
    InvenSubts (INVENSUBT, reference, collection)
    Substitute
    INVENSUBTs (INVENSUBT, reference, collection)
    Substitute
    INVENTRYIMAGESs (INVENTRYIMAGES, reference, collection)
    INVENTRYIMAGESs
    INVENTRYSHOWWEBs (INVENTRYSHOWWEB, reference, collection)
    INVENTRYSHOWWE bs
    INVENUNTs (INVENUNT, reference, collection)
    Units of measure
    INVENWHs (INVENWH, reference, collection)
    Warehousing
    INVENWHYs (INVENWHY, reference, collection)
    INVENWHys
    INVPRICEs (INVPRICE, reference, collection)
    Product
    INVYEARs (INVYEAR, reference, collection)
    INVYEARs
    IsDeleted (Boolean, Boolean, virtual, read-only)
    Is deleted
    IsLocked (Boolean, Boolean, virtual)
    Locked
    IsNewEntity (Boolean, Boolean, virtual)
    Is new entity
    A virtual property that we can base computes off of to show if an entity is virtual
    JOB_OUT_O (ReadOnlyDecimal, Decimal, read-only)
    Job transfer ordered
    JOB_OUT_S (ReadOnlyDecimal, Decimal, read-only)
    Job transfer shipped
    LAST_CHK_D (DateDefaultedToday, Nullable`1)
    Last reconcile date
    LAST_CHK_T (Time, TimeSpan)
    Last reconcile time
    LAST_CHK_U (EbmsPerson, String)
    Last reconcile user
    M_IN_O (ReadOnlyDecimal, Decimal, read-only)
    Manufacturing ordered
    M_IN_S (ReadOnlyDecimal, Decimal, read-only)
    Manufacturing received
    M_OUT_O (ReadOnlyDecimal, Decimal, read-only)
    Manufacturing consumed
    M_OUT_S (ReadOnlyDecimal, Decimal, read-only)
    Manufacturing shipped
    MARKUP (EbmsFormulaText, String)
    {$INOPTION.MARG_MARK}
    Markup template
    MARKUP_ID (EbmsID, String)
    Markup type ID
    MARKUP_ID_Reference (FORMULA, reference)
    Markup type
    MAX_INVEN (Decimal, Decimal, read-only)
    Maximum
    MEMO (MultilineText, String)
    Notes
    MFG (EbmsID, String, read-only)
    Manufacturing
    MFG_PART (EbmsPartNumber, String)
    Part number
    MIN_INVEN (Decimal, Decimal, read-only)
    Minimum
    NET_ORDER (Decimal, Decimal, read-only)
    Net ordered
    NOTQTYSELL (Boolean, Boolean)
    Prevent web purchases exceeding on hand quantity
    ORDER_AMT (Decimal, Decimal, read-only)
    Reorder increment
    OSTK_MSG (EbmsDescription, String)
    Out of stock message
    PRI_VENDOR (EbmsIDSearch, String)
    Primary vendor ID
    PRI_VENDOR_Reference (APVENDOR, reference)
    Primary vendor
    PUR_O (ReadOnlyDecimal, Decimal, read-only)
    Purchase orders ordered
    PUR_S (ReadOnlyDecimal, Decimal, read-only)
    Purchase orders received
    PURC_METH (SmallPositiveInteger, Int32)
    PURC_METH
    Purchase method
    QUAN2ORDER (Decimal, Decimal)
    Quantity to order
    SALES_O (ReadOnlyDecimal, Decimal, read-only)
    Sales orders ordered
    SALES_S (ReadOnlyDecimal, Decimal, read-only)
    Sales orders received
    SalesActivities (SalesActivityDetail, reference, collection, virtual, read-only)
    Sales activities
    SalesActivityCustomer (RealARCUST, reference, virtual)
    Customer
    SalesActivityEndDate (DateDefaultedToday, Nullable`1, virtual)
    End Date
    SalesActivityHiddenColumns (Text, String, collection, virtual)
    Sales activity hidden columns
    SalesActivityInvoiceStatusNames (Text, String, collection, virtual)
    Sales activity invoice status names
    SalesActivityStartDate (Date, Nullable`1, virtual)
    Start Date
    SalesActivityStatus (StatusName, String, virtual)
    Doc Type
    SHOW_WEB (Boolean, Boolean)
    Show in web
    Subtitle (BasicHtmlCompact, String, virtual, read-only)
    Subtitle
    T_AVAIL (Decimal, Decimal, read-only)
    Available
    Depending on which option is selected in Inventory Options > General tab > "Available Quantity Calculation", there are two variations to calculate the available quantity:
    T_ON_HAND (Decimal, Decimal, read-only)
    On hand
    Indicates how many currently available for sale. It is the sum total of the Processed field and the Received/Shipped column.
    TAX_GROUP (EbmsText, String)
    Tax group ID
    TAX_GROUP_Reference (ARTAXGROUP, reference)
    Tax group
    Title (Title, String, virtual, read-only)
    Title
    TREE_ID (EbmsTreeID, String)
    Category ID
    TREE_ID_Reference (UnrestrictedINVENTRE, reference, required)
    Category
    TREE_PATH (EbmsTreePath, String)
    Tree Path
    TYPE (EbmsType, String)
    Type
    UPC (Barcode, String)
    UPC or alternate ID
    UPC2 (Barcode, String)
    UPC 2 or Alternate Id2
    UPC3 (Barcode, String)
    UPC 3 or Alternate Id3
    UPDATECOST (Boolean, Boolean)
    Update cost from purchases
    UPDVENCOST (Boolean, Boolean)
    Update info from purchases
    USE_ITEMGL (Boolean, Boolean)
    Use this item's sales G/L for components
    V_DESCR_1 (EbmsDescription, String)
    Product title
    V_DESCR_2 (EbmsMemo, String)
    Short description
    V_DESCR_3 (EbmsMemo, String)
    Long description
    Warehouse (INVENWH, reference, virtual)
    Warehouse
    WAREHOUSE (EbmsWarehouseSelect, String)
    Warehouse
    Warehouses (EbmsWarehouse, String, collection, virtual)
    Warehouses
    WEB (EbmsWebsite, String)
    Website
    WEB_DESCR1 (EbmsDescription, String)
    Web description 1
    WEB_DESCR2 (EbmsMemo, String)
    Web description 2
    WEB_DESCR3 (EbmsMemo, String)
    Web description 3
    WEIGHT (Decimal, Decimal)
    Gross weight
Version 1.7.283.4, Updated on Thursday, December 19, 2024

Reading products

GEThttps://ecc123456789012345.servicebus.windows.net/MyEbms/ABC/OData/INVENTRY?$filter=ID eq 'DIRSHO'

Creating products

POSThttps://ecc123456789012345.servicebus.windows.net/MyEbms/ABC/OData/INVENTRY
{ 
    "ID": "DIRSHO",
    "TREE_ID": "85",
    "DESCR_1": "Dirt Shovel",
    "COST": 12.42,
    "BASE": 18.59
}

Updating products

PATCHhttps://ecc123456789012345.servicebus.windows.net/MyEbms/ABC/OData/INVENTRY('061PBSEDENMPC801')
{
  "DESCR_1": "Dirt Shovel",
  "UPC": "1234567890"
}

Getting the price of a product

GET
NATURALKEY:  https://ecc123456789012345.servicebus.windows.net/MyEbms/ABC/OData/INVENTRY(ID='BANANAS')/Model.Entities.GetPrice 

GUID: https://ecc123456789012345.servicebus.windows.net/MyEbms/ABC/OData/INVENTRY(50313630-5342-4445-454e-d5043383031)/Model.Entities.GetPrice

EBMS AUTOID: https://ecc123456789012345.servicebus.windows.net/MyEbms/ABC/OData/INVENTRY('061PBSEDENMPC801')/Model.Entities.GetPrice

{

    "PriceLevel": "Wholesale",
    "Uom": "cs",
    "CustomerId": "AMERET", 
    "Quantity": 10
}

Adjusting Inventory

POSThttps://ecc123456789012345.servicebus.windows.net/MyEbms/ABC/OData/INVENTRY('PBRUSHS')/Model.Entities.Adjustments

{
    "Warehouse": "LOCB",  //Default warehouse will be used if not specified.
    "AdjustmentQuantity": 3,  //Adjust the current on hand up or down.
    "NewQuantity": 3,  //Alternative option to AdjustmentQuantity and sets On Hand.
    "Date": "20241127",  //Not required. Today's date will be used in not specified.
    "UnitValue": 15,  //Not required. Only used when increasing value. 
    "Description": "Sample Description"  //Not required.
}