Tax

Core tax definition entity. Represents a tax type with its basic configuration (rate, type, jurisdiction). Base entity for tax management system.

13 properties

Schema

Properties

Property	Type	Mode	Description	Required
code	string	stored	Unique tax code identifier Example: `"VAT-STD-20"`	Required
name	string	stored	Display name of the tax Example: `"VAT Standard Rate"`	Required
description	string	stored	Detailed description of the tax and when it applies Example: `"Standard VAT rate applicable to most goods and services"`	Optional
taxType	string	enum	Category of tax Values: `vat, sales_tax, gst, pst, hst, use_tax, withholding, excise, customs, service_tax, luxury_tax, import_duty, export_duty, carbon_tax, environmental_tax, digital_services_tax, financial_transaction_tax, stamp_duty, tourism_tax, hotel_tax, gambling_tax, payroll_tax, social_security_tax, property_tax, inheritance_tax, gift_tax, capital_gains_tax, zakat, other` Example: `"vat"`	Required
rate	number	stored	Tax rate as percentage (e.g., 20 for 20%) Example: `20`	Required
calculationMethod	string	enum	Method used to calculate the tax Values: `percentage, percentage_tax_included, fixed_amount, tiered, progressive, compound, per_unit` Example: `"percentage"`	Required
jurisdictionRef	TaxJurisdiction	stored	Reference to the tax jurisdiction entity with authority details and hierarchy	Required
jurisdiction	string	stored	Tax jurisdiction code (ISO country code, state, province, city) - Deprecated: use jurisdictionRef Example: `"FR"`	Optional
jurisdictionLevel	string	enum	Level of the tax jurisdiction - Deprecated: use jurisdictionRef.level Values: `federal, country, state, province, city, district, postal_code` Example: `"country"`	Optional
isActive	boolean	stored	Whether this tax is currently active Example: `true`	Optional
effectiveFrom	Date	stored	Date from which this tax rate is effective Example: `"2024-01-01"`	Required
effectiveUntil	Date	stored	Date until which this tax rate is valid (null if indefinite) Example: `"2024-12-31"`	Optional
displayOrder	number	stored	Order in which to display this tax on documents Example: `1`	Optional

Examples

Example 1

{
  "@type": "Tax",
  "code": "VAT-STD-20",
  "name": "VAT Standard Rate",
  "description": "Standard VAT rate in France",
  "taxType": "vat",
  "rate": 20,
  "calculationMethod": "percentage",
  "jurisdiction": "FR",
  "jurisdictionLevel": "country",
  "isActive": true,
  "effectiveFrom": "2014-01-01",
  "displayOrder": 1
}

Example 2

{
  "@type": "Tax",
  "code": "NY-SALES-8.875",
  "name": "New York Sales Tax",
  "taxType": "sales_tax",
  "rate": 8.875,
  "calculationMethod": "percentage",
  "jurisdiction": "NY",
  "jurisdictionLevel": "state",
  "isActive": true,
  "effectiveFrom": "2024-01-01",
  "displayOrder": 1
}

Example 3

{
  "@type": "Tax",
  "code": "DZ-TVA-19",
  "name": "TVA Algérie",
  "description": "Taxe sur la Valeur Ajoutée en Algérie",
  "taxType": "vat",
  "rate": 19,
  "calculationMethod": "percentage",
  "jurisdiction": "DZ",
  "jurisdictionLevel": "country",
  "isActive": true,
  "effectiveFrom": "2024-01-01",
  "displayOrder": 1
}