Tax / Code

(API Version v3)

What can you do with TaxCode?

DELETE api/v3/Tax/Code/{id:int}
GET api/v3/Tax/Code
GET api/v3/Tax/Code/Paged
GET api/v3/Tax/Code/Paged/Detail
GET api/v3/Tax/Code/{id:int}
GET api/v3/Tax/Code/{id:int}/Detail
PATCH api/v3/Tax/Code/{id:int}
POST api/v3/Tax/Code
PUT api/v3/Tax/Code/{id:int}

Properties

Property Details

id	"id": 27 Type: Number This is the unique numeric identifier for the TaxCode
countryId	"countryId": 21 Type: Number Unique identifier for the associated Country object.
stateId	"stateId": 20 Type: Number Unique identifier for the associated State object.
name	"name": "Hello World" Type: String
ownerId	"ownerId": 2 Type: Number Unique identifier for the associated Owner object.
accountTaxCategoryId	"accountTaxCategoryId": 21 Type: Number Unique identifier for the associated AccountTaxCategory object.
serviceTaxCategoryId	"serviceTaxCategoryId": 25 Type: Number Unique identifier for the associated ServiceTaxCategory object.
taxVendorId	"taxVendorId": 10 Type: Number Unique identifier for the associated TaxVendor object.
isReverseVat	"isReverseVat": true Type: Boolean
displayName	"displayName": "Hello World" Type: String
isUsageTaxOnly	"isUsageTaxOnly": true Type: Boolean

Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

countryId
stateId
name
accountTaxCategoryId
serviceTaxCategoryId
taxVendorId
isReverseVat
displayName
isUsageTaxOnly
stateCode
countryCode

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the TaxCode object.

Standard PATCH objects:

taxRate - attach, detach, update
usageClass - attach, detach

DataFlow PATCH objects:

taxCode - create, update, delete
taxRate - attach, detach, update
usageClass - attach, detach

End Points

DELETE	api/v3/Tax/Code/{id:int}
Delete an instance of the TaxCode object.

GET	api/v3/Tax/Code
Retrieve all of the TaxCode objects.

GET	api/v3/Tax/Code/Paged
Retreive all of the TaxCode objects in a paged fashion.

GET	api/v3/Tax/Code/Paged/Detail
Retreive all of the TaxCode objects in a paged fashion with all object details.

GET	api/v3/Tax/Code/{id:int}
Retrieve an instance of the TaxCode object by it's ID.
{id:int}	Unique identifier for the TaxCode object.

GET	api/v3/Tax/Code/{id:int}/Detail
Retreive all of the Detail objects for the specified TaxCode.
{id:int}	Unique identifier for the TaxCode object.

PATCH	api/v3/Tax/Code/{id:int}
Update the TaxCode object and optionally make changes to any child objects.

POST	api/v3/Tax/Code
Create a new instance of the TaxCode object.

PUT	api/v3/Tax/Code/{id:int}
Update an existing instance of the TaxCode object.