ElicustmService
ElicustmService.asmx
This web service provides methods related to customers. User can add, change, delete or view a customer; this web service also has methods for customer inquiries (search) by name or additional user-definable keys.
This web service provides
the following methods:
· AddCustomer
· ChangeCustomer
· DeleteCustomer
· ViewCustomer
· InquiryBy5Keys
· InquiryByCustomerName
· InquiryByCustomerNo
· GetShipTo
Customer number in
input fields of this web service will be padded with leading zeros to make it six
digits long. For example, customer# “123” will become to “000123.”
AddCustomer
This method will add a new customer. To use this method, you need to have a default customer (customer number “&&&&&”). If a field’s value is not provided, most of the time this method will assign a value from default customer. Some fields will default to blank or zero, such as customer’s address, customer balance… etc.
Usage:
AddCustomerResult = A.AddCustomer(UserName, UserPassword, AddCustomerInput)
Parameters UserName and UserPassword are not used at this moment.
AddCustomerInput Structure
Property |
Length |
Type |
Upper |
Detail |
CUS_COLLECTOR |
3 |
String |
Y |
If this field is not provided, its value will be getting from default customer. |
CUS_STREET1 |
30 |
String |
|
Customer address 1. If this field is not provided, its value will be blank. |
CUS_STREET2 |
30 |
String |
|
Customer address 2. If this field is not provided, its value will be blank. |
CUS_ALLOW_BO |
1 |
String |
|
Allow back order or not. The value should be “Y” or “N.” If this field is not provided, its value will be obtained from default customer. |
CUS_ALLOW_PART_SHIP |
1 |
String |
|
Allow partial ship. The value here should be “Y” or “N.” If the value is not provided, this method will be obtained from default customer. |
CUS_ALLOW_SUB_ITMS |
1 |
String |
|
Allow substitute item. The value here should be “Y” or “N.” If the value is not provided, this method will be obtained from default customer. |
CUS_AMT_AGE_PD1 |
9.2 |
Double |
|
Age Amt 30 Days. If this field is not provided, its value will be zero. |
CUS_AMT_AGE_PD2 |
9.2 |
Double |
|
Age Amt 60 Days. If this field is not provided, its value will be zero. |
CUS_AMT_AGE_PD3 |
9.2 |
Double |
|
Age Amt 90 Days. If this field is not provided, its value will be zero. |
CUS_AMT_AGE_PD4 |
9.2 |
Double |
|
Age Amt 120 Days. If this field is not provided, its value will be zero. |
CUS_AR_MAIN_NO |
8 |
String |
Y |
Acct No (part 1). If the value is not provided, this method will get it from default customer. |
CUS_AR_SUB_NO |
8 |
String |
Y |
Acct No (part 2). If the value is not provided, this method will get it from default customer. |
CUS_AR_DP_NO |
8 |
String |
Y |
Acct No (part 3). If the value is not provided, this method will get it from default customer. |
CUS_AVG_PAY_LAST_YR |
5 |
Double |
|
Avg Days Pay Last Yr. If this field is not provided, its value will be zero. |
CUS_AVG_PAY_YTD |
5 |
Double |
|
Avg Days Pay YTD. If this field is not provided, its value will be zero. |
CUS_BALANCE |
9.2 |
Double |
|
Customer balance. If this field is not provided, its value will be zero. |
CUS_BAL_METH |
1 |
String |
Y |
Customer balance method. If the value is not provided, this method will get it from default customer. |
CUS_BILL_TO_NO |
6 |
String |
Y |
Bill to number. If the value is not provided, this method will get it from default customer. |
CUS_CITY |
15 |
String |
|
If this field is not provided, its value will be blank. |
CUS_COMMENT1 |
30 |
String |
Y |
Customer comments (line 1). If the value is not provided, this method will get it from default customer. |
CUS_COMMENT2 |
30 |
String |
Y |
Customer comments (line 2). If the value is not provided, this method will get it from default customer. |
CUS_CONTACT |
20 |
String |
|
Contact. If this field is not provided, its value will be blank. |
CUS_CORR_NAME |
30 |
String |
|
Corresponding name. If this field is not provided, its value will be blank. |
CUS_COST_LAST_YR |
9.2 |
Double |
|
Cost last year. If this field is not provided, its value will be zero. |
CUS_COST_PTD |
9.2 |
Double |
|
Cost period to date. If this field is not provided, its value will be zero. |
CUS_COST_YTD |
9.2 |
Double |
|
Cost year to date. If this field is not provided, its value will be zero. |
CUS_COUNTRY |
10 |
String |
Y |
Country. If the value is not provided, this method will get it from default customer. |
CUS_CR_HOLD_FG |
1 |
String |
Y |
Credit hold flag. This field should be “Y” or “N.” If the value is not provided, this method will get it from default customer. |
CUS_CR_LIMIT |
9 |
Integer |
|
Credit limit. If the value is not provided, this method will get it from default customer. |
CUS_CR_RATING |
4 |
String |
Y |
Credit rate. If the value is not provided, this method will get it from default customer. |
CUS_NAME |
30 |
String |
|
Customer name. If this field is not provided, its value will be blank. |
CUS_NO |
6 |
String |
Y |
If you do not provide a customer number, this method will automatically assign one to the new customer. If you provide a customer number, this method will check if it is unique, and return an error code if it is not unique. |
CUS_TP |
5 |
String |
Y |
Cust type. If the value is not provided, this method will get it from default customer. |
CUS_START_DT |
8 |
Date |
|
If this field is not provided, its value will be system date. |
CUST_TYPE_DESC |
15 |
String |
|
This field is not used. Cust type description will be obtained from customer type file by given customer type. |
CUS_DISC_PCT |
3.2 |
Single |
|
Discount %. If the value is not provided, this method will get it from default customer. |
CUS_EXEMPT_EXP_DATE |
8 |
Date |
|
Exempt expire date. If the value is not provided, this method will get it from default customer. |
CUS_EXEMPT_NO |
15 |
String |
Y |
Exempt number. If the value is not provided, this method will get it from default customer. |
CUS_EXEMPT_REASON_CD |
1 |
String |
Y |
Exempt reason code. If the value is not provided, this method will get it from default customer. |
CUS_FAX_NUMBER |
12 |
String |
Y |
Fax number. If this field is not provided, its value will be blank. |
CUS_FIN_CHG_FG |
1 |
String |
Y |
Finance charge flag. This field should be “Y” or “N.” If the value is not provided, this method will get it from default customer. |
CUS_FORM_NO |
2 |
Integer |
|
Invoice form number. If the value is not provided, this method will get it from default customer. |
CUS_GEO_CODE |
9 |
String |
Y |
Customer geo code. If the value is not provided, this method will get it from default customer. |
CUS_HELD_ORD_AMT |
9.2 |
Double |
|
There is some legacy implementation issue here. Now this field is linked to “Sales year before last year”. The input property CUS_SALES_YR_BF_LY is also linked to the same field, which has higher priority than this field. We suggest you use CUS_SALES_YR_BF_LY instead of this field. |
CUS_HIGH_BALANCE |
9.2 |
Double |
|
Highest balance. If this field is not provided, its value will be zero. |
CUS_INV_LAST_YR |
6 |
Double |
|
Invoices last year. If this field is not provided, its value will be zero. |
CUS_INV_YTD |
6 |
Double |
|
Invoices year to date. If this field is not provided, its value will be zero. |
CUS_LAST_PAY_AMT |
9.2 |
Double |
|
Last payment amount. If this field is not provided, its value will be zero. |
CUS_LAST_PAY_DT |
8 |
Date |
|
Last payment date. If this field is not provided, its value will be zero. |
CUS_LAST_SALE_AMT |
9.2 |
Double |
|
Last sale amount. If this field is not provided, its value will be zero. |
CUS_LAST_SALE_DT |
8 |
Date |
|
Last sale date. If this field is not provided, its value will be zero. |
CUS_LAST_STM_AGE_DT |
8 |
Date |
|
Last aging date. If this field is not provided, its value will be zero. |
CUS_NOTE_1 |
30 |
String |
Y |
User Definable field 1. If the value is not provided, this method will get it from default customer. |
CUS_NOTE_2 |
30 |
String |
Y |
User Definable field 2. If the value is not provided, this method will get it from default customer. |
CUS_NOTE_3 |
30 |
String |
Y |
User Definable field 3. If the value is not provided, this method will get it from default customer. |
CUS_NOTE_4 |
30 |
String |
Y |
User Definable field 4. If the value is not provided, this method will get it from default customer. |
CUS_NOTE_5 |
30 |
String |
Y |
User Definable field 5. If the value is not provided, this method will get it from default customer. |
CUS_OPEN_ORD_AMT |
9.2 |
Double |
|
There is some legacy implementation issue here. Now this field is linked to “Open order pick/invoiced amount.” The input property CUS_PICK_INV_AMT is also linked to the same field, which has higher priority than this field. We suggest you to use CUS_PICK_INV_AMT instead of this field. |
CUS_ORDER_LOC |
2 |
String |
Y |
Customer order location. If the value is not provided, this method will get it from default customer. If no location is provided in the default customer, system will try to determine the location based on the customer state and zip code. |
CUS_OUTSIDE_CITY_LM |
1 |
String |
Y |
Outside city limit. If the value is not provided, this method will get it from default customer. |
CUS_PAID_INV_YTD |
6 |
Integer |
|
Invoices paid year to date. If this field is not provided, its value will be zero. |
CUS_PHONE_NO |
12 |
String |
Y |
Phone number. If this field is not provided, its value will be blank. |
CUS_PRINT_DUNN_FG |
1 |
String |
Y |
Print dunning letters flag. This field should be “Y” or “N.” If the value is not provided, this method will get it from default customer. |
CUS_SALES_LAST_YR |
9.2 |
Double |
|
Sales last year. If this field is not provided, its value will be zero. |
CUS_SLM_NO |
3 |
String |
Y |
Salesman Number. If the value is not provided, this method will get it from default customer. |
CUS_SALES_PTD |
9.2 |
Double |
|
Sales period to date. If this field is not provided, its value will be zero. |
CUS_SALES_YTD |
9.2 |
Double |
|
Sales year to date. If this field is not provided, its value will be zero. |
CUS_SEARCH_NAME |
30 |
String |
|
This field is not used. Customer search name is upper case of customer name. |
SHIP_VIA_CD |
2 |
String |
Y |
Ship via code. If the value is not provided, this method will get it from default customer. |
CUS_SLM_STRT_DT |
8 |
Date |
|
Salesman start date. If the value is not provided, this method will get it from default customer. |
CUS_ST |
2 |
String |
Y |
State. If this field is not provided, its value will be blank. |
CUS_STM_FREQ |
1 |
String |
Y |
Customer statement frequency. If the value is not provided, this method will get it from default customer. |
CUS_TXBL_FG |
1 |
String |
Y |
Taxable flag. This field should be “Y” or “N.” If the value is not provided, this method will get it from default customer. |
CUS_TX_CD1 |
3 |
String |
Y |
Tax code 1. If the value is not provided, this method will get it from default customer. Note: If using the Avalara Integration, you will have to pass the state + "1" for tax code 1, the state + "2" for tax code 2 and the state + "3" for tax code 3. For example, if the state is Missouri, pass MO1 for tax code 1, MO2, for tax code 2, and MO3 for tax code 3. |
CUS_TX_CD2 |
3 |
String |
Y |
Tax code 2. If the value is not provided, this method will get it from default customer. |
CUS_TX_CD3 |
3 |
String |
Y |
Tax code 3. If the value is not provided, this method will get it from default customer. |
TERMS_CD |
2 |
String |
Y |
Terms code. If the value is not provided, this method will get it from default customer. |
CUS_TERR |
2 |
String |
Y |
Territory. If the value is not provided, this method will get UPS zone from default customer. |
CUS_UPS_ZONE |
2 |
String |
Y |
UPS zone. If the value is not provided, this method will get UPS zone from default customer. |
CUS_USE_BILL_TO_ADRR |
1 |
String |
Y |
“Y”: Get Order Bill-To Address from Bill-To No, and Order Ship-To Address from this customer. “N”: Get Order Bill-To Address and Order Ship-To Address from Bill-To No. “S”: Get Order Bill-To Address and Order Ship-To Address from this customer. If the value is not provided, this method will get it from default customer. |
CUS_USER_AMT |
7.2 |
Double |
|
User definable amount. If the value is not provided, this method will get it from default customer. |
CUS_USER_DATE |
8 |
Date |
|
User definable date. If the value is not provided, this method will get it from default customer. |
CUS_YTD_DSC_GIVEN |
9.2 |
Double |
|
Discount given year to date. If this field is not provided, its value will be zero. |
CUS_ZIP |
2 |
String |
Y |
Zip code. If this field is not provided, its value will be blank. |
CUS_PICK_INV_AMT |
9.2 |
Double |
|
Open order pick/invoiced amount. The input property CUS_OPEN_ORD_AMT is also linked to the same field, which has lower priority than this field. We suggest you to use this field instead of CUS_OPEN_ORD_AMT. If there are no values in both fields, this method will get it from default customer. |
CUS_SALES_YR_BF_LY |
9.2 |
Double |
|
Sales year before last year. The input property CUS_HELD_ORD_AMT is also linked to the same field, which has lower priority than this field. We suggest you to use this field instead of CUS_HELD_ORD_AMT. If there are no values in both fields, this method will get it from default customer. |
CUS_ABC_CLASS |
1 |
String |
Y |
ABC class. Should be “A,” “B” or “C.” If the value is not provided, this method will get it from default customer. |
CUS_DEL_LEAD_TIME |
3 |
Integer |
|
Delivery lead time (“Ship To Days” field in Elliott customer file). If the value is not provided, this method will get it from default customer. |
CUS_DEL_DAY_ERLY_ALW |
3 |
Integer |
|
Days delivery early allowed. If the value is not provided, this method will get it from default customer. |
AddCustomerResult Structure
Property Name |
Type |
Detail |
ReturnCode |
Integer |
Zero means OK; for other return codes, please see “ElicustmService Return Code” section. |
ReturnMsg |
String |
This is description of return code. For example, if return code is zero, you can expect “OK” in this field. |
CUS_NO |
String |
This is the customer number of just created customer. It is possible you leave the CUS_NO in Input blank and cause system to sequentially assign the next customer number which is return in this field. |
Code Example (VB)
The following sample code will add a customer. Most of the columns of this newly added customer will get its default value from default customer # “&&&&&&”.
Dim Service As New webServicesCustm.ElicustmService
Dim Result As New webServicesCustm.AddCustomerResult
Dim Input As New webServicesCustm.AddCustomerInput
Input.CUS_NO = “000001”
Input.CUS_NAME = “Netcellent System, Inc.”
Input.CUS_STREET1 = “4030 Valley Blvd. #100”
Input.CUS_CITY = “Walnut”
Input.CUS_ST = “CA”
Input.CUS_ZIP = “91789”
Input.CUS_CONTACT = “John”
Input.CUS_ORDER_LOC = “BR”
Result = Service.AddCustomer(“”, “”, Input)
If Result.ReturnCode = 0 Then
lblResult.Text = “Cust# ” & Result.CUS_NO & “Added”
Else
lblResult.Text = Result.ReturnMsg
lblErrorCode.Text = Result.ReturnCode.ToString
End If
This method can change a customer record. You must specify the Customer Number in order to change. This method supports clearing fields, you can pass a single space to a string field, or pass zero to a numeric field to clear it. If you do not wish to clear the fields, simply do not assign value to the field. Then the field’s original value will not be changed.
Usage:
ChangeCustomerResult = A.ChangeCustomer(UserName, UserPassword, ChangeCustomerInput)
Parameters UserName and UserPassword are not used at this moment.
ChangeCustomerInput Structure
Property |
Length |
Type |
Upper |
Detail |
CUS_COLLECTOR |
3 |
String |
Y |
Collector. |
CUS_STREET1 |
30 |
String |
|
Customer address 1. |
CUS_STREET2 |
30 |
String |
|
Customer address 2. |
CUS_ALLOW_BO |
1 |
String |
|
Allow back order or not. The value should be “Y” or “N”. |
CUS_ALLOW_PART_SHIP |
1 |
String |
|
Allow partial ship. The value here should be “Y” or “N”. |
CUS_ALLOW_SUB_ITMS |
1 |
String |
|
Allow substitute item. The value here should be “Y” or “N”. |
CUS_AMT_AGE_PD1 |
9.2 |
Double |
|
Age Amt 30 Days. |
CUS_AMT_AGE_PD2 |
9.2 |
Double |
|
Age Amt 60 Days. |
CUS_AMT_AGE_PD3 |
9.2 |
Double |
|
Age Amt 90 Days. |
CUS_AMT_AGE_PD4 |
9.2 |
Double |
|
Age Amt 120 Days. |
CUS_AR_MAIN_NO |
8 |
String |
Y |
Acct No (part 1). |
CUS_AR_SUB_NO |
8 |
String |
Y |
Acct No (part 2). |
CUS_AR_DP_NO |
8 |
String |
Y |
Acct No (part 3). |
CUS_AVG_PAY_LAST_YR |
5 |
Double |
|
Avg Days Pay Last Yr. |
CUS_AVG_PAY_YTD |
5 |
Double |
|
Avg Days Pay YTD. |
CUS_BALANCE |
9.2 |
Double |
|
Customer balance. |
CUS_BAL_METH |
1 |
String |
Y |
Customer balance method. |
CUS_BILL_TO_NO |
6 |
String |
Y |
Bill to number. |
CUS_CITY |
15 |
String |
|
City. |
CUS_COMMENT1 |
30 |
String |
Y |
Customer comments (line 1). |
CUS_COMMENT2 |
30 |
String |
Y |
Customer comments (line 2). |
CUS_CONTACT |
20 |
String |
|
Contact. |
CUS_CORR_NAME |
30 |
String |
|
Corresponding name. |
CUS_COST_LAST_YR |
9.2 |
Double |
|
Cost last year. |
CUS_COST_PTD |
9.2 |
Double |
|
Cost period to date. |
CUS_COST_YTD |
9.2 |
Double |
|
Cost year to date. |
CUS_COUNTRY |
10 |
String |
Y |
Country. |
CUS_CR_HOLD_FG |
1 |
String |
Y |
Credit hold flag. This field should be “Y” or “N”. |
CUS_CR_LIMIT |
9 |
Integer |
|
Credit limit. |
CUS_CR_RATING |
4 |
String |
Y |
Credit rate. |
CUS_NAME |
30 |
String |
|
Customer name. |
CUS_NO |
6 |
String |
Y |
Required. This is the key field to locate the customer record. |
CUS_TP |
5 |
String |
Y |
Cust type. |
CUS_START_DT |
8 |
Date |
|
Start date. |
CUST_TYPE_DESC |
15 |
String |
|
This field is not used. |
CUS_DISC_PCT |
3.2 |
Single |
|
Discount %. |
CUS_EXEMPT_EXP_DATE |
8 |
Date |
|
Exempt expire date. |
CUS_EXEMPT_NO |
15 |
String |
Y |
Exempt number. |
CUS_EXEMPT_REASON_CD |
1 |
String |
Y |
Exempt reason code. |
CUS_FAX_NUMBER |
12 |
String |
Y |
Fax number. |
CUS_FIN_CHG_FG |
1 |
String |
Y |
Finance charge flag. This field should be “Y” or “N”. |
CUS_FORM_NO |
2 |
Integer |
|
Invoice form number. |
CUS_GEO_CODE |
9 |
String |
Y |
Customer geo code. |
CUS_HELD_ORD_AMT |
9.2 |
Double |
|
This field is linked to “Sales year before last year”. We suggest you to use CUS_SALES_YR_BF_LY instead of this field. |
CUS_HIGH_BALANCE |
9.2 |
Double |
|
Highest balance. |
CUS_INV_LAST_YR |
6 |
Double |
|
Invoices last year. |
CUS_INV_YTD |
6 |
Double |
|
Invoices year to date. |
CUS_LAST_PAY_AMT |
9.2 |
Double |
|
Last payment amount. |
CUS_LAST_PAY_DT |
8 |
Date |
|
Last payment date. |
CUS_LAST_SALE_AMT |
9.2 |
Double |
|
Last sale amount. |
CUS_LAST_SALE_DT |
8 |
Date |
|
Last sale date. |
CUS_LAST_STM_AGE_DT |
8 |
Date |
|
Last aging date. |
CUS_NOTE_1 |
30 |
String |
Y |
User Definable field 1. |
CUS_NOTE_2 |
30 |
String |
Y |
User Definable field 2. |
CUS_NOTE_3 |
30 |
String |
Y |
User Definable field 3. |
CUS_NOTE_4 |
30 |
String |
Y |
User Definable field 4. |
CUS_NOTE_5 |
30 |
String |
Y |
User Definable field 5. |
CUS_OPEN_ORD_AMT |
9.2 |
Double |
|
This field is linked to “Open order pick/invoiced amount”. We suggest you to use CUS_PICK_INV_AMT instead of this field. |
CUS_ORDER_LOC |
2 |
String |
Y |
Customer order location. |
CUS_OUTSIDE_CITY_LM |
1 |
String |
Y |
Outside city limit. |
CUS_PAID_INV_YTD |
6 |
Integer |
|
Invoices paid year to date. |
CUS_PHONE_NO |
12 |
String |
Y |
Phone number. |
CUS_PRINT_DUNN_FG |
1 |
String |
Y |
Print dunning letters flag. This field should be “Y” or “N”. |
CUS_SALES_LAST_YR |
9.2 |
Double |
|
Sales last year. |
CUS_SLM_NO |
3 |
String |
Y |
Salesman Number. |
CUS_SALES_PTD |
9.2 |
Double |
|
Sales period to date. |
CUS_SALES_YTD |
9.2 |
Double |
|
Sales year to date. |
CUS_SEARCH_NAME |
30 |
String |
|
This field is not used. |
SHIP_VIA_CD |
2 |
String |
Y |
Ship via code. |
CUS_SLM_STRT_DT |
8 |
Date |
|
Salesman start date. |
CUS_ST |
2 |
String |
Y |
State. |
CUS_STM_FREQ |
1 |
String |
Y |
Customer statement frequency. |
CUS_TXBL_FG |
1 |
String |
Y |
Taxable flag. This field should be “Y” or “N”. |
CUS_TX_CD1 |
3 |
String |
Y |
Tax code 1. |
CUS_TX_CD2 |
3 |
String |
Y |
Tax code 2. |
CUS_TX_CD3 |
3 |
String |
Y |
Tax code 3. |
TERMS_CD |
2 |
String |
Y |
Terms code. |
CUS_TERR |
2 |
String |
Y |
Territory. |
CUS_UPS_ZONE |
2 |
String |
Y |
UPS zone. |
CUS_USE_BILL_TO_ADRR |
1 |
String |
Y |
“Y”: Get Order Bill-To Address from Bill-To No, and Order Ship-To Address from this customer. “N”: Get Order Bill-To Address and Order Ship-To Address from Bill-To No. “S”: Get Order Bill-To Address and Order Ship-To Address from this customer. |
CUS_USER_AMT |
7.2 |
Double |
|
User definable amount. |
CUS_USER_DATE |
8 |
Date |
|
User definable date. |
CUS_YTD_DSC_GIVEN |
9.2 |
Double |
|
Discount given year to date. |
CUS_ZIP |
2 |
String |
Y |
Zip code. |
CUS_PICK_INV_AMT |
9.2 |
Double |
|
Open order pick/invoiced amount. The input property CUS_OPEN_ORD_AMT is also linked to the same field, which has lower priority than this field. We suggest you to use this field instead of CUS_OPEN_ORD_AMT. |
CUS_SALES_YR_BF_LY |
9.2 |
Double |
|
Sales year before last year. The input property CUS_HELD_ORD_AMT is also linked to the same field, which has lower priority than this field. We suggest you to use this field instead of CUS_HELD_ORD_AMT. |
CUS_ABC_CLASS |
1 |
String |
Y |
ABC class. Should be “A”, “B” or “C”. |
CUS_DEL_LEAD_TIME |
3 |
Integer |
|
Delivery lead time (“Ship To Days” field in Elliott customer file). |
CUS_DEL_DAY_ERLY_ALW |
3 |
Integer |
|
Days delivery early allowed. |
Output Parameter
Property Name |
Type |
Detail |
ChangeCustomerResult |
Integer |
Contains return code. Zero means OK; for other return codes, please see “ElicustmService Return Code” section. |
Code Example (VB)
The following sample code will put customer# “000001” on credit hold.
Dim Service As New webServicesCustm.ElicustmService
Dim Result As Integer
Dim Input As New webServicesCustm.ChangeCustomerInput
Input.CUS_NO = “000001”
Input.CUS_CR_HOLD_FG = “Y”
Result = Service.ChangeCustomer(“”, “”, Input)
If Result = 0 Then
lblResult.Text = “Customer Data Has Been Changed.”
Else
lblResult.Text = “Error While Changing Customer.”
lblErrorCode.Text = Result.ToString
End If
This method will delete a customer by providing customer number.
Usage:
DeleteCustomerResult = A.DeleteCustomer(UserName, UserPassword, CUS_NO)
Parameters UserName and UserPassword are not used at this moment.
Input Parameter
Parameter |
Length |
Type |
Upper |
Detail |
CUS_NO |
6 |
String |
Y |
Required. |
Output Parameter
Property Name |
Type |
Detail |
DeleteCustomerResult |
Integer |
Contains return code. Zero means OK; for other return codes, please see “EliordiqService Return Code” section. |
Code Example (VB)
The following sample code will delete customer# “000001”.
Dim Service As New webServicesCustm.ElicustmService
Dim Result As Integer
Result = Service.DeleteCustomer(“”, “”, “000001”)
If Result = 0 Then
lblResult.Text = “Customer# 000001 Has Been Deleted.”
Else
lblResult.Text = “Error While Deleting Customer.”
lblErrorCode.Text = Result.ToString
End If
This method will return one customer record by providing a customer number.
Usage:
ViewCustomerResult = A.ViewCustomer(UserName, UserPassword, CUS_NO)
Parameters UserName and UserPassword are not used at this moment.
Input Parameter
Property |
Length |
Type |
Upper |
Detail |
CUS_NO |
6 |
String |
Y |
Required |
ViewCustomerResult Structure
Please see “ChangeCustomerInput Structure” for the explanation of each field.
Property Name |
Type |
Detail |
ReturnCode |
Integer |
Zero means OK; for other return codes, please see “ElicustmService Return Code” section. |
ReturnMsg |
String |
This is description of return code. For example, if return code is zero, you can expect “OK” in this field. |
CUS_COLLECTOR |
String |
|
CUS_STREET1 |
String |
|
CUS_STREET2 |
String |
|
CUS_ALLOW_BO |
String |
|
CUS_ALLOW_PART_SHIP |
String |
|
CUS_ALLOW_SUB_ITMS |
String |
|
CUS_AMT_AGE_PD1 |
Double |
|
CUS_AMT_AGE_PD2 |
Double |
|
CUS_AMT_AGE_PD3 |
Double |
|
CUS_AMT_AGE_PD4 |
Double |
|
CUS_AR_MAIN_NO |
String |
|
CUS_AR_SUB_NO |
String |
|
CUS_AR_DP_NO |
String |
|
CUS_AVG_PAY_LAST_YR |
Double |
|
CUS_AVG_PAY_YTD |
Double |
|
CUS_BALANCE |
Double |
|
CUS_BAL_METH |
String |
|
CUS_BILL_TO_NO |
String |
|
CUS_CITY |
String |
|
CUS_COMMENT1 |
String |
|
CUS_COMMENT2 |
String |
|
CUS_CONTACT |
String |
|
CUS_CORR_NAME |
String |
|
CUS_COST_LAST_YR |
Double |
|
CUS_COST_PTD |
Double |
|
CUS_COST_YTD |
Double |
|
CUS_COUNTRY |
String |
|
CUS_CR_HOLD_FG |
String |
|
CUS_CR_LIMIT |
Integer |
|
CUS_CR_RATING |
String |
|
CUS_NAME |
String |
|
CUS_NO |
String |
|
CUS_TP |
String |
|
CUS_START_DT |
Date |
|
CUST_TYPE_DESC |
String |
|
CUST_TYPE_USE_LABEL |
String |
|
CUS_DISC_PCT |
Single |
|
CUS_EXEMPT_EXP_DATE |
Date |
|
CUS_EXEMPT_NO |
String |
|
CUS_EXEMPT_REASON_CD |
String |
|
CUS_FAX_NUMBER |
String |
|
CUS_FIN_CHG_FG |
String |
|
CUS_FORM_NO |
Integer |
|
CUS_GEO_CODE |
String |
|
CUS_HELD_ORD_AMT |
Double |
|
CUS_HIGH_BALANCE |
Double |
|
CUS_INV_LAST_YR |
Double |
|
CUS_INV_YTD |
Double |
|
CUS_LAST_PAY_AMT |
Double |
|
CUS_LAST_PAY_DT |
Date |
|
CUS_LAST_SALE_AMT |
Double |
|
CUS_LAST_SALE_DT |
Date |
|
CUS_LAST_STM_AGE_DT |
Date |
|
CUS_NOTE_1 |
String |
|
CUS_NOTE_2 |
String |
|
CUS_NOTE_3 |
String |
|
CUS_NOTE_4 |
String |
|
CUS_NOTE_5 |
String |
|
CUS_OPEN_ORD_AMT |
Double |
|
CUS_ORDER_LOC |
String |
|
CUS_OUTSIDE_CITY_LM |
String |
|
CUS_PAID_INV_YTD |
Integer |
|
CUS_PHONE_NO |
String |
|
CUS_PRINT_DUNN_FG |
String |
|
CUS_SALES_LAST_YR |
Double |
|
SLM_ADDRESS1 |
String |
|
SLM_ADDRESS2 |
String |
|
SLM_EMAIL |
String |
|
SLM_INIT |
String |
|
SLM_NAME |
String |
|
CUS_SLM_NO |
String |
|
SLM_PHONE_NO |
String |
|
SLM_TERR |
String |
|
CUS_SALES_PTD |
Double |
|
TAX_CD1_DESC |
String |
|
TAX_CD2_DESC |
String |
|
TAX_CD3_DESC |
String |
|
TAX_CD1_PCT |
Double |
|
TAX_CD2_PCT |
Double |
|
TAX_CD3_PCT |
Double |
|
TAX_FREIGHT1_FLAG |
String |
|
TAX_FREIGHT2_FLAG |
String |
|
TAX_FREIGHT3_FLAG |
String |
|
CUS_SALES_YTD |
Double |
|
CUS_SEARCH_NAME |
String |
|
CARRIER_BOL_REQ |
String |
|
MANIFEST_CARRIER_CD |
String |
|
MANIFEST_MODE_CODE |
String |
|
REQ_SHIPPING_VERIF |
String |
|
SHIP_VIA_CD |
String |
|
SHIP_VIA_CD_DESC |
String |
|
CUS_SLM_STRT_DT |
Date |
|
CUS_ST |
String |
|
CUS_STM_FREQ |
String |
|
CUS_TXBL_FG |
String |
|
CUS_TX_CD1 |
String |
|
CUS_TX_CD2 |
String |
|
CUS_TX_CD3 |
String |
|
TERMS_ABS_DIS_DUE_DT |
Date |
|
TERMS_ABS_DUE_DATE |
Date |
|
TERMS_CD |
String |
|
MANIFEST_COD_TRX_FLG |
String |
|
MANIFEST_COD_TERMS |
String |
|
TERMS_CD_DUE_DAY |
Integer |
|
TERMS_CD_DESC |
String |
|
TERMS_CD_DISC_DAYS |
Integer |
|
TERMS_CD_DISC_PCT |
Double |
|
TERMS_CD_DUE_DAYS |
Integer |
|
TERMS_EXTRA_CHRG_CD |
String |
|
TERMS_EXTRA_CHRG |
Double |
|
TERMS_PROX_MON_END |
Integer |
|
TERMS_PROX_TERMS |
String |
|
TERMS_PROX_TERMS_DSC |
Integer |
|
CUS_TERR |
String |
|
CUS_UPS_ZONE |
String |
|
CUS_USE_BILL_TO_ADRR |
String |
|
CUS_USER_AMT |
Double |
|
CUS_USER_DATE |
Date |
|
CUS_YTD_DSC_GIVEN |
Double |
|
CUS_ZIP |
String |
|
CUS_PICK_INV_AMT |
Double |
|
CUS_SALES_YR_BF_LY |
Double |
|
CUS_ABC_CLASS |
String |
|
CUS_DEL_LEAD_TIME |
Integer |
|
CUS_DEL_DAY_ERLY_ALW |
Integer |
|
CUS_ACCESS_DATE |
Date |
|
CUS_ACCESS_TIME |
Integer |
|
Code Example (VB)
The following sample code will return the record of customer# “000001”.
Dim Service As New webServicesCustm.ElicustmService
Dim Result As New webServicesCustm.ViewCustomerResult
Result = Service.ViewCustomer(“”, “”, “000001”)
If Result.ReturnCode = 0 Then
lblResult.Text = “Customer Name: ” & Result.CUS_NAME
Else
lblResult.Text = “Error While Viewing Customer.”
lblErrorCode.Text = Result.ReturnMsg
End If
InquiryBy5Keys
This method will return up to 999 customer records by providing the customer search key name and its value as a starting point.
Usage:
InquiryBy5KeysResult = A.InquiryBy5Keys(UserName, UserPassword, KeyName, StartingKeyValue, TableSize)
Parameters UserName and UserPassword are not used at this moment.
Input Parameters
Parameter |
Length |
Type |
Upper |
Detail |
KeyName |
15 |
String |
Y |
Required. The value here must be one of the following or you will get error code 29: ADDRESS-1 CITY ZIP-CODE TELEPHONE FAXNUMBER CONTACT COMMENT-1 COMMENT-2 NOTE-1 NOTE-2 NOTE-3 NOTE-4 NOTE-5 ACCT-DATE USER-DATE CUST-TYPE CREDIT-RATE CORRESP-NAME BILL-TO-NO COUNTRY EXEMPT-NO
If provided value is one of the above, but it’s not in one of the five “Additional search key for customer” in Elliott Global Setup, you will not find any customer, which is error code 28. |
StartingKeyValue |
30 |
String |
Y |
The start value of keyname field. |
TableSize |
3 |
Integer |
|
Since this is a begin search, so we need to limit the number of CustomerRecord returned by using this value. The default value is 100 and the maximum value is 999. |
InquiryBy5KeysResult Structure
Property Name |
Type |
Detail |
ReturnCode |
Integer |
Zero means OK; for other return codes, please see “ElicustmService Return Code” section. |
ReturnMsg |
String |
This is description of return code. For example, if return code is zero, you can expect “OK” in this field. |
TableCount |
Integer |
Indicates how many records in CustomerRecord() array. |
CustomerRecord() |
CustomerRecord |
Contains up to 999 customer records. See the following section for the structure of CustomerRecord. |
CustomerRecord Structure
Please see “ChangeCustomerInput Structure” for the explanation of each field.
Property Name |
Type |
Detail |
CUS_NO |
String |
|
CUS_NAME |
String |
|
CUS_CORR_NAME |
String |
|
CUS_STREET1 |
String |
|
CUS_STREET2 |
String |
|
CUS_CITY |
String |
|
CUS_ST |
String |
|
CUS_ZIP |
String |
|
CUS_COUNTRY |
String |
|
CUS_CONTACT |
String |
|
CUS_PHONE_NO |
String |
|
CUS_START_DT |
Date |
|
CUS_SLM_NO |
String |
|
CUS_TP |
String |
|
CUS_BAL_METH |
String |
|
CUS_STM_FREQ |
String |
|
CUS_CR_LIMIT |
Integer |
|
CUS_CR_RATING |
String |
|
CUS_CR_HOLD_FG |
String |
|
FILLER_0001 |
String |
|
CUS_COLLECTOR |
String |
|
CUS_FIN_CHG_FG |
String |
|
CUS_ORDER_LOC |
String |
|
CUS_TERR |
String |
|
CUS_AR_MAIN_NO |
String |
|
CUS_AR_SUB_NO |
String |
|
CUS_AR_DP_NO |
String |
|
CUS_SHIP_VIA_CD |
String |
|
CUS_UPS_ZONE |
String |
|
CUS_TERMS_CD |
String |
|
CUS_DSC_PCT |
Double |
|
CUS_YTD_DSC_GIVEN |
Double |
|
CUS_TXBL_FG |
String |
|
CUS_TX_CD1 |
String |
|
CUS_TX_CD2 |
String |
|
CUS_TX_CD3 |
String |
|
CUS_EXEMPT_NO |
String |
|
CUS_SALES_PTD |
Double |
|
CUS_SALES_YTD |
Double |
|
CUS_SALES_LAST_YR |
Double |
|
CUS_COST_PTD |
Double |
|
CUS_COST_YTD |
Double |
|
CUS_COST_LAST_YR |
Double |
|
CUS_BALANCE |
Double |
|
CUS_HIGH_BALANCE |
Double |
|
CUS_LAST_SALE_DT |
Date |
|
CUS_LAST_SALE_AMT |
Double |
|
CUS_INV_YTD |
Integer |
|
CUS_INV_LAST_YR |
Integer |
|
CUS_PAID_INV_YTD |
Integer |
|
CUS_LAST_PAY_DT |
Date |
|
CUS_LAST_PAY_AMT |
Double |
|
CUS_AVG_PAY_YTD |
Integer |
|
CUS_AVG_PAY_LAST_YR |
Integer |
|
CUS_LAST_STM_AGE_DT |
Date |
|
CUS_AMT_AGE_PD1 |
Double |
|
CUS_AMT_AGE_PD2 |
Double |
|
CUS_AMT_AGE_PD3 |
Double |
|
CUS_AMT_AGE_PD4 |
Double |
|
CUS_ALLOW_SUB_ITMS |
String |
|
CUS_ALLOW_BO |
String |
|
CUS_ALLOW_PART_SHIP |
String |
|
CUS_PRINT_DUNN_FG |
String |
|
CUS_COMMENT1 |
String |
|
CUS_COMMENT2 |
String |
|
CUS_SEARCH_NAME |
String |
|
CUS_NOTE_1 |
String |
|
CUS_NOTE_2 |
String |
|
CUS_NOTE_3 |
String |
|
CUS_NOTE_4 |
String |
|
CUS_NOTE_5 |
String |
|
CUS_USER_DATE |
Date |
|
CUS_USER_AMT |
Double |
|
CUS_EXEMPT_EXP_DATE |
Date |
|
CUS_EXEMPT_REASON_CD |
String |
|
CUS_OUTSIDE_CITY_LM |
String |
|
CUS_GEO_CODE |
String |
|
CUS_USE_BILL_TO_ADRR |
String |
|
CUS_BILL_TO_NO |
String |
|
CUS_FORM_NO |
Integer |
|
CUS_FAX_NUMBER |
String |
|
CUS_SLM_STRT_DT |
Date |
|
CUS_PICK_INV_AMT |
Double |
|
CUS_SALES_YR_BF_LY |
Double |
|
CUS_FRY_PAY_CODE |
String |
|
CUS_ABC_CLASS |
String |
|
CUS_DEL_LEAD_TIME |
Integer |
|
CUS_DEL_DAY_ERLY_ALW |
Integer |
|
CUS_ACCESS_DATE |
Date |
|
CUS_ACCESS_TIME |
Integer |
|
FILLER_2 |
String |
|
Code Example (VB)
The following sample code will return up to 50 customer records whose zip code is equal or greater than “91700”.
Dim Service As New webServicesCustm.ElicustmService
Dim Result As New webServicesCustm.InquiryBy5KeysResult
Dim KeyName As String = “ZIP-CODE”
Dim StartingKeyValue As String = “91700”
Dim TableSize As Integer = 50
Result = Service.InquiryBy5Keys(“”, “”,KeyName, StartingKeyValue, TableSize)
If Result.ReturnCode = 0 Then
lblResult.Text = “First Customer No.: ” & _
Result.CustomerRecord(0).CUS_NO & _
“ Name: ” & _
Result.CustomerRecord(0).CUS_NAME
ElseIf Result.ReturnCode = 28
lblResult.Text = “No record found.”
Else
lblResult.Text = “Error While Querying Customer.”
lblErrorCode.Text = Result.ReturnMsg
End If
This method will return up to 999 customer records by providing starting customer name.
Usage:
InquiryByCustomerNameResult = A.InquiryByCustomerName(UserName, UserPassword, StartingCustomerName, TableSize)
Parameters UserName and UserPassword are not used at this moment.
Input Parameters
Parameter |
Length |
Type |
Upper |
Detail |
StartingCustomerName |
30 |
String |
Y |
|
TableSize |
3 |
Integer |
|
Size of return CustomerRecord array. Default is 100 and Default is 100 and max value is 999. |
InquiryByCustomerNameResult Structure
Property Name |
Type |
Detail |
ReturnCode |
Integer |
Zero means OK; for other return codes, please see “ElicustmService Return Code” section. |
ReturnMsg |
String |
This is description of return code. For example, if return code is zero, you can expect “OK” in this field. |
TableCount |
Integer |
Indicates how many records in CustomerRecord. |
CustomerRecord() |
CustomerRecord |
Contains up to 999 customer records. See “CustomerRecord Structure” in InquiryBy5Keys method for more detail. |
Code Example (VB)
The following sample codes will return up to 50 customer records starting from customer name “Netcellent”.
Dim Service As New webServicesCustm.ElicustmService
Dim Result As New webServicesCustm.InquiryByCustomerNameResult
Dim StartingCustomerName As String = “Netcellent”
Dim TableSize As Integer = 50
Result = Service.InquiryByCustomerName(“”, “”, StartingCustomerName, _
TableSize)
If Result.ReturnCode = 0 Then
lblResult.Text = “First Customer No.: ” & _
Result.CustomerRecord(0).CUS_NO & _
“ Name: ” & Result.CustomerRecord(0).CUS_NAME
ElseIf Result.ReturnCode = 28 Then
lblResult.Text = "No record found."
Else
lblResult.Text = “Error While Querying Customer.”
lblErrorCode.Text = Result.ReturnMsg
End If
This method will return up to 999 customer records by providing starting customer number. This method is different from ViewCustomer where it will perform an exact search on customer number and only return one record if found.
Usage:
InquiryByCustomerNo = A.InquiryByCustomerNo(UserName, UserPassword, StartingCustomerNo, TableSize)
Parameters UserName and UserPassword are not used at this moment.
Input Parameters
Parameter |
Length |
Type |
Upper |
Detail |
StartingCustomerNo |
6 |
String |
Y |
|
TableSize |
3 |
Integer |
|
Size of return CustomerRecord array. Default is 100 and max value is 999. |
InquiryByCustomerNoResult Structure
Property Name |
Type |
Detail |
ReturnCode |
Integer |
Zero means OK; for other return codes, please see “ElicustmService Return Code” section. |
ReturnMsg |
String |
This is description of return code. For example, if return code is zero, you can expect “OK” in this field. |
TableCount |
Integer |
Indicates how many records in CustomerRecord. |
CustomerRecord() |
CustomerRecord |
|
Code Example (VB)
The following sample code will return up to 50 customer records starting from customer number “234000”.
Dim Service As New webServicesCustm.ElicustmService
Dim Result As New webServicesCustm.InquiryByCustomerNoResult
Dim StartingCustomerNo As String = “234000”
Dim TableSize As Integer = 50
Result = Service.InquiryByCustomerNo(“”, “”,StartingCustomerNo, TableSize)
If Result.ReturnCode = 0 Then
lblResult.Text = “First Customer No.: ” & _
Result.CustomerRecord(0).CUS_NO & _
“ Name: ” & Result.CustomerRecord(0).CUS_NAME
ElseIf Result.ReturnCode = 28 Then
lblResult.Text = "No record found"
Else
lblResult.Text = “Error While Querying Customer.”
lblErrorCode.Text = Result.ReturnMsg
End If
This method will return all Ship-To records for the provided customer number. There’s no maximum limit on the number of ship-to records that can be returned in the dataset.
Usage:
GetShipToResult = A.GetShipTo(UserName, UserPassword, SHIP_TO_CUST_NO)
Parameters UserName and UserPassword are not used at this moment.
Input Parameters
Parameter |
Length |
Type |
Upper |
Detail |
SHIP_TO_CUST_NO |
|
String |
|
Required. |
GetShipToResult Structure
Property Name |
Type |
Detail |
ReturnCode |
Integer |
Zero means OK; for other return codes, please see “ElicustmService Return Code” section. |
ReturnMsg |
String |
This is description of return code. For example, if return code is zero, you can expect “OK” in this field. |
CustomerShipTo |
DataSet |
This dataset has a table “CPSHPFIL” which contains the following fields: SHIP_TO_CUST_NO SHIP_TO_NO SHIP_TO_NAME SHIP_TO_ADDRESS1 SHIP_TO_ADDRESS2 SHIP_TO_CITY FILLER_003 SHIP_TO_STATE FILLER_004 SHIP_TO_ZIPCODE SHIP_TO_COUNTRY SHIP_TO_EXE_REA_CODE SHIP_TO_OUT_CITY_LM SHIP_TO_VIA_CODE SHIP_TO_SALESMAN_NO FILLER_0001 SHIP_TO_EXE_EXP_DATE SHIP_TO_UPS_ZONE SHIP_TO_TAX_CODE1 SHIP_TO_TAX_CODE2 SHIP_TO_TAX_CODE3 SHIP_TO_FRE_FRM_FLG SHIP_TO_GEO_CODE SHIP_TO_TAXABLE_FLAG FILLER_002 SHIP_TO_XREF_NO CPSHPFIL_FILLER_003 TAX_CODE1_DESC TAX_CODE2_DESC TAX_CODE3_DESC TAX_CODE1_PCT TAX_CODE2_PCT TAX_CODE3_PCT |
Code Example (VB)
The following sample codes will return ship-to records for customer# “000001”.
Dim Service As New webServicesCustm.ElicustmService
Dim Result As New webServicesCustm.GetShipToResult
Dim SHIP_TO_CUST_NO As String = “000001”
Result = Service.GetShipTo(“”, “”,SHIP_TO_CUST_NO)
If Result.ReturnCode = 0 Then
lblResult.Text = “First Ship-To No.: ” & _
Result.CustomerShipTo.Tables(0).Rows(0).Item("SHIP_TO_NO") & _
“ Ship-To Name: ” & _
Result.CustomerShipTo.Tables(0).Rows(0).Item("SHIP_TO_NAME")
ElseIf Result.ReturnCode = 30001 Then
lblResult.Text = "No record found"
Else
lblResult.Text = “Error While Quering Customer.”
lblErrorCode.Text = Result.ReturnMsg
End If
0 = OK
1 = File Error
2 = Data Missing (Customer No Missing) (Inquiry/Change/Delete)
3 = NSI Control File Not Found (Add)
4 = Customer Not On File (Inquiry/Change/Delete)
5 = No Default Customer '&&&&&&' (Add)
6 = Data Missing (Customer Name Missing) (Add)
7 = Salesman Not On File (Add)
8 = Customer Type Not On File (Add)
9 = Balance Method Must Be "B" or "O" (Add)
10 = Statement Frequency Must Be "N", "D", "W", "M", "S", "Q" (Add)
11 = Ship Via Code Not On File (Add)
12 = Terms Code Not On File (Add)
13 = Credit Hold Flag Must Be "Y" or "N" (Add)
14 = Fin Chg Flag Must Be "Y" or "N" (Add)
15 = A/R Account No Not On File (Add)
16 = Taxable Flag Must Be "Y" or "N" (Add)
17 = Allow Substitute Item Flag Must Be "Y" or "N" (Add)
18 = Backorderable Flag Must Be "Y" or "N" (Add)
19 = Partial Shipment Flag Must Be "Y" or "N" (Add)
20 = Print Dunning Letter Flag Must Be "Y" or "N" (Add)
21 = Tax Code Not On File (Add)
22 = Duplication For Tax Code 1 & 2 & 3 (Add)
23 = Customer No Exist, Cannot Be Added (Add)
24 = Exempt Reason Code Must Be "Y" or "N" (Add)
25 = Outside City Limit Must Be "Y" or "N" (Add)
26 = Use Bill To Addr Must Be "Y" or "N" (Add)
27 = Bill To Customer Not On File (Add)
28 = No Customer For This Inquiry
29 = Invalid Key Name
30 = Customer Record Locked
30000 = Database Error (GetShipTo) - This is likely a DDF mismatch issue
30001 = No record found (GetShipTo)
CLS