Manual Tax Mapping Object


Properties
createdDatestringRead-onlyformat date-time

Date and time the manual tax mapping was created.


descriptionstringmaxLength 1000

Description of the manual tax mapping. Use this field to add context or notes about the tax rate.


exemptRatesArray <ExemptDetails>maxItems 50

Tax exemption details for user-defined exempt groups.


extendedFieldsExtendedFields

Extended fields for storing additional custom data.


idstringRead-onlyformat GUID

Manual tax mapping ID.


jurisdictionstringmaxLength 200

Name of the jurisdiction where this tax rate applies. For example, California or United Kingdom.


jurisdictionTypestring

revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the manual tax mapping is updated. To prevent conflicting changes, the current revision must be passed when updating the manual tax mapping.

Ignored when creating a manual tax mapping.


taxGroupIdstringformat GUID

Tax group ID. Tax groups define collections of items or services that share the same tax treatment.


taxNamestringmaxLength 200

Customer-facing name of the tax, shown at checkout. For example, STATE TAX, GST, or VAT.

Cosmetic only. It doesn't affect the calculated amount. Can be left empty, in which case checkout shows a default label such as Sales Tax.


taxRatestringdecimalValue {"maxScale":6,"gte":"0"}

Tax rate to apply for this tax group and region combination.

Specified as a decimal string representing a fraction, not a percentage. For example, "0.05" is 5%, "0.1" is 10%, and "0.08" is 8%. Don't pass a number (0.05), an integer (5), or a percentage string ("5%"). Up to 6 decimal places are supported.


taxRegionIdstringformat GUID

Tax region ID. Tax regions represent geographical areas where specific tax rules apply.


taxTypestringmaxLength 200

Type of tax being applied, such as VAT, GST, or Sales Tax. This depends on the jurisdiction's tax laws.


updatedDatestringRead-onlyformat date-time

Date and time the manual tax mapping was last updated.

Did this help?