Interface ITmxGeneralParams

Method name: GetAllEmployees

Short Description
Retrieves all employees.
Stored Procedure
com_get_employees
Functionality
SAP POS retrieves all employee data and outputs the result to OutputFile based on the CollectionFormat. CollectionFormat is a comma delimited field list defining the employee data that you want to output.

If CollectionFormat is empty (you do not specify any fields) SAP POS outputs all employee data fields.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
OutputFile	IN	BSTR
CollectionFormat	IN	BSTR

Method name: GetChoiceList

Short Description
Retrieves a choice list.
Functionality
SAP POS performs file manipulations; this method does not provide database access.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
ChoiceListFile	IN	BSTR
OutputFile	IN	BSTR

Method name: GetStoreList

Short Description
Retrieves a store list.
Stored Procedure
com_get_stores
Functionality
SAP POS retrieves store data and outputs the data to OutputFile.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
OutputFile	IN	BSTR

Method name: GetVendorList

Short Description
Retrieves a vendor list.
Stored Procedure
com_get_vendors
Functionality
SAP POS retrieves vendor data and outputs the data to OutputFile.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
OutputFile	IN	BSTR

Method name: GetEmployees

Short Description
Updates receiving document to retrieve employee data.
Stored Procedure
com_get_employees2
Functionality
SAP POS retrieves employee data using the parameters CashierNum and StoreNum and outputs the result to OutputFile based on the CollectionFormat. CollectionFormat is a comma delimited field list defining the employee data that you want to output.

CollectionFormat contains field list tokens that are the names of the database fields from the employee tables and has the following characteristics:
- If CollectionFormat is empty (you do not specify any fields) SAP POS outputs all employee data fields.
- You can define the order of the fields in the CollectionFormat string to meet your specific requirements.
- If you want to output all employee data for all stores enter -1 for both StoreNum (store number) and CashierNum (cashier number).
- If you want to output all employee data for one store enter the specific store number in StoreNum and -1 for the CashierNum (cashier number).
- If you want to output one employee's data for one store enter the specific store number in StoreNum and the specific cashier number in CashierNum.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
OutputFile	IN	BSTR
CollectionFormat	IN	BSTR
StoreNum	IN	VARIANT
CashierNum	IN	VARIANT

Method name: GetPLUCrossRefList

Short Description
Retrieves the list of PLU cross references.
Stored Procedure
com_get_plucrossrefs
Functionality
SAP POS retrieves the PLU cross reference records and outputs the result to OutputFile based on the CollectionFormat. CollectionFormat is a comma delimited field list defining the PLU cross reference data that you want to output.

CollectionFormat contains field list tokens that are the names of the database fields from the table plu_cross_ref. If CollectionFormat is empty (you do not specify any fields) SAP POS outputs all PLU cross reference database fields.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
OutputFile	IN	BSTR
CollectionFormat	IN	BSTR

Method name: GetPLUXRefUpdates

Short Description
Retrieve updates to PLU cross references.
Stored Procedure
com_get_pluxrefupdates
Functionality
SAP POS performs the following actions:
- Retrieves PLU cross reference update records from the table update_audit using StartingDate (Timeof update>StartingDate) and SeqNum (SeqNum>SeqNum).
- Outputs the result to OutputFile based on the CollectionFormat. CollectionFormat is a comma delimited field defining the PLU cross reference update data you want to output.
  The three possible output fields are plunum,xrefnum, and updateditem. Since there are only three output fields, in most cases the collection format is not required.
  
  If CollectionFormat is empty (you do not specify any fields) SAP POS outputs all PLU cross reference update database fields.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
OutputFile	IN	BSTR
StartingDate	IN	VARIANT
SeqNum	IN	VARIANT
CollectionFormat	IN	BSTR

Method name: GetAllPLUs

Short Description
Retrieves all PLU data.
Stored Procedure
com_get_all_plu
Functionality
SAP POS retrieves all PLU data and outputs the result to OutputFile based on the CollectionFormat. CollectionFormat is a comma delimited field list defining the PLU data you want to output. CollectionFormat contains field list tokens are the names of the database fields from the table plu.

If CollectionFormat is empty (you do not specify any fields) SAP POS outputs all PLU database fields.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
OutputFile	IN	BSTR
CollectionFormat	IN	BSTR

Method name: GetVendorUpdates

Short Description
Retrieves vendor update data.
Stored Procedure
com_get_vendorupdates
Functionality
SAP POS performs the following actions:
- Retrieves vendor update records using StartingDate and SeqNum.
- Outputs the result to OutputFile based on CollectionFormat. CollectionFormat is a comma delimited field list defining the vendor record update data you want to output. The two possible output fields are vendorid and updateditem. Since there are only two output fields, in most cases the collection format is not required.
  If CollectionFormat is empty (you do not specify any fields) SAP POS outputs all vendor update database fields.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
OutputFile	IN	BSTR
StartingDate	IN	VARIANT
SeqNum	IN	VARIANT
CollectionFormat	IN	BSTR

Method name: GetAllCategories

Short Description
Retrieves all category data.
Stored Procedure
com_get_all_categories
Functionality
SAP POS retrieve all category data and outputs the result to OutputFile. The format of the output is catagoryNum,description.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
OutputFile	IN	BSTR

Method name: GetAllDeptGroups

Short Description
Retrieve all department group data.
Stored Procedure
com_get_all_deptgroups
Functionality
SAP POS retrieves all department group data and outputs the result to OutputFile. The format of the output is groupNum,catagorynum,description.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
OutputFile	IN	BSTR

Method name: GetTaxTable

Short Description
Retrieve tax table data.
Stored Procedure
com_get_all_tax
Functionality
SAP POS retrieves tax table data and outputs the result to OutputFile. The format of the output is as follows:

storenum,0,regionnum,taxid,taxdesc,taxclassid,receiptcode(receiptcode=taxRate),breakptamt,mintax,0,0,0,prnrectaxzero,prnrePtaxzero,prnmanTaxzero,vat,vatitemprice,vatrecprnstyle,taxontax,taxthreshold,thresitemamt,thresdiffer,0
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
OutputFile	IN	BSTR

Method name: GetInventoryCountUpdates

Short Description
Retrieve inventory update data.
Stored Procedure
com_get_inventorycountupdates
Functionality
SAP performs the following actions:
- Retrieves inventory count update records using StartingDate and SeqNum.
- Outputs the result to OutputFile based on CollectionFormat. CollectionFormat is a comma delimited field list defining the inventory count update data that you want to output.
  The two possible output fields are plunum and qtycurrent. Since there are only two output fields, in most cases the collection format is not required.
  
  If CollectionFormat is empty (you do not specify any fields) SAP POS outputs all inventory count update database fields.
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
OutputFile	IN	BSTR
StartingDate	IN	VARIANT
SeqNum	IN	VARIANT
CollectionFormat	IN	BSTR

Method name: GetBOChoiceList

Short Description
Retrieve the choice list data for the back office database.
Stored Procedure
com_get_bochoicelist
Functionality
SAP POS retrieves the data from the choice list table and outputs the result to OutputFile. The format of the output is as follows:

choicetype,storenum,choicecode,description,linkid,linktype,choicedata
Preconditions
You must register TmxAPI.DLL.
Result
HRESULT

Parameter Name	Parameter Type	Data Type
OutputFile	IN	BSTR