2024
2024-10-28
Improvement
Only exposes file that can be downloaded by the current API user in show employment endpoint
Only list files that can be downloaded by the current API user in the file section of the show employment endpoint.
2024-10-18
Improvement
Expose benefit_renewal_response field in show and list benefit renewal request endpoints
Added benefit_renewal_response
field in show and list benefit renewal request endpoints.
2024-10-11
Feature
New endpoint was added to cancel an onboarding
When Employment is in status
invited
created
created_awaiting_reserve
created_reserve_paid
pre_hire
And the contract has not been signed by the employee we are able to cancel the onboarding, otherwise this error message is shownEmployment not eligible for Onboarding Cancellation
.
2024-10-10
Improvement
Expose has_night_hours, has_weekend_hours and has_holiday_hours in timesheet API timetracking field
Added has_night_hours
, has_weekend_hours
and has_holiday_hours
fields in timetracking for the timesheet API.
2024-10-09
Feature
New endpoint was added to send a timesheet back to the employee for review or modification
Given a timesheet_id
and a sent_back_reason
, this endpoint (POST api/v1/timesheets/:timesheet_id/send-back
) will send an existing timesheet back to the employee in case some review or modification should happen.
2024-10-04
Improvement
Expose Employment Short ID and External ID in Employment Resource Listings and Fetches
We've updated the GET v1/employments/
and GET v1/employments/:employment_id/
endpoints. They now return the short_id
and external_id
for each employment. For more details, please refer to the API Spec Pages.
Specify External ID When Creating an Employment
We've updated the POST v1/employment
endpoint to accept an external ID through the external_id
parameter. While we recommend keeping this ID unique, we don't enforce uniqueness. For more details, please refer to the API Spec Pages.
Update an Employment’s External ID
We've updated the PATCH v1/employment/:employment_id
endpoint to accept an external ID through the external_id
parameter. While we recommend keeping this ID unique, we don't enforce uniqueness. For more details, please refer to the API Spec Pages.
Expose Employment ID in Contractor Invoice Resource Listings and Fetches
We've updated the GET v1/contractor-invoices/
and GET v1/contractor-invoices/:invoice_id/
endpoints. They now return the employment_id
associated with each Contractor Invoice. For more details, please refer to the API Spec Pages.
2024-08-19
Feature
Introduce the Show Company Manager User endpoint
Added the GET v1/company-managers/:user_id
endpoint for showing a company manager user. Fore more information, see the API Spec Pages.
2024-08-11
Feature
New possible expense categories for expenses created via the Remote website or mobile app.
Expenses created in the Remote platform may have additional expense categories (see below). These categories are not yet supported in PUT/POST requests.
Additional expense categories:
car_rental
coworking_office
entertainment
flight
fuel
gifts
insurance
internet
lodging
mileage
parking_toll
per_diem
subscription
transport
vaccination_testing
visa
wellness
Existing expense categories are:
coworking
education_training
home_office
meals
other
phone_utilities
tech_equipment
travel
2024-07-01
Feature
Introduce the Show Contractor Invoice Schedule endpoint
Added the GET v1/contractor-invoice-schedules/:invoice_schedule_id/
endpoint for showing contractor invoice schedules. Fore more information, see the API Spec Pages.
Feature
Introduce the List Contractor Invoice Schedules endpoint
Added the GET v1/contractor-invoice-schedules/
endpoint for listing contractor invoice schedules. Fore more information, see the API Spec Pages.
Feature
Introduce the Create Contractor Invoice Schedules endpoint
Added the POST v1/contractor-invoice-schedules/
endpoint for creating one or many contractor invoice schedules. Fore more information, see the API Spec Pages.
Feature
Introduce the Update Contractor Invoice Schedule endpoint
Added the PATCH/PUT v1/contractor-invoice-schedules/:invoice_schedule_id/
endpoint for updating a contractor invoice schedule. Fore more information, see the API Spec Pages.
Feature
Introduce the Show Contractor Invoice endpoint
Added the GET v1/contractor-invoices/:invoice_id/
endpoint for showing a contractor invoice. Fore more information, see the API Spec Pages.
Feature
Introduce the List Contractor Invoices endpoint
Added the GET v1/contractor-invoices/
endpoint for listing contractor invoices. Fore more information, see the API Spec Pages.
2024-05-16
Feature
Introducing the Work Authorization requested Event
Introduced the work_authorization.requested
webhook event. For more information, see the API Spec pages.
Feature
Introducing the update work authorization requests endpoint
Introduced the PATCH v1/work-authorization-requests/:work-authorization-request-id
endpoint for updating work authorization requests. For more information, see the API Spec pages.
2024-05-14
Feature
Introducing the show work authorization requests endpoint
Introduced the GET v1/work-authorization-requests/:work-authorization-request-id
endpoint for showing work authorization requests. For more information, see the API Spec pages.
Feature
Introducing the list work authorization requests endpoint
Introduced the GET v1/work-authorization-requests
endpoint for listing work authorization requests. For more information, see the API Spec pages.
2024-05-03
Feature
Introducing to update travel letter requests endpoint
Introduced the PATCH/PUT v1/travel-letter-requests/:travel-letter-request-id
endpoint for updating a travel letter request, for more information, see the API Spec pages.
2024-04-30
Feature
Introducing to show travel letter requests endpoint
Introduced the GET v1/travel-letter-requests/:travel-letter-request-id
endpoint for showing a travel letter request, for more information, see the API Spec pages.
Feature
Introducing the List Travel Letter Requests endpoint
Introduced the GET v1/travel-letter-requests
endpoint for listing travel letter requests for more information, see the API Spec pages.
Feature
Introducing the List Benefit Offers by Employment endpoint
Introduced the GET v1/benefit-offers
endpoint for listing benefit offers by employment for more information, see the API Spec pages.
2024-04-26
Feature
Introducing the Decline Identity Verification endpoint
Introduced the POST v1/identity-verification/:employment_id/decline
endpoint for declining the identity verification of an employee. For more information, see the API Spec pages.
2024-04-25
Feature
New parameter to return scheduled groups in Country JSON Schema API
A new optional parameter was added to GET /api/eor/v1/countries/:country_code/:form
only_for_testing_include_scheduled_benefit_groups
If true
, the API will also include scheduled groups in the schema. Defaults to false
See the API spec page.
2024-04-17
Deprecation
Deprecating the Offboarding Done Webhook
The offboarding.done
webhook is being deprecated in favor of offboarding.submitted_to_payroll
. For more information, see the API Spec pages.
2024-04-16
Feature
Introducing the Offboarding Completed Webhook Events
Introduced the offboarding.completed
webhook event. For more information, see the API Spec pages.
2024-04-16
Feature
Introducing the Offboarding Submitted to Payroll Webhook Events
Introduced the offboarding.submitted_to_payroll
webhook event. For more information, see the API Spec pages.
2024-04-10
Feature
Introducing the Custom Field Value Updated Webhook Events
Introduced the custom_field.value_updated
webhook event. For more information, see the API Spec pages.
2024-04-09
Feature
New fields added to Custom Field endpoints
Four new fields were added to the response of GET /api/eor/v1/custom-fields
required
visibility_scope
data_entry_access
metadata
Two new possible values might be returned from GET /api/eor/v1/custom-fields/{custom_field_id}/values/{employment_id}
- Decimal values represented as a String
- Objects containing the selected value in a custom field of type
single_select
More details can be found in the documentation.
2024-04-08
Feature
Introducing the GET api/v1/employment-contracts
endpoint
API users can now request a list of the employment-contracts
records that are associated to a given Employment by specifying the employment_id
as a (required) query parameter.
For more information, see the API Spec Page.
2024-04-05
Feature
Added work_email
to the Employments response
Added the field work_email
to the response of Employments endpoints. More information on the API Spec page.
2024-04-02
Feature
New endpoint was added to show benefits offers country summary for a company
Given a company this endpoint will show benefits offers country summary per country. More details in documentation here.
2024-03-27
Improvement
The number of receipts that can be attached to a single expense has been increased from one to five
The previous restriction on the receipts
property, which limited it to a 1-element list, has been updated to allow a maximum of 5 elements.
This modification impacts the following endpoints:
GET v1/expenses
andGET v1/expense/{id}
: Thereceipts
property is now an array containing up to five objects.POST v1/expenses
: Expenses can now be created with thereceipts
property containing a maximum of five objects.
2024-03-15
Feature
New endpoint was added to show benefits summary per country for a company
Given a company this endpoint will show benefits summary per country. More details in documentation here.
2024-03-14
Bug Fixes
JSON Schemas which include optional enumeration types now correctly accept null values
Previously, JSON Schemas which included an optional enumeration type would represent this as:
{
"my_option": {
"oneOf": [
{"const": "yes"},
{"const": "no"}
],
"type": ["string", "null"]
}
}
Where passing a null value for my_option would fail to validate, as null is not “yes” or “no”.
Now, this same type will instead be validated by a schema of form:
{
"my_option": {
"oneOf": [
{"const": "yes"},
{"const": "no"},
{"const": null}
],
"type": ["string", "null"]
}
}
Which makes it possible to pass a null value for these optional parameters.
2024-03-13
Feature
New endpoint was added to show a single company manager
Give the user_id
of a company manager, use GET /v1/company-managers/:user_id
. Docs here.
2024-02-28
Improvement
New field was added to create an expense in the existing endpoint
Both single object receipt
or a 1-element list of receipts
can be used to create an expense with the POST /v1/expenses
endpoint.
If both receipt
and receipts
are in the request body, the endpoint will respond with a 400 Bad Request error.
An expense can be created using receipt
request body property with POST /v1/expenses
, for example:
{
"employment_id": "9d79f993-9180-4a93-8f3e-b07fa33fc8dc",
"amount": 212,
"category": "education_training",
"currency": "EUR",
"expense_date": "2024-02-27",
"receipt": {
"content": "<binary content of the file encoded in base64>",
"name": "expense.pdf"
},
"tax_amount": 23,
"timezone": "Australia/Sydney",
"title": "Coursera Python Course"
}
Or it can be created using receipts
request body property with POST /v1/expenses
, for example:
{
"employment_id": "9d79f993-9180-4a93-8f3e-b07fa33fc8dc",
"amount": 212,
"category": "education_training",
"currency": "EUR",
"expense_date": "2024-02-27",
"receipts": [
{
"content": "<binary content of the file encoded in base64>",
"name": "expense.pdf"
}
],
"tax_amount": 23,
"timezone": "Australia/Sydney",
"title": "Coursera Python Course"
}
2024-02-27
Improvement
Adding a new field called active_contract_id
to Employment
.
Adding a new required amendment_contract_id
to the POST v1/contract-amendment
and POST v1/contract-amendment/automatable
endpoints. This field corresponds to the active_contract_id
of the employment that needs to be amended.
2024-02-22
Improvement
New endpoint to download expense receipt by id
A new receipt download endpoint and a new receipts
property have been added to expense objects to support multiple receipts per expense.
The new receipts
property is added to the response for GET v1/expenses
and GET v1/expenses/{id}
.
Example:
{
"data":{
"expense":{
"id":"9d79f993-9180-4a93-8f3e-b07fa33fc8dc",
"reason":null,
"status":"pending",
"title":"Coursera Python Course",
"category":"education_training",
"currency":{
"code":"EUR",
"name":"European Euro",
"symbol":"€"
},
"amount":986,
"tax_amount":241,
"notes":null,
"invoice_period":null,
"reviewed_at":null,
"employment_id":"611d3ed7-23c8-4c02-9349-cc5db5fdea1b",
"converted_amount":212,
"converted_currency":{
"code":"EUR",
"name":"European Euro",
"symbol":"€"
},
"reviewer":null,
"receipts":[
{
"id":"f03d8525-eead-46ac-a0d9-ab0fc005f74e",
"name":"expense-1.pdf",
"type":"expense",
"inserted_at":"2024-02-22T08:42:30Z"
},
{
"id":"c0c7a920-8b4c-4394-ae23-be121f9e9eb6",
"name":"expense-2.pdf",
"type":"expense",
"inserted_at":"2024-02-22T08:56:11Z"
}
],
"expense_date":"2024-02-22",
"converted_tax_amount":756
}
}
}
The id
from the receipts
property should now be used to expense receipts.
The new endpoint for downloading expense receipts by id is GET /v1/expenses/{expense_id}/receipts/{receipt_id}
.
The existing download endpoint, GET /v1/expenses/{expense_id}/receipt
, has been deprecated but will continue to work.
2024-02-09
Improvement
Webhook offboarding.submitted
now also triggered in resignation requests
The offboarding.submitted
webhook event is now also triggered when an employee requests a resignation.
2024-02-08
Bug Fixes
Remove the :deleted
status from the Offboarding API docs.
For more information, see the API Spec pages.
2024-02-07
Feature
Enhancements to Employment Creation Process
- Integration of Department
id
andname
Fields:- Endpoint Update: The
POST v1/employments
endpoint now supports thedepartment
object within the employment creation payload. This object can include either aname
field for creating and associating a new department or anid
field for associating an existing department with the newly created employment record. - Usage in Employment Creation:
- For Existing Departments: To associate an employment with an existing department, include the
department.id
field in your request payload. - For New Departments: To create and associate a new department with an employment, include the
department.name
field in your request payload.
- Important Note: Only one of these fields,
id
orname
, should be included in thedepartment
object for each request to avoid processing errors.
- For Existing Departments: To associate an employment with an existing department, include the
- Endpoint Update: The
Examples of Employment Creation Payloads
- Associating an Existing Department:
{
"country_code": "CAN",
"basic_information": {
"name": "John Doe",
"job_title": "Software Engineer",
"email": "[email protected]",
"provisional_start_date": "2024-05-01",
"has_seniority_date": "no",
"department": {
"id": "existing-department-id"
},
"manager": {
"id": "manager-id"
}
},
"type": "employee"
}
- Creating and Associating a New Department:
{
"country_code": "CAN",
"basic_information": {
"name": "Jane Smith",
"job_title": "Product Manager",
"email": "[email protected]",
"provisional_start_date": "2024-06-15",
"has_seniority_date": "no",
"department": {
"name": "Innovation Department"
},
"manager": {
"id": "manager-id"
}
},
"type": "employee"
}
These examples illustrate how to correctly use the department
feature within the employment creation process, either by associating with an existing department or by creating a new one. Please ensure that the payload for your employment creation requests adheres to these guidelines.
2024-01-31
Feature
Introducing Timeoff Approved Webhook Events
Introduced the timeoff.approved
webhook event. For more information, see the API Spec pages.
2024-01-30
Improvement
Webhook timeoff.canceled is now also triggered when an automatic holiday is removed
This event is now triggered when a holiday created by the Automatic Holiday feature is removed. For more information, see the API Spec pages.
2024-01-29
Feature
Adding a new field calledobserved_day
to Holiday
.
Depending on the country, not all public holidays are celebrated, or observed, on the actual official date of the holiday. When this happens, it’s called an observed holiday – which ensures that employees will be able to enjoy a day off of work despite the actual holiday landing on a weekend day. For example, in the United States, when Independence Day (July 4) lands on a Saturday, it is observed on the Friday before. If it happens to land on a Sunday, it is observed on the following Monday (July 5).
2024-01-26
Feature
Introducing the GET api/v1/company-departments
endpoint
API users can now request a list of the company-department
records that are associated to a given Company by specifying the company_id
as a (required) query parameter.
For more information, see the API Spec Page.
(An example request is included in the Postman collection for Partners, available here.)
2024-01-25
Improvement
Introducing management of the association between an employment and a department
When updating an employment, its department_id
can now be specified in the request body for the Update Employment endpoint, in order to associate the employment to that department, where both must belong to the same company
.
An associated department can now also be unassociated from an employment by explicitly including a null
value for department_id
in the request body for the Update Employment endpoint.
(To help construct such associations, List Departments and Create Department endpoints are planned for release this week.)
For more information, see the API Spec Page (partner link).
2024-01-25
Feature
Introducing the accurate termination date in the Offboarding API
Now the Offboarding API
will include the accurate termination_date
in its responses. For more information, see the API Spec pages.
2024-01-25
Feature
Introducing the POST api/v1/company-departments
endpoint
API users can now describe an aspect of company structure in the form of company-department
records which specify a Company Department’s name
and its company_id
association to a Company.
Department name
must be non-empty with no more than 255 characters (Unicode code points).
This feature is part of a project to support association of an employment
to a company-department
. (Additional support is planned for release this week, including a new List Departments endpoint and an improvement to the Update Department endpoint.)
For more information, see the API Spec Page.
(An example request is included in the Postman collection for Partners, available here.)
2024-01-23
Feature
Introducing Timeoff Taken Webhook Events
Introduced the timeoff.taken
webhook event. For more information, see the API Spec pages.
2024-01-22
Feature
Introducing working_hours_per_day field in Time Off Balance
Now, the Time Off Balance
endpoint also include the working_hours_per_day
field in its response. For more information, see the API Spec pages.
2024-01-18
Feature
Introducing contractual_leave_entitlement_type field in Time Off Balance
Now, the Time Off Balance
endpoint also include the contractual_leave_entitlement_type
field in its response. For more information, see the API Spec pages.
2024-01-18
Feature
Introducing Timeoff Updated Webhook Events
Introduced the timeoff.updated
webhook event. For more information, see the API Spec pages.
2024-01-12
Fix
Webhook timeoff.date_changed
is now also triggered when time off hours are updated
Previously, this event was only triggered when time off dates were updated. Now, it is also triggered when the number of hours is updated.
2024-01-11
Improvement
Introducing fields for Department ID and Name in responses to Show, Update, and List Employments
Previously, when an employment
held an association to a department
, only the department’s name was included in the response as the department
field on the employment
.
Now, the unique department_id
is also included in the employment
response data and both department
and department_id
added consistently to these endpoints where not already present before.
For more information, see the API Spec Page and its response specifications and examples for these endpoints.
2024-01-02
Feature
Introducing Offboarding Done Webhook Events
Introduced the offboarding.done
webhook event. For more information, see the API Spec pages.