GuidesReferenceChangelogAPI Upgrades

Tax parameter definition

Represents the type-specific properties of the tax parameter setting value.

🚧

Tax Parameter Type Limitation

Currently, definitions are only supported for tax parameters of type "percent". All other tax parameter types will have the "definitions" field set as null.

See all available tax parameter types here.

The following list of effectively dated definitions is used to provide validation or guidance for the tax parameter setting values. For tax parameters with multiple definitions effective at different dates, the definitions will be sorted in a descending order where the definition with the most recent effective date will appear first.

[
  {
    "effective_date": "2022-01-01",
    "properties": {
      "min_value": "1.00000",
      "max_value": "10.00000",
      "allowed_values": [
        "5.00000",
        "6.00000"
      ],
      "new_company_values": [
        {
          "industry_label": "Default",
          "value": "5.00000",
        }
      ]
    }
  }
]
AttributeDescription
effective_date
YYYY-MM-DD		Date representing when the properties of the definition will start being effective.
properties
object		An object consisting of different tax parameter type-specific properties associated with the tax parameter value. See more details here.

Properties Object

An object consisting of type-specific properties associated with the tax parameter value. The properties can be used to for validation or for informational purposes.

The attributes within the properties object can change depending on the tax parameter type.

Percent-specific Properties

The following attributes are only applicable for tax parameters with type "percent":

AttributeDescription
min_value
decimal		(Optional) The smallest possible value for the tax parameter setting value.

Used to validate the tax parameter setting value.
max_value
decimal		(Optional) The largest possible value for the tax parameter setting value.

Used to validate the tax parameter setting value.
allowed_values
list		(Optional) A list of allowed values for the tax parameter setting value.

Used to validate the tax parameter setting value.
new_company_values
list		(Optional) A list of objects to represent common values for new companies depending on industry type. The industry_label attribute represents the human readable name of the industry and the value attribute represents the common value for that particular industry.

These are common values for new companies that are used for informational purposes, but it is highly recommend to input the assigned tax value from the company's state tax agency notice instead.