Get Started
Product
Resources
Tools & SDKs
Framework
Reference

listAndCountTaxRates - Tax Module Reference

This documentation provides a reference to the listAndCountTaxRates 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 rates along with the total count of available tax rates satisfying the provided filters.

Example#

To retrieve a list of tax rates using their IDs:

Code
1const [taxRates, count] = await taxModuleService.listAndCountTaxRates(2  {3    id: ["txr_123", "txr_321"],4  }5)

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

Code
1const [taxRates, count] = await taxModuleService.listAndCountTaxRates(2  {3    id: ["txr_123", "txr_321"],4  },5  {6    relations: ["tax_region"],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 [taxRates, count] = await taxModuleService.listAndCountTaxRates(2  {3    id: ["txr_123", "txr_321"],4  },5  {6    relations: ["tax_region"],7    take: 20,8    skip: 2,9  }10)

Parameters#

filtersFilterableTaxRatePropsOptional

The filters to apply on the retrieved tax rates.

configFindConfig<TaxRateDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<[TaxRateDTO[], number]>

The list of tax rates along with their total count.

Was this page helpful?