Log In Taxes
FreshBooks allows you to store your previously used taxes to re-apply conveniently.
Access Requirements
| Access | Requires Authorization |
| Scopes | user:taxes:readuser:taxes:write |
Includes
There are no includes for taxes.
Filters
| Filter Type | Name | Field | Description |
|---|---|---|---|
| Equals | taxid | taxid | matches exact taxid |
| In | taxids | taxid | matches list of taxids, one specified per query arg |
| Like | name | name | name containing parameter |
| Like | number | number | number containing parameter |
| Bool | compound | compound | true returns compound taxes, false returns non-compound taxes |
| Between | updated_min | updated | updated date greater than or equal to parameter, YYYY-MM-DD format |
| Between | updated_max | updated | updated date less than parameter, YYYY-MM-DD format |
Field Descriptions
underlined fields are required on creation
| Field | Type | Description |
|---|---|---|
| accounting _systemid | string | unique identifier of business tax exists on |
| updated | datetime | date object was last updated, YYYY-MM-DD HH:MM:SS format |
| name | string | identifiable name for your tax, e.g. “GST” |
| number | string | an external number that identifies your tax submission |
| taxid | int | unique identifier of this tax within this business |
| amount | decimal | string-decimal representing percentage value of tax |
| compound | boolean | compound taxes are calculated on top of primary taxes |
| id | int | unique id to look this tax up later |
Get Single Tax
Request: GET "https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes/<id>"
Response:
{
"response": {
"result": {
"tax": {
"accounting_systemid": "zDmNq",
"updated": "2016-07-20 15:28:44",
"name": "PST",
"number": null,
"taxid": 58728,
"amount": "12",
"compound": false,
"id": 58728
}
}
}
}
Create Single Tax
Request: POST "https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes"
{
"tax": {
"name": "some tax"
}
}
Response:
{
"response": {
"result": {
"tax": {
"accounting_systemid": "zDmNq",
"updated": "2016-09-29 22:24:09",
"name": "some tax",
"number": null,
"taxid": 59384,
"amount": "0",
"compound": false,
"id": 59384
}
}
}
}
Update Single Tax
Request: PUT "https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes/<id>"
{
"tax": {
"name": "other tax"
}
}
Response:
{
"response": {
"result": {
"tax": {
"accounting_systemid": "zDmNq",
"updated": "2016-09-29 22:24:09",
"name": "other tax",
"number": null,
"taxid": 59384,
"amount": "0",
"compound": false,
"id": 59384
}
}
}
}
Delete Single Tax
Request: DELETE https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes/<id>
Response:
{
"response": {}
}
List Taxes
Request: GET https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes
Response:
{
"response": {
"result": {
"per_page": 15,
"total": 3,
"page": 1,
"taxes": [
{
// same format as single tax
},
{
// same format as single tax
},
{
// same format as single tax
}
],
"pages": 1
}
}
}
Get Single Tax
Request: GET
"https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes/<id>"
url = "https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes/<id>"
headers = {'Authorization': 'Bearer <Bearer Token>', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
res = requests.get(url, data=None, headers=headers)
Response:
{
"response": {
"result": {
"tax": {
"accounting_systemid": "zDmNq",
"updated": "2016-07-20 15:28:44",
"name": "PST",
"number": null,
"taxid": 58728,
"amount": "12",
"compound": false,
"id": 58728
}
}
}
}
Create Single Tax
Request: POST
"https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes"
url = "https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes"
headers = {'Authorization': 'Bearer <Bearer Token>', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
payload = {
"tax": {
"name": "some tax"
}
}
res = requests.post(url, data=json.dumps(payload), headers=headers)
Response:
{
"response": {
"result": {
"tax": {
"accounting_systemid": "zDmNq",
"updated": "2016-09-29 22:24:09",
"name": "some tax",
"number": null,
"taxid": 59384,
"amount": "0",
"compound": false,
"id": 59384
}
}
}
}
Update Single Tax
Request: PUT
"https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes/<id>"
url = "https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes/<id>"
headers = {'Authorization': 'Bearer <Bearer Token>', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
payload = {
"tax": {
"name": "other tax"
}
}
res = requests.put(url, data=json.dumps(payload), headers=headers)
Response:
{
"response": {
"result": {
"tax": {
"accounting_systemid": "zDmNq",
"updated": "2016-09-29 22:24:09",
"name": "other tax",
"number": null,
"taxid": 59384,
"amount": "0",
"compound": false,
"id": 59384
}
}
}
}
Delete Single Tax
Request: DELETE
https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes/<id>
url = "https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes/<id>"
headers = {'Authorization': 'Bearer <Bearer Token>', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
res = requests.delete(url, data=None, headers=headers)
Response:
{
"response": {}
}
List Taxes
Request: GET
https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes
url = "https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes"
headers = {'Authorization': 'Bearer <Bearer Token>', 'Api-Version': 'alpha', 'Content-Type': 'application/json'}
res = requests.get(url, data=None, headers=headers)
Response:
{
"response": {
"result": {
"per_page": 15,
"total": 3,
"page": 1,
"taxes": [
{
// same format as single tax
},
{
// same format as single tax
},
{
// same format as single tax
}
],
"pages": 1
}
}
}