REremote-com
Employee State Taxes

Show employee state taxes

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 accepts any one of the following token types:

  • Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See OAuth Assertion.
  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by the employee through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.

Scopes

Any one of the scopes in a token type's row is enough. all:read and all:write work too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Employee-scoped access tokenManage employments (employments)View personal details (personal_detail:read)Manage personal details (personal_detail:write)
Company-scoped access tokenManage employments (employments)View personal details (personal_detail:read)-
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
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: personal_detail:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:write

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

No recorded changes to this operation across all 1 revision of this API.