Get Started
Product
Resources
Tools & SDKs
Framework
Reference

listTaxRateRules - Tax Module Reference

This documentation provides a reference to the listTaxRateRules 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 rate rules based on optional filters and configuration.

Example#

To retrieve a list of tax rate rules using their associated tax rate's ID:

Code
1const taxRateRules = await taxModuleService.listTaxRateRules({2  tax_rate_id: ["txr_123", "txr_321"],3})

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

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

Parameters#

filtersFilterableTaxRateRulePropsOptional

The filters to apply on the retrieved tax rate rules.

configFindConfig<TaxRateRuleDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<TaxRateRuleDTO[]>

The list of tax rate rules.

Was this page helpful?