TaxRate - Tax Module Data Models Reference

This documentation provides a reference to the TaxRate data model. It belongs to the Tax Module.

idPrimaryKeyModifier<IdProperty>

The ID of the tax rate.

codeTextProperty

The code the tax rate is identified by.

nameTextProperty

The name of the tax rate

is_defaultBooleanProperty

Whether this tax rate is the default in the tax region.

is_combinableBooleanProperty

Whether the tax rate should be combined with parent rates. Learn more in this documentation.

tax_regionBelongsTo<TaxRegion>

The associated tax region.

rulesHasMany<TaxRateRule>

The associated rules.

rateFloatPropertyOptional

The rate to charge. @example 10

metadataJSONPropertyOptional

Holds custom data in key-value pairs.

created_byTextPropertyOptional

The ID of the user that created the tax rate

Was this page helpful?