Skip to main content
RateDef defines a single rate inside a category

Schema ID

https://gobl.org/draft-0/tax/regime-def#/$defs/RateDef

Properties

TitlePropertyTypeDescription
Rateratecbc.KeyRate defines the key for which this rate applies.
Keyskeysarray of cbc.KeyKeys identifies the set of tax keys defined in the category that this rate can be used with.
Namenamei18n.StringHuman name of the rate
Descriptiondesci18n.StringUseful description of the rate.
Valuesvaluesarray of tax.RateValueDefValues contains a list of Value objects that contain the current and historical percentage values for the rate and additional filters. Order is important, newer values should come before older values.
Metametacbc.MetaMeta contains additional information about the rate that is relevant for local frequently used implementations.

Validation Rules

FieldTestValidation Code / Message
rate
  • Present
GOBL-TAX-RATEDEF-01
Rate is required
name
  • Present
GOBL-TAX-RATEDEF-02
Name is required
values
  • Date order
GOBL-TAX-RATEDEF-03
Rate values must be in descending chronological order
values[*].percent
  • Present
GOBL-TAX-RATEDEF-04
Rate value percent is required