list - Tax Module Reference

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

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

Example

To retrieve a list of tax rates using their IDs:

const taxRates = await taxModuleService.list({
  id: ["txr_123", "txr_321"],
})

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

const taxRates = await taxModuleService.list(
  {
    id: ["txr_123", "txr_321"],
  },
  {
    relations: ["tax_region"],
  }
)

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 taxRates = await taxModuleService.list(
  {
    id: ["txr_123", "txr_321"],
  },
  {
    relations: ["tax_region"],
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterableTaxRateProps

The filters to apply on the retrieved tax rates.

configFindConfig<TaxRateDTO>

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.

sharedContextContext

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

Returns

PromisePromise<TaxRateDTO[]>Required

The list of tax rates.