---
displayed_sidebar: servicesSidebar
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# TaxProviderService

Finds tax providers and assists in tax related operations.

## Constructors

### constructor

`**new TaxProviderService**(container)`

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "container",
    "type": "AwilixContainer&#60;any&#62;",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

## Properties

<ParameterTypes parameters={[
  {
    "name": "__configModule__",
    "type": "`Record<string, unknown>`",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "__container__",
    "type": "`any`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "__moduleDeclaration__",
    "type": "`Record<string, unknown>`",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "cacheService_",
    "type": "[ICacheService](../interfaces/ICacheService.mdx)",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "container_",
    "type": "AwilixContainer&#60;any&#62;",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "eventBus_",
    "type": "[IEventBusService](../interfaces/IEventBusService.mdx)",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "manager_",
    "type": "EntityManager",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "smTaxLineRepo_",
    "type": "Repository&#60;[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)&#62; & `&#123; deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines  &#125;`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "taxLineRepo_",
    "type": "Repository&#60;[LineItemTaxLine](LineItemTaxLine.mdx)&#62; & `&#123; deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines  &#125;`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "taxProviderRepo_",
    "type": "Repository&#60;[TaxProvider](TaxProvider.mdx)&#62;",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "taxRateService_",
    "type": "[TaxRateService](TaxRateService.mdx)",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "transactionManager_",
    "type": "`undefined` \\| EntityManager",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

## Accessors

### activeManager\_

`Protected get**activeManager_**(): EntityManager`

#### Returns

EntityManager

<ParameterTypes parameters={[
  {
    "name": "EntityManager",
    "type": "EntityManager",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

## Methods

### atomicPhase\_

`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`

Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.

<ParameterTypes parameters={[
  {
    "name": "TResult",
    "type": "`object`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "TError",
    "type": "`object`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "work",
    "type": "(`transactionManager`: EntityManager) => Promise&#60;TResult&#62;",
    "description": "the transactional work to be done",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "isolationOrErrorHandler",
    "type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
    "description": "the isolation level to be used for the work.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "maybeErrorHandlerOrDontFail",
    "type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
    "description": "Potential error handler",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

Promise&#60;TResult&#62;

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "Promise&#60;TResult&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "the result of the transactional work",
    "expandable": false,
    "children": []
  }
]} />

___

### clearLineItemsTaxLines

`**clearLineItemsTaxLines**(itemIds): Promise&#60;void&#62;`

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "itemIds",
    "type": "`string`[]",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

Promise&#60;void&#62;

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "Promise&#60;void&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### clearTaxLines

`**clearTaxLines**(cartId): Promise&#60;void&#62;`

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "cartId",
    "type": "`string`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

Promise&#60;void&#62;

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "Promise&#60;void&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### createShippingTaxLines

`**createShippingTaxLines**(shippingMethod, calculationContext): Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]&#62;`

Persists the tax lines relevant for a shipping method to the database. Used
for return shipping methods.

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "shippingMethod",
    "type": "[ShippingMethod](ShippingMethod.mdx)",
    "description": "the shipping method to create tax lines for",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "calculationContext",
    "type": "[TaxCalculationContext](../types/TaxCalculationContext.mdx)",
    "description": "the calculation context to get tax lines by",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]&#62;

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "the newly created tax lines",
    "expandable": false,
    "children": []
  }
]} />

___

### createTaxLines

`**createTaxLines**(cartOrLineItems, calculationContext): Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]&#62;`

Persists the tax lines relevant for an order to the database.

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "cartOrLineItems",
    "type": "[LineItem](LineItem.mdx)[] \\| [Cart](Cart.mdx)",
    "description": "the cart or line items to create tax lines for",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "calculationContext",
    "type": "[TaxCalculationContext](../types/TaxCalculationContext.mdx)",
    "description": "the calculation context to get tax lines by",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]&#62;

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "the newly created tax lines",
    "expandable": false,
    "children": []
  }
]} />

___

### getCacheKey

`Private **getCacheKey**(id, regionId): string`

The cache key to get cache hits by.

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "id",
    "type": "`string`",
    "description": "the entity id to cache",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "regionId",
    "type": "`string`",
    "description": "the region id to cache",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`string`

<ParameterTypes parameters={[
  {
    "name": "string",
    "type": "`string`",
    "optional": true,
    "defaultValue": "",
    "description": "the cache key to use for the id set",
    "expandable": false,
    "children": []
  }
]} />

___

### getRegionRatesForProduct

`**getRegionRatesForProduct**(productIds, region): Promise&#60;Map&#60;string, [TaxServiceRate](../types/TaxServiceRate.mdx)[]&#62;&#62;`

Gets the tax rates configured for a product. The rates are cached between
calls.

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "productIds",
    "type": "`string` \\| `string`[]",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "region",
    "type": "[RegionDetails](../types/RegionDetails.mdx)",
    "description": "the region to get configured rates for.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

Promise&#60;Map&#60;string, [TaxServiceRate](../types/TaxServiceRate.mdx)[]&#62;&#62;

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "Promise&#60;Map&#60;string, [TaxServiceRate](../types/TaxServiceRate.mdx)[]&#62;&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "the tax rates configured for the shipping option. A map by product id",
    "expandable": false,
    "children": []
  }
]} />

___

### getRegionRatesForShipping

`**getRegionRatesForShipping**(optionId, regionDetails): Promise&#60;[TaxServiceRate](../types/TaxServiceRate.mdx)[]&#62;`

Gets the tax rates configured for a shipping option. The rates are cached
between calls.

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "optionId",
    "type": "`string`",
    "description": "the option id of the shipping method.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "regionDetails",
    "type": "[RegionDetails](../types/RegionDetails.mdx)",
    "description": "the region to get configured rates for.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

Promise&#60;[TaxServiceRate](../types/TaxServiceRate.mdx)[]&#62;

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "Promise&#60;[TaxServiceRate](../types/TaxServiceRate.mdx)[]&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "the tax rates configured for the shipping option.",
    "expandable": false,
    "children": []
  }
]} />

___

### getShippingTaxLines

`**getShippingTaxLines**(shippingMethod, calculationContext): Promise&#60;[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)[]&#62;`

Gets the relevant tax lines for a shipping method. Note: this method
doesn't persist the tax lines. Use createShippingTaxLines if you wish to
persist the tax lines to the DB layer.

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "shippingMethod",
    "type": "[ShippingMethod](ShippingMethod.mdx)",
    "description": "the shipping method to get tax lines for",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "calculationContext",
    "type": "[TaxCalculationContext](../types/TaxCalculationContext.mdx)",
    "description": "the calculation context to get tax lines by",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

Promise&#60;[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)[]&#62;

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "Promise&#60;[ShippingMethodTaxLine](ShippingMethodTaxLine.mdx)[]&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "the computed tax lines",
    "expandable": false,
    "children": []
  }
]} />

___

### getTaxLines

`**getTaxLines**(lineItems, calculationContext): Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]&#62;`

Gets the relevant tax lines for an order or cart. If an order is provided
the order's tax lines will be returned. If a cart is provided the tax lines
will be computed from the tax rules and potentially a 3rd party tax plugin.
Note: this method doesn't persist the tax lines. Use createTaxLines if you
wish to persist the tax lines to the DB layer.

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "lineItems",
    "type": "[LineItem](LineItem.mdx)[]",
    "description": "the cart or order to get tax lines for",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "calculationContext",
    "type": "[TaxCalculationContext](../types/TaxCalculationContext.mdx)",
    "description": "the calculation context to get tax lines by",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]&#62;

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "Promise&#60;([LineItemTaxLine](LineItemTaxLine.mdx) \\| [ShippingMethodTaxLine](ShippingMethodTaxLine.mdx))[]&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "the computed tax lines",
    "expandable": false,
    "children": []
  }
]} />

___

### getTaxLinesMap

`Protected **getTaxLinesMap**(items, calculationContext): Promise&#60;[TaxLinesMaps](../types/TaxLinesMaps.mdx)&#62;`

Return a map of tax lines for line items and shipping methods

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "items",
    "type": "[LineItem](LineItem.mdx)[]",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "calculationContext",
    "type": "[TaxCalculationContext](../types/TaxCalculationContext.mdx)",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

Promise&#60;[TaxLinesMaps](../types/TaxLinesMaps.mdx)&#62;

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "Promise&#60;[TaxLinesMaps](../types/TaxLinesMaps.mdx)&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### list

`**list**(): Promise&#60;[TaxProvider](TaxProvider.mdx)[]&#62;`

#### Returns

Promise&#60;[TaxProvider](TaxProvider.mdx)[]&#62;

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "Promise&#60;[TaxProvider](TaxProvider.mdx)[]&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### registerInstalledProviders

`**registerInstalledProviders**(providers): Promise&#60;void&#62;`

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "providers",
    "type": "`string`[]",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

Promise&#60;void&#62;

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "Promise&#60;void&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### retrieveProvider

`**retrieveProvider**(region): [ITaxService](../interfaces/ITaxService.mdx)`

Retrieves the relevant tax provider for the given region.

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "region",
    "type": "[Region](Region.mdx)",
    "description": "the region to get tax provider for.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

[ITaxService](../interfaces/ITaxService.mdx)

<ParameterTypes parameters={[
  {
    "name": "getTaxLines",
    "type": "(`itemLines`: [ItemTaxCalculationLine](../types/ItemTaxCalculationLine.mdx)[], `shippingLines`: [ShippingTaxCalculationLine](../types/ShippingTaxCalculationLine.mdx)[], `context`: [TaxCalculationContext](../types/TaxCalculationContext.mdx)) => Promise&#60;[ProviderTaxLine](../types/ProviderTaxLine.mdx)[]&#62;",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

___

### shouldRetryTransaction\_

`Protected **shouldRetryTransaction_**(err): boolean`

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "err",
    "type": "`Record<string, unknown>` \\| `&#123; code: string  &#125;`",
    "description": "",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

`boolean`

<ParameterTypes parameters={[
  {
    "name": "boolean",
    "type": "`boolean`",
    "optional": true,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />

___

### withTransaction

`**withTransaction**(transactionManager?): [TaxProviderService](TaxProviderService.mdx)`

#### Parameters

<ParameterTypes parameters={[
  {
    "name": "transactionManager",
    "type": "EntityManager",
    "description": "",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} />

#### Returns

[TaxProviderService](TaxProviderService.mdx)

<ParameterTypes parameters={[
  {
    "name": "TaxProviderService",
    "type": "[TaxProviderService](TaxProviderService.mdx)",
    "optional": false,
    "defaultValue": "",
    "description": "",
    "expandable": false,
    "children": []
  }
]} />
