v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

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.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage employments (employments)	-	Manage personal details (personal_detail:write)

put/v1/employee/federal-taxes

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"
  }
}