docs: generate references manually for v2.1.2 (#10639)
* docs: manually generate references for v2.1.2 * more changes
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
ee62083c52
commit
0f5d640736
196 files changed
+267336
-200539
No files matched your search
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: taxModelReference
|
||||
slug: /references/tax/models/TaxProvider
|
||||
sidebar_label: TaxProvider
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# TaxProvider - Tax Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the TaxProvider . This belongs to the Tax Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`\"is_enabled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="TaxProvider"/>
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: taxModelReference
|
||||
slug: /references/tax/models/TaxRate
|
||||
sidebar_label: TaxRate
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# TaxRate - Tax Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the TaxRate . This belongs to the Tax Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"[TaxRegion](../tax_models.TaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"provider","type":"[TaxProvider](../tax_models.TaxProvider/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`\"is_enabled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"parent","type":"[TaxRegion](../tax_models.TaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"provider","type":"[TaxProvider](../tax_models.TaxProvider/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"parent","type":"[TaxRegion](../tax_models.TaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"Collection<[TaxRate](page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"Collection<[TaxRegion](../tax_models.TaxRegion/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_rates","type":"Collection<[TaxRate](page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","dLine truncated
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: taxModelReference
|
||||
slug: /references/tax/models/TaxRateRule
|
||||
sidebar_label: TaxRateRule
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# TaxRateRule - Tax Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the TaxRateRule . This belongs to the Tax Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[TaxRate](../tax_models.TaxRate/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"[TaxRegion](../tax_models.TaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"provider","type":"[TaxProvider](../tax_models.TaxProvider/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"parent","type":"[TaxRegion](../tax_models.TaxRegion/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"Collection<[TaxRate](../tax_models.TaxRate/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"Collection<[TaxRegion](../tax_models.TaxRegion/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"Collection<[TaxRateRule](page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[TaxRate](../tax_models.TaxRate/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optLine truncated
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
displayed_sidebar: taxModelReference
|
||||
slug: /references/tax/models/TaxRegion
|
||||
sidebar_label: TaxRegion
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# TaxRegion - Tax Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the TaxRegion . This belongs to the Tax Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"provider","type":"[TaxProvider](../tax_models.TaxProvider/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`\"is_enabled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"parent","type":"[TaxRegion](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"provider","type":"[TaxProvider](../tax_models.TaxProvider/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"`\"is_enabled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"parent","type":"[TaxRegion](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"provider","type":"[TaxProvider](../tax_models.TaxProvider/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"parent_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"parent","type":"[TaxRegion](page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"Collection<[TaxRate](../tax_models.TaxRate/page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"Collection<[TaxRegion](page.mdx), object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"[OptionalProps]","type":"[SoftDeletableModelDateColumns](../../../types/DAL/types/types.DAL.SoftDeletableModelDateColumns/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_rates","type":"Collection<[TaxRate](../tax_models.TaLine truncated
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: taxModelReference
|
||||
slug: /references/tax/models/TaxProvider
|
||||
sidebar_label: TaxProvider
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# TaxProvider - Tax Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the TaxProvider data model. It belongs to the Tax Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the tax provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"HasMany<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The regions that use this provider to calculate taxes.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the tax region.\n\n@example us","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"HasMany<() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; country_code: TextProperty; province_code: NullableModifier<string, TextProperty>; ... 5 more ...; tax_rates: HasMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"TaxRegion\">>","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rates","type":"HasMany<[TaxRate](../tax_models.TaxRate/page.mdx)>","description":"The associated tax rates.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`BooleanProperty`","description":"Whether this tax rate is the default in the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`BooleanProperty`","description":"Whether the tax rate should be combined with parent rates. Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"BelongsTo<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The associated tax region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany<[TaxRateRule](../tax_models.TaxRateRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate to charge.\n\n@example 10","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the tax rate","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"province_code","type":"`TextProperty`","description":"The province code of the tax region","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the tax region","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"BelongsTo<[TaxProvider](page.mdx)>","description":"The provider that calculates taxes in this region.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`BooleanProperty`","description":"Whether the tax provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"HasMany<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The regions that use this provider to calculate taxes.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"parent","type":"BelongsTo<() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; country_code: TextProperty; province_code: NullableModifier<string, TextProperty>; ... 5 more ...; tax_rates: HasMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"TaxLine truncated
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: taxModelReference
|
||||
slug: /references/tax/models/TaxRate
|
||||
sidebar_label: TaxRate
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# TaxRate - Tax Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the TaxRate data model. It belongs to the Tax Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`BooleanProperty`","description":"Whether this tax rate is the default in the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`BooleanProperty`","description":"Whether the tax rate should be combined with parent rates. Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"BelongsTo<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The associated tax region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the tax region.\n\n@example us","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"HasMany<() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; country_code: TextProperty; province_code: NullableModifier<string, TextProperty>; ... 5 more ...; tax_rates: HasMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"TaxRegion\">>","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rates","type":"HasMany<[TaxRate](page.mdx)>","description":"The associated tax rates.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`BooleanProperty`","description":"Whether this tax rate is the default in the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`BooleanProperty`","description":"Whether the tax rate should be combined with parent rates. Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"BelongsTo<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The associated tax region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"HasMany<[TaxRateRule](../tax_models.TaxRateRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rate","type":"`FloatProperty`","description":"The rate to charge.\n\n@example 10","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the tax rate","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"province_code","type":"`TextProperty`","description":"The province code of the tax region","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the tax region","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"BelongsTo<[TaxProvider](../tax_models.TaxProvider/page.mdx)>","description":"The provider that calculates taxes in this region.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":Line truncated
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: taxModelReference
|
||||
slug: /references/tax/models/TaxRateRule
|
||||
sidebar_label: TaxRateRule
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# TaxRateRule - Tax Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the TaxRateRule data model. It belongs to the Tax Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"BelongsTo<[TaxRate](../tax_models.TaxRate/page.mdx)>","description":"The associated tax rate.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`BooleanProperty`","description":"Whether this tax rate is the default in the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`BooleanProperty`","description":"Whether the tax rate should be combined with parent rates. Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"BelongsTo<[TaxRegion](../tax_models.TaxRegion/page.mdx)>","description":"The associated tax region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the tax region.\n\n@example us","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"HasMany<() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; country_code: TextProperty; province_code: NullableModifier<string, TextProperty>; ... 5 more ...; tax_rates: HasMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"TaxRegion\">>","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rates","type":"HasMany<[TaxRate](../tax_models.TaxRate/page.mdx)>","description":"The associated tax rates.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"province_code","type":"`TextProperty`","description":"The province code of the tax region","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the tax region","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"BelongsTo<[TaxProvider](../tax_models.TaxProvider/page.mdx)>","description":"The provider that calculates taxes in this region.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"parent","type":"BelongsTo<() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; country_code: TextProperty; province_code: NullableModifier<string, TextProperty>; ... 5 more ...; tax_rates: HasMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"TaxRegion\">>","description":"The tax region's parent.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"rules","type":"HasMany<[TaxRateRule](page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"BelongsTo<[TaxRate](../tax_models.TaxRate/page.mdx)>","description":"The associated tax rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"reference","type":"`TextProperty`","description":"The name of the table this rule references.\n\n@example product\\_type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`TextProperty`","description":"The id of a record in the table that this rule references.\n\n@example ptyp\\_1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the tax rate rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rate","tyLine truncated
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
displayed_sidebar: taxModelReference
|
||||
slug: /references/tax/models/TaxRegion
|
||||
sidebar_label: TaxRegion
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# TaxRegion - Tax Module Data Models Reference
|
||||
|
||||
This documentation provides a reference to the TaxRegion data model. It belongs to the Tax Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the tax region.\n\n@example us","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"HasMany<() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; country_code: TextProperty; province_code: NullableModifier<string, TextProperty>; ... 5 more ...; tax_rates: HasMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"TaxRegion\">>","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rates","type":"HasMany<[TaxRate](../tax_models.TaxRate/page.mdx)>","description":"The associated tax rates.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`BooleanProperty`","description":"Whether this tax rate is the default in the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`BooleanProperty`","description":"Whether the tax rate should be combined with parent rates. Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region","type":"BelongsTo<[TaxRegion](page.mdx)>","description":"The associated tax region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`TextProperty`","description":"The country code of the tax region.\n\n@example us","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"children","type":"HasMany<() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; country_code: TextProperty; province_code: NullableModifier<string, TextProperty>; ... 5 more ...; tax_rates: HasMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"TaxRegion\">>","description":"The tax region's children..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rates","type":"HasMany<[TaxRate](../tax_models.TaxRate/page.mdx)>","description":"The associated tax rates.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"province_code","type":"`TextProperty`","description":"The province code of the tax region","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`TextProperty`","description":"The ID of the user that created the tax region","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"BelongsTo<[TaxProvider](../tax_models.TaxProvider/page.mdx)>","description":"The provider that calculates taxes in this region.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"parent","type":"BelongsTo<() => DmlEntity<{ id: PrimaryKeyModifier<string, IdProperty>; country_code: TextProperty; province_code: NullableModifier<string, TextProperty>; ... 5 more ...; tax_rates: HasMany<...>; } & { ...; } & {} & DMLSchemaDefaults, \"TaxRegion\">>","description":"The tax region's parent.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"rules","type":"HasMany<[TaxRateRule](../tax_models.TaxRateRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"BelongsTo<[TaxRate](../tax_models.TaxRate/page.mdx)>","description":"The associated tax rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"reference","type":"`TextProperty`","description":"The name of the table this rule references.\n\n@example product\\_type","optional":false,"defaultValue":"","expandable":false,"children":[Line truncated
|
||||
Reference in new issue
Block a user