Sales Tax Summary

GET https://api.freshbooks.com/accounting/account/{{accountId}}/reports/accounting/taxsummary?start_date=2019-01-01&end_date=2019-05-01&currency_code=USD&cash_based=true

Request Params

KeyDatatypeRequiredDescription
start_datestringcreated during or after the given date i.e. 2019-01-01
end_datestringcreated during or before the given date i.e. 2019-05-01
currency_codestringreports using the given currency as primary currency i.e. "USD"
cash_basedbooleanTrue ignores billed payments and uses just collected payments i.e. true, false

RESPONSES

status: OK

{"response":{"result":{"taxsummary":{"cash_based":true,"currency_code":"USD","download_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2NvdW50aWQiOiJ3a01kMmciLCJ1c2VyaWQiOjEsImNvbnRhY3RpZCI6LTEsImxldmVsIjozLCJ0eXBlIjoicmVwb3J0Iiwib2JqZWN0aWQiOiJ0YXhzdW1tYXJ5IiwicGFyYW1zIjp7InN0YXJ0X2RhdGUiOiIyMDE5LTAxLTAxIiwiZW5kX2RhdGUiOiIyMDE5LTA1LTAxIiwiY3VycmVuY3lfY29kZSI6IlVTRCIsImNhc2hfYmFzZWQiOnRydWV9LCJpYXQiOjE1NTYxMzA2MTksImV4cCI6MTU1ODcyMjYxOX0.7Ewyvilpqg_TzcPjGm70jfkLZhg-jAm6N0i5QJICrl8","end_date":"2019-05-01","start_date":"2019-01-01","taxes":[{"net_tax":{"amount":"-659.42","code":"USD"},"net_taxable_amount":{"amount":"-4815.57","code":"USD"},"tax_collected":{"amount":"146.00","code":"USD"},"tax_name":"HST","tax_paid":{"amount":"805.42","code":"USD"},"taxable_amount_collected":{"amount":"1380.00","code":"USD"},"taxable_amount_paid":{"amount":"6195.57","code":"USD"}},{"net_tax":{"amount":"-18.34","code":"USD"},"net_taxable_amount":{"amount":"-141.12","code":"USD"},"tax_collected":{"amount":"0.00","code":"USD"},"tax_name":"other tax","tax_paid":{"amount":"18.34","code":"USD"},"taxable_amount_collected":{"amount":"0.00","code":"USD"},"taxable_amount_paid":{"amount":"141.12","code":"USD"}}],"total_invoiced":{"amount":"9891.00","code":"USD"}}}}}