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

400

Bad Request

401

Unauthorized - Authorization Required

422

Unprocessable Entity

default

General Error

get/employments

Request samples

curl
C#
Java
PHP

Response samples

200
400
401
422
default

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments"
},
"data": [{"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
"type": "employments",
"attributes": {"EmploymentId": "Z0012",
"startDate": "2021-02-16",
"leavingDate": "2022-06-16",
"continuousServiceStartDate": "2022-06-16",
"employmentStatus": null,
"IR35OffPayrollWorker": false
},
"relationships": {"employer": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/employer",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/employer"
},
"data": {"type": "employers",
"id": "69049d80-0887-fd71-2197-75605a257ce6"
}
},
"person": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/person",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/person"
},
"data": {"type": "people",
"id": "1dec1ded-116f-b026-4cd0-f3d8b771baed"
}
},
"location": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/location",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/location"
},
"data": {"type": "locations",
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
},
"payroll": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/payroll",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/payroll"
},
"data": {"type": "payrolls",
"id": "7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5"
}
}
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
],
"included": [{"type": "people",
"attributes": {"firstName": "John",
"surname": "Doe"
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
]
}

Create an Employment

SecuritybearerAuth

Request

Request Body schema: application/vnd.api+json

Employment to be added

object

Responses

200

Employment Response

400

Bad Request

401

Unauthorized - Authorization Required

422

Unprocessable Entity

default

General Error

post/employments

Request samples

Payload
curl
C#
Java
PHP

application/vnd.api+json

{"data": {"type": "employments",
"attributes": {"EmploymentId": "Z0012",
"startDate": "2021-02-16",
"leavingDate": "2022-06-16",
"continuousServiceStartDate": "2022-06-16",
"employmentStatus": null,
"IR35OffPayrollWorker": false
},
"relationships": {"0": null,
"employer": {"data": {"id": "1",
"type": "employers"
}
},
"person": {"data": {"id": "4b30b724-26e1-4fcb-90f0-92936523133c",
"type": "people"
}
},
"location": {"data": {"id": "4d07d27b-a4ea-4e40-b65f-c4fd73507bf5",
"type": "locations"
}
},
"payroll": {"data": {"id": "7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5",
"type": "payrolls"
}
}
}
}
}

Response samples

200
400
401
422
default

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments"
},
"data": {"0": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"type": "employment",
"attributes": {"EmploymentId": "Z0012",
"startDate": "2021-02-16",
"leavingDate": "2022-06-16",
"continuousServiceStartDate": "2022-06-16",
"employmentStatus": null,
"IR35OffPayrollWorker": false
},
"relationships": {"employer": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/employer",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/employer"
},
"data": {"type": "employers",
"id": "69049d80-0887-fd71-2197-75605a257ce6"
}
},
"person": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/person",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/person"
},
"data": {"type": "people",
"id": "1dec1ded-116f-b026-4cd0-f3d8b771baed"
}
},
"location": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/location",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/location"
},
"data": {"type": "locations",
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
},
"payroll": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/payroll",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/payroll"
},
"data": {"type": "payrolls",
"id": "7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5"
}
}
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"included": [{"type": "people",
"attributes": {"firstName": "John",
"surname": "Doe"
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
]
}

Get Employment by ID

SecuritybearerAuth

Request

path Parameters

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

400

Bad Request

401

Unauthorized - Authorization Required

404

Not Found

422

Unprocessable Entity

default

General Error

get/employments/{id}

Request samples

curl
C#
Java
PHP

Response samples

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments"
},
"data": {"0": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"type": "employment",
"attributes": {"EmploymentId": "Z0012",
"startDate": "2021-02-16",
"leavingDate": "2022-06-16",
"continuousServiceStartDate": "2022-06-16",
"employmentStatus": null,
"IR35OffPayrollWorker": false
},
"relationships": {"employer": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/employer",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/employer"
},
"data": {"type": "employers",
"id": "69049d80-0887-fd71-2197-75605a257ce6"
}
},
"person": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/person",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/person"
},
"data": {"type": "people",
"id": "1dec1ded-116f-b026-4cd0-f3d8b771baed"
}
},
"location": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/location",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/location"
},
"data": {"type": "locations",
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
},
"payroll": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/payroll",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/payroll"
},
"data": {"type": "payrolls",
"id": "7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5"
}
}
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"included": [{"type": "people",
"attributes": {"firstName": "John",
"surname": "Doe"
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
]
}

Update an existing Employment

Update an existing employment by ID (partial update)

SecuritybearerAuth

Request

path Parameters

required

string <guid>

Employment ID

Example: 906264f1-2dff-4f72-a10b-59918cf738d7

Request Body schema: application/vnd.api+json

Employment object that needs to be updated

object

Responses

200

Employment Response

400

Bad Request

401

Unauthorized - Authorization Required

404

Not Found

422

Unprocessable Entity

default

General Error

patch/employments/{id}

Request samples

Payload
curl
C#
Java
PHP

application/vnd.api+json

{"data": {"type": "employments",
"attributes": {"EmploymentId": "Z0012",
"startDate": "2021-02-16",
"leavingDate": "2022-06-16",
"continuousServiceStartDate": "2022-06-16",
"employmentStatus": null,
"IR35OffPayrollWorker": false
},
"relationships": {"0": null,
"employer": {"data": {"id": "1",
"type": "employers"
}
},
"person": {"data": {"id": "4b30b724-26e1-4fcb-90f0-92936523133c",
"type": "people"
}
},
"location": {"data": {"id": "4d07d27b-a4ea-4e40-b65f-c4fd73507bf5",
"type": "locations"
}
},
"payroll": {"data": {"id": "7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5",
"type": "payrolls"
}
}
},
"id": "906264f1-2dff-4f72-a10b-59918cf738d7"
}
}

Response samples

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments"
},
"data": {"0": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"type": "employment",
"attributes": {"EmploymentId": "Z0012",
"startDate": "2021-02-16",
"leavingDate": "2022-06-16",
"continuousServiceStartDate": "2022-06-16",
"employmentStatus": null,
"IR35OffPayrollWorker": false
},
"relationships": {"employer": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/employer",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/employer"
},
"data": {"type": "employers",
"id": "69049d80-0887-fd71-2197-75605a257ce6"
}
},
"person": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/person",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/person"
},
"data": {"type": "people",
"id": "1dec1ded-116f-b026-4cd0-f3d8b771baed"
}
},
"location": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/location",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/location"
},
"data": {"type": "locations",
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
},
"payroll": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/payroll",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/payroll"
},
"data": {"type": "payrolls",
"id": "7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5"
}
}
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"included": [{"type": "people",
"attributes": {"firstName": "John",
"surname": "Doe"
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
]
}

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

400

Bad Request

401

Unauthorized - Authorization Required

404

Not Found

422

Unprocessable Entity

default

General Error

get/employments/EmploymentId/{customerEmploymentId}

Request samples

curl
C#
Java
PHP

Response samples

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments"
},
"data": {"0": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"type": "employment",
"attributes": {"EmploymentId": "Z0012",
"startDate": "2021-02-16",
"leavingDate": "2022-06-16",
"continuousServiceStartDate": "2022-06-16",
"employmentStatus": null,
"IR35OffPayrollWorker": false
},
"relationships": {"employer": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/employer",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/employer"
},
"data": {"type": "employers",
"id": "69049d80-0887-fd71-2197-75605a257ce6"
}
},
"person": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/person",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/person"
},
"data": {"type": "people",
"id": "1dec1ded-116f-b026-4cd0-f3d8b771baed"
}
},
"location": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/location",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/location"
},
"data": {"type": "locations",
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
},
"payroll": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/payroll",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/payroll"
},
"data": {"type": "payrolls",
"id": "7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5"
}
}
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/employments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"included": [{"type": "people",
"attributes": {"firstName": "John",
"surname": "Doe"
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
]
}

➔ Next to employment history