Sign in

v1

latestOpenAPI 3.1.02026-08-06118124285.7 KB
Agreements

Partially update an existing agreement

patch/v2/employee/agreements/{id}

Query parameters

string required

The Quinyx ID of the resource.

OR
string required

The external string ID, which must start with 'xrefId:'.

Example:xrefId:1234

Agreement identifier

Request body

Example request

{
  "payroll": {
    "payScheduleId": "546"
  }
}

Response

Agreement details

idstring
xrefIdstring
namestring

Example response

{
  "id": "29339",
  "xrefId": "agr-1382",
  "name": "John's monthly agreement",
  "payroll": {
    "payScheduleId": "546"
  }
}