1. Customer Tax

Customer Tax API is used to add or edit Tax information for customers. The Get function for Tax API is used to view the tax information for a customer. The Delete function is used to remove tax information from a customer record. 

1.1. Add

Functions

Customer Add Tax API is used to add tax information to a customer's information.

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 Y  
tax_rate Tax Rate Y  
Tax_id Tax ID Y  
recordtype Record Type Y  
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

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 a 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

}

1.2. Edit

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

}

1.3. Delete

Functions

Customer Tax delete API is used to remove tax information from a customer's records

URL:{Root URL}/API/Customer/TaxDelete/{API Key}

Parameters

Parameter Description Required Comment
Custno Customer Number Y  

Example Strings

Delete tax information

URL?CustNo=0000000011

JSON

{

'CustNo','0000000011'

}

A successful delete request should result in

{

"$id": "1",

"Code": 200,

"Message": "ShipTax deleted successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Common Error

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

}

URL Error

If there is an issue 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/ShipTax/Delete/23456789'.",

"MessageDetail": "No action was found on the controller 'ShipTax' that matches the request."

}

Missing Required Parameter

If a required parameter is missing the system will return an error message specifying which parameter.

{

"$id": "1",

"Code": 403,

"Message": "Customer number or customer name not provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.4. Get

Functions

Customer Tax get API is used to find and view existing tax information

URL:{Root URL}/API/ShipTax/Get/{API Key}

Parameters

Parameter Description Required Comment
Linkadd Link to Ship Bill Table Y Links the tax info to the shipping info

Example Strings

Get Tax Information

URL:?LinkAdd=LINKADD

JSON

{

'LinkAdd':'LINKADD'

}

A successful get request should result in

{

"$id": "1",

"Code": 200,

"Message": "ShipTax details:",

"SessionId": null,

"IsValidUser": true,

-"ResponseObject": [

-{

"$id": "2",

"ShipBill": null,

"UNQSHIPTAX": "_41X0YBZJX",

"LINKADD": "_41X0YBRKE",

"CUSTNO": "0000000007",

"ADDRESS1": " ",

"TAXDESC": "SANTA CLARA CNTY. USE TAX",

"TAXTYPE": "S",

"TAX_RATE": 8.25,

"TAX_ID": "CA USE ",

"RECORDTYPE": "S",

"PTPROD": false,

"PTFRT": false,

"STPROD": false,

"STFRT": false,

"STTX": false,

"ModifiedDate": null

},

{

"$id": "3",

"ShipBill": null,

"UNQSHIPTAX": "_41X0YC231",

"LINKADD": "_41X0YBRKE",

"CUSTNO": "0000000007",

"ADDRESS1": " ",

"TAXDESC": "SANTA CLARA CNTY. USE TAX",

"TAXTYPE": "C",

"TAX_RATE": 8.25,

"TAX_ID": "CA USE ",

"RECORDTYPE": "S",

"PTPROD": false,

"PTFRT": false,

"STPROD": false,

"STFRT": false,

"STTX": false,

"ModifiedDate": 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/ShipTaxGet/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'ShipTaxGet'."

}

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

}

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": "ShipTax does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}