REremote-com
Employee State Taxes

Submit employee state taxes

Submits the authenticated employee's US state tax withholding answers for a single jurisdiction (e.g. NY).

Available for US Global Payroll employees once they reach the post-enrollment state, at which point the per-jurisdiction state tax task exists.

This endpoint requires country/jurisdiction-specific data. Query the Show form schema endpoint with global_payroll_state_taxes as the form name to discover the schema for a given country.

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:write works too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Employee-scoped access tokenManage employments (employments)-Manage personal details (personal_detail:write)
Company-scoped access tokenManage employments (employments)--
put/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:write
    • 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: employments
    • 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

Request body

state_taxesobject required

State taxes params for the jurisdiction in the path. As its properties vary depending on the country and jurisdiction, you must query the Show form schema endpoint passing the country code and global_payroll_state_taxes as path parameters.

Example request

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

Response

Success

Example response

{
  "data": {
    "status": "ok"
  }
}

Changes

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