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"
}
Attribute | Description |
---|---|
id string | Unique identifier for the tax parameter. |
label | Short human-readable description identifying the tax parameter. |
description | Human-readable description identifying the tax parameter. |
name | Non-unique identifier for the tax parameter. |
options |
|
type | The tax parameter type. See types of tax parameters for a complete list of supported types. |
depends_on | (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 | Indicates whether the tax parameter can be edited. |
effective_datable | Indicates whether the tax parameter can be effective dated. |
can_be_applied_for | Indicates whether the tax parameter can be marked as applied for. |
jurisdiction | ID of tax parameter’s jurisdiction. |
tax |
|
setting |
|
valid_formats |
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 |
|
default_value |
|
help_links |
|
submitter | The entity that should submit this parameter. Can be either |