Function
The Customer Add Tax API is used to add tax information to a customer's information.
Parameters
| Parameter | Description | Required | Comment | |
| 1 | unqshiptax | Primary tax key | Y | Must be unique. |
| 2 | Linkadd | Link to ship bill table | Y | Links the tax info to the shipping info. |
| 3 | Custno | Customer number | Y | |
| 4 | Taxdesc | Tax description | Y | |
| 5 | tax_rate | Tax rate | Y | |
| 6 | Tax_id | Tax ID | Y | |
| 7 | recordtype | Record type | Y | |
| 8 | ptProd | Primary tax product | N | |
| 9 | ptFr | Primary tax freight | N | |
| 10 | stProd | Secondary tax product | N | |
| 11 | stFrt | Secondary tax freight | N | |
| 12 | stTx | Secondary tax | N | |
| 13 | modifiedDate | Last modified date | N |
Example Strings
Add New Tax Information
URL
?Linkadd=LINKADD&Custno=0000000011&Taxdesc=SANTA CLARA CNTY. USE TAX&Taxtype=S&Tax_Rate=8.2500&Tax_id=CA USE&Recordtype=S |
JSON
{ “Linkadd”:”LINKADD”, “Custno”:”0000000011”, “Taxdesc”:”SANTA CLARA CNTY. USE TAX”, “Taxtype”:”S”, “Tax_Rate”:”8.2500” , “Tax_id”:”CA USE “, “Recordtype”:”S” } |
A successful add should result in:
{ "$id": "1", "Code": "200", "Message": "ShipTax added successfully.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |
Common Errors
API Key Error
If there is an error with the entered API key, the system will return an error message describing an API key error:
{ "$id": "1", "Code": "403", "Message": "Invalid API Key.", "SessionId": "null", "IsValidUser": "false", "ResponseObject": "null" } |
URL Error
If there is an error with the URL, the system will return an HTTP error message:
{ "$id": "1", "Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/ShipTaxAdd/123456789'.", "MessageDetail": "No type was found that matches the controller named 'ShipTaxAdd'." } |
Parameter Value Error
If there is a problem with one of the entered parameter values or a required parameter is missing, the system will return an error message describing the problem:
{ "$id": "1", "Code": "403", "Message": "'ShipTax' Object is not initialized properly.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |