|
Tax
An object that represents a tax.
Supported API Calls: List | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique ID representing the Taxobject. When adding a new Tax the value must be 0. |
|
Name |
string (100) |
The name of the tax. |
|
Code |
string (100) |
The tax's customary short form (e.g., VAT) |
List
Description
Returns a list of taxes used by BlueCamroo.
URL
https://{company}.bluecamroo.com/api/tax/list
HTTP Method
GET
Data Return
Returns the list of taxes in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Add
Description
Adds the tax to the list of taxes.
URL
https://{company}.bluecamroo.com/api/tax/add
HTTP Method
POST
Parameters
A tax object
Data Return
Returns the tax object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Update
Description
Updates a tax object.
URL
https://{company}.bluecamroo.com/api/tax/update
HTTP Method
PUT
Parameters
A tax object
Data Return
Returns the tax object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Delete
Description
Deletes the specified tax.
URL
https://{company}.bluecamroo.com/api/tax/delete/{id}
HTTP Method
DELETE
Parameters
None
Data Return
None
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
|