API Reference

Update employment

patch
https://gateway.remote.com/v1/sandbox/employments/

Updates an employment. Use this endpoint to:

  • modify employment states for testing
  • Backdate employment start dates

This endpoint will respond with a 404 outside of the Sandbox environment.

partner_external_id cannot be updated here and is ignored if sent, like any other
unsupported field. Set it with PATCH /api/eor/v1/employments/{employment_id} instead.

For updating an employment's parameters outside of testing purposes, use this Employment update endpoint.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Employment ID

Query Params
boolean

When true, returns tax_servicing_countries grouped into global/regions/subregions instead of a flat list of country names.

Body Params

Employment params

Required params to update an employment in the Sandbox environment.

Currently supports setting the Employment Status to active and backdating the employment start date.

All fields other than the ones listed are ignored.

date
string
enum

The current status of the employment record.

  • active: The employee is fully onboarded and actively working.
  • created: The employment has been created but onboarding has not started.
  • pre_hire: A pre-hire employment record, created before formal onboarding begins.
  • created_awaiting_reserve: The employment is created but waiting for a risk reserve deposit to be paid.
  • created_reserve_paid: The risk reserve has been paid and the employment can proceed with onboarding.
  • initiated: Onboarding has been started by the employer.
  • invited: The employee has been invited to complete their self-enrollment on Remote.
  • pending: The employment is pending review or further action before it can become active.
  • review: The employment is under review by Remote (e.g., contract or compliance review).
  • job_title_review: The job title is pending verification by Remote; once approved, the employment returns to created.
  • pending_post_self_enrollment_actions: Self-enrollment is complete, but some actions are still missing before the employment can be activated.
  • archived: The employment has been terminated or offboarded.
  • deleted: The employment record has been deleted.
Responses

Callback

Updated 5 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?