retrieve - Tax Module Reference

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

This method retrieves a tax by its ID.

Example

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

const taxRate = await taxModuleService.retrieve("txr_123")

To specify relations that should be retrieved:

const taxRate = await taxModuleService.retrieve("txr_123", {
  relations: ["tax_region"],
})

Parameters

taxRateIdstringRequired

The tax rate's ID.

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 retrieved tax.