| # | Method | Signatures (param types → return) | Description (methodHelp) |
|---|---|---|---|
| 1 | weberp.xmlrpc_Login | (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to login into the API methods for the specified the database.<p>NOTE: using this function means that the User Name and Password fields in the following functions are not required. When calling those functions, leave the last two parameters off, and send along a session cookie.</p></td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Database Name</td><td>The name of the database to use for the requests to come. </td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array. The fist element of it is an integer. Zero means the function was successful. Otherwise an error code is returned. When the login is successful, a session cookie is also returned in the HTTP headers</td></tr></table> |
| 2 | weberp.xmlrpc_Logout | () : int | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to logout from the API methods. It terminates the user's session thus freeing the server resources.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an integer. Zero means the function was successful. Otherwise an error code is returned. </td></tr></table> |
| 3 | weberp.xmlrpc_InsertCustomer | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to insert a new customer into the webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Customer Details</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=debtorsmaster">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.<p>If the Create Debtor Codes Automatically flag is set, then anything sent in the debtorno field will be ignored, and the debtorno field will be set automatically.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 4 | weberp.xmlrpc_ModifyCustomer | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to modify a customer which is already setup in the webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Customer Details</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=debtorsmaster">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.<p>The debtorno must already exist in the weberp database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no modification takes place. </td></tr></table> |
| 5 | weberp.xmlrpc_GetCustomer | (p1: string) : struct (p1: string, p2: string, p3: string) : struct | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to retrieve the details of a customer from the webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Debtor number</td><td>This is a string value. It must be a valid debtor number that is already in the webERP database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a set of key/value pairs containing the details of this customer. The key will be identical with field name from the debtorsmaster table. All fields will be in the set regardless of whether the value was set.<p>Otherwise an array of error codes is returned. </td></tr></table> |
| 6 | weberp.xmlrpc_SearchCustomers | (p1: string, p2: string) : array (p1: string, p2: string, p3: string, p4: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to retrieve the details of a customer from the webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Field Name</td><td>The name of a database field to search on. The field names can be found <a href="../../Z_DescribeTable.php?table=debtorsmaster">here </a>and are case sensitive. </td></tr><tr><td valign="top">Search Criteria</td><td>A (partial) string to match in the above Field Name.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of customer IDs, which may be integers or strings. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 7 | weberp.xmlrpc_GetCurrencyList | () : array (p1: string, p2: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns a list of currency abbreviations.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of currency abbreviations. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 8 | weberp.xmlrpc_GetCurrencyDetails | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a currency abbreviation and returns details of that currency.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Currency abbreviation</td><td>A currency abbreviation as returned by the GetCurrencyList function.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of currency details.</td></tr></table> |
| 9 | weberp.xmlrpc_GetSalesTypeList | () : array (p1: string, p2: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns a list of sales type abbreviations.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of sales type abbreviations. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 10 | weberp.xmlrpc_GetSalesTypeDetails | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a sales type abbreviation and returns details of that sales type.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Sales type abbreviation</td><td>A sales type abbreviation as returned by the GetSalesTypeList function.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of sales type details.</td></tr></table> |
| 11 | weberp.xmlrpc_InsertSalesType | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to insert sales type details into the webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Sales Type Details</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=salestypes">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 12 | weberp.xmlrpc_GetHoldReasonList | () : array (p1: string, p2: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns a list of hold reason codes.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of hold reason codes.</td></tr></table> |
| 13 | weberp.xmlrpc_GetHoldReasonDetails | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a hold reason code and returns details of that hold reason.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Hold reason code</td><td>A hold reason abbreviation as returned by the GetHoldReasonList function.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of hold reason details.</td></tr></table> |
| 14 | weberp.xmlrpc_GetPaymentTermsList | () : array (p1: string, p2: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns a list of payment terms abbreviations.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of payment terms abbreviations.</td></tr></table> |
| 15 | weberp.xmlrpc_GetPaymentTermsDetails | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a payment terms abbreviation and returns details of that payment terms type.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Hold reason code</td><td>A payment terms abbreviation as returned by the GetPaymentTermsList function.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of payment terms details.</td></tr></table> |
| 16 | weberp.xmlrpc_GetPaymentMethodsList | () : array (p1: string, p2: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns a list of payment method codes.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of payment method codes.</td></tr></table> |
| 17 | weberp.xmlrpc_GetPaymentMethodDetails | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a payment method code and returns details of that payment method.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Payment method code</td><td>A payment method code as returned by the GetPaymentMethodsList function.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of payment terms details.</td></tr></table> |
| 18 | weberp.xmlrpc_InsertStockItem | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function inserts a new stock item into webERP, including updating the locstock table.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Stock Item Details</td><td>Key/value pairs of data to insert. The key must be identical with the database field name.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 19 | weberp.xmlrpc_ModifyStockItem | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function modifies a stock item that already exists in webERP.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Stock Item Details</td><td>Key/value pairs of data to modify.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no modification takes place. </td></tr></table> |
| 20 | weberp.xmlrpc_GetStockItem | (p1: string) : struct (p1: string, p2: string, p3: string) : struct | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a stock item code and returns an array of key/value pairs.The keys represent the database field names, and the values are the value of that field.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Stock ID</td><td>The StockID code to identify the item in the database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a set of key/value pairs containing the details of this stock item. The key will be identical with field name from the stockmaster table. All fields will be in the set regardless of whether the value was set.<p>Otherwise an array of error codes is returned. </td></tr></table> |
| 21 | weberp.xmlrpc_SearchStockItems | (p1: string, p2: string) : array (p1: string, p2: string, p3: string, p4: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function searches the stockmaster table and returns an array of stock items matching that criteria.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Field Name</td><td>The field name to search on.</td></tr><tr><td valign="top">Match Criteria</td><td>The SQL search pattern to select items in the database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">Returns an array of stock codes matching the criteria send, or an array of error codes</td></tr></table> |
| 22 | weberp.xmlrpc_GetStockBalance | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns the stock balance for the given stockid.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Stock ID</td><td>A string field containing a valid stockid that must already be setup in the stockmaster table. The api will check this before making the enquiry.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of stock quantities by location for this stock item. </td></tr></table> |
| 23 | weberp.xmlrpc_GetStockReorderLevel | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns the reorder levels by location.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Stock ID</td><td>A string field containing a valid stockid that must already be setup in the stockmaster table. The api will check this before making the enquiry.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of stock reorder levels by location for this stock item.</td></tr></table> |
| 24 | weberp.xmlrpc_SetStockReorderLevel | (p1: string, p2: string, p3: string) : undefined (p1: string, p2: string, p3: string, p4: string, p5: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>This function sets the reorder level for the given stockid in the given location.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Stock ID</td><td>A string field containing a valid stockid that must already be setup in the stockmaster table. The api will check this before making the enquiry.</td></tr><tr><td valign="top">Location Code</td><td>A string field containing a valid location code that must already be setup in the locations table. The api will check this before making the enquiry.</td></tr><tr><td valign="top">Reorder level</td><td>A numeric field containing the reorder level for this stockid/location combination.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns zero if the transaction was successful or an array of error codes if not. </td></tr></table> |
| 25 | weberp.xmlrpc_GetAllocatedStock | (p1: string) : undefined (p1: string, p2: string, p3: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns the quantity allocated of the stock item id sent as a parameter.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Stock ID</td><td>The StockID code to identify items ordered but not yet shipped.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an integer value of the quantity allocated or an array of error codes if not. </td></tr></table> |
| 26 | weberp.xmlrpc_GetOrderedStock | (p1: string) : undefined (p1: string, p2: string, p3: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a stock ID and returns the quantity of this stock that is currently on outstanding purchase orders.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Stock ID</td><td>The StockID code to identify items in the database on order, but not yet received.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an integer value of the quantity on order or an array of error codes if not.</td></tr></table> |
| 27 | weberp.xmlrpc_SetStockPrice | (p1: string, p2: string, p3: string, p4: string) : undefined (p1: string, p2: string, p3: string, p4: string, p5: string, p6: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>This function sets the sales price for a stock ID in the sales type and currency passed to the function</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Stock ID</td><td>The StockID code to identify the item in the database.</td></tr><tr><td valign="top">Currency Code</td><td>The currency involved.</td></tr><tr><td valign="top">Sales Type</td><td>The sales type to identify the item in the database.</td></tr><tr><td valign="top">Price</td><td>The price to apply to this item.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">Returns a zero if successful or else an array of error codes</td></tr></table> |
| 28 | weberp.xmlrpc_GetStockPrice | (p1: string, p2: string, p3: string) : double (p1: string, p2: string, p3: string, p4: string, p5: string) : double | <tr><td><b><u>Description</u></b></td><td colspan=2>This function gets the sales price for a stock ID in the sales type and currency passed to the function</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Stock ID</td><td>The StockID code to identify the item in the database.</td></tr><tr><td valign="top">Currency Code</td><td>The currency involved.</td></tr><tr><td valign="top">Sales Type</td><td>The sales type of the item in the database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">Returns the sales price for the stock item whose ID is passed in the function</td></tr></table> |
| 29 | weberp.xmlrpc_InsertSalesInvoice | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>Inserts a sales invoice into the debtortrans table and does the relevant GL entries. Note that this function does not do the tax entries, insert stock movements, update the stock quanties, sales analysis data or do any cost of sales gl journals. Caution is advised in using this function. To create a full webERP invoice with all tables updated use the InvoiceSalesOrder function.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Invoice Details</td><td>An array of index/value items describing the invoice.The field names can be found <a href="../../Z_DescribeTable.php?table=debtortrans">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. The transno key is generated by this call, and if a value is supplied, it will be ignored. Two additional fields are required. partcode needs to be a genuine part number, though it appears to serve no real purpose. salesarea also is required, though again it appears to serve no useful purpose. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful, and the second element is the invoice number. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 30 | weberp.xmlrpc_AllocateTrans | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>Allocates a debtor receipt or credit to a debtor invoice. Using the customerref field to match up which invoice to allocate to</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Allocation Details</td><td>An associative array describing the customer, the transaction being allocated from, it's transaction type 12 for a receipt or 11 for a credit note, the webERP transaction number, the customer ref that is to be searched for in invoices to match to. The fields are: debtorno, type, transno, customerref</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful.Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 31 | weberp.xmlrpc_InsertDebtorReceipt | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>Creates a customer receipt from the details passed to the method as an associative array</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Receipt Details</td><td>An associative array describing the customer receipt with the following fields: debtorno - the customer code; trandate - the date of the receipt in Y-m-d format; amountfx - the amount in FX; paymentmethod - the payment method of the receipt e.g. cash/EFTPOS/credit card; bankaccount - the webERP bank account to use for the transaction, reference - the reference to record against the webERP receipt transaction</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful, and the second element is the receipt number. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 32 | weberp.xmlrpc_CreateCreditNote | (p1: struct) : array (p1: struct, p2: array, p3: string, p4: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>Creates a credit note from header details associative array and line items. This function implements most of a webERP credit note with the exception that it cannot handle serialised or lot/batch controlled items. All the necessary updates and inserts are handled for stock quantities returned, taxes, sales analysis, stock movements, sales and cost of sales journals</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Credit Note Header Details</td><td>An associative array describing the credit note header with the fields debtorno, branchcode, trandate, tpe, fromstkloc, customerref, shipvia</td></tr><tr><td valign="top">Credit note line items</td><td>The lines of stock being returned on this credit note. Only stock returns can be dealt with using this API method. This is an array of associative arrays containing the fields, stockid, price, qty, discountpercent for the items returned</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful, and the second element is the credit note number. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 33 | weberp.xmlrpc_InsertSalesCredit | (p1: struct) : undefined (p1: struct, p2: string, p3: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to insert a new Sales Credit to the webERP database. Note that this function does not implement a webERP credit note in full and caution is advised in using this function. It does not handle tax at all, it does not add stockmovements, it does not update stock for any quantity returned or update sales analysis. To create a credit note using webERP logic use the CreateCreditNote function</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Credit Details</td><td>An array of index/value items describing the credit. All values must be negative.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">Return Value Descriptions go here</td></tr></table> |
| 34 | weberp.xmlrpc_InsertBranch | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to insert a new customer branch into the webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Branch Details</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=custbranch">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 35 | weberp.xmlrpc_ModifyBranch | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to modify a customer branch which is already setup in the webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Branch Details</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=custbranch">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.<p>The branchcode/debtorno combination must already exist in the weberp database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 36 | weberp.xmlrpc_GetCustomerBranchCodes | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to retrieve a list of the branch codes for the Debtor Number supplied.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Debtor number</td><td>This is a string value. It must be a valid debtor number that is already in the webERP database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns an array of branch codes, which may be strings or integers. If the first element is zero then the function was successful.<p>Otherwise an array of error codes is returned. </td></tr></table> |
| 37 | weberp.xmlrpc_GetCustomerBranch | (p1: string, p2: string) : struct (p1: string, p2: string, p3: string, p4: string) : struct | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to retrieve the details of a customer branch from the webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Debtor number</td><td>This is a string value. It must be a valid debtor number that is already in the webERP database.</td></tr><tr><td valign="top">Branch Code</td><td>This is a string value. It must be a valid branch code that is already in the webERP database, and associated with the debtorno in Parameter[0]</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a set of key/value pairs containing the details of this branch. The key will be identical with field name from the <a href="../../Z_DescribeTable.php?table=custbranch">custbranch table. </a>All fields will be in the set regardless of whether the value was set.<p>Otherwise an array of error codes is returned. </td></tr></table> |
| 38 | weberp.xmlrpc_InsertSalesOrderHeader | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to start a new sales order.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Insert Sales Order Header</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=salesorders">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. The orderno key is generated by this call, and if a value is supplied, it will be ignored. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a two element array; the first element is 0 for success or an error code, while the second element is the order number.</td></tr></table> |
| 39 | weberp.xmlrpc_ModifySalesOrderHeader | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to modify the header details of a sales order</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Modify Sales Order Header Details</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=salesorders">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a single element array with the value 0; otherwise, it contains all error codes encountered during the update.</td></tr></table> |
| 40 | weberp.xmlrpc_InsertSalesOrderLine | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to add line items to a sales order.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Insert Sales Order Line</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=salesorderdetails">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. The orderno key must be one of these values. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array; the first element is 0 for success; otherwise the array contains a list of all errors encountered.</td></tr></table> |
| 41 | weberp.xmlrpc_ModifySalesOrderLine | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to modify line items on a sales order.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Modify Sales Order Line</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=salesorderdetails">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. The orderno and stkcode keys must be one of these values. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array; the first element is 0 for success; otherwise the array contains a list of all errors encountered.</td></tr></table> |
| 42 | weberp.xmlrpc_InvoiceSalesOrder | (p1: struct) : array (p1: int, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to invoice a sales order for the full quantity on the order assuming it is all dispatched. NB It does not deal with serialised/controlled items.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Sales Order to invoice</td><td>An integer representing the webERP sales order number</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a two element array; the first element is 0 for success or an error code, while the second element is the invoice number.</td></tr></table> |
| 43 | weberp.xmlrpc_InsertGLAccount | (p1: struct) : undefined (p1: struct, p2: string, p3: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>Function Description go here</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Account Details</td><td>An array of index/value items describing the GL Account and fields to set.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">Return Value Descriptions go here</td></tr></table> |
| 44 | weberp.xmlrpc_InsertGLAccountSection | (p1: struct) : undefined (p1: struct, p2: string, p3: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>Function Description go here</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Account Section Details</td><td>An array of index/value items describing the account section to insert.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">Return Value Descriptions go here</td></tr></table> |
| 45 | weberp.xmlrpc_InsertGLAccountGroup | (p1: struct) : undefined (p1: struct, p2: string, p3: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>Function Description go here</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Account Group Details</td><td>An array of index/value items describing the account group to insert.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">Return Value Descriptions go here</td></tr></table> |
| 46 | weberp.xmlrpc_GetLocationList | () : array (p1: string, p2: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns a list of stock location ids.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of stock location ids.</td></tr></table> |
| 47 | weberp.xmlrpc_GetLocationDetails | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a stock location id and returns details of that stock location.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Stock Location Code</td><td>A stock location code as returned by the GetLocationList function.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of stock location details.</td></tr></table> |
| 48 | weberp.xmlrpc_GetShipperList | () : array (p1: string, p2: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns a list of stock shipper ids.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of stock shipper ids.</td></tr></table> |
| 49 | weberp.xmlrpc_GetShipperDetails | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a stock shipper id and returns details of that shipper.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Stock Shipper ID</td><td>A stock shipper ID as returned by the GetShippersList function.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of stock shipper details.</td></tr></table> |
| 50 | weberp.xmlrpc_GetSalesAreasList | () : array (p1: string, p2: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns a list of sales area codes.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of sales area codes.</td></tr></table> |
| 51 | weberp.xmlrpc_InsertSalesArea | (p1: struct) : undefined (p1: struct, p2: string, p3: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>Function Description go here</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Sales Area Details</td><td>An array of index/value items describing the sales area to insert.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">Return Value Descriptions go here</td></tr></table> |
| 52 | weberp.xmlrpc_GetSalesAreaDetails | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a sales area code and returns details of that sales area.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Sales Area Code</td><td>A sales area code as returned by the GetSalesAreasList function.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of sales area details.</td></tr></table> |
| 53 | weberp.xmlrpc_GetSalesAreaDetailsFromName | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a sales area description and returns details of that sales area.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Sales Area Description</td><td>A sales area description of the sales area of interest.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of sales area details.</td></tr></table> |
| 54 | weberp.xmlrpc_GetSalesmanList | () : array (p1: string, p2: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns a list of salesman codes.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of salesman codes.</td></tr></table> |
| 55 | weberp.xmlrpc_GetSalesmanDetails | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a salesman code and returns details of that salesman.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Sales Area Code</td><td>A salesman code as returned by the GetSalesmanList function.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of salesman details.</td></tr></table> |
| 56 | weberp.xmlrpc_GetSalesmanDetailsFromName | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a salesman's name and returns details of that salesman.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Salesman Name</td><td>The name of the salesman of interest.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of salesman details.</td></tr></table> |
| 57 | weberp.xmlrpc_InsertSalesman | (p1: struct) : undefined (p1: struct, p2: string, p3: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>Function Description go here</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Salesman Details</td><td>An array of index/value items describing the salesman to insert.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">Return Value Descriptions go here</td></tr></table> |
| 58 | weberp.xmlrpc_GetTaxGroupList | () : array (p1: string, p2: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns a list of tax group IDs.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of tax group IDs.</td></tr></table> |
| 59 | weberp.xmlrpc_GetTaxGroupDetails | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a tax group ID and returns details of that tax group.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Tax Group ID</td><td>A tax group ID as returned by the GetTaxgroupList function.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of tax group details.</td></tr></table> |
| 60 | weberp.xmlrpc_GetTaxGroupTaxes | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a tax group ID and returns the taxes that belong to that tax group.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Tax Group ID</td><td>A tax group ID as returned by the GetTaxgroupList function.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of tax group details.</td></tr></table> |
| 61 | weberp.xmlrpc_GetTaxAuthorityList | () : array (p1: string, p2: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns a list of tax authority IDs.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of tax group IDs.</td></tr></table> |
| 62 | weberp.xmlrpc_GetTaxAuthorityDetails | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a tax authority ID and returns details of that tax authority.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Tax Authority ID</td><td>A tax Authority ID as returned by the GetTaxAuthorityList function.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of tax authority details.</td></tr></table> |
| 63 | weberp.xmlrpc_GetTaxAuthorityRates | (p1: string) : struct (p1: string, p2: string, p3: string) : struct | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a tax authority ID and returns the rates of tax for the authority.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Tax Authority ID</td><td>A tax Authority ID as returned by the GetTaxAuthorityList function.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns the tax rates for the authority.</td></tr></table> |
| 64 | weberp.xmlrpc_GetCustomerTypeList | () : array (p1: string, p2: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns a list of customer types.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of customer types</td></tr></table> |
| 65 | weberp.xmlrpc_GetCustomerTypeDetails | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a customer type ID and returns details of that customer type.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Customer Type ID</td><td>A customer type ID as returned by the GetCustomerTypeList function.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of customer type details.</td></tr></table> |
| 66 | weberp.xmlrpc_InsertStockCategory | (p1: struct) : undefined (p1: struct, p2: string, p3: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>Function Description go here</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Category Details</td><td>An array of index/value items describing the stock category to insert.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">Return Value Descriptions go here</td></tr></table> |
| 67 | weberp.xmlrpc_ModifyStockCategory | (p1: struct) : undefined (p1: struct, p2: string, p3: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>Function Description go here</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Category Details</td><td>An array of index/value items describing the stock category to modify.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">Return Value Descriptions go here</td></tr></table> |
| 68 | weberp.xmlrpc_GetStockCategory | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a stock category ID and returns details of that stock category type.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Stock Category ID</td><td>A Stock Category ID as returned by the *WHAT* function.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of stock category details.</td></tr></table> |
| 69 | weberp.xmlrpc_SearchStockCategories | (p1: string, p2: string) : undefined (p1: string, p2: string, p3: string, p4: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>Function Description go here</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Field Name</td><td>The field name to search on.</td></tr><tr><td valign="top">Match Criteria</td><td>The SQL search pattern to select items in the database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">Return Value Descriptions go here</td></tr></table> |
| 70 | weberp.xmlrpc_StockCatPropertyList | (p1: string, p2: string) : undefined (p1: string, p2: string, p3: string, p4: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>Function Description go here</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Label Name</td><td>The category label to search on.</td></tr><tr><td valign="top">Match Criteria</td><td>The SQL search pattern to select items in the database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">Return Value Descriptions go here</td></tr></table> |
| 71 | weberp.xmlrpc_GetStockCategoryList | () : array (p1: string, p2: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns a list of stock category abbreviations.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful, this function returns an array of stock category ids. Otherwise an array of error codes is returned and no stock categories are returned. </td></tr></table> |
| 72 | weberp.xmlrpc_GetGLAccountList | () : array (p1: string, p2: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns a list of general ledger account codes.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of general ledger account codes.</td></tr></table> |
| 73 | weberp.xmlrpc_GetGLAccountDetails | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a general ledger account code and returns details of that account.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">General Ledger Account Code</td><td>A general ledger account code as returned by the GetGLAccountList function.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of general ledger account details.</td></tr></table> |
| 74 | weberp.xmlrpc_GetStockTaxRate | (p1: string, p2: string) : array (p1: string, p2: string, p3: string, p4: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a stock code ID and a tax authority code and returns the relevant tax rate.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">StockID</td><td>The stock ID of the item whose tax rate is desired.</td></tr><tr><td valign="top">Tax Authority Code</td><td>The code identifying the tax authority of interest.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of general ledger account details.</td></tr></table> |
| 75 | weberp.xmlrpc_InsertSupplier | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to insert a new supplier into the webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Supplier Details</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=suppliers">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 76 | weberp.xmlrpc_ModifySupplier | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to modify a supplier which is already setup in the webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Supplier Details</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=suppliers">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.<p>The supplierid must already exist in the weberp database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no modification takes place. </td></tr></table> |
| 77 | weberp.xmlrpc_GetSupplier | (p1: string) : struct (p1: string, p2: string, p3: string) : struct | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to retrieve the details of a supplier from the webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Supplier ID</td><td>This is a string value. It must be a valid supplier id that is already in the webERP database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a set of key/value pairs containing the details of this supplier. The key will be identical with field name from the suppliers table. All fields will be in the set regardless of whether the value was set.<p>Otherwise an array of error codes is returned. </td></tr></table> |
| 78 | weberp.xmlrpc_SearchSuppliers | (p1: string, p2: string) : array (p1: string, p2: string, p3: string, p4: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to retrieve the details of a supplier from the webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Field name</td><td>This is a string value. It must be a valid field in the suppliers table. This is case sensitive</td></tr><tr><td valign="top">Criteria</td><td>This is a string value. It holds the string that is searched for in the given field. It will search for all or part of the field.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns an array of supplier ids. Otherwise an array of error codes is returned. </td></tr></table> |
| 79 | weberp.xmlrpc_StockAdjustment | (p1: string, p2: string, p3: double, p4: string) : undefined (p1: string, p2: string, p3: double, p4: string, p5: string, p6: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>Adjust the stock balance for the given stock code at the given location by the amount given.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Stock ID</td><td>A string field containing a valid stockid that must already be setup in the stockmaster table. The api will check this before making the enquiry.</td></tr><tr><td valign="top">Location</td><td>A string field containing a valid location code that must already be setup in the locations table. The api will check this before making the enquiry.</td></tr><tr><td valign="top">Quantity</td><td>This is an integer value. It holds the amount of stock to be adjusted. Should be negative if is stock is to be reduced</td></tr><tr><td valign="top">Transaction Date</td><td>This is a string value. It holds the string that is searched for in the given field. It will search for all or part of the field.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns 0. Otherwise an array of error codes is returned. </td></tr></table> |
| 80 | weberp.xmlrpc_WorkOrderIssue | (p1: string, p2: string, p3: string, p4: string, p5: string, p6: string) : undefined (p1: string, p2: string, p3: string, p4: string, p5: string, p6: string, p7: string, p8: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>Issues stock to a given work order from the given location</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Work Order Number</td><td>A string field containing a valid work order number that has already been created. The api will check this before making the enquiry.</td></tr><tr><td valign="top">Stock ID</td><td>A string field containing a valid stockid that must already be setup in the stockmaster table. The api will check this before making the enquiry.</td></tr><tr><td valign="top">Location</td><td>A string field containing a valid location code that must already be setup in the locations table. The api will check this before making the enquiry.</td></tr><tr><td valign="top">Quantity</td><td>This is an integer value. It holds the amount of stock to be adjusted. Should be negative if is stock is to be reduced</td></tr><tr><td valign="top">Batch number</td><td>This is a string value. It holds the reference to the batch number for the product being issued. If the stockid is not batch controlled this is ignored.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns 0. Otherwise an array of error codes is returned. </td></tr></table> |
| 81 | weberp.xmlrpc_InsertPurchData | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to insert new purchasing data into the webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Purchasing data</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=purchdata">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 82 | weberp.xmlrpc_ModifyPurchData | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to modify purchasing data into the webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Purchasing data</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=purchdata">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 83 | weberp.xmlrpc_InsertWorkOrder | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to insert a new work order into the webERP database. Currently this works only for single line orders.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Work order details</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=workorders">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 84 | weberp.xmlrpc_WorkOrderReceive | (p1: string, p2: string, p3: string, p4: string, p5: string) : undefined (p1: string, p2: string, p3: string, p4: string, p5: string, p6: string, p7: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>Receives stock from a given work order from the given location</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Work Order Number</td><td>A string field containing a valid work order number that has already been created. The api will check this before making the enquiry.</td></tr><tr><td valign="top">Stock ID</td><td>A string field containing a valid stockid that must already be setup in the stockmaster table. The api will check this before making the enquiry.</td></tr><tr><td valign="top">Location</td><td>A string field containing a valid location code that must already be setup in the locations table. The api will check this before making the enquiry.</td></tr><tr><td valign="top">Quantity</td><td>This is an integer value. It holds the amount of stock to be adjusted. Should be negative if is stock is to be reduced</td></tr><tr><td valign="top">Transaction Date</td><td>This is a string value. It holds the string that is searched for in the given field. It will search for all or part of the field.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns 0. Otherwise an array of error codes is returned. </td></tr></table> |
| 85 | weberp.xmlrpc_SearchWorkOrders | (p1: string, p2: string) : array (p1: string, p2: string, p3: string, p4: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to retrieve the details of a work order from the webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Field name</td><td>This is a string value. It must be a valid field in the workorders table. This is case sensitive</td></tr><tr><td valign="top">Criteria</td><td>This is a string value. It holds the string that is searched for in the given field. It will search for all or part of the field.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns an array of work order numbers. Otherwise an array of error codes is returned. </td></tr></table> |
| 86 | weberp.xmlrpc_GetBatches | (p1: string, p2: string) : array (p1: string, p2: string, p3: string, p4: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to retrieve the details of stock batches.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Stock ID</td><td>A string field containing a valid stockid that must already be setup in the stockmaster table. The api will check this before making the enquiry.</td></tr><tr><td valign="top">Criteria</td><td>This is a string value. It holds the string that is searched for in the given field. It will search for all or part of the field.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">Returns a two dimensional array of stock batch details. The fields returned are stockid, loccode, batchno, quantity, itemcost. </td></tr></table> |
| 87 | weberp.xmlrpc_GetDefaultDateFormat | () : undefined (p1: string, p2: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>Returns the webERP default date format</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a string contain the default date format. Otherwise an array of error codes is returned. </td></tr></table> |
| 88 | weberp.xmlrpc_GetDefaultShipper | () : array (p1: string, p2: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>Returns the webERP default shipper</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns an array of two elements the first should contain an integer of zero for successful and the second an associative array containing the key of confvalue the value of which is the Default_Shipper.Otherwise an array of error codes is returned. </td></tr></table> |
| 89 | weberp.xmlrpc_GetDefaultCurrency | () : undefined (p1: string, p2: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>Returns the webERP default location</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a string contain the default location. Otherwise an array of error codes is returned. </td></tr></table> |
| 90 | weberp.xmlrpc_GetDefaultPriceList | () : undefined (p1: string, p2: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>Returns the webERP default price list</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a string contain the default price list code. Otherwise an array of error codes is returned. </td></tr></table> |
| 91 | weberp.xmlrpc_GetDefaultLocation | () : undefined (p1: string, p2: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>Returns the webERP default inventory location</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a string contain the default inventory location. Otherwise an array of error codes is returned. </td></tr></table> |
| 92 | weberp.xmlrpc_GetReportsDirectory | () : string (p1: string, p2: string) : string | <tr><td><b><u>Description</u></b></td><td colspan=2>Returns the webERP reports directory for the company selected</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a string containing the path to the company reports directory Otherwise an array of error codes is returned. </td></tr></table> |
| 93 | weberp.xmlrpc_CreatePOSDataFull | (p1: string, p2: string, p3: string, p4: string) : int | <tr><td><b><u>Description</u></b></td><td colspan=2>This function creates a POS data file on the webERP server for download by the POS</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">POS Customer Code - a valid webERP customer that sales from the POS are made against.</td><td>POS Customer Branch Code - a valid branch code of the webERP customer that the POS sales are made against</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns 0 for success and 1 for error. </td></tr></table> |
| 94 | weberp.xmlrpc_DeletePOSData | (p1: string, p2: string) : int | <tr><td><b><u>Description</u></b></td><td colspan=2>This function deletes a POS data file on the webERP server</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">Returns 0 if the delete POS Data was successful</td></tr></table> |
| 95 | weberp.xmlrpc_GetStockCatProperty | (p1: string, p2: string) : undefined (p1: string, p2: string, p3: string, p4: string) : undefined | <tr><td><b><u>Description</u></b></td><td colspan=2>Returns the value of the specified stock category property for the specified stock item category</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Property</td><td>The name of the specific property to be returned.</td></tr><tr><td valign="top">Stock ID</td><td>The ID of the stock item for which the value of the above property is required. </td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns zero, and the value of the requested property. Otherwise an array of error codes is returned. </td></tr></table> |
| 96 | weberp.xmlrpc_GetErrorMessages | (p1: array) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>Returns (possibly translated) error text from error codes</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Error codes</td><td>An array of error codes to change into text messages. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">An array of two element arrays, one per error code. The second array has the error code in element 0 and the error string in element 1. </td></tr></table> |
| 97 | weberp.xmlrpc_GetSalesOrderValue | (p1: string) : struct (p1: string, p2: string, p3: string) : struct | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes an order number and returns an array of key/value pairs.The keys represent the database field names, and the values are the value of that field.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Order No</td><td>The Order No to identify the order in the database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a set of key/value pairs containing the details of this order. The key will be identical with field name from the salesorders table. All fields will be in the set regardless of whether the value was set.<p>Otherwise an array of error codes is returned. </td></tr></table> |
| 98 | weberp.xmlrpc_GetSalesOrderLineDetails | (p1: struct) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes an order number and returns an array of key/value pairs.The keys represent the database field names, and the values are the value of that field.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Order No</td><td>The Order No to identify the order in the database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a set of key/value pairs containing the details of this order. The key will be identical with field name from the salesorders table. All fields will be in the set regardless of whether the value was set.<p>Otherwise an array of error codes is returned. </td></tr></table> |
| 99 | weberp.xmlrpc_GetSalesOrderList | () : array (p1: string, p2: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns a list of created Orders.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of one order codes. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 100 | weberp.xmlrpc_GetStockLocations | (p1: string) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns the locations for the given stockid.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Stock ID</td><td>A string field containing a valid stockid that must already be setup in the stockmaster table. The api will check this before making the enquiry.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of locations for this stock item, each containing the location code, location name, and quantity on hand.</td></tr></table> |
| 101 | weberp.xmlrpc_GetSupplierInquiry | (p1: string) : struct (p1: string, p2: string, p3: string) : struct | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a supplier ID and returns an array of key/value pairs.The keys represent the database field names, and the values are the value of that field.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Supplier ID</td><td>The Supplier ID to identify the supplier in the database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a set of key/value pairs containing the details of this order. The key will be identical with field name from the tables involved in the query. All fields will be in the set regardless of whether the value was set.<p>Otherwise an array of error codes is returned. </td></tr></table> |
| 102 | weberp.xmlrpc_InsertLocation | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to insert a new Location into the webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Location Details</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=locations">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 103 | weberp.xmlrpc_ModifyLocation | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to modify a location which is already setup in the webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Location Details</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=locations">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.<p>The branchcode/debtorno combination must already exist in the weberp database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of integers. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 104 | weberp.xmlrpc_GetDebtorInvoiceDetails | (p1: string) : struct (p1: string, p2: string, p3: string) : struct | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a stock item code and returns an array of key/value pairs.The keys represent the database field names, and the values are the value of that field.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Stock ID</td><td>The StockID code to identify the item in the database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a set of key/value pairs containing the details of this stock item. The key will be identical with field name from the stockmaster table. All fields will be in the set regardless of whether the value was set.<p>Otherwise an array of error codes is returned. </td></tr></table> |
| 105 | weberp.xmlrpc_SearchInvoices | n/a | — |
| 106 | weberp.xmlrpc_InsertSupplierInvoice | (p1: struct, p2: struct) : array (p1: struct, p2: struct, p3: string, p4: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to insert the details of a Supplier Invoice to a webERP database.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Invoice Header details</td><td>The Invoice Header varibles </td></tr><tr><td valign="top">Detailed Sales Invoice</td><td>A (partial) string to match in the above Field Name.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of order IDs, which may be integers or strings. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 107 | weberp.xmlrpc_InsertSupplierInvoiceHeader | (p1: struct, p2: struct) : array (p1: struct, p2: struct, p3: string, p4: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to start a new Supplier invoice header.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Insert Supplier Invoice Header</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=salesorders">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. The orderno key is generated by this call, and if a value is supplied, it will be ignored. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">Insert Supplier Invoice Header</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=salesorders">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. The orderno key is generated by this call, and if a value is supplied, it will be ignored. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a two element array; the first element is 0 for success or an error code, while the second element is the order number.</td></tr></table> |
| 108 | weberp.xmlrpc_ModifySupplierInvoiceHeader | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to modify the header details of a supplier invoice</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Modify Sales Order Header Details</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=salesorders">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a single element array with the value 0; otherwise, it contains all error codes encountered during the update.</td></tr></table> |
| 109 | weberp.xmlrpc_InsertSupplierInvoiceLine | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to add line items to a supplier invoice.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Insert Supplier Invoice Line</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=salesorderdetails">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. The orderno key must be one of these values. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array; the first element is 0 for success; otherwise the array contains a list of all errors encountered.</td></tr></table> |
| 110 | weberp.xmlrpc_ModifySupplierInvoiceLine | (p1: struct) : array (p1: struct, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to modify line items on a supplier invoice.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Modify Supplier Invoice Line</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=salesorderdetails">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. The orderno and stkcode keys must be one of these values. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array; the first element is 0 for success; otherwise the array contains a list of all errors encountered.</td></tr></table> |
| 111 | weberp.xmlrpc_GetSupplierInvoiceHeaderDetail | (p1: string) : struct (p1: string, p2: string, p3: string) : struct | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a supplier invoive number and returns an array of key/value pairs.The keys represent the database field names, and the values are the value of that field.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">InvoiceNo</td><td>The Invoice No to identify the invoice in the database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a set of key/value pairs containing the details of this stock item. The key will be identical with field name from the stockmaster table. All fields will be in the set regardless of whether the value was set.<p>Otherwise an array of error codes is returned. </td></tr></table> |
| 112 | weberp.xmlrpc_GetSupplierInvoiceList | () : array (p1: string, p2: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function returns a list of created supplier invoices.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">This function returns an array of one order codes. If the first element is zero then the function was successful. Otherwise an array of error codes is returned and no insertion takes place. </td></tr></table> |
| 113 | weberp.xmlrpc_GetSupplierInvoiceLineDetails | (p1: struct) : array (p1: string, p2: string, p3: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function takes a supplier invoice number and returns an array of key/value pairs.The keys represent the database field names, and the values are the value of that field.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Invoice Number</td><td>The Invoice No to identify the invoice in the database.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a set of key/value pairs containing the details of this order. The key will be identical with field name from the salesorders table. All fields will be in the set regardless of whether the value was set.<p>Otherwise an array of error codes is returned. </td></tr></table> |
| 114 | weberp.xmlrpc_GetAgedDebtors | (p1: struct, p2: struct) : array (p1: struct, p2: struct, p3: string, p4: string) : array | <tr><td><b><u>Description</u></b></td><td colspan=2>This function is used to print a new AgedDebtors report.</td></tr> <tr><td valign="top"><b><u>Parameters</u></b></td><tr><td valign="top">Array of Report filter criteria</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=salesorders">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. The orderno key is generated by this call, and if a value is supplied, it will be ignored. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">Array of Customers filter criteria</td><td>A set of key/value pairs where the key must be identical to the name of the field to be updated. The field names can be found <a href="../../Z_DescribeTable.php?table=salesorders">here </a>and are case sensitive. The values should be of the correct type, and the api will check them before updating the database. The orderno key is generated by this call, and if a value is supplied, it will be ignored. It is not necessary to include all the fields in this parameter, the database default value will be used if the field is not given.</td></tr><tr><td valign="top">User name</td><td>A valid weberp username. This user should have security access to this data.</td></tr><tr><td valign="top">User password</td><td>The weberp password associated with this user name. </td></tr><tr><td valign="top"><b><u>Return Value<td valign="top">If successful this function returns a two element array; the first element is 0 for success or an error code, while the second element is the order number.</td></tr></table> |