Employee Federal Taxes

Show employee federal taxes

Returns the authenticated employee's saved US federal tax (W-4) answers, keyed like the global_payroll_federal_taxes form so they can pre-fill it. federal_taxes is null when nothing has been saved yet.

Available for US Global Payroll employees once they reach the post-enrollment state. Calls made before then return a 404.

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/federal-taxes

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/employee/federal-taxes
  • 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

Response

Success

Example response

{
  "data": {
    "federal_taxes": {
      "deductions": 99900,
      "dependents_amount": 500,
      "extra_withholding": 1200,
      "filing_status": "Married",
      "other_income": 56700,
      "two_jobs": "yes"
    }
  }
}

Changes

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