The tax parameter object

Represents the tax parameter that are available to companies and employees.

Use the tax parameter to show the information that needs to be collected from companies and employees.

{
  "id": "spa_h7zSw4NITCtef4Taf5yA",
  "label": "Federal Employer Identification Number",
  "description": "Enter your FEIN in the following format XX-XXXXXXX",
  "name": "federal_ein",
  "type": "string",
  "options": null,
  "depends_on": null,
  "editable": true,
  "effective_datable": false,
  "can_be_applied_for": true,
  "jurisdiction": "jur_mRpDYFyFSUD1ArZdrMis",
  "tax": "tax_afRJqY785WwYH0PrtFde",
  "setting": null,
  "valid_formats": [
      {
        "format": "##-#######"
      }
    ],
  "definitions": null,
  "default_value": null,
  "help_links": null,
  "submitter": "company"
}
AttributeDescription
id
string
Unique identifier for the tax parameter.
label
string
Short human-readable description identifying the tax parameter.
description
string
Human-readable description identifying the tax parameter.
name
string
Non-unique identifier for the tax parameter.
options
list
(Optional) List representation of the allowed value options when the type == select. See Tax Parameter Option.
type
string
The tax parameter type. See types of tax parameters for a complete list of supported types.
depends_on
object
(Optional) Representation of the dependency that this tax parameter has on another tax parameter. See Tax Parameter Dependency object. Dependencies are not fully supported for employee tax parameters.
editable
boolean
Indicates whether the tax parameter can be edited.
effective_datable
boolean
Indicates whether the tax parameter can be effective dated.
can_be_applied_for
boolean
Indicates whether the tax parameter can be marked as applied for.
jurisdiction
string
ID of tax parameter’s jurisdiction.
tax
string
(Optional) ID of the tax parameter’s related tax.
setting
object
(Optional) Representation of the tax parameter. See Tax Parameter Setting.
valid_formats
list
(Optional) List representation of the the accepted formats for a particular tax parameter.

A "#" indicates any numeric number (0-9) and a "@" indicates any alphanumeric value (0-9 or A-Z) at that particular position. Any other character outside of those two represent the actual character.

For example: If the format is "12-###" then the accepted values must start with "12-".
definitions
list
(Optional) A list of effectively dated tax parameter definitions organized by the effective date sorted in a descending order. See Tax Parameter Definition.
default_value
string
(Optional) The default value used for the tax parameter for informational purposes. The default_value for a parameter with a non-empty options list will always correspond to the value of one of those options.

Note: The API does not automatically populate the tax parameter with this value.
help_links
list
(Optional) A list representing different websites that contain further information associated with the tax parameter. The objects within the list will always have a label and url field.
submitter
string
The entity that should submit this parameter. Can be either company or employee.