Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateTaxRate

Creates a tax rate.

  • CountryID is a foreign key to the Countries table, which uses the ISO 3166-2 standard as ID
  • CountrySubdivisionID is a foreign key to the CountrySubdivisions table, which uses the ISO 3166-2 standard as ID
  • TaxCodeID is a foreign key to the TaxCodes table, which can be listed using the ListTaxCodes service

Percentages are a human readable formatted result of a fraction - applications use a Rate instead as an actual result of fraction to maintain precision and integrity. If you wish to set a 21% tax percentage, that means a 1.21 tax rate. Setting a rate of 1.00 implies a 0% tax percentage, and setting to 2.00 would mean a rediculous 100% tax percentage, doubling prices. You can probably tell that a Rate of 2.00 here is much more readable than a 100% increase, but hey; nobody's forcing you to stick to percentages. At least - we're not!

Oh, and you can set a tax rate of 0.00, which would mean it will be fully sponsored by the government and will be free to purchase. The services block anything lower than 0.00 and higher than 2.00 for sanity reasons. Will recap when governments gone mad.

:key: The combination of CountryID, CountrySubdivision and TaxCodeID is unique and will be enforced by EVA.

:point_right: StartDate and EndDate are optional, and can be used to transition from one rate to a next when it changes. Both these dates are inclusive, meaning you'd want to set the EndDate of the expiring tax rate to 2018-12-31 and the StartDate of the new tax rate to 2019-01-01 (for example).

Hierarchy

  • CreateTaxRate

Index

Properties

Optional Category

Category: TaxRateCategory

Defines in which category the provided Rate falls for the provided CountryID. For example, a rate of 25% in the country Denmark should have Category = High as 25% is the high VAT rate in Denmark.

If the TaxCode used for this TaxRate is one of the predefined ones (High, Low, Zero, Exempt, Intermediate) this parameter is ignored but Category must be provided when using a custom TaxCode.

The Category Dynamic should be used for countries such as the US where the actual tax rate is context dependent and calculated dynamically.

Optional CountryID

CountryID: undefined | string

Entity type: Country

Optional CountrySubdivisionID

CountrySubdivisionID: undefined | string

Entity type: CountrySubdivision

Optional EndDate

EndDate: undefined | string

Rate

Rate: number

Range: 1-2

Optional StartDate

StartDate: undefined | string

TaxCodeID

TaxCodeID: number

Entity type: TaxCode