|
1089 | 1089 | } |
1090 | 1090 | }, |
1091 | 1091 | "description" : "" |
| 1092 | +}; |
| 1093 | + defs["ContractType"] = { |
| 1094 | + "title" : "", |
| 1095 | + "type" : "string", |
| 1096 | + "description" : "The contract type of the employee.", |
| 1097 | + "example" : "FullTime", |
| 1098 | + "enum" : [ "FullTime", "PartTime", "ZeroHour", "Unspecified" ] |
| 1099 | +}; |
| 1100 | + defs["Contracts"] = { |
| 1101 | + "title" : "", |
| 1102 | + "required" : [ "contractType", "employmentStatus", "startDate" ], |
| 1103 | + "type" : "object", |
| 1104 | + "properties" : { |
| 1105 | + "startDate" : { |
| 1106 | + "type" : "string", |
| 1107 | + "description" : "The contract start date of the employee. This will be locked once an employee has been paid and cannot be changed (YYYY-MM-DD)", |
| 1108 | + "format" : "date", |
| 1109 | + "example" : "2024-12-02", |
| 1110 | + "x-is-date" : true |
| 1111 | + }, |
| 1112 | + "employmentStatus" : { |
| 1113 | + "$ref" : "#/components/schemas/EmploymentStatus" |
| 1114 | + }, |
| 1115 | + "contractType" : { |
| 1116 | + "$ref" : "#/components/schemas/ContractType" |
| 1117 | + }, |
| 1118 | + "publicKey" : { |
| 1119 | + "type" : "string", |
| 1120 | + "description" : "The public key of the contract. Public key is required if the intention is to edit an existing contract. If no key is supplied a new contract will be created", |
| 1121 | + "format" : "uuid" |
| 1122 | + }, |
| 1123 | + "isFixedTerm" : { |
| 1124 | + "type" : "boolean", |
| 1125 | + "description" : "describes whether the contract is fixed term (required if trying to create Fixed term contract)" |
| 1126 | + }, |
| 1127 | + "fixedTermEndDate" : { |
| 1128 | + "type" : "string", |
| 1129 | + "description" : "The fixed term end date of the employee. Not required if isFixedTerm is false or not provided (required if trying to create Fixed term contract)", |
| 1130 | + "format" : "date", |
| 1131 | + "example" : "2025-11-01", |
| 1132 | + "x-is-date" : true |
| 1133 | + }, |
| 1134 | + "developmentalRoleDetails" : { |
| 1135 | + "$ref" : "#/components/schemas/DevelopmentalRoleDetails" |
| 1136 | + } |
| 1137 | + }, |
| 1138 | + "description" : "" |
1092 | 1139 | }; |
1093 | 1140 | defs["CourtOrderLine"] = { |
1094 | 1141 | "title" : "", |
|
1247 | 1294 | } |
1248 | 1295 | }, |
1249 | 1296 | "description" : "" |
| 1297 | +}; |
| 1298 | + defs["DevelopmentalRoleDetails"] = { |
| 1299 | + "title" : "", |
| 1300 | + "required" : [ "developmentalRole", "endDate", "startDate" ], |
| 1301 | + "type" : "object", |
| 1302 | + "properties" : { |
| 1303 | + "startDate" : { |
| 1304 | + "type" : "string", |
| 1305 | + "description" : "The start date of the developmental role", |
| 1306 | + "format" : "date", |
| 1307 | + "example" : "2024-12-02", |
| 1308 | + "x-is-date" : true |
| 1309 | + }, |
| 1310 | + "endDate" : { |
| 1311 | + "type" : "string", |
| 1312 | + "description" : "The end date of the developmental role", |
| 1313 | + "format" : "date", |
| 1314 | + "example" : "2024-12-02", |
| 1315 | + "x-is-date" : true |
| 1316 | + }, |
| 1317 | + "developmentalRole" : { |
| 1318 | + "type" : "string", |
| 1319 | + "description" : "The developmental role type - \"Apprentice\" is the only supported role currently", |
| 1320 | + "example" : "Apprentice" |
| 1321 | + }, |
| 1322 | + "publicKey" : { |
| 1323 | + "type" : "string", |
| 1324 | + "description" : "The public key of the developmental role. Public key is required if the intention is to edit an existing developmental role. If no key is supplied a new developmental role will be created", |
| 1325 | + "format" : "uuid" |
| 1326 | + } |
| 1327 | + }, |
| 1328 | + "description" : "" |
1250 | 1329 | }; |
1251 | 1330 | defs["EarningsLine"] = { |
1252 | 1331 | "title" : "", |
|
1611 | 1690 | "isOffPayrollWorker" : { |
1612 | 1691 | "type" : "boolean", |
1613 | 1692 | "description" : "Whether the employee is an off payroll worker" |
| 1693 | + }, |
| 1694 | + "contracts" : { |
| 1695 | + "type" : "array", |
| 1696 | + "description" : "The employee's contracts", |
| 1697 | + "items" : { |
| 1698 | + "$ref" : "#/components/schemas/Contracts" |
| 1699 | + } |
1614 | 1700 | } |
1615 | 1701 | }, |
1616 | 1702 | "description" : "" |
|
2298 | 2384 | "items" : { |
2299 | 2385 | "$ref" : "#/components/schemas/NICategory" |
2300 | 2386 | } |
| 2387 | + }, |
| 2388 | + "contracts" : { |
| 2389 | + "type" : "array", |
| 2390 | + "description" : "The employee's contracts", |
| 2391 | + "items" : { |
| 2392 | + "$ref" : "#/components/schemas/Contracts" |
| 2393 | + } |
2301 | 2394 | } |
2302 | 2395 | }, |
2303 | 2396 | "description" : "" |
|
2317 | 2410 | } |
2318 | 2411 | }, |
2319 | 2412 | "description" : "" |
| 2413 | +}; |
| 2414 | + defs["EmploymentStatus"] = { |
| 2415 | + "title" : "", |
| 2416 | + "type" : "string", |
| 2417 | + "description" : "The employment status of the employee.", |
| 2418 | + "example" : "Employee", |
| 2419 | + "enum" : [ "Employee", "Worker", "Unspecified" ] |
2320 | 2420 | }; |
2321 | 2421 | defs["InvalidField"] = { |
2322 | 2422 | "title" : "", |
|
3596 | 3696 | <nav id="scrollingNav"> |
3597 | 3697 | <ul class="sidenav nav nav-list"> |
3598 | 3698 | <li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li> |
3599 | | - <li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>12.2.0</li> |
| 3699 | + <li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>12.3.0</li> |
3600 | 3700 | <li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li> |
3601 | 3701 | <li data-group="PayrollUk" data-name="approveTimesheet" class=""> |
3602 | 3702 | <a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a> |
|
0 commit comments