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
}

Attribute

Description

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.

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.