Update federal taxes

Updates employment's federal taxes.

Requirements to update federal taxes successfully:

Employment should be Global Payroll
Employment should be in the post-enrollment state
Employment should belong to USA

This endpoint requires and returns country-specific data. The exact required and returned fields will vary depending on which country the employment is in. To see the list of parameters for each country, see the Show form schema endpoint under the Countries category.

Please note that the compliance requirements for each country are subject to change according to local laws. Given its continual updates, using Remote's json-schema-form should be considered in order to avoid compliance issues and to have the latest version of a country requirements.

If you are using this endpoint to build an integration, make sure you are dynamically collecting or displaying the latest parameters for each country by querying the "Show form schema" endpoint.

For more information on JSON Schemas, see the How JSON Schemas work documentation.

To learn how you can dynamically generate forms to display in your UI, see the documentation for the json-schema-form tool.

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage employments (employments)	-	Manage employments (employment:write)

put/v1/employments/{employment_id}/federal-taxes

Request

Base URL: https://gateway.remote.com
URL: https://gateway.remote.com/v1/employments/{employment_id}/federal-taxes
Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, employment:write, employments, all:write)

Path parameters

employment_idstring required

Employment ID

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 65 revisions of this API.