Skip to main content
Version: 2.4

Currency and VAT

Currency and VAT entities provide financial reference data used by billing documents and invoice rendering. These entities define formatting behavior, precision rules, and tax rates used during amount presentation and calculations.


1. Business Meaning

1.1 Currency Governance

Currency controls:

  • currency code/name identity,
  • symbol and symbol placement,
  • decimal precision in GUI and invoice output,
  • lifecycle validity and localization.

1.2 VAT Governance

VatRate controls configurable tax rates with validity windows. It allows project-level VAT changes over time without schema changes in billing document models.


2. Entity Reference: Currency (Currency)

FieldTypeRequiredRead-onlyDescription
idUUIDNoNoCurrency primary key.
nameStringYesNoCurrency display name.
codeStringYesNoCurrency technical/business code.
positionCurrencyPositionNoNoSymbol position (PREFIX or SUFFIX, default SUFFIX).
symbolStringYesNoCurrency symbol shown in UI/invoices.
precisionGUIIntYesNoNumber of decimal places shown in UI.
precisionInvoiceIntYesNoNumber of decimal places shown on invoice output.
validityFromDateNoNoValidity start.
validityToDateNoNoValidity end.
descriptionStringNoNoOptional description.
localizationDataLocalizationDataNoNoLocalization payload.
dataTagsList<String>NoNoOptional labels/tags.
configMap<String, Any?>NoNoAdditional configuration payload.

3. Entity Reference: VatRate (VatRate)

FieldTypeRequiredRead-onlyDescription
idUUIDNoNoVAT rate primary key.
codeStringYesNoVAT technical code.
nameStringYesNoVAT display name.
validityFromDateNoNoValidity start.
validityToDateNoNoValidity end.
descriptionStringNoNoOptional VAT description.
localizationDataLocalizationDataNoNoLocalization payload.
dataTagsList<String>NoNoOptional labels/tags.
configMap<String, Any?>NoNoAdditional configuration payload.
rateDoubleYesNoVAT percentage/rate value.

4. Enum Reference: CurrencyPosition (CurrencyPosition)

ValueMeaning
PREFIXDisplay currency symbol before amount (for example $ 10.00).
SUFFIXDisplay currency symbol after amount (for example 10.00 Kč).