Employments
Employee State Taxes

Show employee state taxes

Changed on

Returns the authenticated employee's saved US state tax withholding answers for a single jurisdiction (e.g. NY), keyed like that jurisdiction's global_payroll_state_taxes form so they can pre-fill it. state_taxes is null when nothing has been saved yet.

Returns a 404 when the employment has no state tax form for the jurisdiction.

Authentication

This endpoint requires the following token type:

  • Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See Authentication for partners.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)View personal details (personal_detail:read)Manage personal details (personal_detail:write)
get/v1/employee/state-taxes/{jurisdiction}

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/employee/state-taxes/{jurisdiction}
  • Auth: OAuth 2 (client credentials, token URL /auth/oauth2/token, scopes: personal_detail:read, personal_detail:write, employments, all:write, all:read)

Path parameters

jurisdictionstring required

Two-letter US state/jurisdiction code

Response

Success

Example response

{
  "data": {
    "state_taxes": {
      "allowances": 2,
      "extra_withholding": 50,
      "filing_status": "Single"
    }
  }
}

Changes