Interface ITmxInventory

Method name: ChangeInventoryControl

Short Description
Provides inventory control.
Stored Procedure
com_update_inv_changeinvctl
Functionality
Change the following attributes of the current inventory record (DBA.inventory_current) based on the PLU number (item):
- CanOder
- MinStockAmt
- MaxStockAmt
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
Item	IN	BSTR
CanOrder	IN	BOOL
MinStockAmt	IN	VARIANT
MaxStockAmt	IN	VARIANT

Method name: GetStoreTransferDtl

Short Description
Retrieves the transfer detail.
Stored Procedure
com_get_store_transfer_dtl
Functionality
You make the query based on the parameters Documentnum and Plunum. SAP POS stores the results in memory. You can access the stored results by calling get_Qty, get_Qtyreceived, and get_Shortove.
Preconditions
You have registered TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
Documentnum	IN	BSTR
Plunum	IN	BSTR

Method name: Inquiry

Short Description
Inquires on the inventory for a specific item.
Stored Procedure
com_get_inventory_current
Functionality
Search for an inventory record in the database based on the PLU number. SAP POS stores the first record it finds in memory for use by the function calls that follow, such as get_StoreNumber. You can find a list of similar calls in TmxApi.tlh. There is a corresponding get method for every single field in the table DBA.inventory_current.

You can provide a collection format by calling put_collectionFormat before the inquiry.
- If you provide a collection format, get_collection returns the fields corresponding to the collection format.
- If you do not provide a collection format, get_collection returns the entire record.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
Item	IN	BSTR
SkuType	IN	SkuTypeEnum

Method name: InquiryBatch

Short Description
Runs a batch of inventory inquiries and outputs the results to a file.
Stored Procedure
com_get_inventory_current
Functionality
Search for inventory records in the database based on the values you provide in the parameter ItemListFile. ItemListFile is a comma delimited file with the following two fields:
- Plunum
- Itemtype
SAP POS stores the result in memory for use by the function calls that follow, such as ManualAdjustment. SAP POS also outputs the results of the inventory record to the file with the name passed in the parameter OutputFile.
Preconditions
TmxAPI.DLL must be registered.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
ItemListFile	IN	BSTR
OutputFile	IN	BSTR

Method name: put_CollectionFormat

Short Description
Define a list of the fields that you want to query.
Functionality
Define a list of fields that you want to query based on the following available tokens:

PluNumber,ItemType,CanOrder,QuantityMinimum,QuantityMaximum,CreationDate,QuantityPreissue,QuantityCurrent,LastOrderedDate,LastReceivedDate,LastVendorCost,LastVendorID,LastSoldDate,LastReturnDate,PeriodStartDate,InventoryControlled,QuantityOnOrder,StoreNumber

Field tokens must be comma delimited.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
arg	IN	BSTR

Method name: InsertStoreTransfer

Short Description
Creates a store transfer record.
Stored Procedure
com_insert_store_transfer
Functionality
Insert a store transfer record into the database.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
CartonCount	IN	VARIANT
HashQty	IN	VARIANT
Manual	IN	BSTR
Modtime	IN	VARIANT
Note	IN	BSTR
Origin	IN	BSTR
ReasonCode	IN	BSTR
ReceiveMethod	IN	BSTR
ShipType	IN	BSTR
TransferDate	IN	VARIANT
TransferStore	IN	VARIANT
TransferType	IN	BSTR
Transnum	IN	VARIANT
TxnDate	IN	VARIANT
TxnStatus	IN	BSTR
VendorNum	IN	BSTR

Method name: ManualAdjustment

Short Description
Provides an inventory manual adjustment.
Stored Procedure
com_manualadjustment
Functionality
Update the inventory adjustment record based on the input. If you set the UpdateTLOGFlag parameter to TRUE this method also updates the TLOG.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
UpdateTLOGFlag	IN	BOOL
StartInvControlFlag	IN	BOOL
Cashier	IN	VARIANT
TransactionDate	IN	VARIANT
Item	IN	BSTR
SkuType	IN	SkuTypeEnum
AdjustmentType	IN	AdjustmentTypeEnum
Quantity	IN	VARIANT
ReasonID	IN	VARIANT
Note	IN	BSTR

Method name: PhysicalInventory

Short Description
Updates the physical inventory.
Stored Procedure
com_physical
Functionality
Update the physical inventory record based on the input. If you set the UpdateTLOGFlag parameter to TRUE this method also updates the TLOG.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
UpdateTLOGFlag	IN	BOOL
StartInvControlFlag	IN	BOOL
Cashier	IN	VARIANT
TransactionDate	IN	VARIANT
Item	IN	BSTR
SkuType	IN	SkuTypeEnum
Quantity	IN	VARIANT
ReasonID	IN	VARIANT
Note	IN	BSTR

Method name: Receiving

Short Description
Creates a receiving record.
Stored Procedure
com_receiving
Functionality
Creates an inventory receiving record based on the input. If you set the UpdateTLOGFlag parameter to TRUE this method also updates the TLOG.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
UpdateTLOGFlag	IN	BOOL
StartInvControlFlag	IN	BOOL
Cashier	IN	VARIANT
TransactionDate	IN	VARIANT
Item	IN	BSTR
SkuType	IN	SkuTypeEnum
Quantity	IN	VARIANT
ReasonID	IN	VARIANT
Note	IN	BSTR
LastVendorCost	IN	VARIANT
LastVendorID	IN	BSTR

Method name: ResetQuantityOnHand

Short Description
Resets the inventory quantity.
Stored Procedure
com_update_inv_reset
Functionality
Set the current inventory quantity to 0 in the table inventory_current and delete all records from the table invertory_current_ext.
Preconditions
TmxAPI.DLL must be registered.
Result
HRESULT

Method name: StartInventoryControl

Short Description
Starts inventory control processing.
Stored Procedure
com_update_inv_startinvctl
Functionality
SAP POS performs the following actions:
- Inserts the proper records into the inventory tables.
- Sets the field invcontrolled in the PLU table to Y based on the PLU number (Item) and SkuType.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
TransactionDate	IN	VARIANT
Item	IN	BSTR
SkuType	IN	SkuTypeEnum
CanOrder	IN	BOOL
MinStockAmt	IN	VARIANT
MaxStockAmt	IN	VARIANT
OpenStock	IN	VARIANT

Method name: StopInventoryControl

Short Description
Stops inventory control processing.
Stored Procedure
com_update_inv_stopinvctl
Functionality
SAP POS performs the following actions:
- Removes the PLU (Item) from the tablesinventory_current and inventory_history.
- Updates the PLU table for the PLU item by setting the incontrolled field to N.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
Item	IN	BSTR

Method name: Transfer

Short Description
Initiates a transfer.
Stored Procedure
com_transfer
Functionality
SAP POS updates or inserts inventory records for the item (PLU number). Based on the FunctionType parameter, SAP POS adds to the quantity (it is set to transfer in) or subtracts from the quantity (it is set to transfer off). If you set the UpdateTLOGFlag to TRUE this method also updates the TLOG.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
UpdateTLOGFlag	IN	BOOL
StartInvControlFlag	IN	BOOL
Cashier	IN	VARIANT
TransactionDate	IN	VARIANT
Item	IN	BSTR
SkuType	IN	SkuTypeEnum
FunctionType	IN	FunctionTypeEnum
Quantity	IN	VARIANT
ReasonID	IN	VARIANT
Note	IN	BSTR
LastVendorID	IN	BSTR

Method name: Update

Short Description
Update the inventory.
Stored Procedure
com_update_inventory
Functionality
SAP POS updates all related inventory tables with the input. If you set the UpdateTLOGFlag parameter to TRUE this method also updates the TLOG.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
UpdateTLOGFlag	IN	BOOL
StartInvControlFlag	IN	BOOL
Cashier	IN	VARIANT
TransactionDate	IN	VARIANT
Item	IN	BSTR
SkuType	IN	SkuTypeEnum
AdjustmentType	IN	AdjustmentTypeEnum
Quantity	IN	VARIANT
ReasonID	IN	VARIANT
FunctionType	IN	FunctionTypeEnum
Note	IN	BSTR
LastVendorCost	IN	VARIANT
LastVendorID	IN	BSTR
CanOrder	IN	BOOL
MinStockAmt	IN	VARIANT
MaxStockAmt	IN	VARIANT
OpenStock	IN	VARIANT

Method name: UpdateBatch

Short Description
Update the inventory using batches.
Stored Procedure
com_update_inventory
Functionality
Similar to the method update except that this methods processes multiple records from the input file FileName. If you set the UpdateTLOGFlag parameter to TRUE this method also updates the TLOG.

The input file is comma delimited and has the following format:

CashierNum,BusinessDate,ItemNum,ItemType(InvItemPLU,InvItemCrossReference),AdjustmentType(InvLoss,InvGain,InvQuantityOnHand),quantity,reason id,function id(InvManualAdjustment,InvTransferIn,InvTransferOut,InvReceiving,InvPhysical,InvStartInventoryControl,InvStopInventoryControl,InvChangeInventoryControl),note,vendor cost,last vendor,suggested order,minimum stock amount,maximum stock amount,open stock
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
UpdateTLOGFlag	IN	BOOL
StartInvControlFlag	IN	BOOL
FileName	IN	BSTR

Method name: UpdateStoreTransferDtl

Short Description
Updates store transfer detail.
Stored Procedure
com_update_store_transfer_dtl
Functionality
Call the method InsertStoreTransfer before calling this method to update the tablestore_transfer_dtl.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
Modtime	IN	VARIANT
Pluanchor	IN	BSTR
Plunum	IN	BSTR
Qty	IN	VARIANT
QtyReceived	IN	VARIANT
RetailPrice	IN	VARIANT
ShortOver	IN	VARIANT
Skunum	IN	BSTR
Documentnum	IN	BSTR

Method name: ValidateStoreTransferDocNum

Short Description
Validates the store transfer document number.
Stored Procedure
com_validate_store_transfer_doc_num
Functionality
SAP POS uses the input to check whether the record exists in the database.
Preconditions
TmxAPI.DLL must be registered.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
DocumentNum	IN	BSTR
TransferType	IN	BSTR
ReceiveMethod	IN	BSTR