Bulk get employee tax parameter settings

Changed on

Get a paginated list of tax parameter details for the employees of a company, one entry per employee and tax parameter. 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. value and effective_start are null when applied_for is true. 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/settings

Request

Query parameters

companystring required

Unique ID of the company.

as_ofstring

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.

jurisdictionstring

Used to further filter down the list of the employee’s tax parameters to specific jurisdictions.

submitterstring

Filter by submitter type. Can be employee or company.

Response

200

nextstring nullable
previousstring nullable

Example response

{
  "results": [
    {
      "id": "spa_yqVxHQZb7aVPHrh16HRq",
      "employee": "emp_Zf0tF6JdqUs3ZEjxV5Ia",
      "company": "com_Vn3UdsDvnK2I0Rk6m4Ye",
      "jurisdiction": "jur_mRpDYFyFSUD1ArZdrMis",
      "jurisdiction_abbreviation": "FED",
      "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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status