Functions
Add API is used to add a new customer to the system
{Root URL}/API/Customer/Add/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| Custno |
Customer Number |
N |
Must be unique |
| Custname |
Customer Name |
Y |
|
| Status |
Account Status |
Y |
Can be: Active, Inactive, Quote (please note must be camel-cased) |
| 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 |
| 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 |
| Saledsctid |
Sales Discount Id |
N |
|
| Acctaxable |
Account Taxable |
N |
|
Example Strings
Add new customer
URL:?CustName=CustomerName&Status=Active'
JSON
{
"Custname": "CustomerName",
"Status": "Active"
}
A successful add should result in
{
"$id": "1",
"Code": 200,
"Message": "Customer added successfully.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": {
"$id": "2",
"CUSTNO": "0000000010",
"CUSTNAME": "CustomerName",
"PHONE": "",
"FAX": "",
"BLINKADD": "",
"SLINKADD": "",
"TERRITORY": "",
"TERMS": "",
"CREDLIMIT": 0,
"PROFILE": "",
"CUSTNOTE": "",
"ACCTSTATUS": "",
"DIVISION": "",
"SREPS": "",
"CREDITOK": "",
"RESL_NO": "",
"AR_CALDATE": null,
"AR_CALTIME": "",
"AR_CALBY": "",
"AR_CALNOTE": "",
"AR_HIGHBAL": 0,
"CREDITNOTE": "",
"ACCT_DATE": "2014-11-19T10:09:57.041868-05:00",
"SAVEINIT": "",
"OUT_MARGIN": 0,
"TL_MARGIN": 0,
"MAT_MARGIN": 0,
"LAB_MARGIN": 0,
"MIN_ORDAMT": 0,
"SCRAP_FACT": 0,
"COMMITEM": 0,
"CUSTSPEC": 0,
"LABOR": false,
"MATERIAL": false,
"SPLIT1": 0,
"SPLIT2": 0,
"SPLITAMT": 0,
"SPLITPERC": 0,
"TOOLING": false,
"SIC_CODE": "",
"SIC_DESC": "",
"DELIVTIME": "",
"STATUS": "Active",
"SERIFLAG": false,
"OVERHEAD": 0,
"IS_EDITED": "",
"SALEDSCTID": "",
"CUSTPFX": "",
"ACTTAXABLE": false,
"INACTDT": null,
"INACTINIT": "",
"modifiedDate": null,
"UserId": null,
"LinkAddList": null
}
}
Common Errors
URL Error
If there is an error with the entered URL the system will return a HTTP error.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/CustomerAdd/123456789'.",
"MessageDetail": "No type was found that matches the controller named 'CustomerAdd'."
}
Parameter Error
If a required parameter is missing, or the entered value is incorrect the system will return an object reference error message.
{
"$id": "1",
"Code": 403,
"Message": "Customer add failed.Object reference not set to an instance of an object.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
API Key Error
If there is a problem with the used API key the system will return an error describing it.
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
|
