Documentation
Documentation
Tax Rule
Close
Tax Rule

A tax rule is a collection of tax rates. Each rate may apply a different tax on a given amount according to different rules.

States
  • Create
    The create state indicates that the Tax Rule is in creation.
  • Active
    The active state indicates that the Tax Rule is active and may be used.
  • Inactive
    The inactive state indicates that the Tax Rule is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Tax Rule is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Class
  • ID
    A unique identifier for the object.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Name
    The tax rule name is shown during the payment process. Choose an appropriate name as it will be displayed to your customer.
  • 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.
  • State
    The object's current state.

    A tax rule can have the following states:

    Active

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

    Inactive

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

    Deleting

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

    Deleted

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

  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.