URL |
https://api_host/v1/tax |
Supported Methods |
GET |
Description |
Returns taxes specified for the firm. |
Accepted Query Formats
GET /tax[.format] |
retrieve all Taxes |
GET /tax/1[.format] |
retrieve tax with ID = 1 |
Elements
id |
Unique ID assigned to tax record |
name |
tax name (i.e. GST, VAT) |
tax_type |
The id of the related Tax Type, which can be either Cascading or Value Added |
tax_rates |
A series of related tax rates and their effective dates. |
Examples
Retrieve all taxes in XML format:
$ curl -i --header "VERSACCOUNTS_AUTHORIZATION:409696900e0b3f5a4297e3cd5823f734f0095e66" https://api_host/v1/tax.xml
<?xml version="1.0" encoding="UTF-8"?>
<taxes>
<tax>
<id>361</id>
<name>ON PST @ 8%</name>
<collected>false</collected>
<paid>true</paid>
<tax_type>
<description>Value Added Tax</description>
</tax_type>
<tax_rates>
<tax_rate>
<rate>0.08</rate>
<effective_date>2011-07-01</effective_date>
</tax_rate>
</tax_rates>
</tax>
<tax>
<id>321</id>
<name>GST @ 5%</name>
<collected>true</collected>
<paid>true</paid>
<tax_type>
<description>Value Added Tax</description>
</tax_type>
<tax_rates>
<tax_rate>
<rate>0.05</rate>
<effective_date>2011-07-13</effective_date>
</tax_rate>
</tax_rates>
</tax>
<tax>
<id>316</id>
<name>HST @ 13%</name>
<collected>true</collected>
<paid>true</paid>
<tax_type>
<description>Value Added Tax</description>
</tax_type>
<tax_rates>
<tax_rate>
<rate>0.13</rate>
<effective_date>2010-07-01</effective_date>
</tax_rate>
</tax_rates>
</tax>
<tax>
<id>326</id>
<name>HST @ 15%</name>
<collected>true</collected>
<paid>true</paid>
<tax_type>
<description>Value Added Tax</description>
</tax_type>
<tax_rates>
<tax_rate>
<rate>0.15</rate>
<effective_date>2011-07-22</effective_date>
</tax_rate>
</tax_rates>
</tax>
<tax>
<id>324</id>
<name>HST</name>
<collected>false</collected>
<paid>false</paid>
<tax_type>
<description>Value Added Tax</description>
</tax_type>
<tax_rates>
</tax_rates>
</tax>
</taxes>
Comments and Suggestions
0 comments
Please sign in to leave a comment.
Related articles