Employments
Employee Federal Taxes

Show employee federal taxes

Changed on

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 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/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, personal_detail:write, employments, all:write, all:read)

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