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)--
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Employee federal taxes params

Federal taxes schema compatible params.

federal_taxes
object
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.

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json