|
1091 | 1091 | } |
1092 | 1092 | }, |
1093 | 1093 | "description" : "" |
| 1094 | +}; |
| 1095 | + defs["ContractType"] = { |
| 1096 | + "title" : "", |
| 1097 | + "type" : "string", |
| 1098 | + "description" : "The contract type of the employee.", |
| 1099 | + "example" : "FullTime", |
| 1100 | + "enum" : [ "FullTime", "PartTime", "ZeroHour", "Unspecified" ] |
| 1101 | +}; |
| 1102 | + defs["Contracts"] = { |
| 1103 | + "title" : "", |
| 1104 | + "required" : [ "contractType", "employmentStatus", "startDate" ], |
| 1105 | + "type" : "object", |
| 1106 | + "properties" : { |
| 1107 | + "startDate" : { |
| 1108 | + "type" : "string", |
| 1109 | + "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)", |
| 1110 | + "format" : "date", |
| 1111 | + "example" : "2024-12-02", |
| 1112 | + "x-is-date" : true |
| 1113 | + }, |
| 1114 | + "employmentStatus" : { |
| 1115 | + "$ref" : "#/components/schemas/EmploymentStatus" |
| 1116 | + }, |
| 1117 | + "contractType" : { |
| 1118 | + "$ref" : "#/components/schemas/ContractType" |
| 1119 | + }, |
| 1120 | + "publicKey" : { |
| 1121 | + "type" : "string", |
| 1122 | + "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", |
| 1123 | + "format" : "uuid" |
| 1124 | + }, |
| 1125 | + "isFixedTerm" : { |
| 1126 | + "type" : "boolean", |
| 1127 | + "description" : "describes whether the contract is fixed term (required if trying to create Fixed term contract)" |
| 1128 | + }, |
| 1129 | + "fixedTermEndDate" : { |
| 1130 | + "type" : "string", |
| 1131 | + "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)", |
| 1132 | + "format" : "date", |
| 1133 | + "example" : "2025-11-01", |
| 1134 | + "x-is-date" : true |
| 1135 | + }, |
| 1136 | + "developmentalRoleDetails" : { |
| 1137 | + "$ref" : "#/components/schemas/DevelopmentalRoleDetails" |
| 1138 | + } |
| 1139 | + }, |
| 1140 | + "description" : "" |
1094 | 1141 | }; |
1095 | 1142 | defs["CourtOrderLine"] = { |
1096 | 1143 | "title" : "", |
|
1249 | 1296 | } |
1250 | 1297 | }, |
1251 | 1298 | "description" : "" |
| 1299 | +}; |
| 1300 | + defs["DevelopmentalRoleDetails"] = { |
| 1301 | + "title" : "", |
| 1302 | + "required" : [ "developmentalRole", "endDate", "startDate" ], |
| 1303 | + "type" : "object", |
| 1304 | + "properties" : { |
| 1305 | + "startDate" : { |
| 1306 | + "type" : "string", |
| 1307 | + "description" : "The start date of the developmental role", |
| 1308 | + "format" : "date", |
| 1309 | + "example" : "2024-12-02", |
| 1310 | + "x-is-date" : true |
| 1311 | + }, |
| 1312 | + "endDate" : { |
| 1313 | + "type" : "string", |
| 1314 | + "description" : "The end date of the developmental role", |
| 1315 | + "format" : "date", |
| 1316 | + "example" : "2024-12-02", |
| 1317 | + "x-is-date" : true |
| 1318 | + }, |
| 1319 | + "developmentalRole" : { |
| 1320 | + "type" : "string", |
| 1321 | + "description" : "The developmental role type - \"Apprentice\" is the only supported role currently", |
| 1322 | + "example" : "Apprentice" |
| 1323 | + }, |
| 1324 | + "publicKey" : { |
| 1325 | + "type" : "string", |
| 1326 | + "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", |
| 1327 | + "format" : "uuid" |
| 1328 | + } |
| 1329 | + }, |
| 1330 | + "description" : "" |
1252 | 1331 | }; |
1253 | 1332 | defs["EarningsLine"] = { |
1254 | 1333 | "title" : "", |
|
1613 | 1692 | "isOffPayrollWorker" : { |
1614 | 1693 | "type" : "boolean", |
1615 | 1694 | "description" : "Whether the employee is an off payroll worker" |
| 1695 | + }, |
| 1696 | + "contracts" : { |
| 1697 | + "type" : "array", |
| 1698 | + "description" : "The employee's contracts", |
| 1699 | + "items" : { |
| 1700 | + "$ref" : "#/components/schemas/Contracts" |
| 1701 | + } |
1616 | 1702 | } |
1617 | 1703 | }, |
1618 | 1704 | "description" : "" |
|
2300 | 2386 | "items" : { |
2301 | 2387 | "$ref" : "#/components/schemas/NICategory" |
2302 | 2388 | } |
| 2389 | + }, |
| 2390 | + "contracts" : { |
| 2391 | + "type" : "array", |
| 2392 | + "description" : "The employee's contracts", |
| 2393 | + "items" : { |
| 2394 | + "$ref" : "#/components/schemas/Contracts" |
| 2395 | + } |
2303 | 2396 | } |
2304 | 2397 | }, |
2305 | 2398 | "description" : "" |
|
2319 | 2412 | } |
2320 | 2413 | }, |
2321 | 2414 | "description" : "" |
| 2415 | +}; |
| 2416 | + defs["EmploymentStatus"] = { |
| 2417 | + "title" : "", |
| 2418 | + "type" : "string", |
| 2419 | + "description" : "The employment status of the employee.", |
| 2420 | + "example" : "Employee", |
| 2421 | + "enum" : [ "Employee", "Worker", "Unspecified" ] |
2322 | 2422 | }; |
2323 | 2423 | defs["InvalidField"] = { |
2324 | 2424 | "title" : "", |
|
3599 | 3699 | <nav id="scrollingNav"> |
3600 | 3700 | <ul class="sidenav nav nav-list"> |
3601 | 3701 | <li class="nav-header" data-group="PayrollUk"><strong>SDK: </strong><span id='sdk-name'></span></li> |
3602 | | - <li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>10.2.0</li> |
| 3702 | + <li class="nav-header" data-group="PayrollUk"><strong>VSN: </strong>10.3.0</li> |
3603 | 3703 | <li class="nav-header" data-group="PayrollUk"><a href="#api-PayrollUk">Methods</a></li> |
3604 | 3704 | <li data-group="PayrollUk" data-name="approveTimesheet" class=""> |
3605 | 3705 | <a href="#api-PayrollUk-approveTimesheet">approveTimesheet</a> |
|
0 commit comments