Taxjar integration: operations for AI agents
Taxjar connects to Type.com as an integration. This page lists the 21 operations documented for Claude and Codex in Type.com: 12 read, 6 write, 3 destructive.
About Taxjar
TaxJar provides a comprehensive sales tax API for real-time tax calculations, reporting, and filing.
Categories: Finance & Accounting
How to connect Taxjar to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
21 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
21 operations listed.
categories
- Read
List tax categories
Lists all tax categories. GET https://api.taxjar.com/v2/categories Returns a categories JSON object with an array of product categories and corresponding tax codes. The following categories are currently supported: Documented Category: Code: Countries: Description: . Documented Parameter: Type: Description: product_tax_code: string: Tax code of the given product category.; name: string: Name of the given product category.; description: string: Description of the given product category.. Documented JSON request/response-example field names (examples, not additional required schemas): categories, categories[].name, categories[].product_tax_code, categories[].description.
GET /v2/categories
taxes
- Read
Calculate sales tax for an order
Shows the sales tax that should be collected for a given order. POST https://api.taxjar.com/v2/taxes Either amount or line_items parameters are required to perform tax calculations. The to_zip parameter is required when to_country is ‘US’. The to_state parameter is required when to_country is ‘US’ or ‘CA’. Either an address on file, nexus_addresses parameter, or from_ parameters are required to perform tax calculations. Providing nexus_addresses in API calls will override TaxJar Account ‘State Settings’ configurations. Returns a tax JSON object with sales tax for a given order. If available, returns a breakdown of rates by jurisdiction at the order, shipping, and line item level. Documented Parameter: Type: Required: Description: from_country: string: optional: Two-letter ISO country code of the country where the order shipped from. View Note; from_zip: string: optional: Postal code where the order shipped from (5-Digit ZIP or ZIP+4).; from_state: string: optional: Two-letter ISO state code where the order shipped from.; from_city: string: optional: City where the order shipped from.; from_street: string: optional: Street address where the order shipped from.; to_country: string: required: Two-letter ISO country code of the country where the order shipped to.; to_zip: string: required: Postal code where the order shipped to (5-Digit ZIP or ZIP+4).; to_state: string: required: Two-letter ISO state code where the order shipped to.; to_city: string: optional: City where the order shipped to.; to_street: string: optional: Street address where the order shipped to. View Note; amount: float: optional: Total amount of the order, excluding shipping . View Note; shipping: float: required: Total amount of shipping for the order.; customer_id: string: optional: Unique identifier of the given customer for exemptions.; exemption_type: string: optional: Type of exemption for the order: wholesale , government , marketplace , other , or non_exempt . View Note; nexus_addresses[][id]: string: optional: Unique identifier of the given nexus address. View Note; nexus_addresses[][country]: string: conditional: Two-letter ISO country code for the nexus address.; nexus_addresses[][zip]: string: optional: Postal code for the nexus address.; nexus_addresses[][state]: string: conditional: Two-letter ISO state code for the nexus address.; nexus_addresses[][city]: string: optional: City for the nexus address.; nexus_addresses[][street]: string: optional: Street address for the nexus address.; line_items[][id]: string: optional: Unique identifier of the given line item. View Note; line_items[][quantity]: integer: optional: Quantity for the item.; line_items[][product_tax_code]: string: optional: Product tax code for the item. If omitted, the item will remain fully taxable.; line_items[][unit_price]: float: optional: Unit price for the item.; line_items[][discount]: float: optional: Total discount (non-unit) for the item.. Documented Parameter: Type: Description: order_total_amount: float: Total amount of the order.; shipping: float: Total amount of shipping for the order.; taxable_amount: float: Amount of the order to be taxed.; amount_to_collect: float: Amount of sales tax to collect.; rate: float: Overall sales tax rate of the order ( amount_to_collect ÷ taxable_amount ).; has_nexus: bool: Whether or not you have nexus for the order based on an address on file, nexus_addresses parameter, or from_ parameters.; freight_taxable: bool: Freight taxability for the order.; tax_source: string: Origin-based or destination-based sales tax collection.; exemption_type: string: Type of exemption for the order: wholesale , government , marketplace , other , or non_exempt . If no customer_id or exemption_type is provided, no exemption_type is returned in the response.; jurisdictions: object: Jurisdiction names for the order.; breakdown: object: Breakdown of rates by jurisdiction for the order, shipping, and individual line items. If has_nexus is false or no line items are provided, no breakdown is returned in the response.. Documented Parameter: Type: Description: country: string: Two-letter ISO country code for given location.; state: string: Postal abbreviated state name for given location.; county: string: County name for given location.; city: string: City name for given location.. Documented Parameter: Type: Description: taxable_amount: float: Total amount of the order to be taxed.; tax_collectable: float: Total amount of sales tax to collect.; combined_tax_rate: float: Overall sales tax rate of the breakdown which includes state, county, city and district tax for the order and shipping if applicable.; state_taxable_amount: float: Amount of the order to be taxed at the state tax rate.; state_tax_rate: float: State sales tax rate for given location.; state_tax_collectable: float: Amount of sales tax to collect for the state.; county_taxable_amount: float: Amount of the order to be taxed at the county tax rate.; county_tax_rate: float: County sales tax rate for given location.; county_tax_collectable: float: Amount of sales tax to collect for the county.; city_taxable_amount: float: Amount of the order to be taxed at the city tax rate.; city_tax_rate: float: City sales tax rate for given location.; city_tax_collectable: float: Amount of sales tax to collect for the city.; special_district_taxable_amount: float: Amount of the order to be taxed at the special district tax rate.; special_tax_rate: float: Special district sales tax rate for given location.; special_district_tax_collectable: float: Amount of sales tax to collect for the special district.; shipping: object: Breakdown of shipping rates if applicable.; line_items: object: Breakdown of rates by line item if applicable.. Documented JSON request/response-example field names (examples, not additional required schemas): tax, tax.order_total_amount, tax.shipping, tax.taxable_amount, tax.amount_to_collect, tax.rate, tax.has_nexus, tax.freight_taxable, tax.tax_source, tax.jurisdictions, tax.jurisdictions.country, tax.jurisdictions.state, tax.jurisdictions.county, tax.jurisdictions.city, tax.breakdown, tax.breakdown.taxable_amount, tax.breakdown.tax_collectable, tax.breakdown.combined_tax_rate, tax.breakdown.state_taxable_amount, tax.breakdown.state_tax_rate, tax.breakdown.state_tax_collectable, tax.breakdown.county_taxable_amount, tax.breakdown.county_tax_rate, tax.breakdown.county_tax_collectable, tax.breakdown.city_taxable_amount, tax.breakdown.city_tax_rate, tax.breakdown.city_tax_collectable, tax.breakdown.special_district_taxable_amount, tax.breakdown.special_tax_rate, tax.breakdown.special_district_tax_collectable, tax.breakdown.line_items, tax.breakdown.line_items[].id, tax.breakdown.line_items[].taxable_amount, tax.breakdown.line_items[].tax_collectable, tax.breakdown.line_items[].combined_tax_rate, tax.breakdown.line_items[].state_taxable_amount, tax.breakdown.line_items[].state_sales_tax_rate, tax.breakdown.line_items[].state_amount, tax.breakdown.line_items[].county_taxable_amount, tax.breakdown.line_items[].county_tax_rate, tax.breakdown.line_items[].county_amount, tax.breakdown.line_items[].city_taxable_amount, tax.breakdown.line_items[].city_tax_rate, tax.breakdown.line_items[].city_amount, tax.breakdown.line_items[].special_district_taxable_amount, tax.breakdown.line_items[].special_tax_rate, tax.breakdown.line_items[].special_district_amount, tax.breakdown.shipping, tax.breakdown.shipping.city_amount, tax.breakdown.shipping.city_tax_rate, tax.breakdown.shipping.city_taxable_amount, tax.breakdown.shipping.combined_tax_rate, tax.breakdown.shipping.county_amount, tax.breakdown.shipping.county_tax_rate, tax.breakdown.shipping.county_taxable_amount, tax.breakdown.shipping.special_district_amount, tax.breakdown.shipping.special_tax_rate, tax.breakdown.shipping.special_taxable_amount, tax.breakdown.shipping.state_amount, tax.breakdown.shipping.state_sales_tax_rate, tax.breakdown.shipping.state_taxable_amount, tax.breakdown.shipping.tax_collectable, tax.breakdown.shipping.taxable_amount.
POST /v2/taxes
transactions
- Read
List order transactions
Lists existing order transactions created through the API. GET https://api.taxjar.com/v2/transactions/orders Use transaction_date to list transactions for a specific date. Otherwise, use from_transaction_date and to_transaction_date for a range of dates. Returns an orders JSON object with an array of order IDs created through the API. Documented Parameter: Type: Required: Description: transaction_date: date: optional: The date the transactions were originally recorded. View Note; from_transaction_date: date: optional: Start date of a range for which the transactions were originally recorded.; to_transaction_date: date: optional: End date of a range for which the transactions were originally recorded.; provider: string: optional: Source of where the transactions were originally recorded. Defaults to “api”.. Documented JSON request/response-example field names (examples, not additional required schemas): orders.
GET /v2/transactions/orders - Read
Show an order transaction
Shows an existing order transaction created through the API. GET https://api.taxjar.com/v2/transactions/orders/:transaction_id Returns an order JSON object with details of a given order transaction created through the API. Documented Parameter: Type: Required: Description: transaction_id: string: required: Unique identifier of the given order transaction.; provider: string: optional: Source of where the transaction was originally recorded. Defaults to “api”, if omitted will scope to a provider of “api”. When looking up a transaction for a different provider, add “?provider=XYZ” to your request.. Documented Parameter: Type: Description: transaction_id: string: Unique identifier of the given order transaction.; user_id: integer: Unique identifier of the user who created the order transaction.; transaction_date: datetime: The date/time the transaction was originally recorded.; provider: string: Source of where the transaction was originally recorded.; exemption_type: string: Type of exemption for the order: wholesale , government , marketplace , other , non_exempt , or null . View Note; from_country: string: Two-letter ISO country code of the country where the order shipped from.; from_zip: string: Postal code where the order shipped from (5-Digit ZIP or ZIP+4).; from_state: string: Two-letter ISO state code where the order shipped from.; from_city: string: City where the order shipped from.; from_street: string: Street address where the order shipped from.; to_country: string: Two-letter ISO country code of the country where the order shipped to.; to_zip: string: Postal code where the order shipped to (5-Digit ZIP or ZIP+4).; to_state: string: Two-letter ISO state code where the order shipped to.; to_city: string: City where the order shipped to.; to_street: string: Street address where the order shipped to.; amount: float: Total amount of the order with shipping, excluding sales tax .; shipping: float: Total amount of shipping for the order.; sales_tax: float: Total amount of sales tax collected for the order.; line_items[][id]: string: Unique identifier of the given line item.; line_items[][quantity]: integer: Quantity for the item.; line_items[][product_identifier]: string: Product identifier for the item.; line_items[][description]: string: Description of the line item (up to 255 characters).; line_items[][product_tax_code]: string: Product tax code for the item.; line_items[][unit_price]: float: Unit price for the item in dollars.; line_items[][discount]: float: Total discount (non-unit) for the item in dollars.; line_items[][sales_tax]: float: Total sales tax collected (non-unit) for the item in dollars.. Documented JSON request/response-example field names (examples, not additional required schemas): order, order.transaction_id, order.user_id, order.transaction_date, order.provider, order.to_country, order.to_zip, order.to_state, order.to_city, order.to_street, order.amount, order.shipping, order.sales_tax, order.line_items, order.line_items[].id, order.line_items[].quantity, order.line_items[].product_identifier, order.line_items[].description, order.line_items[].unit_price, order.line_items[].discount, order.line_items[].sales_tax.
GET /v2/transactions/orders/{transaction_id} - Read
List refund transactions
Lists existing refund transactions created through the API. GET https://api.taxjar.com/v2/transactions/refunds Use transaction_date to list transactions for a specific date. Otherwise, use from_transaction_date and to_transaction_date for a range of dates. Returns a refunds JSON object with an array of refund IDs created through the API. Documented Parameter: Type: Required: Description: transaction_date: date: optional: The date the transactions were originally recorded. View Note; from_transaction_date: date: optional: The start date of a range for which the transactions were originally recorded.; to_transaction_date: date: optional: The end date of a range for which the transactions were originally recorded.; provider: string: optional: Source of where the transactions were originally recorded. Defaults to “api”.. Documented JSON request/response-example field names (examples, not additional required schemas): refunds.
GET /v2/transactions/refunds - Read
Show a refund transaction
Shows an existing refund transaction created through the API. GET https://api.taxjar.com/v2/transactions/refunds/:transaction_id Returns a refund JSON object with details of a given refund transaction created through the API. Documented Parameter: Type: Required: Description: transaction_id: string: required: Unique identifier of the given refund transaction.; provider: string: optional: Source of where the transaction was originally recorded. Defaults to “api”.. Documented Parameter: Type: Description: transaction_id: string: Unique identifier of the given refund transaction.; user_id: integer: Unique identifier of the user who created the refund transaction.; transaction_date: datetime: The date/time the transaction was originally recorded.; provider: string: Source of where the transaction was originally recorded.; exemption_type: string: Type of exemption for the order: wholesale , government , marketplace , other , non_exempt , or null . View Note; from_country: string: Two-letter ISO country code of the country where the order shipped from.; from_zip: string: Postal code where the order shipped from (5-Digit ZIP or ZIP+4).; from_state: string: Two-letter ISO state code where the order shipped from.; from_city: string: City where the order shipped from.; from_street: string: Street address where the order shipped from.; to_country: string: Two-letter ISO country code of the country where the order shipped to.; to_zip: string: Postal code where the order shipped to (5-Digit ZIP or ZIP+4).; to_state: string: Two-letter ISO state code where the order shipped to.; to_city: string: City where the order shipped to.; to_street: string: Street address where the order shipped to.; amount: float: Total amount of the refunded order with shipping, excluding sales tax .; shipping: float: Total amount of shipping for the refunded order.; sales_tax: float: Total amount of sales tax collected for the refunded order.; line_items[][id]: string: Unique identifier of the given line item.; line_items[][quantity]: integer: Quantity for the item.; line_items[][product_identifier]: string: Product identifier for the item.; line_items[][description]: string: Description of the line item (up to 255 characters).; line_items[][product_tax_code]: string: Product tax code for the item.; line_items[][unit_price]: float: Unit price for the item in dollars.; line_items[][discount]: float: Total discount (non-unit) for the item in dollars.; line_items[][sales_tax]: float: Total sales tax collected (non-unit) for the item in dollars.. Documented JSON request/response-example field names (examples, not additional required schemas): refund, refund.transaction_id, refund.user_id, refund.transaction_date, refund.transaction_reference_id, refund.provider, refund.to_country, refund.to_zip, refund.to_state, refund.to_city, refund.to_street, refund.amount, refund.shipping, refund.sales_tax, refund.line_items, refund.line_items[].id, refund.line_items[].quantity, refund.line_items[].product_identifier, refund.line_items[].description, refund.line_items[].unit_price, refund.line_items[].discount, refund.line_items[].sales_tax.
GET /v2/transactions/refunds/{transaction_id} - Write
Create an order transaction
Creates a new order transaction. POST https://api.taxjar.com/v2/transactions/orders Either an address on file or from_ parameters are required to create order transactions. The transaction_id should only include alphanumeric characters, underscores, and dashes. The transaction_date may be a date ‘2015-05-25’, an ISO UTC date/time ‘2015-05-25T13:05:45’, or an ISO date/time with zone offset ‘2015-05-25T13:05:45-05:00’. We recommend passing positive values for monetary amounts when creating or updating order transactions. Values will be signed automatically regardless of what you send in. Do not update existing orders with negative amounts to indicate a refund. Instead, create a refund transaction . Returns an order JSON object with details of the new order transaction. Documented Parameter: Type: Required: Description: transaction_id: string: required: Unique identifier of the given order transaction. View Note; transaction_date: datetime: required: The date/time the transaction was originally recorded. View Note; provider: string: optional: Source of where the transaction was originally recorded. Defaults to “api”. View Note; from_country: string: optional: Two-letter ISO country code of the country where the order shipped from. View Note; from_zip: string: optional: Postal code where the order shipped from (5-Digit ZIP or ZIP+4).; from_state: string: optional: Two-letter ISO state code where the order shipped from.; from_city: string: optional: City where the order shipped from.; from_street: string: optional: Street address where the order shipped from.; to_country: string: required: Two-letter ISO country code of the country where the order shipped to.; to_zip: string: required: Postal code where the order shipped to (5-Digit ZIP or ZIP+4).; to_state: string: required: Two-letter ISO state code where the order shipped to.; to_city: string: optional: City where the order shipped to.; to_street: string: optional: Street address where the order shipped to.; amount: float: required: Total amount of the order with shipping, excluding sales tax in dollars.; shipping: float: required: Total amount of shipping for the order in dollars.; sales_tax: float: required: Total amount of sales tax collected for the order in dollars.; customer_id: string: optional: Unique identifier of the given customer for exemptions.; exemption_type: string: optional: Type of exemption for the order: wholesale , government , marketplace , other , or non_exempt . View Note; line_items[][id]: string: optional: Unique identifier of the given line item.; line_items[][quantity]: integer: optional: Quantity for the item.; line_items[][product_identifier]: string: optional: Product identifier for the item.; line_items[][description]: string: optional: Description of the line item (up to 255 characters).; line_items[][product_tax_code]: string: optional: Product tax code for the item. If omitted, the item will remain fully taxable. View Note; line_items[][unit_price]: float: optional: Unit price for the item in dollars.; line_items[][discount]: float: optional: Total discount (non-unit) for the item in dollars.; line_items[][sales_tax]: float: conditional: Total sales tax collected (non-unit) for the item in dollars.. Documented Parameter: Type: Description: transaction_id: string: Unique identifier of the given order transaction.; user_id: integer: Unique identifier of the user who created the order transaction.; transaction_date: datetime: The date/time the transaction was originally recorded.; provider: string: Source of where the transaction was originally recorded.; exemption_type: string: Type of exemption for the order: wholesale , government , marketplace , other , non_exempt , or null . View Note; from_country: string: Two-letter ISO country code of the country where the order shipped from.; from_zip: string: Postal code where the order shipped from (5-Digit ZIP or ZIP+4).; from_state: string: Two-letter ISO state code where the order shipped from.; from_city: string: City where the order shipped from.; from_street: string: Street address where the order shipped from.; to_country: string: Two-letter ISO country code of the country where the order shipped to.; to_zip: string: Postal code where the order shipped to (5-Digit ZIP or ZIP+4).; to_state: string: Two-letter ISO state code where the order shipped to.; to_city: string: City where the order shipped to.; to_street: string: Street address where the order shipped to.; amount: float: Total amount of the order with shipping, excluding sales tax .; shipping: float: Total amount of shipping for the order.; sales_tax: float: Total amount of sales tax collected for the order.; line_items[][id]: string: Unique identifier of the given line item.; line_items[][quantity]: integer: Quantity for the item.; line_items[][product_identifier]: string: Product identifier for the item.; line_items[][description]: string: Description of the line item (up to 255 characters).; line_items[][product_tax_code]: string: Product tax code for the item.; line_items[][unit_price]: float: Unit price for the item in dollars.; line_items[][discount]: float: Total discount (non-unit) for the item in dollars.; line_items[][sales_tax]: float: Total sales tax collected (non-unit) for the item in dollars.. Documented JSON request/response-example field names (examples, not additional required schemas): order, order.transaction_id, order.user_id, order.transaction_date, order.provider, order.to_country, order.to_zip, order.to_state, order.to_city, order.to_street, order.amount, order.shipping, order.sales_tax, order.line_items, order.line_items[].id, order.line_items[].quantity, order.line_items[].product_identifier, order.line_items[].description, order.line_items[].unit_price, order.line_items[].discount, order.line_items[].sales_tax.
POST /v2/transactions/orders - Write
Update an order transaction
Updates an existing order transaction created through the API. PUT https://api.taxjar.com/v2/transactions/orders/:transaction_id Either an address on file or from_ parameters are required to update order transactions. The transaction_date may be a date ‘2015-05-25’, an ISO UTC date/time ‘2015-05-25T13:05:45’, or an ISO date/time with zone offset ‘2015-05-25T13:05:45-05:00’. Returns an order JSON object with details of the updated order transaction. Documented Parameter: Type: Required: Description: transaction_id: string: required: Unique identifier of the given order transaction.; transaction_date: datetime: optional: The date/time the transaction was originally recorded. View Note; from_country: string: optional: Two-letter ISO country code of the country where the order shipped from. View Note; from_zip: string: optional: Postal code where the order shipped from (5-Digit ZIP or ZIP+4).; from_state: string: optional: Two-letter ISO state code where the order shipped from.; from_city: string: optional: City where the order shipped from.; from_street: string: optional: Street address where the order shipped from.; to_country: string: optional: Two-letter ISO country code of the country where the order shipped to.; to_zip: string: optional: Postal code where the order shipped to (5-Digit ZIP or ZIP+4).; to_state: string: optional: Two-letter ISO state code where the order shipped to.; to_city: string: optional: City where the order shipped to.; to_street: string: optional: Street address where the order shipped to.; amount: float: optional: Total amount of the order with shipping, excluding sales tax in dollars.; shipping: float: optional: Total amount of shipping for the order in dollars.; sales_tax: float: optional: Total amount of sales tax collected for the order in dollars.; customer_id: string: optional: Unique identifier of the given customer for exemptions.; exemption_type: string: optional: Type of exemption for the order: wholesale , government , marketplace , other , or non_exempt . View Note; line_items[][id]: string: optional: Unique identifier of the given line item.; line_items[][quantity]: integer: optional: Quantity for the item.; line_items[][product_identifier]: string: optional: Product identifier for the item.; line_items[][description]: string: optional: Description of the line item (up to 255 characters).; line_items[][product_tax_code]: string: optional: Product tax code for the item. If omitted, the item will remain fully taxable. View Note; line_items[][unit_price]: float: optional: Unit price for the item in dollars.; line_items[][discount]: float: optional: Total discount (non-unit) for the item in dollars.; line_items[][sales_tax]: float: optional: Total sales tax collected (non-unit) for the item in dollars.. Documented Parameter: Type: Description: transaction_id: string: Unique identifier of the given order transaction.; user_id: integer: Unique identifier of the user who created the order transaction.; transaction_date: datetime: The date/time the transaction was originally recorded.; provider: string: Source of where the transaction was originally recorded.; exemption_type: string: Type of exemption for the order: wholesale , government , marketplace , other , non_exempt , or null . View Note; from_country: string: Two-letter ISO country code of the country where the order shipped from.; from_zip: string: Postal code where the order shipped from (5-Digit ZIP or ZIP+4).; from_state: string: Two-letter ISO state code where the order shipped from.; from_city: string: City where the order shipped from.; from_street: string: Street address where the order shipped from.; to_country: string: Two-letter ISO country code of the country where the order shipped to.; to_zip: string: Postal code where the order shipped to (5-Digit ZIP or ZIP+4).; to_state: string: Two-letter ISO state code where the order shipped to.; to_city: string: City where the order shipped to.; to_street: string: Street address where the order shipped to.; amount: float: Total amount of the order with shipping, excluding sales tax .; shipping: float: Total amount of shipping for the order.; sales_tax: float: Total amount of sales tax collected for the order.; line_items[][id]: string: Unique identifier of the given line item.; line_items[][quantity]: integer: Quantity for the item.; line_items[][product_identifier]: string: Product identifier for the item.; line_items[][description]: string: Description of the line item (up to 255 characters).; line_items[][product_tax_code]: string: Product tax code for the item.; line_items[][unit_price]: float: Unit price for the item in dollars.; line_items[][discount]: float: Total discount (non-unit) for the item in dollars.; line_items[][sales_tax]: float: Total sales tax collected (non-unit) for the item in dollars.. Documented JSON request/response-example field names (examples, not additional required schemas): order, order.transaction_id, order.user_id, order.transaction_date, order.provider, order.to_country, order.to_zip, order.to_state, order.to_city, order.to_street, order.amount, order.shipping, order.sales_tax, order.line_items, order.line_items[].id, order.line_items[].quantity, order.line_items[].product_identifier, order.line_items[].description, order.line_items[].unit_price, order.line_items[].discount, order.line_items[].sales_tax.
PUT /v2/transactions/orders/{transaction_id} - Write
Create a refund transaction
Creates a new refund transaction. POST https://api.taxjar.com/v2/transactions/refunds Either an address on file or from_ parameters are required to create refund transactions. The transaction_id should only include alphanumeric characters, underscores, and dashes. The transaction_date may be a date ‘2015-05-25’, an ISO UTC date/time ‘2015-05-25T13:05:45’, or an ISO date/time with zone offset ‘2015-05-25T13:05:45-05:00’. We recommend passing negative values for monetary amounts when creating or updating refund transactions. Values will be signed automatically regardless of what you send in. Returns a refund JSON object with details of the new refund transaction. Documented Parameter: Type: Required: Description: transaction_id: string: required: Unique identifier of the given refund transaction. View Note; transaction_reference_id: string: required: Unique identifier of the corresponding order transaction for the refund.; transaction_date: datetime: required: The date/time the transaction was originally recorded. View Note; provider: string: optional: Source of where the transaction was originally recorded. Defaults to “api”. View Note; from_country: string: optional: Two-letter ISO country code of the country where the order shipped from. View Note; from_zip: string: optional: Postal code where the order shipped from (5-Digit ZIP or ZIP+4).; from_state: string: optional: Two-letter ISO state code where the order shipped from.; from_city: string: optional: City where the order shipped from.; from_street: string: optional: Street address where the order shipped from.; to_country: string: required: Two-letter ISO country code of the country where the order shipped to.; to_zip: string: required: Postal code where the order shipped to (5-Digit ZIP or ZIP+4).; to_state: string: required: Two-letter ISO state code where the order shipped to.; to_city: string: optional: City where the order shipped to.; to_street: string: optional: Street address where the order shipped to.; amount: float: required: Total amount of the refunded order with shipping, excluding sales tax in dollars.; shipping: float: required: Total amount of shipping for the refunded order in dollars.; sales_tax: float: required: Total amount of sales tax collected for the refunded order in dollars.; customer_id: string: optional: Unique identifier of the given customer for exemptions.; exemption_type: string: optional: Type of exemption for the order: wholesale , government , marketplace , other , or non_exempt . View Note; line_items[][id]: string: optional: Unique identifier of the given line item.; line_items[][quantity]: integer: optional: Quantity for the item.; line_items[][product_identifier]: string: optional: Product identifier for the item.; line_items[][description]: string: optional: Description of the line item (up to 255 characters).; line_items[][product_tax_code]: string: optional: Product tax code for the item. If omitted, the item will remain fully taxable. View Note; line_items[][unit_price]: float: optional: Unit price for the item in dollars.; line_items[][discount]: float: optional: Total discount (non-unit) for the item in dollars.; line_items[][sales_tax]: float: conditional: Total sales tax collected (non-unit) for the item in dollars.. Documented Parameter: Type: Description: transaction_id: string: Unique identifier of the given refund transaction.; user_id: integer: Unique identifier of the user who created the refund transaction.; transaction_date: datetime: The date/time the transaction was originally recorded.; provider: string: Source of where the transaction was originally recorded.; exemption_type: string: Type of exemption for the order: wholesale , government , marketplace , other , non_exempt , or null . View Note; from_country: string: Two-letter ISO country code of the country where the order shipped from.; from_zip: string: Postal code where the order shipped from (5-Digit ZIP or ZIP+4).; from_state: string: Two-letter ISO state code where the order shipped from.; from_city: string: City where the order shipped from.; from_street: string: Street address where the order shipped from.; to_country: string: Two-letter ISO country code of the country where the order shipped to.; to_zip: string: Postal code where the order shipped to (5-Digit ZIP or ZIP+4).; to_state: string: Two-letter ISO state code where the order shipped to.; to_city: string: City where the order shipped to.; to_street: string: Street address where the order shipped to.; amount: float: Total amount of the refunded order with shipping, excluding sales tax .; shipping: float: Total amount of shipping for the refunded order.; sales_tax: float: Total amount of sales tax collected for the refunded order.; line_items[][id]: string: Unique identifier of the given line item.; line_items[][quantity]: integer: Quantity for the item.; line_items[][product_identifier]: string: Product identifier for the item.; line_items[][description]: string: Description of the line item (up to 255 characters).; line_items[][product_tax_code]: string: Product tax code for the item.; line_items[][unit_price]: float: Unit price for the item in dollars.; line_items[][discount]: float: Total discount (non-unit) for the item in dollars.; line_items[][sales_tax]: float: Total sales tax collected (non-unit) for the item in dollars.. Documented JSON request/response-example field names (examples, not additional required schemas): refund, refund.transaction_id, refund.user_id, refund.transaction_date, refund.transaction_reference_id, refund.provider, refund.to_country, refund.to_zip, refund.to_state, refund.to_city, refund.to_street, refund.amount, refund.shipping, refund.sales_tax, refund.line_items, refund.line_items[].id, refund.line_items[].quantity, refund.line_items[].product_identifier, refund.line_items[].description, refund.line_items[].unit_price, refund.line_items[].discount, refund.line_items[].sales_tax.
POST /v2/transactions/refunds - Write
Update a refund transaction
Updates an existing refund transaction created through the API. PUT https://api.taxjar.com/v2/transactions/refunds/:transaction_id Either an address on file or from_ parameters are required to update refund transactions. The transaction_date may be a date ‘2015-05-25’, an ISO UTC date/time ‘2015-05-25T13:05:45’, or an ISO date/time with zone offset ‘2015-05-25T13:05:45-05:00’. Returns a refund JSON object with details of the updated refund transaction. Documented Parameter: Type: Required: Description: transaction_id: string: required: Unique identifier of the given transaction.; transaction_reference_id: string: required: Unique identifier of the corresponding order transaction for the refund.; transaction_date: datetime: optional: The date/time the transaction was originally recorded.; from_country: string: optional: Two-letter ISO country code of the country where the order shipped from. View Note; from_zip: string: optional: Postal code where the order shipped from (5-Digit ZIP or ZIP+4).; from_state: string: optional: Two-letter ISO state code where the order shipped from.; from_city: string: optional: City where the order shipped from.; from_street: string: optional: Street address where the order shipped from.; to_country: string: optional: Two-letter ISO country code of the country where the refunded order shipped to.; to_zip: string: optional: Postal code where the refunded order shipped to (5-Digit ZIP or ZIP+4).; to_state: string: optional: Two-letter ISO state code where the refunded order shipped to.; to_city: string: optional: City where the refunded order shipped to.; to_street: string: optional: Street address where the refunded order shipped to.; amount: float: optional: Total amount of the refunded order with shipping, excluding sales tax in dollars.; shipping: float: optional: Total amount of shipping for the refunded order in dollars.; sales_tax: float: optional: Total amount of sales tax collected for the refunded order in dollars.; customer_id: string: optional: Unique identifier of the given customer for exemptions.; exemption_type: string: optional: Type of exemption for the order: wholesale , government , marketplace , other , or non_exempt . View Note; line_items[][id]: string: optional: Unique identifier of the given line item.; line_items[][quantity]: integer: optional: Quantity for the item.; line_items[][product_identifier]: string: optional: Product identifier for the item.; line_items[][description]: string: optional: Description of the line item (up to 255 characters).; line_items[][product_tax_code]: string: optional: Product tax code for the item. If omitted, the item will remain fully taxable. View Note; line_items[][unit_price]: float: optional: Unit price for the item in dollars.; line_items[][discount]: float: optional: Total discount (non-unit) for the item in dollars.; line_items[][sales_tax]: float: optional: Total sales tax collected (non-unit) for the item in dollars.. Documented Parameter: Type: Description: transaction_id: string: Unique identifier of the given refund transaction.; user_id: integer: Unique identifier of the user who created the refund transaction.; transaction_date: datetime: The date/time the transaction was originally recorded.; provider: string: Source of where the transaction was originally recorded.; exemption_type: string: Type of exemption for the order: wholesale , government , marketplace , other , non_exempt , or null . View Note; from_country: string: Two-letter ISO country code of the country where the order shipped from.; from_zip: string: Postal code where the order shipped from (5-Digit ZIP or ZIP+4).; from_state: string: Two-letter ISO state code where the order shipped from.; from_city: string: City where the order shipped from.; from_street: string: Street address where the order shipped from.; to_country: string: Two-letter ISO country code of the country where the order shipped to.; to_zip: string: Postal code where the order shipped to (5-Digit ZIP or ZIP+4).; to_state: string: Two-letter ISO state code where the order shipped to.; to_city: string: City where the order shipped to.; to_street: string: Street address where the order shipped to.; amount: float: Total amount of the refunded order with shipping, excluding sales tax .; shipping: float: Total amount of shipping for the refunded order.; sales_tax: float: Total amount of sales tax collected for the refunded order.; line_items[][id]: string: Unique identifier of the given line item.; line_items[][quantity]: integer: Quantity for the item.; line_items[][product_identifier]: string: Product identifier for the item.; line_items[][description]: string: Description of the line item (up to 255 characters).; line_items[][product_tax_code]: string: Product tax code for the item.; line_items[][unit_price]: float: Unit price for the item in dollars.; line_items[][discount]: float: Total discount (non-unit) for the item in dollars.; line_items[][sales_tax]: float: Total sales tax collected (non-unit) for the item in dollars.. Documented JSON request/response-example field names (examples, not additional required schemas): refund, refund.transaction_id, refund.user_id, refund.transaction_date, refund.transaction_reference_id, refund.provider, refund.to_country, refund.to_zip, refund.to_state, refund.to_city, refund.to_street, refund.amount, refund.shipping, refund.sales_tax, refund.line_items, refund.line_items[].id, refund.line_items[].quantity, refund.line_items[].product_identifier, refund.line_items[].description, refund.line_items[].unit_price, refund.line_items[].discount, refund.line_items[].sales_tax.
PUT /v2/transactions/refunds/{transaction_id} - Destructive
Delete an order transaction
Deletes an existing order transaction created through the API. DELETE https://api.taxjar.com/v2/transactions/orders/:transaction_id Returns an order JSON object with the deleted order transaction identifiers. Documented Parameter: Type: Required: Description: transaction_id: string: required: Unique identifier of the given order transaction.; provider: string: optional: Source of where the transaction was originally recorded. Defaults to “api”.. Documented Parameter: Type: Description: transaction_id: string: Unique identifier of the given order transaction.; user_id: integer: Unique identifier of the user who created the order transaction.; provider: string: Source of where the transaction was originally recorded.. Documented JSON request/response-example field names (examples, not additional required schemas): order, order.transaction_id, order.user_id, order.transaction_date, order.transaction_reference_id, order.provider, order.from_country, order.from_zip, order.from_state, order.from_city, order.from_street, order.to_country, order.to_zip, order.to_state, order.to_city, order.to_street, order.amount, order.shipping, order.sales_tax, order.line_items.
DELETE /v2/transactions/orders/{transaction_id} - Destructive
Delete a refund transaction
Deletes an existing refund transaction created through the API. DELETE https://api.taxjar.com/v2/transactions/refunds/:transaction_id Returns a refund JSON object with the deleted refund transaction identifiers. Documented Parameter: Type: Required: Description: transaction_id: string: required: Unique identifier of the given refund transaction.; provider: string: optional: Source of where the transaction was originally recorded. Defaults to “api”.. Documented Parameter: Type: Description: transaction_id: string: Unique identifier of the given refund transaction.; user_id: integer: Unique identifier of the user who created the refund transaction.; provider: string: Source of where the transaction was originally recorded.. Documented JSON request/response-example field names (examples, not additional required schemas): refund, refund.transaction_id, refund.user_id, refund.transaction_date, refund.transaction_reference_id, refund.provider, refund.from_country, refund.from_zip, refund.from_state, refund.from_city, refund.from_street, refund.to_country, refund.to_zip, refund.to_state, refund.to_city, refund.to_street, refund.amount, refund.shipping, refund.sales_tax, refund.line_items.
DELETE /v2/transactions/refunds/{transaction_id}
customers
- Read
List customers
Lists existing customers created through the API. GET https://api.taxjar.com/v2/customers Returns a customers JSON object with an array of customer IDs created through the API. Documented JSON request/response-example field names (examples, not additional required schemas): customers.
GET /v2/customers - Read
Show a customer
Shows an existing customer created through the API. GET https://api.taxjar.com/v2/customers/:customer_id Returns a customer JSON object with details of a customer created through the API. Documented Parameter: Type: Required: Description: customer_id: string: required: Unique identifier of the given customer.. Documented Parameter: Type: Description: customer_id: string: Unique identifier of the given customer.; exemption_type: string: Type of customer exemption: wholesale , government , other , or non_exempt .; exempt_regions[][country]: string: Two-letter ISO country code where the customer is exempt.; exempt_regions[][state]: string: Two-letter ISO state code where the customer is exempt.; name: string: Name of the customer.; country: string: Two-letter ISO country code of the customer’s primary address.; state: string: Two-letter ISO state code of the customer’s primary address.; zip: string: Postal code of the customer’s primary address.; city: string: City of the customer’s primary address.; street: string: Street address of the customer’s primary address.. Documented JSON request/response-example field names (examples, not additional required schemas): customer, customer.customer_id, customer.exemption_type, customer.exempt_regions, customer.exempt_regions[].country, customer.exempt_regions[].state, customer.name, customer.country, customer.state, customer.zip, customer.city, customer.street.
GET /v2/customers/{customer_id} - Write
Create a customer
Creates a new customer. POST https://api.taxjar.com/v2/customers Returns a customer JSON object with details of the new customer. Documented Parameter: Type: Required: Description: customer_id: string: required: Unique identifier of the given customer.; exemption_type: string: required: Type of customer exemption: wholesale , government , other , or non_exempt .; name: string: required: Name of the customer.; exempt_regions[][country]: string: optional: Two-letter ISO country code where the customer is exempt. View Note; exempt_regions[][state]: string: optional: Two-letter ISO state code where the customer is exempt.; country: string: optional: Two-letter ISO country code of the customer’s primary address.; state: string: optional: Two-letter ISO state code of the customer’s primary address.; zip: string: optional: Postal code of the customer’s primary address.; city: string: optional: City of the customer’s primary address.; street: string: optional: Street address of the customer’s primary address.. Documented Parameter: Type: Description: customer_id: string: Unique identifier of the given customer.; exemption_type: string: Type of customer exemption: wholesale , government , other , or non_exempt .; exempt_regions[][country]: string: Two-letter ISO country code where the customer is exempt.; exempt_regions[][state]: string: Two-letter ISO state code where the customer is exempt.; name: string: Name of the customer.; country: string: Two-letter ISO country code of the customer’s primary address.; state: string: Two-letter ISO state code of the customer’s primary address.; zip: string: Postal code of the customer’s primary address.; city: string: City of the customer’s primary address.; street: string: Street address of the customer’s primary address.. Documented JSON request/response-example field names (examples, not additional required schemas): customer, customer.customer_id, customer.exemption_type, customer.exempt_regions, customer.exempt_regions[].country, customer.exempt_regions[].state, customer.name, customer.country, customer.state, customer.zip, customer.city, customer.street.
POST /v2/customers - Write
Update a customer
Updates an existing customer created through the API. PUT https://api.taxjar.com/v2/customers/:customer_id Returns a customer JSON object with details of the updated customer. Documented Parameter: Type: Required: Description: customer_id: string: required: Unique identifier of the given customer.; exemption_type: string: required: Type of customer exemption: wholesale , government , other , or non_exempt .; name: string: required: Name of the customer.; exempt_regions[][country]: string: optional: Two-letter ISO country code where the customer is exempt. View Note; exempt_regions[][state]: string: optional: Two-letter ISO state code where the customer is exempt.; country: string: optional: Two-letter ISO country code of the customer’s primary address.; state: string: optional: Two-letter ISO state code of the customer’s primary address.; zip: string: optional: Postal code of the customer’s primary address.; city: string: optional: City of the customer’s primary address.; street: string: optional: Street address of the customer’s primary address.. Documented Parameter: Type: Description: customer_id: string: Unique identifier of the given customer.; exemption_type: string: Type of customer exemption: wholesale , government , other , or non_exempt .; exempt_regions[][country]: string: Two-letter ISO country code where the customer is exempt.; exempt_regions[][state]: string: Two-letter ISO state code where the customer is exempt.; name: string: Name of the customer.; country: string: Two-letter ISO country code of the customer’s primary address.; state: string: Two-letter ISO state code of the customer’s primary address.; zip: string: Postal code of the customer’s primary address.; city: string: City of the customer’s primary address.; street: string: Street address of the customer’s primary address.. Documented JSON request/response-example field names (examples, not additional required schemas): customer, customer.customer_id, customer.exemption_type, customer.exempt_regions, customer.exempt_regions[].country, customer.exempt_regions[].state, customer.name, customer.country, customer.state, customer.zip, customer.city, customer.street.
PUT /v2/customers/{customer_id} - Destructive
Delete a customer
Deletes an existing customer created through the API. DELETE https://api.taxjar.com/v2/customers/:customer_id Returns a customer JSON object with the deleted customer identifiers. Documented Parameter: Type: Required: Description: customer_id: string: required: Unique identifier of the given customer.. Documented Parameter: Type: Description: customer_id: string: Unique identifier of the given customer.. Documented JSON request/response-example field names (examples, not additional required schemas): customer, customer.customer_id, customer.exemption_type, customer.exempt_regions, customer.exempt_regions[].country, customer.exempt_regions[].state, customer.name, customer.country, customer.state, customer.zip, customer.city, customer.street.
DELETE /v2/customers/{customer_id}
rates
- Read
Show tax rates for a location
Shows the sales tax rates for a given location. Please note this endpoint only returns the full combined rate for a given location. It does not support nexus determination, sourcing based on a ship from and ship to address, shipping taxability, product exemptions, customer exemptions, or sales tax holidays. We recommend using our taxes endpoint to accurately calculate sales tax for an order. GET https://api.taxjar.com/v2/rates/:zip Returns a rate JSON object with rates for a given location broken down by state, county, city, and district. United States Attributes Documented Parameter: Type: Required: Description: country: string: optional: Two-letter ISO country code for given location.; zip: string: required: Postal code for given location (5-Digit ZIP or ZIP+4).; state: string: optional: Two-letter ISO state code for given location.; city: string: optional: City for given location.; street: string: optional: Street address for given location. View Note. Documented Parameter: Type: Description: zip: string: Postal code for given location.; country: string: Country for given location if SST state. View Note; country_rate: float: Country sales tax rate for given location if SST state. View Note; state: string: Postal abbreviated state name for given location.; state_rate: float: State sales tax rate for given location.; county: string: County name for given location.; county_rate: float: County sales tax rate for given location.; city: string: City name for given location.; city_rate: float: City sales tax rate for given location.; combined_district_rate: float: Aggregate rate for all city and county sales tax districts effective at the location.; combined_rate: float: Overall sales tax rate which includes state, county, city and district tax. This rate should be used to determine how much sales tax to collect for an order.; freight_taxable: bool: Freight taxability for given location..
GET /v2/rates/{zip}
nexus
- Read
List nexus regions
Lists existing nexus locations for an existing TaxJar account. GET https://api.taxjar.com/v2/nexus/regions Returns a regions JSON object with an array of nexus regions sorted alphabetically. Documented Parameter: Type: Description: country_code: string: Two-letter ISO country code for nexus region.; country: string: Country name for nexus region.; region_code: string: Two-letter ISO region code for nexus region.; region: string: Region name for nexus region.. Documented JSON request/response-example field names (examples, not additional required schemas): regions, regions[].country_code, regions[].country, regions[].region_code, regions[].region.
GET /v2/nexus/regions
addresses
- Read
Validate an address
Validates a customer address and returns back a collection of address matches. Address validation requires a TaxJar Professional or higher subscription. POST https://api.taxjar.com/v2/addresses/validate Returns an addresses JSON object with an array of address matches. If no addresses are found, a 404 response is returned. Documented Parameter: Type: Required: Description: country: string: optional: Two-letter ISO country code of the customer’s address. At this time only US addresses can be validated.; state: string: conditional: Two-letter ISO state code of the customer’s address.; zip: string: conditional: Postal code of the customer’s address (5-Digit ZIP or ZIP+4).; city: string: conditional: City of the customer’s address.; street: string: conditional: Street address of the customer’s address or the entire address as “freeform” input.. Documented Parameter: Type: Description: country: string: Two-letter ISO country code of the customer’s address.; state: string: Two-letter ISO state code of the customer’s address.; zip: string: Postal code of the customer’s address (ZIP+4). View Note; city: string: City of the customer’s address.; street: string: Street address of the customer’s address.. Documented Parameter: Type: Description: country: string: Two-letter ISO country code of the customer’s address.; state: string: Two-letter ISO state code of the customer’s address.; zip: string: Postal code of the customer’s address. View Note; city: string: City of the customer’s address.. Documented JSON request/response-example field names (examples, not additional required schemas): addresses, addresses[].zip, addresses[].street, addresses[].state, addresses[].country, addresses[].city.
POST /v2/addresses/validate
summary_rates
- Read
Summarize tax rates for all regions
Response Example Summary response shortened for brevity. Retrieve minimum and average sales tax rates by region as a backup. GET https://api.taxjar.com/v2/summary_rates Returns a summary_rates JSON object with an array of summarized rates for each region/state. Documented Parameter: Type: Description: country_code: string: Country code for summarized region.; country: string: Country name for summarized region.; region_code: string: Region code for summarized region.; region: string: Region name for summarized region.; minimum_rate: object: Region/state-only sales tax rate with label.; average_rate: object: Average rate for region/state and local sales tax across all postal codes in the summarized region with label.. Documented JSON request/response-example field names (examples, not additional required schemas): summary_rates, summary_rates[].country_code, summary_rates[].country, summary_rates[].region_code, summary_rates[].region, summary_rates[].minimum_rate, summary_rates[].minimum_rate.label, summary_rates[].minimum_rate.rate, summary_rates[].average_rate, summary_rates[].average_rate.label, summary_rates[].average_rate.rate.
GET /v2/summary_rates
No operations match.
See How connections work for access and permissions, or browse all integrations.