REremote-com
Employee Federal Taxes

Submit employee federal taxes

Submits the authenticated employee's US federal tax (W-4) details.

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

This endpoint requires country-specific data. Query the Show form schema endpoint with global_payroll_federal_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/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: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

Request body

federal_taxesobject required

Federal taxes params. As its properties may vary depending on the country, you must query the Show form schema endpoint passing the country code and global_payroll_federal_taxes as path parameters.

Example request

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

Response

Success

Example response

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

Changes

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