# TaxJar

> Calculate sales tax, look up rates, validate addresses and report orders, refunds and exempt customers to TaxJar.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/taxjar

## Actions

### Calculate tax

Calculate the sales tax due on an order, from where it ships from to where it ships to.

**Inputs**

- From country (`from_country`, text): From country. One of: `AD` (Andorra), `AE` (United Arab Emirates), `AF` (Afghanistan), `AG` (Antigua & Barbuda), `AI` (Anguilla), `AL` (Albania), `AM` (Armenia), `AO` (Angola), `AQ` (Antarctica), `AR` (Argentina), and 240 more.
- From state (`from_state`, text): From state.
- From zip (`from_zip`, text): From zip.
- From city (`from_city`, text): From city.
- From street (`from_street`, text): From street.
- To country (`to_country`, text, required): To country. One of: `AD` (Andorra), `AE` (United Arab Emirates), `AF` (Afghanistan), `AG` (Antigua & Barbuda), `AI` (Anguilla), `AL` (Albania), `AM` (Armenia), `AO` (Angola), `AQ` (Antarctica), `AR` (Argentina), and 240 more.
- To state (`to_state`, text, required): To state.
- To zip (`to_zip`, text, required): To zip.
- To city (`to_city`, text): To city.
- To street (`to_street`, text): To street.
- Amount (`amount`, number): Amount. At least 0.
- Shipping (`shipping`, number, required): Shipping. At least 0.
- Customer (`customer_id`, text): Customer id.
- Line items (`line_items`, list): Line items.
- Nexus addresses (`nexus_addresses`, list): Nexus addresses.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {
    "tax": {}
  },
  "environment": "sandbox",
  "next_cursor": ""
}
```

### Create customer

Add a customer who is exempt from sales tax, such as a wholesaler or nonprofit.

**Inputs**

- Customer id (`customer_id`, text, required): Customer id.
- Exemption type (`exemption_type`, text, required): Exemption type. One of: `wholesale`, `government`, `other`, `non_exempt` (Non exempt).
- Name (`name`, text, required): Name.
- Exempt regions (`exempt_regions`, list): Exempt regions.
- Country (`country`, text): Country. One of: `AD` (Andorra), `AE` (United Arab Emirates), `AF` (Afghanistan), `AG` (Antigua & Barbuda), `AI` (Anguilla), `AL` (Albania), `AM` (Armenia), `AO` (Angola), `AQ` (Antarctica), `AR` (Argentina), and 240 more.
- State (`state`, text): State.
- Zip (`zip`, text): Zip.
- City (`city`, text): City.
- Street (`street`, text): Street.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {
    "customer": {
      "amount": 1.0,
      "customer_id": "example",
      "name": "example",
      "transaction_id": "example",
      "transaction_reference_id": "example"
    }
  },
  "environment": "sandbox",
  "next_cursor": ""
}
```

### Create order

Report an order for sales tax reporting and filing.

**Inputs**

- Transaction id (`transaction_id`, text, required): Transaction id.
- Transaction date (`transaction_date`, date and time, required): Transaction date.
- Amount (`amount`, number, required): Amount.
- Shipping (`shipping`, number, required): Shipping.
- Sales tax (`sales_tax`, number, required): Sales tax.
- From country (`from_country`, text): From country. One of: `AD` (Andorra), `AE` (United Arab Emirates), `AF` (Afghanistan), `AG` (Antigua & Barbuda), `AI` (Anguilla), `AL` (Albania), `AM` (Armenia), `AO` (Angola), `AQ` (Antarctica), `AR` (Argentina), and 240 more.
- From state (`from_state`, text): From state.
- From zip (`from_zip`, text): From zip.
- From city (`from_city`, text): From city.
- From street (`from_street`, text): From street.
- To country (`to_country`, text, required): To country. One of: `AD` (Andorra), `AE` (United Arab Emirates), `AF` (Afghanistan), `AG` (Antigua & Barbuda), `AI` (Anguilla), `AL` (Albania), `AM` (Armenia), `AO` (Angola), `AQ` (Antarctica), `AR` (Argentina), and 240 more.
- To state (`to_state`, text, required): To state.
- To zip (`to_zip`, text, required): To zip.
- To city (`to_city`, text): To city.
- To street (`to_street`, text): To street.
- Customer (`customer_id`, text): Customer id.
- Exemption type (`exemption_type`, text): Exemption type. One of: `wholesale`, `government`, `marketplace`, `other`, `non_exempt` (Non exempt).
- Line items (`line_items`, list): Line items.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {
    "order": {
      "amount": 1.0,
      "customer_id": "example",
      "name": "example",
      "transaction_id": "example",
      "transaction_reference_id": "example"
    }
  },
  "environment": "sandbox",
  "next_cursor": ""
}
```

### Create refund

Report a refund for sales tax reporting and filing.

**Inputs**

- Transaction id (`transaction_id`, text, required): Transaction id.
- Transaction date (`transaction_date`, date and time, required): Transaction date.
- Amount (`amount`, number, required): Amount.
- Shipping (`shipping`, number, required): Shipping.
- Sales tax (`sales_tax`, number, required): Sales tax.
- From country (`from_country`, text): From country. One of: `AD` (Andorra), `AE` (United Arab Emirates), `AF` (Afghanistan), `AG` (Antigua & Barbuda), `AI` (Anguilla), `AL` (Albania), `AM` (Armenia), `AO` (Angola), `AQ` (Antarctica), `AR` (Argentina), and 240 more.
- From state (`from_state`, text): From state.
- From zip (`from_zip`, text): From zip.
- From city (`from_city`, text): From city.
- From street (`from_street`, text): From street.
- To country (`to_country`, text, required): To country. One of: `AD` (Andorra), `AE` (United Arab Emirates), `AF` (Afghanistan), `AG` (Antigua & Barbuda), `AI` (Anguilla), `AL` (Albania), `AM` (Armenia), `AO` (Angola), `AQ` (Antarctica), `AR` (Argentina), and 240 more.
- To state (`to_state`, text, required): To state.
- To zip (`to_zip`, text, required): To zip.
- To city (`to_city`, text): To city.
- To street (`to_street`, text): To street.
- Customer (`customer_id`, text): Customer id.
- Exemption type (`exemption_type`, text): Exemption type. One of: `wholesale`, `government`, `marketplace`, `other`, `non_exempt` (Non exempt).
- Line items (`line_items`, list): Line items.
- Transaction reference id (`transaction_reference_id`, text, required): Transaction reference id.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {
    "refund": {
      "amount": 1.0,
      "customer_id": "example",
      "name": "example",
      "transaction_id": "example",
      "transaction_reference_id": "example"
    }
  },
  "environment": "sandbox",
  "next_cursor": ""
}
```

### Delete customer

Delete an exempt customer.

**Inputs**

- Customer (`customer_id`, text, required): Customer id.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {},
  "environment": "sandbox",
  "next_cursor": ""
}
```

### Delete order

Delete an order you reported.

**Inputs**

- Transaction id (`transaction_id`, text, required): Transaction id.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {},
  "environment": "sandbox",
  "next_cursor": ""
}
```

### Delete refund

Delete a refund you reported.

**Inputs**

- Transaction id (`transaction_id`, text, required): Transaction id.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {},
  "environment": "sandbox",
  "next_cursor": ""
}
```

### Get customer

Get an exempt customer's details and the regions they are exempt in.

**Inputs**

- Customer (`customer_id`, text, required): Customer id.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {
    "customer": {
      "amount": 1.0,
      "customer_id": "example",
      "name": "example",
      "transaction_id": "example",
      "transaction_reference_id": "example"
    }
  },
  "environment": "sandbox",
  "next_cursor": ""
}
```

### Get order

Get an order you reported, with its amounts, addresses and line items.

**Inputs**

- Transaction id (`transaction_id`, text, required): Transaction id.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {
    "order": {
      "amount": 1.0,
      "customer_id": "example",
      "name": "example",
      "transaction_id": "example",
      "transaction_reference_id": "example"
    }
  },
  "environment": "sandbox",
  "next_cursor": ""
}
```

### Get rates

Get the sales tax rates for a location.

**Inputs**

- Zip (`zip`, text, required): Zip.
- Country (`country`, text): Country. One of: `AD` (Andorra), `AE` (United Arab Emirates), `AF` (Afghanistan), `AG` (Antigua & Barbuda), `AI` (Anguilla), `AL` (Albania), `AM` (Armenia), `AO` (Angola), `AQ` (Antarctica), `AR` (Argentina), and 240 more.
- State (`state`, text): State.
- City (`city`, text): City.
- Street (`street`, text): Street.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {
    "rate": {}
  },
  "environment": "sandbox",
  "next_cursor": ""
}
```

### Get refund

Get a refund you reported, with its amounts, addresses and line items.

**Inputs**

- Transaction id (`transaction_id`, text, required): Transaction id.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {
    "refund": {
      "amount": 1.0,
      "customer_id": "example",
      "name": "example",
      "transaction_id": "example",
      "transaction_reference_id": "example"
    }
  },
  "environment": "sandbox",
  "next_cursor": ""
}
```

### List categories

List the product tax codes TaxJar uses for items taxed differently, such as clothing or food.

**Inputs**: None.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {
    "categories": []
  },
  "environment": "sandbox",
  "next_cursor": ""
}
```

### List customers

List the IDs of your exempt customers.

**Inputs**: None.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {
    "customers": []
  },
  "environment": "sandbox",
  "next_cursor": ""
}
```

### List nexus regions

List the states and countries where you have nexus and collect sales tax.

**Inputs**: None.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {
    "regions": []
  },
  "environment": "sandbox",
  "next_cursor": ""
}
```

### List orders

List the IDs of the orders you reported, within a date range.

**Inputs**

- From transaction date (`from_transaction_date`, date): From transaction date.
- To transaction date (`to_transaction_date`, date): To transaction date.
- Transaction date (`transaction_date`, date): Transaction date.
- Provider (`provider`, text): Provider.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {
    "orders": []
  },
  "environment": "sandbox",
  "next_cursor": ""
}
```

### List refunds

List the IDs of the refunds you reported, within a date range.

**Inputs**

- From transaction date (`from_transaction_date`, date): From transaction date.
- To transaction date (`to_transaction_date`, date): To transaction date.
- Transaction date (`transaction_date`, date): Transaction date.
- Provider (`provider`, text): Provider.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {
    "refunds": []
  },
  "environment": "sandbox",
  "next_cursor": ""
}
```

### Update customer

Change an exempt customer's details or exemption.

**Inputs**

- Customer (`customer_id`, text, required): Customer id.
- Exemption type (`exemption_type`, text): Exemption type. One of: `wholesale`, `government`, `other`, `non_exempt` (Non exempt).
- Name (`name`, text): Name.
- Exempt regions (`exempt_regions`, list): Exempt regions.
- Country (`country`, text): Country. One of: `AD` (Andorra), `AE` (United Arab Emirates), `AF` (Afghanistan), `AG` (Antigua & Barbuda), `AI` (Anguilla), `AL` (Albania), `AM` (Armenia), `AO` (Angola), `AQ` (Antarctica), `AR` (Argentina), and 240 more.
- State (`state`, text): State.
- Zip (`zip`, text): Zip.
- City (`city`, text): City.
- Street (`street`, text): Street.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {
    "customer": {
      "amount": 1.0,
      "customer_id": "example",
      "name": "example",
      "transaction_id": "example",
      "transaction_reference_id": "example"
    }
  },
  "environment": "sandbox",
  "next_cursor": ""
}
```

### Update order

Change an order you reported.

**Inputs**

- Transaction id (`transaction_id`, text, required): Transaction id.
- Transaction date (`transaction_date`, date and time): Transaction date.
- Amount (`amount`, number): Amount.
- Shipping (`shipping`, number): Shipping.
- Sales tax (`sales_tax`, number): Sales tax.
- From country (`from_country`, text): From country. One of: `AD` (Andorra), `AE` (United Arab Emirates), `AF` (Afghanistan), `AG` (Antigua & Barbuda), `AI` (Anguilla), `AL` (Albania), `AM` (Armenia), `AO` (Angola), `AQ` (Antarctica), `AR` (Argentina), and 240 more.
- From state (`from_state`, text): From state.
- From zip (`from_zip`, text): From zip.
- From city (`from_city`, text): From city.
- From street (`from_street`, text): From street.
- To country (`to_country`, text): To country. One of: `AD` (Andorra), `AE` (United Arab Emirates), `AF` (Afghanistan), `AG` (Antigua & Barbuda), `AI` (Anguilla), `AL` (Albania), `AM` (Armenia), `AO` (Angola), `AQ` (Antarctica), `AR` (Argentina), and 240 more.
- To state (`to_state`, text): To state.
- To zip (`to_zip`, text): To zip.
- To city (`to_city`, text): To city.
- To street (`to_street`, text): To street.
- Customer (`customer_id`, text): Customer id.
- Exemption type (`exemption_type`, text): Exemption type. One of: `wholesale`, `government`, `marketplace`, `other`, `non_exempt` (Non exempt).
- Line items (`line_items`, list): Line items.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {
    "order": {
      "amount": 1.0,
      "customer_id": "example",
      "name": "example",
      "transaction_id": "example",
      "transaction_reference_id": "example"
    }
  },
  "environment": "sandbox",
  "next_cursor": ""
}
```

### Update refund

Change a refund you reported.

**Inputs**

- Transaction id (`transaction_id`, text, required): Transaction id.
- Transaction date (`transaction_date`, date and time): Transaction date.
- Amount (`amount`, number): Amount.
- Shipping (`shipping`, number): Shipping.
- Sales tax (`sales_tax`, number): Sales tax.
- From country (`from_country`, text): From country. One of: `AD` (Andorra), `AE` (United Arab Emirates), `AF` (Afghanistan), `AG` (Antigua & Barbuda), `AI` (Anguilla), `AL` (Albania), `AM` (Armenia), `AO` (Angola), `AQ` (Antarctica), `AR` (Argentina), and 240 more.
- From state (`from_state`, text): From state.
- From zip (`from_zip`, text): From zip.
- From city (`from_city`, text): From city.
- From street (`from_street`, text): From street.
- To country (`to_country`, text): To country. One of: `AD` (Andorra), `AE` (United Arab Emirates), `AF` (Afghanistan), `AG` (Antigua & Barbuda), `AI` (Anguilla), `AL` (Albania), `AM` (Armenia), `AO` (Angola), `AQ` (Antarctica), `AR` (Argentina), and 240 more.
- To state (`to_state`, text): To state.
- To zip (`to_zip`, text): To zip.
- To city (`to_city`, text): To city.
- To street (`to_street`, text): To street.
- Customer (`customer_id`, text): Customer id.
- Exemption type (`exemption_type`, text): Exemption type. One of: `wholesale`, `government`, `marketplace`, `other`, `non_exempt` (Non exempt).
- Line items (`line_items`, list): Line items.
- Transaction reference id (`transaction_reference_id`, text): Transaction reference id.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {
    "refund": {
      "amount": 1.0,
      "customer_id": "example",
      "name": "example",
      "transaction_id": "example",
      "transaction_reference_id": "example"
    }
  },
  "environment": "sandbox",
  "next_cursor": ""
}
```

### Validate address

Check a US address and get its corrected, complete form.

**Inputs**

- Country (`country`, text): Country. One of: `AD` (Andorra), `AE` (United Arab Emirates), `AF` (Afghanistan), `AG` (Antigua & Barbuda), `AI` (Anguilla), `AL` (Albania), `AM` (Armenia), `AO` (Angola), `AQ` (Antarctica), `AR` (Argentina), and 240 more.
- State (`state`, text): State.
- Zip (`zip`, text): Zip.
- City (`city`, text): City.
- Street (`street`, text): Street.

**Outputs**

- `data` (object): Response.
- `environment` (text): The connected TaxJar environment.
- `next_cursor` (text): Continuation token, when returned by the service.

**Example output**

```json
{
  "data": {
    "addresses": []
  },
  "environment": "sandbox",
  "next_cursor": ""
}
```
