This API endpoint allows you to submit the employment record within your system when all required hiring information is collected. Below are all the required fields depending on the country you assign to the employment. You will receive a complete response with the updated record details.
To successfully submit an Employment in the next step, certain objects are required based on the Employment's designated country and employmentType. The schema includes 5 principle objects, some of which are required for employment submission:
| Name | Required? | Notes |
|---|---|---|
| manager | No | |
| role | Yes | |
| personalDetails | Yes | |
| compensation | Yes | |
| defaultSigner | Yes |
Within the required objects, not all items are required. The following tables show the required items for each required object. For more information about required fields for the different objects in the following tables, see the documentation.
Within the role object, the following are required:
| Name | Type | Notes |
|---|---|---|
| seniorityLevel | field | |
| roleTypeId | field | This can be looked up using the Role Types endpoint |
| role | field | |
| jobDescription | field | |
| startDate | field | |
| endDate | field | |
| employmentType | field | This must be either FULL_TIME or PART_TIME |
| fullTimeHoursPerWeek | object | Only required for FULL_TIME employments. |
| partTimeDaysPerWeek | object | Only required for PART_TIME employments. |
| partTimeHoursPerWeek | object | Only required for PART_TIME employments. |
| probationPeriod | object | |
| terminationNotice | object | This field is required in: Australia, UK, Ireland, India |
| resignationNotice | object | This field is required in: Australia, UK, Ireland, India |
| salary | object |
Within the compensation object, the following are required:
| Name | Type | Notes |
|---|---|---|
| salary | object | |
| paidHolidayDays | field | |
| remoteWorkCosts | object | |
| sickPay | object | This field is required in: UK, Ireland, Netherlands |
Within the defaultSigner object, the following are required:
| Name | Type | Notes |
|---|---|---|
| phone | object |