www/apps/resources/references/tax/ITaxModuleService/methods/tax.ITaxModuleService.createTaxRateRules/page.mdx
import { TypeList } from "docs-ui"
This documentation provides a reference to the createTaxRateRules method. This belongs to the Tax Module.
You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.
</Note>This method creates a tax rate rule.
const taxRateRule = await taxModuleService.createTaxRateRules(
{
reference: "product_type",
reference_id: "ptyp_123",
tax_rate_id: "txr_123",
}
)
<TypeList types={[{"name":"data","type":"CreateTaxRateRuleDTO","description":"The tax rate rule to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"string","description":"The snake-case name of the data model that the tax rule references.\nFor example, product.\n\nLearn more in this guide.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"string","description":"The ID of the record of the data model that the tax rule references.\nFor example, prod_123.\n\nLearn more in this guide.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"string","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"MetadataType","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"null \| string","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"Context","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type TManager, which is a typed parameter passed to the context to specify the type of the transactionManager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type TManager, which is a typed parameter passed to the context to specify the type of the manager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"string","description":"A string indicating the isolation level of the context. Possible values are READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, or SERIALIZABLE.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"boolean","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"string","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"string","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"string","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"IMessageAggregator","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"string","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"boolean","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"boolean","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"boolean","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRateRules"/>
<TypeList types={[{"name":"Promise","type":"Promise<TaxRateRuleDTO>","optional":false,"defaultValue":"","description":"The created tax rate rule.","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"string","description":"The snake-case name of the data model that the tax rule references.\nFor example, product.\n\nLearn more in this guide.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"string","description":"The ID of the record of the data model that the tax rule references.\nFor example, prod_123.\n\nLearn more in this guide.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"string","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"The creation date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"The update date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"null \| string","description":"Who created the tax rate rule. For example, the ID of the user\nthat created the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"TaxRateDTO","description":"The associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"null \| number","description":"The rate to charge.","optional":false,"defaultValue":"","example":"10","expandable":false,"children":[]},{"name":"code","type":"null \| string","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","example":"VAT","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"string","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"boolean","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more here.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"boolean","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| Date","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"null \| string","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRateRules"/>
This method creates tax rate rules.
const taxRateRules =
await taxModuleService.createTaxRateRules([
{
reference: "product_type",
reference_id: "ptyp_123",
tax_rate_id: "txr_123",
},
{
reference: "product",
reference_id: "prod_123",
tax_rate_id: "txr_321",
},
])
<TypeList types={[{"name":"data","type":"CreateTaxRateRuleDTO[]","description":"The tax rate rules to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"string","description":"The snake-case name of the data model that the tax rule references.\nFor example, product.\n\nLearn more in this guide.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"string","description":"The ID of the record of the data model that the tax rule references.\nFor example, prod_123.\n\nLearn more in this guide.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"string","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"MetadataType","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"null \| string","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"Context","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type TManager, which is a typed parameter passed to the context to specify the type of the transactionManager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type TManager, which is a typed parameter passed to the context to specify the type of the manager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"string","description":"A string indicating the isolation level of the context. Possible values are READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, or SERIALIZABLE.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"boolean","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"string","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"string","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"string","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"IMessageAggregator","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"string","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"boolean","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"boolean","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"boolean","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRateRules"/>
<TypeList types={[{"name":"Promise","type":"Promise<TaxRateRuleDTO[]>","optional":false,"defaultValue":"","description":"The created tax rate rules.","expandable":false,"children":[{"name":"TaxRateRuleDTO[]","type":"TaxRateRuleDTO[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"string","description":"The snake-case name of the data model that the tax rule references.\nFor example, product.\n\nLearn more in this guide.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"string","description":"The ID of the record of the data model that the tax rule references.\nFor example, prod_123.\n\nLearn more in this guide.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"string","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"The creation date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"The update date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"null \| string","description":"Who created the tax rate rule. For example, the ID of the user\nthat created the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"TaxRateDTO","description":"The associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"null \| number","description":"The rate to charge.","optional":false,"defaultValue":"","example":"10","expandable":false,"children":[]},{"name":"code","type":"null \| string","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","example":"VAT","expandable":false,"children":[]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"string","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"boolean","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more here.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"boolean","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"string \| Date","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"string \| Date","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| Date","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"null \| string","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"null \| Record<string, unknown>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRateRules"/>