| Edit |
Functions
Customer edit API is used to modify existing customer information
{Root URL}/API/Customer/Edit/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| Custno |
Customer Number |
Y |
Must be unique and ten digits. |
| Custname |
Customer Name |
N |
|
| Phone |
Customer’s phone number |
N |
|
| Fax |
Customer’s fax |
N |
|
| Territory |
The customer’s territory |
N |
Can be: SOUTHERN CA, NORTHERN CA, EAST, WEST, MIDWEST, NEW ENGLAND, SOUTH, GREAT LAKES, MEXICO, CANADA, UNITED KINGDOM |
| Terms |
The customer’s sales terms |
N |
Can be: NET 10, NET 15, NET 30, NET 30/2% 10, NET 45, COD, NONE |
| Credlimit |
Credit Limit |
N |
This is the customer’s credit limit. Must be Greater than or equal to 0 |
| Creditok |
Credit Status |
N |
Can be: OK, HOLD, REJECT |
| Resl_no |
Reseller Number |
N |
|
| Ar_highBal |
Accounts Receivable balance |
N |
Must be greater than or equal to 0 |
| Acct_date |
Date the account was created |
N |
In MM/DD/YYYY format |
| Status |
Account Status |
N |
Can be: ACTIVE, INACTIVE, QUOTE |
| Saledsctid |
Sales Discount Id |
N |
|
| Acctaxable |
Account Taxable |
N |
|
| Inactdt |
Account inactive date |
N |
Must be in MM/DD/YYYY |
| Inactinit |
Inactive initial |
N |
|
| modifieddate |
Account Modified Date |
N |
Must be in MM/DD/YYYY format. |
Example Strings
Edit Customer Details
URL:?CUSTNO=0000000000&CUSTNAME=CustomerName&ACCT_DATE=YYYY-MM-DD00:00:00&STATUS=Active&territory=NEW ENGLAND'
{
'CUSTNO':'0000000000',
'CUSTNAME':'CustomerName',
'ACCT_DATE':'YYYY-MM-DD00:00:00',
'STATUS':'Active',
'territory':'NEW ENGLAND'
}
A successful edit should result in
{
"$id": "1",
"Code": 200,
"Message": "Customer edited successfully.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Common Errors
API Key Error
If there is an error with the API Key the system will return an error message describing it.
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
URL Error
If there is an error with the used URL the system will return a HTTP error.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/CustomerEdit/123456789'.",
"MessageDetail": "No type was found that matches the controller named 'CustomerEdit'."
}
Parameter Error
If there is an error with one of the used parameters the system will return an error message describing the error.
{
"$id": "1",
"Code": 403,
"Message": "Customer edit failed.Customer Number or Customer Name is Required",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
|
|
|
|
|
|
|
|
| Article ID: 5822 |
