Documentation
Documentation
    • English (United States)
Tax Rate
Close
Tax Rate

Each tax rate can define a certain percentage which should be applied depending on some rules (country, state, post code).

States
  • Create
    The create state indicates that the Tax Rate is in creation.
  • Active
    The active state indicates that the Tax Rate is active and may be used.
  • Inactive
    The inactive state indicates that the Tax Rate is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Tax Rate is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Country
    The country to which the tax rate should be limited to. If some country is provided the tax rate is applied only in this country.
  • ID
    A unique identifier for the object.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Planned Purge Date
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • Postcode Pattern
    The postcode pattern can be used to restrict the application of the tax rate to certain postcodes. The place holder '*' can be used to replace any chars. E.g. The pattern '40*' will restrict this tax rate to all post codes which starts with 40. The pattern '34*4' will apply the tax rule to all post codes which starts with 34 and ends with 4. Examples which matches the pattern '34*4': 344, 34567894
  • Priority
    In case multiple rates matches the criteria the priority determines the tax rate which is applied. The lower the value, the higher the priority is going to be. This value can also be a negative number.
  • Rate
    The rate is the actual rate which gets applied. Use the actual percentages: e.g. for 10% tax this value is 10.
  • State
    The object's current state.

    A tax rate can have the following states:

    Active

    When the state is set to Active the tax rate can be applied.

    Inactive

    When the state is set to Inactive the tax rate is ignored. However, all the information is not deleted and you can reactivate it at any moment.

    Deleting

    The tax rate is in the process of deletion. This may take some time until the tax rate is marked as Deleting before being marked as Deleted.

    Deleted

    The tax rule is deleted. Since the tax rate is linked with data which cannot be deleted immediately, we need to keep it until all the data can be removed.

  • State of the country
    The state to which the rate should be limited to. If some state is provided the rate is applied only in this state.
  • Tax Rule
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.