Cintra Integrations logo
Powered by Redocly

employments

An employment record represents a period of time for which a person is employed by an Employer. All payroll data (payslip data, absence data etc.) will belong to an Employment record

Get Employments

SecuritybearerAuth
Request
query Parameters
include
string

include one or more related objects

Example: include=person
page[number]
number >= 1

The page number

Example: page[number]=1
page[size]
number >= 1

The number of items per page

Example: page[size]=1
Responses
200

Employments Response - Array

get/employments
Request samples 
Response samples 
application/vnd.api+json
{}
Create an Employment
Create an Employment


SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
Employment to be added. startDate is required.


Important Date Validation Constraints:


    

  • startDate must not create overlapping employment periods for the same person
    • 

  • leavingDate (if provided) must be on or after startDate and must not create overlapping employment periods
    • 

  • continuousServiceStartDate (if provided) must be on or before startDate
    • 



Relationship Validation Constraints:


    

  • payroll must be on the same payroll schema as the employer
    • 



object
 
Responses 
201
Employment Response


post/employments
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{}
Get Employment by ID
Get Employment by ID


SecuritybearerAuth 
Request 
path Parameters
id
required
string <guid> 
Employment ID


 
 Example:  906264f1-2dff-4f72-a10b-59918cf738d7
query Parameters
include
string
include one or more related objects


 
 Example:  include=person
Responses 
200
Employment Response


get/employments/{id}
Request samples 
Response samples 
application/vnd.api+json
{}
Update an existing Employment
Update an existing employment by ID (partial update)


SecuritybearerAuth 
Request 
path Parameters
id
required
string <guid> 
Employment ID


 
 Example:  906264f1-2dff-4f72-a10b-59918cf738d7
Request Body schema: application/vnd.api+json
Employment object for partial update. Only the fields provided will be updated. No fields are required for PATCH operations.


Important Date Validation Constraints:


    

  • startDate must not create overlapping employment periods for the same person
    • 

  • leavingDate (if provided) must be on or after startDate and must not create overlapping employment periods
    • 

  • continuousServiceStartDate (if provided) must be on or before startDate
    • 



Relationship Validation Constraints:


    

  • payroll must be on the same payroll schema as the employer
    • 



object
 
Responses 
200
Employment Response


patch/employments/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{}
Get Employment by customer provided employment ID
Get Employment by customer provided employment ID


SecuritybearerAuth 
Request 
path Parameters
customerEmploymentId
required
string <string> 
Employment ID (provided by Customer)


 
 Example:  Z0012
Responses 
200
Employment Response


get/employments/EmploymentId/{customerEmploymentId}
Request samples 
Response samples 
application/vnd.api+json
{}
➔ Next to employment RTI working time