Skip to main content
Server path: /taxjar | Type: Application | PCID required: Yes

Tools

ToolDescription
taxjar_calculate_taxCalculate the sales tax for a given order. Requires shipping destination and at least one line item.
taxjar_create_customerCreate a customer with a tax exemption profile.
taxjar_create_order_transactionCreate an order transaction for tax reporting. Records a completed order in TaxJar.
taxjar_create_refund_transactionCreate a refund transaction for tax reporting. Records a completed refund in TaxJar.
taxjar_delete_order_transactionDelete an existing order transaction by transaction ID.
taxjar_delete_refund_transactionDelete an existing refund transaction by transaction ID.
taxjar_list_categoriesList all TaxJar product tax categories. Returns categories with their name, description, and product_tax_code for use in tax calculations.
taxjar_list_customersList customers with tax exemption profiles.
taxjar_list_order_transactionsList order transactions. Optionally filter by date range, provider, or transaction source.
taxjar_list_refund_transactionsList refund transactions. Optionally filter by date range or provider.
taxjar_list_summary_ratesList minimum and average tax rates by region. Returns tax rate summaries for all US states and territories.
taxjar_show_customerShow details of a specific customer and their tax exemption profile.
taxjar_show_order_transactionShow details of a specific order transaction by transaction ID.
taxjar_show_refund_transactionShow details of a specific refund transaction by transaction ID.
taxjar_show_tax_ratesShow tax rates for a specific location by ZIP code. Optionally provide city, state, and country for more accurate results.
taxjar_update_order_transactionUpdate an existing order transaction. All fields are optional except transaction_id.
taxjar_update_refund_transactionUpdate an existing refund transaction. All fields are optional except transaction_id.
taxjar_validate_addressValidate a shipping address. Returns a validated and standardized version of the address.

taxjar_calculate_tax

Calculate the sales tax for a given order. Requires shipping destination and at least one line item. Parameters:
ParameterTypeRequiredDefaultDescription
from_countrystringNoTwo-letter ISO country code of the ship-from address
from_zipstringNoZIP code of the ship-from address
from_statestringNoTwo-letter state code of the ship-from address
from_citystringNoCity of the ship-from address
from_streetstringNoStreet address of the ship-from address
to_countrystringYesTwo-letter ISO country code of the ship-to address
to_zipstringYesZIP code of the ship-to address
to_statestringYesTwo-letter state code of the ship-to address
to_citystringNoCity of the ship-to address
to_streetstringNoStreet address of the ship-to address
amountnumberNoTotal amount of the order (excluding shipping). If line_items are provided, amount may be omitted.
shippingnumberYesTotal shipping cost for the order
customer_idstringNoUnique customer identifier for exemption matching
exemption_typestringNoType of exemption
nexus_addressesobject[]NoArray of nexus address objects with id, country, state, zip
line_itemsobject[]NoArray of line item objects with id, quantity, product_tax_code, unit_price, discount

taxjar_create_customer

Create a customer with a tax exemption profile. Parameters:
ParameterTypeRequiredDefaultDescription
customer_idstringYesUnique identifier for the customer
exemption_typestringYesType of tax exemption
namestringYesCustomer name
exempt_regionsobject[]NoArray of exempt region objects with country and state
countrystringNoTwo-letter ISO country code
statestringNoTwo-letter state code
zipstringNoZIP code
citystringNoCity name
streetstringNoStreet address

taxjar_create_order_transaction

Create an order transaction for tax reporting. Records a completed order in TaxJar. Parameters:
ParameterTypeRequiredDefaultDescription
transaction_idstringYesUnique identifier of the order transaction
transaction_datestringYesDate of the transaction (YYYY-MM-DD or ISO 8601)
from_countrystringNoTwo-letter ISO country code of the ship-from address
from_zipstringNoZIP code of the ship-from address
from_statestringNoTwo-letter state code of the ship-from address
from_citystringNoCity of the ship-from address
from_streetstringNoStreet address of the ship-from address
to_countrystringYesTwo-letter ISO country code of the ship-to address
to_zipstringYesZIP code of the ship-to address
to_statestringYesTwo-letter state code of the ship-to address
to_citystringNoCity of the ship-to address
to_streetstringNoStreet address of the ship-to address
amountnumberYesTotal amount of the order (excluding shipping)
shippingnumberYesTotal shipping cost
sales_taxnumberYesTotal sales tax collected
customer_idstringNoUnique customer identifier
exemption_typestringNoType of exemption
line_itemsobject[]NoArray of line item objects with id, quantity, product_identifier, description, unit_price, discount, sales_tax

taxjar_create_refund_transaction

Create a refund transaction for tax reporting. Records a completed refund in TaxJar. Parameters:
ParameterTypeRequiredDefaultDescription
transaction_idstringYesUnique identifier of the refund transaction
transaction_reference_idstringYesIdentifier of the original order transaction being refunded
transaction_datestringYesDate of the refund transaction (YYYY-MM-DD or ISO 8601)
from_countrystringNoTwo-letter ISO country code of the ship-from address
from_zipstringNoZIP code of the ship-from address
from_statestringNoTwo-letter state code of the ship-from address
from_citystringNoCity of the ship-from address
from_streetstringNoStreet address of the ship-from address
to_countrystringYesTwo-letter ISO country code of the ship-to address
to_zipstringYesZIP code of the ship-to address
to_statestringYesTwo-letter state code of the ship-to address
to_citystringNoCity of the ship-to address
to_streetstringNoStreet address of the ship-to address
amountnumberYesTotal refund amount (excluding shipping, negative values allowed)
shippingnumberYesShipping refund amount
sales_taxnumberYesSales tax refund amount
customer_idstringNoUnique customer identifier
exemption_typestringNoType of exemption
line_itemsobject[]NoArray of line item objects with id, quantity, product_identifier, description, unit_price, discount, sales_tax

taxjar_delete_order_transaction

Delete an existing order transaction by transaction ID. Parameters:
ParameterTypeRequiredDefaultDescription
transaction_idstringYesUnique identifier of the order transaction to delete

taxjar_delete_refund_transaction

Delete an existing refund transaction by transaction ID. Parameters:
ParameterTypeRequiredDefaultDescription
transaction_idstringYesUnique identifier of the refund transaction to delete

taxjar_list_categories

List all TaxJar product tax categories. Returns categories with their name, description, and product_tax_code for use in tax calculations.

taxjar_list_customers

List customers with tax exemption profiles.

taxjar_list_order_transactions

List order transactions. Optionally filter by date range, provider, or transaction source. Parameters:
ParameterTypeRequiredDefaultDescription
transaction_datestringNoFilter by exact transaction date (YYYY-MM-DD)
from_transaction_datestringNoStart of transaction date range (YYYY-MM-DD)
to_transaction_datestringNoEnd of transaction date range (YYYY-MM-DD)
providerstringNoFilter by provider (e.g. api)

taxjar_list_refund_transactions

List refund transactions. Optionally filter by date range or provider. Parameters:
ParameterTypeRequiredDefaultDescription
transaction_datestringNoFilter by exact transaction date (YYYY-MM-DD)
from_transaction_datestringNoStart of transaction date range (YYYY-MM-DD)
to_transaction_datestringNoEnd of transaction date range (YYYY-MM-DD)
providerstringNoFilter by provider (e.g. api)

taxjar_list_summary_rates

List minimum and average tax rates by region. Returns tax rate summaries for all US states and territories.

taxjar_show_customer

Show details of a specific customer and their tax exemption profile. Parameters:
ParameterTypeRequiredDefaultDescription
customer_idstringYesUnique identifier of the customer

taxjar_show_order_transaction

Show details of a specific order transaction by transaction ID. Parameters:
ParameterTypeRequiredDefaultDescription
transaction_idstringYesUnique identifier of the order transaction

taxjar_show_refund_transaction

Show details of a specific refund transaction by transaction ID. Parameters:
ParameterTypeRequiredDefaultDescription
transaction_idstringYesUnique identifier of the refund transaction

taxjar_show_tax_rates

Show tax rates for a specific location by ZIP code. Optionally provide city, state, and country for more accurate results. Parameters:
ParameterTypeRequiredDefaultDescription
zipstringYesZIP code to look up tax rates for
countrystringNoTwo-letter ISO country code (default US)
statestringNoTwo-letter state code
citystringNoCity name for more accurate rates
streetstringNoStreet address for rooftop-level accuracy

taxjar_update_order_transaction

Update an existing order transaction. All fields are optional except transaction_id. Parameters:
ParameterTypeRequiredDefaultDescription
transaction_idstringYesUnique identifier of the order transaction to update
transaction_datestringNoDate of the transaction (YYYY-MM-DD or ISO 8601)
from_countrystringNoTwo-letter ISO country code of the ship-from address
from_zipstringNoZIP code of the ship-from address
from_statestringNoTwo-letter state code of the ship-from address
from_citystringNoCity of the ship-from address
from_streetstringNoStreet address of the ship-from address
to_countrystringNoTwo-letter ISO country code of the ship-to address
to_zipstringNoZIP code of the ship-to address
to_statestringNoTwo-letter state code of the ship-to address
to_citystringNoCity of the ship-to address
to_streetstringNoStreet address of the ship-to address
amountnumberNoTotal amount of the order (excluding shipping)
shippingnumberNoTotal shipping cost
sales_taxnumberNoTotal sales tax collected
customer_idstringNoUnique customer identifier
exemption_typestringNoType of exemption
line_itemsobject[]NoArray of line item objects with id, quantity, product_identifier, description, unit_price, discount, sales_tax

taxjar_update_refund_transaction

Update an existing refund transaction. All fields are optional except transaction_id. Parameters:
ParameterTypeRequiredDefaultDescription
transaction_idstringYesUnique identifier of the refund transaction to update
transaction_reference_idstringNoIdentifier of the original order transaction being refunded
transaction_datestringNoDate of the refund transaction (YYYY-MM-DD or ISO 8601)
from_countrystringNoTwo-letter ISO country code of the ship-from address
from_zipstringNoZIP code of the ship-from address
from_statestringNoTwo-letter state code of the ship-from address
from_citystringNoCity of the ship-from address
from_streetstringNoStreet address of the ship-from address
to_countrystringNoTwo-letter ISO country code of the ship-to address
to_zipstringNoZIP code of the ship-to address
to_statestringNoTwo-letter state code of the ship-to address
to_citystringNoCity of the ship-to address
to_streetstringNoStreet address of the ship-to address
amountnumberNoTotal refund amount (excluding shipping)
shippingnumberNoShipping refund amount
sales_taxnumberNoSales tax refund amount
customer_idstringNoUnique customer identifier
exemption_typestringNoType of exemption
line_itemsobject[]NoArray of line item objects with id, quantity, product_identifier, description, unit_price, discount, sales_tax

taxjar_validate_address

Validate a shipping address. Returns a validated and standardized version of the address. Parameters:
ParameterTypeRequiredDefaultDescription
countrystringYesTwo-letter ISO country code (currently only US supported)
statestringYesTwo-letter state code
zipstringYesZIP code
citystringNoCity name
streetstringNoStreet address