Create employment

post

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

Creates an employment without provisional_start_date validation.

This endpoint is only available in Sandbox and allows creating employments which
provisional_start_date is in the past. This is especially helpful for:

Testing the Timeoff Balance endpoints
Testing the Offboarding endpoints
Testing features around probation periods

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

For creating an employment's parameters outside of testing purposes, use this
Employment create endpoint

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Employment params

Description of the basic required and onboarding tasks params to create an employment.
You do not need to include all onboarding tasks when creating or updating an employment.

basic_information

object

required

Employment basic information. As its properties may vary depending on the country,
you must query the Show form schema endpoint
passing the country code and employment_basic_information as path parameters.

bill_to_legal_entity_id

string

Id of the legal entity that should be billed for the employment. If omitted, falls back to engaged_by_legal_entity_id. For EOR and Contractor employments this may differ from engaged_by_legal_entity_id. For Global Payroll and Direct (HRIS) employments it must match engaged_by_legal_entity_id.

company_id

string

This optional field is deprecated.

country_code

string

required

The ISO 3166-1 3-letter country code where the employee will be based (e.g., AUS, GBR, USA).

engaged_by_entity_slug

string

deprecated

Deprecated alias for engaged_by_legal_entity_id. Use engaged_by_legal_entity_id instead.

engaged_by_legal_entity_id

string

Id of the legal entity that engages the employee or contractor. Required for Global Payroll employees. For EOR and Contractor employments this may differ from bill_to_legal_entity_id. For Global Payroll and Direct (HRIS) employments it must match bill_to_legal_entity_id.

external_id

string

length ≤ 64

A unique reference code for the employment record in a non-Remote system. This optional field links to external data sources. If not provided, it defaults to null. While uniqueness is recommended, it is not strictly enforced within Remote's system.

partner_external_id

string | null

A reference code for the employment record in the calling integration's own system.
Private to that integration — no other integration can read or overwrite it.
Omit the field to leave the value unchanged; send null to clear it. Surrounding
whitespace is trimmed off. It can be set at any employment status, and the same
value may be used on several employments (for example a rehire).

type

string

enum

If not provided, it will default to employee.

Allowed:

Responses

Callback

201Success

400Bad Request

401Unauthorized

404Not Found

422Unprocessable Entity

429Too many requests