listTaxRateRules - Tax Module Reference

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

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:

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

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

const taxRateRules = await taxModuleService.listTaxRateRules(
  {
    tax_rate_id: ["txr_123", "txr_321"],
  },
  {
    relations: ["tax_rate"],
  }
)

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

const taxRateRules = await taxModuleService.listTaxRateRules(
  {
    tax_rate_id: ["txr_123", "txr_321"],
  },
  {
    relations: ["tax_rate"],
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterableTaxRateRuleProps

The filters to apply on the retrieved tax rate rules.

configFindConfig<TaxRateRuleDTO>

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.

sharedContextContext

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

Returns

PromisePromise<TaxRateRuleDTO[]>Required

The list of tax rate rules.