retrieveTaxRate - Tax Module Reference

This documentation provides a reference to the retrieveTaxRate 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 tax by its ID.

Example#

A simple example that retrieves a tax rate by its ID:

Code
const taxRate = await taxModuleService.retrieveTaxRate("txr_123")

To specify relations that should be retrieved:

Note: You can only retrieve data models defined in the same module. To retrieve linked data models from other modules, use Query instead.

Code
1const taxRate = await taxModuleService.retrieveTaxRate("txr_123", {2  relations: ["tax_region"],3})

Parameters#

taxRateIdstring

The tax rate's ID.

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>

The retrieved tax.