CHcheckhq

Get a specific employee's tax parameter setting

Changed on

Get an employee’s tax parameter detail. The top-level value and effective_start are the value in force on as_of, today by default: what applies when. settings lists every recorded value that has not been deleted, newest effective_start first and, within one effective_start, newest created_at first: what changed. A tax parameter written more than once with the same effective_start lists every write. The entry with the latest created_at for an effective_start is the value in force from that date, and each earlier entry for that date was replaced at the created_at of the entry listed above it. Deleted values are not listed, including earlier values replaced by a form submission. For a tax parameter that is not effective dated, value is the current value and effective_start is null. Each entry in settings carries an actor object naming the party that wrote that value: check, partner, company, or employee. party classifies the actor, not the setting’s subject, so a company user who edits an employee-scoped setting reads as company. actor is null when the attribution cannot be recovered.

get/employee_tax_params/{employee_id}/settings/{tax_param_id}

Request

Path parameters

employee_idstring required

ID of the employee used to get the applicable tax parameter details.

tax_param_idstring required

ID of the tax parameter used to detail the values.

Query parameters

as_ofstring date

Date that selects the top-level value and effective_start: the value in force on this date. Defaults to today. Does not filter settings, which lists every recorded value. Ignored for a tax parameter that is not effective dated.

Response

200

idstring
jurisdictionstring
applied_forunknown
valuestring nullable

The value in force on as_of.

effective_startstring date nullable

The effective_start of the value in force on as_of. null for a tax parameter that is not effective dated.

Example response

{
  "id": "spa_yqVxHQZb7aVPHrh16HRq",
  "jurisdiction": "jur_mRpDYFyFSUD1ArZdrMis",
  "value": "M",
  "effective_start": "2021-03-15",
  "settings": [
    {
      "value": "M",
      "effective_start": "2021-03-15",
      "created_at": "2021-03-16T10:41:27.385220Z",
      "actor": {
        "party": "employee"
      }
    }
  ]
}

Changes