chore(docs): Updated API Reference (v2) (#9148)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
a63f6910d0
commit
56ee4d6aad
@@ -1,5 +1,5 @@
|
||||
type: object
|
||||
description: SUMMARY
|
||||
description: The tax rate's details.
|
||||
x-schemaName: AdminCreateTaxRate
|
||||
required:
|
||||
- name
|
||||
@@ -9,18 +9,20 @@ properties:
|
||||
type: string
|
||||
title: name
|
||||
description: The tax rate's name.
|
||||
example: VAT
|
||||
tax_region_id:
|
||||
type: string
|
||||
title: tax_region_id
|
||||
description: The tax rate's tax region id.
|
||||
description: The ID of the tax region this rate belongs to.
|
||||
rate:
|
||||
type: number
|
||||
title: rate
|
||||
description: The tax rate's rate.
|
||||
description: The rate to charge.
|
||||
example: 10
|
||||
code:
|
||||
type: string
|
||||
title: code
|
||||
description: The tax rate's code.
|
||||
description: The code the tax rate is identified by.
|
||||
rules:
|
||||
type: array
|
||||
description: The tax rate's rules.
|
||||
@@ -29,11 +31,14 @@ properties:
|
||||
is_default:
|
||||
type: boolean
|
||||
title: is_default
|
||||
description: The tax rate's is default.
|
||||
description: Whether the tax rate is the default in its tax region.
|
||||
is_combinable:
|
||||
type: boolean
|
||||
title: is_combinable
|
||||
description: The tax rate's is combinable.
|
||||
description: Whether the tax rate should be combined with parent rates.
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates
|
||||
metadata:
|
||||
type: object
|
||||
description: The tax rate's metadata.
|
||||
description: The tax rate's metadata, used to store custom key-value pairs.
|
||||
|
||||
Reference in New Issue
Block a user