PUT taxclasses/{taxClassId}
Update a Tax Class by ID
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
taxClassId | The ID of the Tax Class to update | integer | Required |
Body Parameters
The Tax Class object
TaxClassBaseModel
Name | Description | Type | Additional information |
---|---|---|---|
Name | The name given to tax class. | string | None. |
TaxRate | The tax rate for instance 17.5 | decimal number | None. |
TaxClassID | The ID for the tax class. | integer | None. |
Request Formats
application/json, text/json
Sample:
{ "Name": "Standard Tax Rate", "TaxRate": 17.5, "TaxClassID": 0 }
application/xml, text/xml
Sample:
<TaxClassBaseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <TaxClassID>0</TaxClassID> <Name>Standard Tax Rate</Name> <TaxRate>17.5</TaxRate> </TaxClassBaseModel>
Response Information
Resource Description
Update a Tax Class by ID
TaxClassResponseName | Description | Type | Additional information |
---|---|---|---|
Success | An indicator of the success of a create, update or delete | boolean | None. |
Error | In the event of a failure, a description of the problem | string | None. |
TaxClassID | The ID for the tax class. | integer | None. |
TaxClassGuid | The GUID for the tax class | globally unique identifier | None. |
CreatedOn | Utc Date of Creation | date | None. |
IsGlobal | This field determines whether the tax class is a custom tax class created on the account. | boolean | None. |
TaxRateCountries | List of all Country modifiers to that Tax Rate | Collection of TaxRateCountryModel | None. |
Name | The name given to tax class. | string | None. |
TaxRate | The tax rate for instance 17.5 | decimal number | None. |
Response Formats
application/json, text/json
Sample:
{ "Success": false, "Error": "An error occurred", "TaxClassID": 1, "TaxClassGuid": "00000000-0000-0000-0000-000000000000", "CreatedOn": "0001-01-01T00:00:00", "IsGlobal": false, "Name": "17.5% Tax", "TaxRate": 17.5 }
application/xml, text/xml
Sample:
<TaxClassResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <TaxClassID>1</TaxClassID> <Name>17.5% Tax</Name> <TaxRate>17.5</TaxRate> <TaxClassGuid>00000000-0000-0000-0000-000000000000</TaxClassGuid> <CreatedOn>0001-01-01T00:00:00</CreatedOn> <IsGlobal>false</IsGlobal> <Success>false</Success> <Error>An error occurred</Error> </TaxClassResponse>