Get Started
Product
Resources
Tools & SDKs
Framework
Reference

listTaxRegions - Tax Module Reference

This documentation provides a reference to the listTaxRegions method. This belongs to the Tax Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method retrieves a paginated list of tax regions based on optional filters and configuration.

Example#

To retrieve a list of tax regions using their IDs:

Code
1const taxRegions = await taxModuleService.listTaxRegions({2  id: ["txreg_123", "txreg_321"],3})

To specify relations that should be retrieved within the tax region:

Code
1const taxRegions = await taxModuleService.listTaxRegions(2  {3    id: ["txreg_123", "txreg_321"],4  },5  {6    relations: ["tax_rates"],7  }8)

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

Code
1const taxRegions = await taxModuleService.listTaxRegions(2  {3    id: ["txreg_123", "txreg_321"],4  },5  {6    relations: ["tax_rates"],7    take: 20,8    skip: 2,9  }10)

Parameters#

filtersFilterableTaxRegionPropsOptional

The filters to apply on the retrieved tax regions.

configFindConfig<TaxRegionDTO>Optional

The configurations determining how the tax region is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a tax region.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<TaxRegionDTO[]>

The list of tax regions.

Was this page helpful?