Functions
Customer Tax edit API is used to modify existing tax information.
URL:{Root URL}/API/ShipTax/Edit/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| unqshiptax |
Primary Tax Key |
Y |
Must be Unique |
| Linkadd |
Link to Ship Bill Table |
Y |
Links the tax info to the shipping info |
| Custno |
Customer Number |
Y |
|
| Taxdesc |
Tax Description |
N |
|
| tax_rate |
Tax Rate |
N |
|
| Tax_id |
Tax ID |
N |
|
| recordtype |
Record Type |
N |
|
| ptProd |
Primary Tax Product |
N |
|
| ptFr |
Primary Tax Freigh |
N |
|
| stProd |
Secondary Tax Product |
N |
|
| stFrt |
Secondary Tax Freight |
N |
|
| stTx |
Secondary Tax |
N |
|
| modifiedDate |
Last Modified Date |
N |
|
Example Strings
Edit Tax Details
URL:?UNQSHIPTAX=UniqShipTa&Custno=0000000011&Taxdesc=ORANGE COUNTY&Taxtype=S&Tax_Rate=7.5&Tax_id=CA USE&Recordtype=S
{
'UNQSHIPTAX':'USQNT0M26L',
'Custno':'0000000011',
'Taxdesc':'ORANGE COUNTY',
'Taxtype':'S',
'Tax_Rate':'7.5' ,
'Tax_id':'CA USE ',
'Recordtype':'S'
}
A successful edit should result in
{
"$id": "1",
"Code": 200,
"Message": "ShipTax edited 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 a HTTP error message.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/ShipTaxEdit/123456789'.",
"MessageDetail": "No type was found that matches the controller named 'ShipTaxEdit'."
}
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
}
|