The TaxationRules resource allows taxation rules to be listed and viewed. Here are some examples URIs:
- /TaxationRules – returns list of taxation rules;
- /TaxationRules?isActive=true - returns ACTIVE taxation rules;
- /TaxationRules?name=ABC - returns taxation rules with description starting with ABC
- /TaxationRules?Account=Sales%20Tax - returns taxation rules linked to “Sales Tax” Account
The full range of URIs and HTTP Verbs supported are:
Operation |
HTTP Action |
List taxation rules |
GET /TaxationRules |
Get taxation rule |
GET /TaxationRules/{id} |
These filters can be used with the GET TaxationRules endpoint:
Filter |
Description |
name |
Only return taxation rules with name starts with the specific name |
isActive |
Only return only ACTIVE taxation rules |
Account |
Only return taxation rules linked to specific account |
IsTaxForSale |
Only return taxation rules which are applicable for Sales |
IsTaxForPurchase |
Only return taxation rules which are applicable for Purchase |
Filters are used by adding the filter and value to the URI: /TaxationRules?name=ABC
Available Fields for Taxation rule:
Property |
Type |
Length |
Required |
Notes |
Id |
Guid |
Required for PUT, Ignored for POST operations |
||
Name |
String |
50 |
Yes |
Taxation rule name |
Account |
String |
50 |
Yes |
Account code from chart of accounts with class=LIABILITY |
Type |
String |
50 |
Yes |
Tax type |
IsActive |
Boolean |
Flag indicates if tax rule is ACTIVE |
||
TaxInclusive |
Boolean |
Flag indicates if this tax rule is inclusive |
||
TaxPercent |
Decimal |
Yes |
Effective Taxation Rate |
|
IsTaxForSale |
Boolean |
Flag indicates if tax rule is applicable for Sales |
||
IsTaxForPurchase |
Boolean |
Flag indicates if tax rule is applicable for Purchase |