Upsert engagement agreement details
Changed onCreates or updates the engagement agreement details for an employment.
This endpoint requires country-specific data. The exact required 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 compliance requirements for each country are subject to change according to local laws. Using Remote's json-schema-form is recommended to avoid compliance issues and to have the latest version of a country's requirements.
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) |
Request
- Base URL: https://gateway.remote.com
- URL: https://gateway.remote.com/v1/employments/{employment_id}/engagement-agreement-details
- 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 ID
Request body
Example request
{
"engagement_agreement_details": {
"allowances_details": [
"meal_allowance",
"transportation_commuter_allowance"
],
"available_pto": 20,
"break_time_per_day": 1,
"business_expenses": "Business expenses details",
"cba": "CBA 1",
"cba_document": [
{
"content": "JVBERi0xLjQKJSBDQkEgZG9jdW1lbnQK",
"name": "cba_document.pdf"
}
],
"covenants": [
"confidentiality",
"non_compete"
],
"has_allowances": "yes",
"has_bonus": "yes",
"has_business_expenses": "yes",
"has_business_presence": "yes",
"has_cba": "yes",
"has_commissions": "yes",
"has_covenants": "yes",
"has_illness_remuneration": "yes",
"has_overtime_compensation": "yes",
"has_pension_scheme": "yes",
"has_signing_bonus": "yes",
"has_similar_roles": "yes",
"has_similar_work_conditions": "yes",
"illness_remuneration_details": "Illness remuneration details",
"max_annual_gross_salary": 100000,
"min_annual_gross_salary": 50000,
"overtime_compensation_begins": 10,
"overtime_compensation_type": "extra_pay",
"overtime_pay_percentage": 5,
"pension_scheme": "Pension scheme details",
"similar_roles": "Role 1, Role 2, Role 3",
"similar_work_conditions_details": "Similar work conditions details",
"work_hours_per_week": 40,
"working_days": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
]
}
}Response
Success
Example response
{
"data": {
"status": "ok"
}
}Changes
- info
the
//request property type was generalized fromintegertonumber, and format from no format todouble
- info
- breaking
the
//request property type changed fromobjecttoarray
- breaking