1{
2 "swagger": "2.0",
3 "info": {
4 "version": "V2",
5 "title": "Payroll"
6 },
7 "host": "localhost:9333",
8 "schemes": [
9 "http"
10 ],
11 "paths": {
12 "/api/v2/business/{businessId}/aba": {
13 "get": {
14 "tags": [
15 "AbaSettings"
16 ],
17 "summary": "List ABA Settings",
18 "description": "Retrieves all the ABA settings associated with the business.\n\nThis operation supports OData queries.",
19 "operationId": "ABA_GetAbaDetails",
20 "consumes": [],
21 "produces": [
22 "application/json",
23 "text/json",
24 "application/xml",
25 "text/xml"
26 ],
27 "parameters": [
28 {
29 "name": "businessId",
30 "in": "path",
31 "required": true,
32 "type": "string"
33 }
34 ],
35 "responses": {
36 "200": {
37 "description": "OK",
38 "schema": {
39 "type": "array",
40 "items": {
41 "$ref": "#/definitions/BusinessAbaModel"
42 },
43 "xml": {
44 "name": "BusinessAbaModel",
45 "wrapped": true
46 },
47 "title": "IEnumerable<BusinessAbaModel>"
48 }
49 }
50 }
51 },
52 "post": {
53 "tags": [
54 "AbaSettings"
55 ],
56 "summary": "Create ABA Settings Record",
57 "description": "Creates a new ABA settings record for the business.",
58 "operationId": "ABA_Post",
59 "consumes": [
60 "application/json",
61 "text/json",
62 "application/xml",
63 "text/xml",
64 "application/x-www-form-urlencoded"
65 ],
66 "produces": [
67 "application/json",
68 "text/json",
69 "application/xml",
70 "text/xml"
71 ],
72 "parameters": [
73 {
74 "name": "abaDetails",
75 "in": "body",
76 "required": true,
77 "schema": {
78 "$ref": "#/definitions/BusinessAbaModel"
79 }
80 },
81 {
82 "name": "businessId",
83 "in": "path",
84 "required": true,
85 "type": "string"
86 }
87 ],
88 "responses": {
89 "200": {
90 "description": "OK"
91 }
92 }
93 }
94 },
95 "/api/v2/business/{businessId}/aba/{id}": {
96 "get": {
97 "tags": [
98 "AbaSettings"
99 ],
100 "summary": "Get ABA Settings Record by ID",
101 "description": "Gets the details for the ABA settings record with the specified ID.",
102 "operationId": "ABA_Get",
103 "consumes": [],
104 "produces": [
105 "application/json",
106 "text/json",
107 "application/xml",
108 "text/xml"
109 ],
110 "parameters": [
111 {
112 "name": "id",
113 "in": "path",
114 "required": true,
115 "type": "integer",
116 "format": "int32",
117 "title": "Int32"
118 },
119 {
120 "name": "businessId",
121 "in": "path",
122 "required": true,
123 "type": "string"
124 }
125 ],
126 "responses": {
127 "200": {
128 "description": "OK",
129 "schema": {
130 "$ref": "#/definitions/BusinessAbaModel"
131 }
132 }
133 }
134 },
135 "put": {
136 "tags": [
137 "AbaSettings"
138 ],
139 "summary": "Update ABA Settings Record",
140 "description": "Updates the ABA settings record with the specified ID.",
141 "operationId": "ABA_Put",
142 "consumes": [
143 "application/json",
144 "text/json",
145 "application/xml",
146 "text/xml",
147 "application/x-www-form-urlencoded"
148 ],
149 "produces": [
150 "application/json",
151 "text/json",
152 "application/xml",
153 "text/xml"
154 ],
155 "parameters": [
156 {
157 "name": "id",
158 "in": "path",
159 "required": true,
160 "type": "integer",
161 "format": "int32",
162 "title": "Int32"
163 },
164 {
165 "name": "abaDetails",
166 "in": "body",
167 "required": true,
168 "schema": {
169 "$ref": "#/definitions/BusinessAbaModel"
170 }
171 },
172 {
173 "name": "businessId",
174 "in": "path",
175 "required": true,
176 "type": "string"
177 }
178 ],
179 "responses": {
180 "200": {
181 "description": "OK"
182 }
183 }
184 },
185 "delete": {
186 "tags": [
187 "AbaSettings"
188 ],
189 "summary": "Delete ABA Settings Record",
190 "description": "Deletes the ABA settings record with the specified ID.",
191 "operationId": "ABA_Delete",
192 "consumes": [],
193 "produces": [
194 "application/json",
195 "text/json",
196 "application/xml",
197 "text/xml"
198 ],
199 "parameters": [
200 {
201 "name": "id",
202 "in": "path",
203 "required": true,
204 "type": "integer",
205 "format": "int32",
206 "title": "Int32"
207 },
208 {
209 "name": "businessId",
210 "in": "path",
211 "required": true,
212 "type": "string"
213 }
214 ],
215 "responses": {
216 "200": {
217 "description": "OK"
218 }
219 }
220 }
221 },
222 "/oauth/token": {
223 "post": {
224 "tags": [
225 "Authentication"
226 ],
227 "summary": "OAuth Token",
228 "description": "See the guide on OAuth2 authentication for more details.",
229 "operationId": "Token_Post",
230 "consumes": [],
231 "produces": [
232 "application/json",
233 "text/json",
234 "application/xml",
235 "text/xml"
236 ],
237 "parameters": [
238 {
239 "name": "request",
240 "in": "query",
241 "required": true,
242 "type": "object",
243 "title": "HttpRequestMessage"
244 }
245 ],
246 "responses": {
247 "200": {
248 "description": "OK"
249 }
250 }
251 }
252 },
253 "/api/v2/singlesignon": {
254 "post": {
255 "tags": [
256 "Authentication"
257 ],
258 "summary": "Single Sign On",
259 "description": "can either be called via /api/v2/singlesignon or /api/v2/business/singlesignon (which goes to the business controller)",
260 "operationId": "SingleSignOn_Post",
261 "consumes": [
262 "application/json",
263 "text/json",
264 "application/xml",
265 "text/xml",
266 "application/x-www-form-urlencoded"
267 ],
268 "produces": [
269 "application/json",
270 "text/json",
271 "application/xml",
272 "text/xml"
273 ],
274 "parameters": [
275 {
276 "name": "model",
277 "in": "body",
278 "required": true,
279 "schema": {
280 "$ref": "#/definitions/SingleSignOnRequestModel"
281 }
282 }
283 ],
284 "responses": {
285 "200": {
286 "description": "OK",
287 "schema": {
288 "$ref": "#/definitions/SingleSignOnResponseModel"
289 }
290 }
291 }
292 }
293 },
294 "/api/v2/business/{businessId}/singlesignon": {
295 "post": {
296 "tags": [
297 "Authentication"
298 ],
299 "summary": "Single Sign On",
300 "description": "can either be called via /api/v2/singlesignon or /api/v2/business/singlesignon (which goes to the business controller)",
301 "operationId": "SingleSignOn_PostApiV2BusinessByBusinessIdSinglesignon",
302 "consumes": [
303 "application/json",
304 "text/json",
305 "application/xml",
306 "text/xml",
307 "application/x-www-form-urlencoded"
308 ],
309 "produces": [
310 "application/json",
311 "text/json",
312 "application/xml",
313 "text/xml"
314 ],
315 "parameters": [
316 {
317 "name": "model",
318 "in": "body",
319 "required": true,
320 "schema": {
321 "$ref": "#/definitions/SingleSignOnRequestModel"
322 }
323 },
324 {
325 "name": "businessId",
326 "in": "path",
327 "required": true,
328 "type": "string"
329 }
330 ],
331 "responses": {
332 "200": {
333 "description": "OK",
334 "schema": {
335 "$ref": "#/definitions/SingleSignOnResponseModel"
336 }
337 }
338 }
339 }
340 },
341 "/api/v2/business/{businessId}/employee/{employeeId}/singlesignon": {
342 "post": {
343 "tags": [
344 "Authentication"
345 ],
346 "summary": "Single Sign On",
347 "description": "can either be called via /api/v2/singlesignon or /api/v2/business/singlesignon (which goes to the business controller)",
348 "operationId": "SingleSignOn_PostApiV2BusinessByBusinessIdEmployeeByEmployeeIdSinglesignon",
349 "consumes": [
350 "application/json",
351 "text/json",
352 "application/xml",
353 "text/xml",
354 "application/x-www-form-urlencoded"
355 ],
356 "produces": [
357 "application/json",
358 "text/json",
359 "application/xml",
360 "text/xml"
361 ],
362 "parameters": [
363 {
364 "name": "model",
365 "in": "body",
366 "required": true,
367 "schema": {
368 "$ref": "#/definitions/SingleSignOnRequestModel"
369 }
370 },
371 {
372 "name": "businessId",
373 "in": "path",
374 "required": true,
375 "type": "string"
376 },
377 {
378 "name": "employeeId",
379 "in": "path",
380 "required": true,
381 "type": "string"
382 }
383 ],
384 "responses": {
385 "200": {
386 "description": "OK",
387 "schema": {
388 "$ref": "#/definitions/SingleSignOnResponseModel"
389 }
390 }
391 }
392 }
393 },
394 "/api/v2/business/{businessId}/roundingrules": {
395 "get": {
396 "tags": [
397 "Business"
398 ],
399 "summary": "Get Rounding Rules",
400 "description": "Gets the rounding rules for the business.",
401 "operationId": "RoundingRules_GetRoundingRules",
402 "consumes": [],
403 "produces": [
404 "application/json",
405 "text/json",
406 "application/xml",
407 "text/xml"
408 ],
409 "parameters": [
410 {
411 "name": "businessId",
412 "in": "path",
413 "required": true,
414 "type": "string"
415 }
416 ],
417 "responses": {
418 "200": {
419 "description": "OK",
420 "schema": {
421 "$ref": "#/definitions/TimesheetRoundingRulesModel"
422 }
423 }
424 }
425 },
426 "post": {
427 "tags": [
428 "Business"
429 ],
430 "summary": "Set Rounding Rules",
431 "description": "Sets the rounding rules for the business.",
432 "operationId": "RoundingRules_SetRoundingRules",
433 "consumes": [
434 "application/json",
435 "text/json",
436 "application/xml",
437 "text/xml",
438 "application/x-www-form-urlencoded"
439 ],
440 "produces": [
441 "application/json",
442 "text/json",
443 "application/xml",
444 "text/xml"
445 ],
446 "parameters": [
447 {
448 "name": "roundingRules",
449 "in": "body",
450 "required": true,
451 "schema": {
452 "$ref": "#/definitions/TimesheetRoundingRulesModel"
453 }
454 },
455 {
456 "name": "businessId",
457 "in": "path",
458 "required": true,
459 "type": "string"
460 }
461 ],
462 "responses": {
463 "200": {
464 "description": "OK"
465 }
466 }
467 }
468 },
469 "/api/v2/business/{businessId}/ato": {
470 "get": {
471 "tags": [
472 "Business"
473 ],
474 "summary": "Get ATO Details",
475 "description": "Gets the ATO details for the business.",
476 "operationId": "ATO_Get",
477 "consumes": [],
478 "produces": [
479 "application/json",
480 "text/json",
481 "application/xml",
482 "text/xml"
483 ],
484 "parameters": [
485 {
486 "name": "businessId",
487 "in": "path",
488 "required": true,
489 "type": "integer",
490 "format": "int32",
491 "title": "Int32"
492 }
493 ],
494 "responses": {
495 "200": {
496 "description": "OK",
497 "schema": {
498 "$ref": "#/definitions/BusinessAtoSupplierModel"
499 }
500 }
501 }
502 },
503 "post": {
504 "tags": [
505 "Business"
506 ],
507 "summary": "Set ATO Details",
508 "description": "Sets the ATO details for the business.",
509 "operationId": "ATO_Post",
510 "consumes": [
511 "application/json",
512 "text/json",
513 "application/xml",
514 "text/xml",
515 "application/x-www-form-urlencoded"
516 ],
517 "produces": [
518 "application/json",
519 "text/json",
520 "application/xml",
521 "text/xml"
522 ],
523 "parameters": [
524 {
525 "name": "model",
526 "in": "body",
527 "required": true,
528 "schema": {
529 "$ref": "#/definitions/BusinessAtoSupplierModel"
530 }
531 },
532 {
533 "name": "businessId",
534 "in": "path",
535 "required": true,
536 "type": "string"
537 }
538 ],
539 "responses": {
540 "200": {
541 "description": "OK"
542 }
543 }
544 }
545 },
546 "/api/v2/business/{businessId}/entitlements": {
547 "get": {
548 "tags": [
549 "Business"
550 ],
551 "summary": "List Entitlements",
552 "description": "Lists all of the entitlements for the business.",
553 "operationId": "Entitlements_GetEntitlements",
554 "consumes": [],
555 "produces": [
556 "application/json",
557 "text/json",
558 "application/xml",
559 "text/xml"
560 ],
561 "parameters": [
562 {
563 "name": "businessId",
564 "in": "path",
565 "required": true,
566 "type": "string"
567 }
568 ],
569 "responses": {
570 "200": {
571 "description": "OK",
572 "schema": {
573 "$ref": "#/definitions/EntitlementsModel"
574 }
575 }
576 }
577 }
578 },
579 "/api/v2/business/{businessId}/document": {
580 "get": {
581 "tags": [
582 "Business"
583 ],
584 "summary": "List Business Document Details",
585 "description": "Lists the details for all of the documents in the business.",
586 "operationId": "Document_Get",
587 "consumes": [],
588 "produces": [
589 "application/json",
590 "text/json",
591 "application/xml",
592 "text/xml"
593 ],
594 "parameters": [
595 {
596 "name": "businessId",
597 "in": "path",
598 "required": true,
599 "type": "string"
600 }
601 ],
602 "responses": {
603 "200": {
604 "description": "OK",
605 "schema": {
606 "type": "array",
607 "items": {
608 "$ref": "#/definitions/DocumentModel"
609 },
610 "xml": {
611 "name": "DocumentModel",
612 "wrapped": true
613 },
614 "title": "List<DocumentModel>"
615 }
616 }
617 }
618 },
619 "post": {
620 "tags": [
621 "Business"
622 ],
623 "summary": "Create Business Document",
624 "description": "Uploads new document(s) for business. The request should be a MIME multipart file upload request.",
625 "operationId": "Document_Post",
626 "consumes": [],
627 "produces": [
628 "application/json",
629 "text/json",
630 "application/xml",
631 "text/xml"
632 ],
633 "parameters": [
634 {
635 "name": "visibleToAll",
636 "in": "query",
637 "required": false,
638 "type": "boolean",
639 "default": false,
640 "title": "Boolean"
641 },
642 {
643 "name": "businessId",
644 "in": "path",
645 "required": true,
646 "type": "string"
647 }
648 ],
649 "responses": {
650 "200": {
651 "description": "OK",
652 "schema": {
653 "type": "array",
654 "items": {
655 "$ref": "#/definitions/DocumentModel"
656 },
657 "xml": {
658 "name": "DocumentModel",
659 "wrapped": true
660 },
661 "title": "List<DocumentModel>"
662 }
663 }
664 }
665 }
666 },
667 "/api/v2/business/{businessId}/document/{id}": {
668 "get": {
669 "tags": [
670 "Business"
671 ],
672 "summary": "Get Business Document Details",
673 "description": "Gets the details for the specified business document.",
674 "operationId": "Document_GetApiV2BusinessByBusinessIdDocumentById",
675 "consumes": [],
676 "produces": [
677 "application/json",
678 "text/json",
679 "application/xml",
680 "text/xml"
681 ],
682 "parameters": [
683 {
684 "name": "id",
685 "in": "path",
686 "required": true,
687 "type": "integer",
688 "format": "int32",
689 "title": "Int32"
690 },
691 {
692 "name": "businessId",
693 "in": "path",
694 "required": true,
695 "type": "string"
696 }
697 ],
698 "responses": {
699 "200": {
700 "description": "OK",
701 "schema": {
702 "$ref": "#/definitions/DocumentModel"
703 }
704 }
705 }
706 },
707 "put": {
708 "tags": [
709 "Business"
710 ],
711 "summary": "Update Business Document Permissions",
712 "description": "Updates permissions for the business document with the specified ID.",
713 "operationId": "Document_Put",
714 "consumes": [
715 "application/json",
716 "text/json",
717 "application/xml",
718 "text/xml",
719 "application/x-www-form-urlencoded"
720 ],
721 "produces": [
722 "application/json",
723 "text/json",
724 "application/xml",
725 "text/xml"
726 ],
727 "parameters": [
728 {
729 "name": "id",
730 "in": "path",
731 "required": true,
732 "type": "integer",
733 "format": "int32",
734 "title": "Int32"
735 },
736 {
737 "name": "model",
738 "in": "body",
739 "required": true,
740 "schema": {
741 "$ref": "#/definitions/UpdateDocumentPermissionsModel"
742 }
743 },
744 {
745 "name": "businessId",
746 "in": "path",
747 "required": true,
748 "type": "string"
749 }
750 ],
751 "responses": {
752 "200": {
753 "description": "OK",
754 "schema": {
755 "$ref": "#/definitions/DocumentModel"
756 }
757 }
758 }
759 },
760 "delete": {
761 "tags": [
762 "Business"
763 ],
764 "summary": "Delete Business Document",
765 "description": "Deletes the business document with the specified ID.",
766 "operationId": "Document_Delete",
767 "consumes": [],
768 "produces": [
769 "application/json",
770 "text/json",
771 "application/xml",
772 "text/xml"
773 ],
774 "parameters": [
775 {
776 "name": "id",
777 "in": "path",
778 "required": true,
779 "type": "integer",
780 "format": "int32",
781 "title": "Int32"
782 },
783 {
784 "name": "businessId",
785 "in": "path",
786 "required": true,
787 "type": "string"
788 }
789 ],
790 "responses": {
791 "200": {
792 "description": "OK"
793 }
794 }
795 }
796 },
797 "/api/v2/business/{businessId}/document/{id}/content": {
798 "get": {
799 "tags": [
800 "Business"
801 ],
802 "summary": "Get Business Document Content",
803 "description": "Gets the file content for the business document with the specified ID.",
804 "operationId": "Document_Content",
805 "consumes": [],
806 "produces": [
807 "application/json",
808 "text/json",
809 "application/xml",
810 "text/xml"
811 ],
812 "parameters": [
813 {
814 "name": "id",
815 "in": "path",
816 "required": true,
817 "type": "integer",
818 "format": "int32",
819 "title": "Int32"
820 },
821 {
822 "name": "businessId",
823 "in": "path",
824 "required": true,
825 "type": "string"
826 }
827 ],
828 "responses": {
829 "200": {
830 "description": "OK",
831 "schema": {
832 "$ref": "#/definitions/DocumentFile"
833 }
834 }
835 }
836 }
837 },
838 "/api/v2/business": {
839 "get": {
840 "tags": [
841 "Business"
842 ],
843 "summary": "List Businesses",
844 "description": "Lists all the businesses associated with the current user.\n\nThis operation supports OData queries.",
845 "operationId": "Business_GetBusinesses",
846 "consumes": [],
847 "produces": [
848 "application/json",
849 "text/json",
850 "application/xml",
851 "text/xml"
852 ],
853 "parameters": [],
854 "responses": {
855 "200": {
856 "description": "OK",
857 "schema": {
858 "type": "array",
859 "items": {
860 "$ref": "#/definitions/BusinessModel"
861 },
862 "xml": {
863 "name": "BusinessModel",
864 "wrapped": true
865 },
866 "title": "IEnumerable<BusinessModel>"
867 }
868 }
869 }
870 },
871 "post": {
872 "tags": [
873 "Business"
874 ],
875 "summary": "Create New Business",
876 "description": "Creates a new business.",
877 "operationId": "Business_Post",
878 "consumes": [
879 "application/json",
880 "text/json",
881 "application/xml",
882 "text/xml",
883 "application/x-www-form-urlencoded"
884 ],
885 "produces": [
886 "application/json",
887 "text/json",
888 "application/xml",
889 "text/xml"
890 ],
891 "parameters": [
892 {
893 "name": "model",
894 "in": "body",
895 "required": true,
896 "schema": {
897 "$ref": "#/definitions/BusinessModel"
898 }
899 },
900 {
901 "name": "setupDefaultData",
902 "in": "query",
903 "required": false,
904 "type": "boolean",
905 "default": true,
906 "title": "Boolean"
907 }
908 ],
909 "responses": {
910 "200": {
911 "description": "OK"
912 }
913 }
914 }
915 },
916 "/api/v2/business/{businessId}": {
917 "get": {
918 "tags": [
919 "Business"
920 ],
921 "summary": "Get Business Details",
922 "description": "Retrieves the details of the business with the specified ID.",
923 "operationId": "Business_GetBusiness",
924 "consumes": [],
925 "produces": [
926 "application/json",
927 "text/json",
928 "application/xml",
929 "text/xml"
930 ],
931 "parameters": [
932 {
933 "name": "businessId",
934 "in": "path",
935 "required": true,
936 "type": "integer",
937 "format": "int32",
938 "title": "Int32"
939 }
940 ],
941 "responses": {
942 "200": {
943 "description": "OK",
944 "schema": {
945 "$ref": "#/definitions/BusinessModel"
946 }
947 }
948 }
949 }
950 },
951 "/api/v2/business/externalid": {
952 "get": {
953 "tags": [
954 "Business"
955 ],
956 "summary": "Get Business Details by External ID",
957 "description": "Retrieves the details of the business with the specified external ID.",
958 "operationId": "Business_GetBusinessByExternalId",
959 "consumes": [],
960 "produces": [
961 "application/json",
962 "text/json",
963 "application/xml",
964 "text/xml"
965 ],
966 "parameters": [
967 {
968 "name": "externalId",
969 "in": "query",
970 "required": true,
971 "type": "string",
972 "title": "String"
973 }
974 ],
975 "responses": {
976 "200": {
977 "description": "OK",
978 "schema": {
979 "$ref": "#/definitions/BusinessModel"
980 }
981 }
982 }
983 }
984 },
985 "/api/v2/business/{businessId}/access": {
986 "get": {
987 "tags": [
988 "Business"
989 ],
990 "summary": "List All Business Access Users",
991 "description": "Lists all of the users with access to this business, as well as the types of access they each have.\n\nThis operation supports OData queries.",
992 "operationId": "BusinessAccess_GetAll",
993 "consumes": [],
994 "produces": [
995 "application/json",
996 "text/json",
997 "application/xml",
998 "text/xml"
999 ],
1000 "parameters": [
1001 {
1002 "name": "businessId",
1003 "in": "path",
1004 "required": true,
1005 "type": "string"
1006 }
1007 ],
1008 "responses": {
1009 "200": {
1010 "description": "OK",
1011 "schema": {
1012 "type": "array",
1013 "items": {
1014 "$ref": "#/definitions/BusinessAccessModel"
1015 },
1016 "xml": {
1017 "name": "BusinessAccessModel",
1018 "wrapped": true
1019 },
1020 "title": "IQueryable<BusinessAccessModel>"
1021 }
1022 }
1023 }
1024 },
1025 "put": {
1026 "tags": [
1027 "Business"
1028 ],
1029 "summary": "Update Business Access",
1030 "description": "Updates a user's access to this business.",
1031 "operationId": "BusinessAccess_Put",
1032 "consumes": [
1033 "application/json",
1034 "text/json",
1035 "application/xml",
1036 "text/xml",
1037 "application/x-www-form-urlencoded"
1038 ],
1039 "produces": [
1040 "application/json",
1041 "text/json",
1042 "application/xml",
1043 "text/xml"
1044 ],
1045 "parameters": [
1046 {
1047 "name": "email",
1048 "in": "query",
1049 "required": true,
1050 "type": "string",
1051 "title": "String"
1052 },
1053 {
1054 "name": "viewModel",
1055 "in": "body",
1056 "required": true,
1057 "schema": {
1058 "$ref": "#/definitions/AccessModel"
1059 }
1060 },
1061 {
1062 "name": "businessId",
1063 "in": "path",
1064 "required": true,
1065 "type": "string"
1066 }
1067 ],
1068 "responses": {
1069 "200": {
1070 "description": "OK"
1071 }
1072 }
1073 },
1074 "post": {
1075 "tags": [
1076 "Business"
1077 ],
1078 "summary": "Assign Business Access",
1079 "description": "Assigns business access to a name/email.",
1080 "operationId": "BusinessAccess_Post",
1081 "consumes": [
1082 "application/json",
1083 "text/json",
1084 "application/xml",
1085 "text/xml",
1086 "application/x-www-form-urlencoded"
1087 ],
1088 "produces": [
1089 "application/json",
1090 "text/json",
1091 "application/xml",
1092 "text/xml"
1093 ],
1094 "parameters": [
1095 {
1096 "name": "viewModel",
1097 "in": "body",
1098 "required": true,
1099 "schema": {
1100 "$ref": "#/definitions/CreateBusinessAccessModel"
1101 }
1102 },
1103 {
1104 "name": "businessId",
1105 "in": "path",
1106 "required": true,
1107 "type": "string"
1108 }
1109 ],
1110 "responses": {
1111 "200": {
1112 "description": "OK"
1113 }
1114 }
1115 },
1116 "delete": {
1117 "tags": [
1118 "Business"
1119 ],
1120 "summary": "Revoke Business Access",
1121 "description": "Revokes a user's access to the business.",
1122 "operationId": "BusinessAccess_Delete",
1123 "consumes": [],
1124 "produces": [
1125 "application/json",
1126 "text/json",
1127 "application/xml",
1128 "text/xml"
1129 ],
1130 "parameters": [
1131 {
1132 "name": "email",
1133 "in": "query",
1134 "required": true,
1135 "type": "string",
1136 "title": "String"
1137 },
1138 {
1139 "name": "businessId",
1140 "in": "path",
1141 "required": true,
1142 "type": "string"
1143 }
1144 ],
1145 "responses": {
1146 "200": {
1147 "description": "OK"
1148 }
1149 }
1150 }
1151 },
1152 "/api/v2/business/{businessId}/access/user": {
1153 "get": {
1154 "tags": [
1155 "Business"
1156 ],
1157 "summary": "Get User Business Access",
1158 "description": "Returns the business access assigned to the user with the specified email address.",
1159 "operationId": "BusinessAccess_Get",
1160 "consumes": [],
1161 "produces": [
1162 "application/json",
1163 "text/json",
1164 "application/xml",
1165 "text/xml"
1166 ],
1167 "parameters": [
1168 {
1169 "name": "email",
1170 "in": "query",
1171 "required": true,
1172 "type": "string",
1173 "title": "String"
1174 },
1175 {
1176 "name": "businessId",
1177 "in": "path",
1178 "required": true,
1179 "type": "string"
1180 }
1181 ],
1182 "responses": {
1183 "200": {
1184 "description": "OK",
1185 "schema": {
1186 "$ref": "#/definitions/BusinessAccessModel"
1187 }
1188 }
1189 }
1190 }
1191 },
1192 "/api/v2/business/{businessId}/deductioncategory": {
1193 "get": {
1194 "tags": [
1195 "DeductionCategories"
1196 ],
1197 "summary": "List Deduction Categories",
1198 "description": "Lists all the deduction categories for the business.\n\nThis operation supports OData queries.",
1199 "operationId": "DeductionCategory_GetDeductionCategories",
1200 "consumes": [],
1201 "produces": [
1202 "application/json",
1203 "text/json",
1204 "application/xml",
1205 "text/xml"
1206 ],
1207 "parameters": [
1208 {
1209 "name": "businessId",
1210 "in": "path",
1211 "required": true,
1212 "type": "string"
1213 }
1214 ],
1215 "responses": {
1216 "200": {
1217 "description": "OK",
1218 "schema": {
1219 "type": "array",
1220 "items": {
1221 "$ref": "#/definitions/DeductionCategoryModel"
1222 },
1223 "xml": {
1224 "name": "DeductionCategoryModel",
1225 "wrapped": true
1226 },
1227 "title": "IEnumerable<DeductionCategoryModel>"
1228 }
1229 }
1230 }
1231 },
1232 "post": {
1233 "tags": [
1234 "DeductionCategories"
1235 ],
1236 "summary": "Create Deduction Category",
1237 "description": "Creates a deduction category for the business.",
1238 "operationId": "DeductionCategory_Post",
1239 "consumes": [
1240 "application/json",
1241 "text/json",
1242 "application/xml",
1243 "text/xml",
1244 "application/x-www-form-urlencoded"
1245 ],
1246 "produces": [
1247 "application/json",
1248 "text/json",
1249 "application/xml",
1250 "text/xml"
1251 ],
1252 "parameters": [
1253 {
1254 "name": "deductionCategory",
1255 "in": "body",
1256 "required": true,
1257 "schema": {
1258 "$ref": "#/definitions/DeductionCategoryModel"
1259 }
1260 },
1261 {
1262 "name": "businessId",
1263 "in": "path",
1264 "required": true,
1265 "type": "string"
1266 }
1267 ],
1268 "responses": {
1269 "200": {
1270 "description": "OK"
1271 }
1272 }
1273 }
1274 },
1275 "/api/v2/business/{businessId}/deductioncategory/{id}": {
1276 "get": {
1277 "tags": [
1278 "DeductionCategories"
1279 ],
1280 "summary": "Get Deduction Category By ID",
1281 "description": "Gets the deduction category with the specified ID.",
1282 "operationId": "DeductionCategory_Get",
1283 "consumes": [],
1284 "produces": [
1285 "application/json",
1286 "text/json",
1287 "application/xml",
1288 "text/xml"
1289 ],
1290 "parameters": [
1291 {
1292 "name": "id",
1293 "in": "path",
1294 "required": true,
1295 "type": "integer",
1296 "format": "int32",
1297 "title": "Int32"
1298 },
1299 {
1300 "name": "businessId",
1301 "in": "path",
1302 "required": true,
1303 "type": "string"
1304 }
1305 ],
1306 "responses": {
1307 "200": {
1308 "description": "OK",
1309 "schema": {
1310 "$ref": "#/definitions/DeductionCategoryModel"
1311 }
1312 }
1313 }
1314 },
1315 "put": {
1316 "tags": [
1317 "DeductionCategories"
1318 ],
1319 "summary": "Update Deduction Category",
1320 "description": "Updates the deduction category with the specified ID.",
1321 "operationId": "DeductionCategory_Put",
1322 "consumes": [
1323 "application/json",
1324 "text/json",
1325 "application/xml",
1326 "text/xml",
1327 "application/x-www-form-urlencoded"
1328 ],
1329 "produces": [
1330 "application/json",
1331 "text/json",
1332 "application/xml",
1333 "text/xml"
1334 ],
1335 "parameters": [
1336 {
1337 "name": "id",
1338 "in": "path",
1339 "required": true,
1340 "type": "integer",
1341 "format": "int32",
1342 "title": "Int32"
1343 },
1344 {
1345 "name": "deductionCategory",
1346 "in": "body",
1347 "required": true,
1348 "schema": {
1349 "$ref": "#/definitions/DeductionCategoryModel"
1350 }
1351 },
1352 {
1353 "name": "businessId",
1354 "in": "path",
1355 "required": true,
1356 "type": "string"
1357 }
1358 ],
1359 "responses": {
1360 "200": {
1361 "description": "OK"
1362 }
1363 }
1364 },
1365 "delete": {
1366 "tags": [
1367 "DeductionCategories"
1368 ],
1369 "summary": "Delete Deduction Category",
1370 "description": "Deletes the deduction category with the specified ID.",
1371 "operationId": "DeductionCategory_Delete",
1372 "consumes": [],
1373 "produces": [
1374 "application/json",
1375 "text/json",
1376 "application/xml",
1377 "text/xml"
1378 ],
1379 "parameters": [
1380 {
1381 "name": "id",
1382 "in": "path",
1383 "required": true,
1384 "type": "integer",
1385 "format": "int32",
1386 "title": "Int32"
1387 },
1388 {
1389 "name": "businessId",
1390 "in": "path",
1391 "required": true,
1392 "type": "string"
1393 }
1394 ],
1395 "responses": {
1396 "200": {
1397 "description": "OK"
1398 }
1399 }
1400 }
1401 },
1402 "/api/v2/business/{businessId}/employee/{employeeId}/worktype": {
1403 "get": {
1404 "tags": [
1405 "Employee"
1406 ],
1407 "summary": "Get Employee Work Types",
1408 "description": "Lists all the work types for the employee.\n\nThis operation supports OData queries.",
1409 "operationId": "EmployeeWorkType_Get",
1410 "consumes": [],
1411 "produces": [
1412 "application/json",
1413 "text/json",
1414 "application/xml",
1415 "text/xml"
1416 ],
1417 "parameters": [
1418 {
1419 "name": "businessId",
1420 "in": "path",
1421 "required": true,
1422 "type": "string"
1423 },
1424 {
1425 "name": "employeeId",
1426 "in": "path",
1427 "required": true,
1428 "type": "string"
1429 }
1430 ],
1431 "responses": {
1432 "200": {
1433 "description": "OK",
1434 "schema": {
1435 "type": "array",
1436 "items": {
1437 "$ref": "#/definitions/WorkTypeModel"
1438 },
1439 "xml": {
1440 "name": "WorkTypeModel",
1441 "wrapped": true
1442 },
1443 "title": "IQueryable<WorkTypeModel>"
1444 }
1445 }
1446 }
1447 }
1448 },
1449 "/api/v2/business/{businessId}/employee/{employeeId}/image": {
1450 "get": {
1451 "tags": [
1452 "Employee"
1453 ],
1454 "summary": "Get Employee Profile Image",
1455 "description": "Returns the file content for the employee's current profile image.",
1456 "operationId": "EmployeeProfileImage_Get",
1457 "consumes": [],
1458 "produces": [
1459 "application/json",
1460 "text/json",
1461 "application/xml",
1462 "text/xml"
1463 ],
1464 "parameters": [
1465 {
1466 "name": "businessId",
1467 "in": "path",
1468 "required": true,
1469 "type": "string"
1470 },
1471 {
1472 "name": "employeeId",
1473 "in": "path",
1474 "required": true,
1475 "type": "string"
1476 }
1477 ],
1478 "responses": {
1479 "200": {
1480 "description": "OK"
1481 }
1482 }
1483 },
1484 "post": {
1485 "tags": [
1486 "Employee"
1487 ],
1488 "summary": "Set Employee Profile Image",
1489 "description": "Uploads a new employee profile image. The request should be a MIME multipart file upload request.",
1490 "operationId": "EmployeeProfileImage_Post",
1491 "consumes": [],
1492 "produces": [
1493 "application/json",
1494 "text/json",
1495 "application/xml",
1496 "text/xml"
1497 ],
1498 "parameters": [
1499 {
1500 "name": "businessId",
1501 "in": "path",
1502 "required": true,
1503 "type": "string"
1504 },
1505 {
1506 "name": "employeeId",
1507 "in": "path",
1508 "required": true,
1509 "type": "string"
1510 }
1511 ],
1512 "responses": {
1513 "200": {
1514 "description": "OK",
1515 "schema": {
1516 "$ref": "#/definitions/ProfileImageMetadata"
1517 }
1518 }
1519 }
1520 },
1521 "delete": {
1522 "tags": [
1523 "Employee"
1524 ],
1525 "summary": "Delete Employee Profile Image",
1526 "description": "Delete's the employee's profile image.",
1527 "operationId": "EmployeeProfileImage_Delete",
1528 "consumes": [],
1529 "produces": [
1530 "application/json",
1531 "text/json",
1532 "application/xml",
1533 "text/xml"
1534 ],
1535 "parameters": [
1536 {
1537 "name": "businessId",
1538 "in": "path",
1539 "required": true,
1540 "type": "string"
1541 },
1542 {
1543 "name": "employeeId",
1544 "in": "path",
1545 "required": true,
1546 "type": "string"
1547 }
1548 ],
1549 "responses": {
1550 "200": {
1551 "description": "OK"
1552 }
1553 }
1554 }
1555 },
1556 "/api/v2/business/{businessId}/employee/details": {
1557 "get": {
1558 "tags": [
1559 "Employee"
1560 ],
1561 "summary": "List basic details for employees",
1562 "description": "This endpoint returns a list of employees. The details are a subset of the 'unstructured' employee endpoint.\r\nThis data can be filtered much more efficiently though so if you only need the basic employee details, this endpoint is preferred.\n\nThis operation supports OData queries.",
1563 "operationId": "EmployeeDetails_GetEmployees",
1564 "consumes": [],
1565 "produces": [
1566 "application/json",
1567 "text/json",
1568 "application/xml",
1569 "text/xml"
1570 ],
1571 "parameters": [
1572 {
1573 "name": "businessId",
1574 "in": "path",
1575 "required": true,
1576 "type": "string"
1577 }
1578 ],
1579 "responses": {
1580 "200": {
1581 "description": "OK",
1582 "schema": {
1583 "$ref": "#/definitions/EmployeeDetailsModel"
1584 }
1585 }
1586 }
1587 }
1588 },
1589 "/api/v2/business/{businessId}/employee/{employeeId}/details": {
1590 "get": {
1591 "tags": [
1592 "Employee"
1593 ],
1594 "summary": "Get Employee basic details by ID",
1595 "description": "returns the basic employee details for the specified employee",
1596 "operationId": "EmployeeDetails_GetEmployee",
1597 "consumes": [],
1598 "produces": [
1599 "application/json",
1600 "text/json",
1601 "application/xml",
1602 "text/xml"
1603 ],
1604 "parameters": [
1605 {
1606 "name": "employeeId",
1607 "in": "path",
1608 "required": true,
1609 "type": "integer",
1610 "format": "int32",
1611 "title": "Int32"
1612 },
1613 {
1614 "name": "businessId",
1615 "in": "path",
1616 "required": true,
1617 "type": "string"
1618 }
1619 ],
1620 "responses": {
1621 "200": {
1622 "description": "OK",
1623 "schema": {
1624 "$ref": "#/definitions/EmployeeDetailsModel"
1625 }
1626 }
1627 }
1628 }
1629 },
1630 "/api/v2/business/{businessId}/employee/{employeeId}/shiftcondition": {
1631 "get": {
1632 "tags": [
1633 "Employee"
1634 ],
1635 "summary": "Get Employee Shift Conditions",
1636 "description": "Lists all the shift conditions for this employee.\n\nThis operation supports OData queries.",
1637 "operationId": "EmployeeShiftCondition_Get",
1638 "consumes": [],
1639 "produces": [
1640 "application/json",
1641 "text/json",
1642 "application/xml",
1643 "text/xml"
1644 ],
1645 "parameters": [
1646 {
1647 "name": "businessId",
1648 "in": "path",
1649 "required": true,
1650 "type": "string"
1651 },
1652 {
1653 "name": "employeeId",
1654 "in": "path",
1655 "required": true,
1656 "type": "string"
1657 }
1658 ],
1659 "responses": {
1660 "200": {
1661 "description": "OK",
1662 "schema": {
1663 "type": "array",
1664 "items": {
1665 "$ref": "#/definitions/WorkTypeModel"
1666 },
1667 "xml": {
1668 "name": "WorkTypeModel",
1669 "wrapped": true
1670 },
1671 "title": "IQueryable<WorkTypeModel>"
1672 }
1673 }
1674 }
1675 }
1676 },
1677 "/api/v2/business/{businessId}/employee/unstructured": {
1678 "get": {
1679 "tags": [
1680 "Employee"
1681 ],
1682 "summary": "List Employees",
1683 "description": "This endpoint returns the unstructured employee details for all matching employees.\r\n<p>\r\nSee also: List basic details for employees (which is much more efficient if that is all the information that is required)\r\n</p>\n\nThis operation supports OData queries.",
1684 "operationId": "Employee_GetEmployees",
1685 "consumes": [],
1686 "produces": [
1687 "application/json",
1688 "text/json",
1689 "application/xml",
1690 "text/xml"
1691 ],
1692 "parameters": [
1693 {
1694 "name": "businessId",
1695 "in": "path",
1696 "required": true,
1697 "type": "string"
1698 },
1699 {
1700 "name": "filter.payScheduleId",
1701 "in": "query",
1702 "required": false,
1703 "type": "integer",
1704 "format": "int32",
1705 "title": "Nullable<Int32>"
1706 },
1707 {
1708 "name": "filter.locationId",
1709 "in": "query",
1710 "required": false,
1711 "type": "integer",
1712 "format": "int32",
1713 "title": "Nullable<Int32>"
1714 }
1715 ],
1716 "responses": {
1717 "200": {
1718 "description": "OK",
1719 "schema": {
1720 "$ref": "#/definitions/UnstructuredEmployeeModel"
1721 }
1722 }
1723 }
1724 },
1725 "post": {
1726 "tags": [
1727 "Employee"
1728 ],
1729 "summary": "Create or Update Employee",
1730 "description": "If the employee with the specified ID already exists, update it. Otherwise, create a new employee.",
1731 "operationId": "Employee_PostEmployee",
1732 "consumes": [
1733 "application/json",
1734 "text/json",
1735 "application/xml",
1736 "text/xml",
1737 "application/x-www-form-urlencoded"
1738 ],
1739 "produces": [
1740 "application/json",
1741 "text/json",
1742 "application/xml",
1743 "text/xml"
1744 ],
1745 "parameters": [
1746 {
1747 "name": "model",
1748 "in": "body",
1749 "required": true,
1750 "schema": {
1751 "$ref": "#/definitions/UnstructuredEmployeeModel"
1752 }
1753 },
1754 {
1755 "name": "businessId",
1756 "in": "path",
1757 "required": true,
1758 "type": "string"
1759 }
1760 ],
1761 "responses": {
1762 "200": {
1763 "description": "OK"
1764 }
1765 }
1766 }
1767 },
1768 "/api/v2/business/{businessId}/employee/unstructured/{employeeId}": {
1769 "get": {
1770 "tags": [
1771 "Employee"
1772 ],
1773 "summary": "Get Employee By ID",
1774 "description": "Gets the employee with the specified ID.",
1775 "operationId": "Employee_GetEmployeeById",
1776 "consumes": [],
1777 "produces": [
1778 "application/json",
1779 "text/json",
1780 "application/xml",
1781 "text/xml"
1782 ],
1783 "parameters": [
1784 {
1785 "name": "employeeId",
1786 "in": "path",
1787 "required": true,
1788 "type": "integer",
1789 "format": "int32",
1790 "title": "Int32"
1791 },
1792 {
1793 "name": "businessId",
1794 "in": "path",
1795 "required": true,
1796 "type": "string"
1797 }
1798 ],
1799 "responses": {
1800 "200": {
1801 "description": "OK",
1802 "schema": {
1803 "$ref": "#/definitions/UnstructuredEmployeeModel"
1804 }
1805 }
1806 }
1807 },
1808 "put": {
1809 "tags": [
1810 "Employee"
1811 ],
1812 "summary": "Update Employee",
1813 "description": "Updates the employee with the specified ID.",
1814 "operationId": "Employee_PutEmployee",
1815 "consumes": [
1816 "application/json",
1817 "text/json",
1818 "application/xml",
1819 "text/xml",
1820 "application/x-www-form-urlencoded"
1821 ],
1822 "produces": [
1823 "application/json",
1824 "text/json",
1825 "application/xml",
1826 "text/xml"
1827 ],
1828 "parameters": [
1829 {
1830 "name": "employeeId",
1831 "in": "path",
1832 "required": true,
1833 "type": "integer",
1834 "format": "int32",
1835 "title": "Int32"
1836 },
1837 {
1838 "name": "model",
1839 "in": "body",
1840 "required": true,
1841 "schema": {
1842 "$ref": "#/definitions/UnstructuredEmployeeModel"
1843 }
1844 },
1845 {
1846 "name": "businessId",
1847 "in": "path",
1848 "required": true,
1849 "type": "string"
1850 }
1851 ],
1852 "responses": {
1853 "200": {
1854 "description": "OK"
1855 }
1856 }
1857 }
1858 },
1859 "/api/v2/business/{businessId}/employee/unstructured/externalid": {
1860 "get": {
1861 "tags": [
1862 "Employee"
1863 ],
1864 "summary": "Get Employee By External ID",
1865 "description": "Gets the employee with the specified external ID.",
1866 "operationId": "Employee_GetEmployeeByExternalId",
1867 "consumes": [],
1868 "produces": [
1869 "application/json",
1870 "text/json",
1871 "application/xml",
1872 "text/xml"
1873 ],
1874 "parameters": [
1875 {
1876 "name": "externalId",
1877 "in": "query",
1878 "required": true,
1879 "type": "string",
1880 "title": "String"
1881 },
1882 {
1883 "name": "businessId",
1884 "in": "path",
1885 "required": true,
1886 "type": "string"
1887 }
1888 ],
1889 "responses": {
1890 "200": {
1891 "description": "OK",
1892 "schema": {
1893 "$ref": "#/definitions/UnstructuredEmployeeModel"
1894 }
1895 }
1896 }
1897 }
1898 },
1899 "/api/v2/business/{businessId}/employee/unstructured/externalreferenceid": {
1900 "get": {
1901 "tags": [
1902 "Employee"
1903 ],
1904 "summary": "Get Employee By External Reference ID",
1905 "description": "Gets the employee with the specified external reference ID.",
1906 "operationId": "Employee_GetByExternalReferenceId",
1907 "consumes": [],
1908 "produces": [
1909 "application/json",
1910 "text/json",
1911 "application/xml",
1912 "text/xml"
1913 ],
1914 "parameters": [
1915 {
1916 "name": "externalReferenceId",
1917 "in": "query",
1918 "required": true,
1919 "type": "string",
1920 "title": "String"
1921 },
1922 {
1923 "name": "source",
1924 "in": "query",
1925 "required": true,
1926 "type": "string",
1927 "enum": [
1928 "None",
1929 "Saasu",
1930 "Xero",
1931 "MYOB",
1932 "Deputy",
1933 "EmployeeTimePunch",
1934 "ClickSuper",
1935 "IntegratedTimesheets",
1936 "FileImport",
1937 "FileExport",
1938 "QuickBooks",
1939 "Harmony",
1940 "AwardStore",
1941 "Attache",
1942 "IntegratedRostering",
1943 "ReckonAccounts",
1944 "API",
1945 "MicroPower",
1946 "RosterLive",
1947 "NetSuite",
1948 "Kounta",
1949 "TimeAndAttendanceKiosk",
1950 "DetailedFileExport",
1951 "JonasPremier",
1952 "WageEasy",
1953 "Maestrano",
1954 "WorkZone",
1955 "EmployeePortal",
1956 "RosterTemplate",
1957 "Onboarding",
1958 "Admin",
1959 "WorkZoneClockOnOff"
1960 ],
1961 "title": "ExternalService"
1962 },
1963 {
1964 "name": "businessId",
1965 "in": "path",
1966 "required": true,
1967 "type": "string"
1968 }
1969 ],
1970 "responses": {
1971 "200": {
1972 "description": "OK",
1973 "schema": {
1974 "$ref": "#/definitions/UnstructuredEmployeeModel"
1975 }
1976 }
1977 }
1978 }
1979 },
1980 "/api/v2/business/{businessId}/employee/{employeeId}": {
1981 "delete": {
1982 "tags": [
1983 "Employee"
1984 ],
1985 "summary": "Delete Employee",
1986 "description": "Deletes the employee with the specified ID.",
1987 "operationId": "Employee_DeleteEmployee",
1988 "consumes": [],
1989 "produces": [
1990 "application/json",
1991 "text/json",
1992 "application/xml",
1993 "text/xml"
1994 ],
1995 "parameters": [
1996 {
1997 "name": "employeeId",
1998 "in": "path",
1999 "required": true,
2000 "type": "integer",
2001 "format": "int32",
2002 "title": "Int32"
2003 },
2004 {
2005 "name": "businessId",
2006 "in": "path",
2007 "required": true,
2008 "type": "string"
2009 }
2010 ],
2011 "responses": {
2012 "200": {
2013 "description": "OK"
2014 }
2015 }
2016 }
2017 },
2018 "/api/v2/business/{businessId}/employee/{employeeId}/synctoqbo": {
2019 "post": {
2020 "tags": [
2021 "Employee"
2022 ],
2023 "summary": "Sync Employee to QBO",
2024 "description": "Syncs an employee record to QBO.",
2025 "operationId": "Employee_SyncEmployeeToQBO",
2026 "consumes": [],
2027 "produces": [
2028 "application/json",
2029 "text/json",
2030 "application/xml",
2031 "text/xml"
2032 ],
2033 "parameters": [
2034 {
2035 "name": "employeeId",
2036 "in": "path",
2037 "required": true,
2038 "type": "integer",
2039 "format": "int32",
2040 "title": "Int32"
2041 },
2042 {
2043 "name": "businessId",
2044 "in": "path",
2045 "required": true,
2046 "type": "string"
2047 }
2048 ],
2049 "responses": {
2050 "200": {
2051 "description": "OK"
2052 }
2053 }
2054 }
2055 },
2056 "/api/v2/business/{businessId}/employee/activate/{employeeId}": {
2057 "post": {
2058 "tags": [
2059 "Employee"
2060 ],
2061 "summary": "Activate Employee",
2062 "description": "Activates the employee with the specified ID.",
2063 "operationId": "EmployeeActivate_PostActivate",
2064 "consumes": [],
2065 "produces": [
2066 "application/json",
2067 "text/json",
2068 "application/xml",
2069 "text/xml"
2070 ],
2071 "parameters": [
2072 {
2073 "name": "employeeId",
2074 "in": "path",
2075 "required": true,
2076 "type": "integer",
2077 "format": "int32",
2078 "title": "Int32"
2079 },
2080 {
2081 "name": "businessId",
2082 "in": "path",
2083 "required": true,
2084 "type": "string"
2085 }
2086 ],
2087 "responses": {
2088 "200": {
2089 "description": "OK"
2090 }
2091 }
2092 }
2093 },
2094 "/api/v2/business/{businessId}/employee/{employeeId}/leavebalances": {
2095 "get": {
2096 "tags": [
2097 "Employee"
2098 ],
2099 "summary": "Get Leave Balances",
2100 "description": "Gets leave balances for this employee.",
2101 "operationId": "LeaveBalances_GetLeaveBalances",
2102 "consumes": [],
2103 "produces": [
2104 "application/json",
2105 "text/json",
2106 "application/xml",
2107 "text/xml"
2108 ],
2109 "parameters": [
2110 {
2111 "name": "asAtDate",
2112 "in": "query",
2113 "required": false,
2114 "type": "string",
2115 "format": "date-time",
2116 "title": "Nullable<DateTime>"
2117 },
2118 {
2119 "name": "businessId",
2120 "in": "path",
2121 "required": true,
2122 "type": "string"
2123 },
2124 {
2125 "name": "employeeId",
2126 "in": "path",
2127 "required": true,
2128 "type": "string"
2129 }
2130 ],
2131 "responses": {
2132 "200": {
2133 "description": "OK",
2134 "schema": {
2135 "type": "array",
2136 "items": {
2137 "$ref": "#/definitions/LeaveBalanceModel"
2138 },
2139 "xml": {
2140 "name": "LeaveBalanceModel",
2141 "wrapped": true
2142 },
2143 "title": "IList<LeaveBalanceModel>"
2144 }
2145 }
2146 }
2147 }
2148 },
2149 "/api/v2/business/{businessId}/employee/{employeeId}/notes": {
2150 "get": {
2151 "tags": [
2152 "Employee"
2153 ],
2154 "summary": "Get Employee Notes",
2155 "description": "Gets the notes for the specified employee.",
2156 "operationId": "Notes_Get",
2157 "consumes": [],
2158 "produces": [
2159 "application/json",
2160 "text/json",
2161 "application/xml",
2162 "text/xml"
2163 ],
2164 "parameters": [
2165 {
2166 "name": "businessId",
2167 "in": "path",
2168 "required": true,
2169 "type": "string"
2170 },
2171 {
2172 "name": "employeeId",
2173 "in": "path",
2174 "required": true,
2175 "type": "string"
2176 }
2177 ],
2178 "responses": {
2179 "200": {
2180 "description": "OK",
2181 "schema": {
2182 "type": "array",
2183 "items": {
2184 "$ref": "#/definitions/EmployeeNoteModel"
2185 },
2186 "xml": {
2187 "name": "EmployeeNoteModel",
2188 "wrapped": true
2189 },
2190 "title": "IList<EmployeeNoteModel>"
2191 }
2192 }
2193 }
2194 },
2195 "post": {
2196 "tags": [
2197 "Employee"
2198 ],
2199 "summary": "Set Employee Notes",
2200 "description": "Sets the notes for the specified employee.",
2201 "operationId": "Notes_Post",
2202 "consumes": [
2203 "application/json",
2204 "text/json",
2205 "application/xml",
2206 "text/xml",
2207 "application/x-www-form-urlencoded"
2208 ],
2209 "produces": [
2210 "application/json",
2211 "text/json",
2212 "application/xml",
2213 "text/xml"
2214 ],
2215 "parameters": [
2216 {
2217 "name": "model",
2218 "in": "body",
2219 "required": true,
2220 "schema": {
2221 "$ref": "#/definitions/CreateEmployeeNoteModel"
2222 }
2223 },
2224 {
2225 "name": "businessId",
2226 "in": "path",
2227 "required": true,
2228 "type": "string"
2229 },
2230 {
2231 "name": "employeeId",
2232 "in": "path",
2233 "required": true,
2234 "type": "string"
2235 }
2236 ],
2237 "responses": {
2238 "200": {
2239 "description": "OK"
2240 }
2241 }
2242 }
2243 },
2244 "/api/v2/business/{businessId}/employee/{employeeId}/payrate": {
2245 "get": {
2246 "tags": [
2247 "Employee"
2248 ],
2249 "summary": "Get Pay Rates",
2250 "description": "Gets the pay rates for this employee.",
2251 "operationId": "EmployeePayRates_Get",
2252 "consumes": [],
2253 "produces": [
2254 "application/json",
2255 "text/json",
2256 "application/xml",
2257 "text/xml"
2258 ],
2259 "parameters": [
2260 {
2261 "name": "businessId",
2262 "in": "path",
2263 "required": true,
2264 "type": "string"
2265 },
2266 {
2267 "name": "employeeId",
2268 "in": "path",
2269 "required": true,
2270 "type": "string"
2271 }
2272 ],
2273 "responses": {
2274 "200": {
2275 "description": "OK",
2276 "schema": {
2277 "type": "array",
2278 "items": {
2279 "$ref": "#/definitions/EmployeePayRateModel"
2280 },
2281 "xml": {
2282 "name": "EmployeePayRateModel",
2283 "wrapped": true
2284 },
2285 "title": "IList<EmployeePayRateModel>"
2286 }
2287 }
2288 }
2289 }
2290 },
2291 "/api/v2/business/{businessId}/employee/grantkioskaccess/{employeeId}": {
2292 "post": {
2293 "tags": [
2294 "Employee"
2295 ],
2296 "summary": "Grant Kiosk Access",
2297 "description": "Grants kiosk access to the specified employee.",
2298 "operationId": "EmployeeKioskAccess_PostGrantKioskAccess",
2299 "consumes": [],
2300 "produces": [
2301 "application/json",
2302 "text/json",
2303 "application/xml",
2304 "text/xml"
2305 ],
2306 "parameters": [
2307 {
2308 "name": "employeeId",
2309 "in": "path",
2310 "required": true,
2311 "type": "integer",
2312 "format": "int32",
2313 "title": "Int32"
2314 },
2315 {
2316 "name": "businessId",
2317 "in": "path",
2318 "required": true,
2319 "type": "string"
2320 }
2321 ],
2322 "responses": {
2323 "200": {
2324 "description": "OK"
2325 }
2326 }
2327 }
2328 },
2329 "/api/v2/business/{businessId}/employee/revokekioskaccess/{employeeId}": {
2330 "post": {
2331 "tags": [
2332 "Employee"
2333 ],
2334 "summary": "Revoke Kiosk Access",
2335 "description": "Revokes kiosk access from the specified employee.",
2336 "operationId": "EmployeeKioskAccess_PostRevokeKioskAccess",
2337 "consumes": [],
2338 "produces": [
2339 "application/json",
2340 "text/json",
2341 "application/xml",
2342 "text/xml"
2343 ],
2344 "parameters": [
2345 {
2346 "name": "employeeId",
2347 "in": "path",
2348 "required": true,
2349 "type": "integer",
2350 "format": "int32",
2351 "title": "Int32"
2352 },
2353 {
2354 "name": "businessId",
2355 "in": "path",
2356 "required": true,
2357 "type": "string"
2358 }
2359 ],
2360 "responses": {
2361 "200": {
2362 "description": "OK"
2363 }
2364 }
2365 }
2366 },
2367 "/api/v2/business/{businessId}/employee/{employeeId}/OpeningBalances": {
2368 "get": {
2369 "tags": [
2370 "Employee"
2371 ],
2372 "summary": "Get Opening Balances",
2373 "description": "Gets the opening balances for this employee.",
2374 "operationId": "OpeningBalances_Get",
2375 "consumes": [],
2376 "produces": [
2377 "application/json",
2378 "text/json",
2379 "application/xml",
2380 "text/xml"
2381 ],
2382 "parameters": [
2383 {
2384 "name": "businessId",
2385 "in": "path",
2386 "required": true,
2387 "type": "string"
2388 },
2389 {
2390 "name": "employeeId",
2391 "in": "path",
2392 "required": true,
2393 "type": "string"
2394 }
2395 ],
2396 "responses": {
2397 "200": {
2398 "description": "OK",
2399 "schema": {
2400 "$ref": "#/definitions/OpeningBalancesEditModel"
2401 }
2402 }
2403 }
2404 },
2405 "post": {
2406 "tags": [
2407 "Employee"
2408 ],
2409 "summary": "Set Opening Balances",
2410 "description": "Sets the opening balances for this employee.",
2411 "operationId": "OpeningBalances_Post",
2412 "consumes": [
2413 "application/json",
2414 "text/json",
2415 "application/xml",
2416 "text/xml",
2417 "application/x-www-form-urlencoded"
2418 ],
2419 "produces": [
2420 "application/json",
2421 "text/json",
2422 "application/xml",
2423 "text/xml"
2424 ],
2425 "parameters": [
2426 {
2427 "name": "model",
2428 "in": "body",
2429 "required": true,
2430 "schema": {
2431 "$ref": "#/definitions/OpeningBalancesEditModel"
2432 }
2433 },
2434 {
2435 "name": "businessId",
2436 "in": "path",
2437 "required": true,
2438 "type": "string"
2439 },
2440 {
2441 "name": "employeeId",
2442 "in": "path",
2443 "required": true,
2444 "type": "string"
2445 }
2446 ],
2447 "responses": {
2448 "200": {
2449 "description": "OK"
2450 }
2451 }
2452 }
2453 },
2454 "/api/v2/business/{businessId}/employee/{employeeId}/access": {
2455 "get": {
2456 "tags": [
2457 "EmployeeAccess"
2458 ],
2459 "summary": "Get Users With Access to Employee",
2460 "description": "Gets a list of all users with access to this employee.\n\nThis operation supports OData queries.",
2461 "operationId": "EmployeeAccess_GetAll",
2462 "consumes": [],
2463 "produces": [
2464 "application/json",
2465 "text/json",
2466 "application/xml",
2467 "text/xml"
2468 ],
2469 "parameters": [
2470 {
2471 "name": "businessId",
2472 "in": "path",
2473 "required": true,
2474 "type": "string"
2475 },
2476 {
2477 "name": "employeeId",
2478 "in": "path",
2479 "required": true,
2480 "type": "string"
2481 }
2482 ],
2483 "responses": {
2484 "200": {
2485 "description": "OK",
2486 "schema": {
2487 "type": "array",
2488 "items": {
2489 "$ref": "#/definitions/EmployeeAccessModel"
2490 },
2491 "xml": {
2492 "name": "EmployeeAccessModel",
2493 "wrapped": true
2494 },
2495 "title": "IQueryable<EmployeeAccessModel>"
2496 }
2497 }
2498 }
2499 },
2500 "put": {
2501 "tags": [
2502 "EmployeeAccess"
2503 ],
2504 "summary": "Update Employee Access Record",
2505 "description": "Updates the employee access record for the specified user.",
2506 "operationId": "EmployeeAccess_UpdateUserAccess",
2507 "consumes": [
2508 "application/json",
2509 "text/json",
2510 "application/xml",
2511 "text/xml",
2512 "application/x-www-form-urlencoded"
2513 ],
2514 "produces": [
2515 "application/json",
2516 "text/json",
2517 "application/xml",
2518 "text/xml"
2519 ],
2520 "parameters": [
2521 {
2522 "name": "email",
2523 "in": "query",
2524 "required": true,
2525 "type": "string",
2526 "title": "String"
2527 },
2528 {
2529 "name": "viewModel",
2530 "in": "body",
2531 "required": true,
2532 "schema": {
2533 "$ref": "#/definitions/AccessModel"
2534 }
2535 },
2536 {
2537 "name": "businessId",
2538 "in": "path",
2539 "required": true,
2540 "type": "string"
2541 },
2542 {
2543 "name": "employeeId",
2544 "in": "path",
2545 "required": true,
2546 "type": "string"
2547 }
2548 ],
2549 "responses": {
2550 "200": {
2551 "description": "OK"
2552 }
2553 }
2554 },
2555 "post": {
2556 "tags": [
2557 "EmployeeAccess"
2558 ],
2559 "summary": "Grant Employee Access",
2560 "description": "Grants a user access to the employee.",
2561 "operationId": "EmployeeAccess_AddEmployeeAccess",
2562 "consumes": [
2563 "application/json",
2564 "text/json",
2565 "application/xml",
2566 "text/xml",
2567 "application/x-www-form-urlencoded"
2568 ],
2569 "produces": [
2570 "application/json",
2571 "text/json",
2572 "application/xml",
2573 "text/xml"
2574 ],
2575 "parameters": [
2576 {
2577 "name": "viewModel",
2578 "in": "body",
2579 "required": true,
2580 "schema": {
2581 "$ref": "#/definitions/CreateEmployeeAccessModel"
2582 }
2583 },
2584 {
2585 "name": "businessId",
2586 "in": "path",
2587 "required": true,
2588 "type": "string"
2589 },
2590 {
2591 "name": "employeeId",
2592 "in": "path",
2593 "required": true,
2594 "type": "string"
2595 }
2596 ],
2597 "responses": {
2598 "200": {
2599 "description": "OK"
2600 }
2601 }
2602 },
2603 "delete": {
2604 "tags": [
2605 "EmployeeAccess"
2606 ],
2607 "summary": "Revoke Employee Access",
2608 "description": "Revoke a user's access to the employee.",
2609 "operationId": "EmployeeAccess_DeleteEmployeeAccess",
2610 "consumes": [],
2611 "produces": [
2612 "application/json",
2613 "text/json",
2614 "application/xml",
2615 "text/xml"
2616 ],
2617 "parameters": [
2618 {
2619 "name": "email",
2620 "in": "query",
2621 "required": true,
2622 "type": "string",
2623 "title": "String"
2624 },
2625 {
2626 "name": "businessId",
2627 "in": "path",
2628 "required": true,
2629 "type": "string"
2630 },
2631 {
2632 "name": "employeeId",
2633 "in": "path",
2634 "required": true,
2635 "type": "string"
2636 }
2637 ],
2638 "responses": {
2639 "200": {
2640 "description": "OK"
2641 }
2642 }
2643 }
2644 },
2645 "/api/v2/business/{businessId}/employee/{employeeId}/access/email": {
2646 "get": {
2647 "tags": [
2648 "EmployeeAccess"
2649 ],
2650 "summary": "Get Employee Access for User",
2651 "description": "Gets a list of all employees to which the user (specified by email) has access.",
2652 "operationId": "EmployeeAccess_ListEmployeeAccess",
2653 "consumes": [],
2654 "produces": [
2655 "application/json",
2656 "text/json",
2657 "application/xml",
2658 "text/xml"
2659 ],
2660 "parameters": [
2661 {
2662 "name": "email",
2663 "in": "query",
2664 "required": true,
2665 "type": "string",
2666 "title": "String"
2667 },
2668 {
2669 "name": "businessId",
2670 "in": "path",
2671 "required": true,
2672 "type": "string"
2673 },
2674 {
2675 "name": "employeeId",
2676 "in": "path",
2677 "required": true,
2678 "type": "string"
2679 }
2680 ],
2681 "responses": {
2682 "200": {
2683 "description": "OK",
2684 "schema": {
2685 "$ref": "#/definitions/EmployeeAccessModel"
2686 }
2687 }
2688 }
2689 }
2690 },
2691 "/api/v2/business/{businessId}/employee/{employeeId}/bankaccount": {
2692 "get": {
2693 "tags": [
2694 "EmployeeBankAccount"
2695 ],
2696 "summary": "List Bank Accounts",
2697 "description": "Lists all of the bank accounts for this employee.",
2698 "operationId": "EmployeeBankAccount_List",
2699 "consumes": [],
2700 "produces": [
2701 "application/json",
2702 "text/json",
2703 "application/xml",
2704 "text/xml"
2705 ],
2706 "parameters": [
2707 {
2708 "name": "businessId",
2709 "in": "path",
2710 "required": true,
2711 "type": "string"
2712 },
2713 {
2714 "name": "employeeId",
2715 "in": "path",
2716 "required": true,
2717 "type": "string"
2718 }
2719 ],
2720 "responses": {
2721 "200": {
2722 "description": "OK",
2723 "schema": {
2724 "type": "array",
2725 "items": {
2726 "$ref": "#/definitions/BankAccountModel"
2727 },
2728 "xml": {
2729 "name": "BankAccountModel",
2730 "wrapped": true
2731 },
2732 "title": "IEnumerable<BankAccountModel>"
2733 }
2734 }
2735 }
2736 },
2737 "post": {
2738 "tags": [
2739 "EmployeeBankAccount"
2740 ],
2741 "summary": "Create Bank Account",
2742 "description": "Creates a new bank account for the employee.",
2743 "operationId": "EmployeeBankAccount_Post",
2744 "consumes": [
2745 "application/json",
2746 "text/json",
2747 "application/xml",
2748 "text/xml",
2749 "application/x-www-form-urlencoded"
2750 ],
2751 "produces": [
2752 "application/json",
2753 "text/json",
2754 "application/xml",
2755 "text/xml"
2756 ],
2757 "parameters": [
2758 {
2759 "name": "model",
2760 "in": "body",
2761 "required": true,
2762 "schema": {
2763 "$ref": "#/definitions/BankAccountModel"
2764 }
2765 },
2766 {
2767 "name": "businessId",
2768 "in": "path",
2769 "required": true,
2770 "type": "string"
2771 },
2772 {
2773 "name": "employeeId",
2774 "in": "path",
2775 "required": true,
2776 "type": "string"
2777 }
2778 ],
2779 "responses": {
2780 "200": {
2781 "description": "OK",
2782 "schema": {
2783 "$ref": "#/definitions/SaveBankAccountResponseModel"
2784 }
2785 }
2786 }
2787 }
2788 },
2789 "/api/v2/business/{businessId}/employee/{employeeId}/bankaccount/{bankAccountId}": {
2790 "get": {
2791 "tags": [
2792 "EmployeeBankAccount"
2793 ],
2794 "summary": "Get Bank Account by ID",
2795 "description": "Gets the bank account for this employee with the specified ID.",
2796 "operationId": "EmployeeBankAccount_Get",
2797 "consumes": [],
2798 "produces": [
2799 "application/json",
2800 "text/json",
2801 "application/xml",
2802 "text/xml"
2803 ],
2804 "parameters": [
2805 {
2806 "name": "bankAccountId",
2807 "in": "path",
2808 "required": true,
2809 "type": "integer",
2810 "format": "int32",
2811 "title": "Int32"
2812 },
2813 {
2814 "name": "businessId",
2815 "in": "path",
2816 "required": true,
2817 "type": "string"
2818 },
2819 {
2820 "name": "employeeId",
2821 "in": "path",
2822 "required": true,
2823 "type": "string"
2824 }
2825 ],
2826 "responses": {
2827 "200": {
2828 "description": "OK",
2829 "schema": {
2830 "$ref": "#/definitions/BankAccountModel"
2831 }
2832 }
2833 }
2834 },
2835 "delete": {
2836 "tags": [
2837 "EmployeeBankAccount"
2838 ],
2839 "summary": "Delete Bank Account",
2840 "description": "Deletes the employee's bank account with the specified ID.",
2841 "operationId": "EmployeeBankAccount_Delete",
2842 "consumes": [],
2843 "produces": [
2844 "application/json",
2845 "text/json",
2846 "application/xml",
2847 "text/xml"
2848 ],
2849 "parameters": [
2850 {
2851 "name": "bankAccountId",
2852 "in": "path",
2853 "required": true,
2854 "type": "integer",
2855 "format": "int32",
2856 "title": "Int32"
2857 },
2858 {
2859 "name": "businessId",
2860 "in": "path",
2861 "required": true,
2862 "type": "string"
2863 },
2864 {
2865 "name": "employeeId",
2866 "in": "path",
2867 "required": true,
2868 "type": "string"
2869 }
2870 ],
2871 "responses": {
2872 "200": {
2873 "description": "OK",
2874 "schema": {
2875 "$ref": "#/definitions/SaveBankAccountResponseModel"
2876 }
2877 }
2878 }
2879 }
2880 },
2881 "/api/v2/business/{businessId}/employee/{employeeId}/bankaccount/{id}": {
2882 "put": {
2883 "tags": [
2884 "EmployeeBankAccount"
2885 ],
2886 "summary": "Update Bank Account",
2887 "description": "Updates the employee's bank account with the specified ID.",
2888 "operationId": "EmployeeBankAccount_Put",
2889 "consumes": [
2890 "application/json",
2891 "text/json",
2892 "application/xml",
2893 "text/xml",
2894 "application/x-www-form-urlencoded"
2895 ],
2896 "produces": [
2897 "application/json",
2898 "text/json",
2899 "application/xml",
2900 "text/xml"
2901 ],
2902 "parameters": [
2903 {
2904 "name": "id",
2905 "in": "path",
2906 "required": true,
2907 "type": "integer",
2908 "format": "int32",
2909 "title": "Int32"
2910 },
2911 {
2912 "name": "model",
2913 "in": "body",
2914 "required": true,
2915 "schema": {
2916 "$ref": "#/definitions/BankAccountModel"
2917 }
2918 },
2919 {
2920 "name": "businessId",
2921 "in": "path",
2922 "required": true,
2923 "type": "string"
2924 },
2925 {
2926 "name": "employeeId",
2927 "in": "path",
2928 "required": true,
2929 "type": "string"
2930 }
2931 ],
2932 "responses": {
2933 "200": {
2934 "description": "OK",
2935 "schema": {
2936 "$ref": "#/definitions/SaveBankAccountResponseModel"
2937 }
2938 }
2939 }
2940 }
2941 },
2942 "/api/v2/business/{businessId}/employee/{employeeId}/document/{documentId}/timesheet/{id}": {
2943 "post": {
2944 "tags": [
2945 "EmployeeDocument"
2946 ],
2947 "summary": "Link Employee Document to Timesheet",
2948 "description": "Takes the specified employee document and adds it as an attachment to the timesheet with the specified ID.",
2949 "operationId": "EmployeeDocumentTimesheetLink_CreateLink",
2950 "consumes": [],
2951 "produces": [
2952 "application/json",
2953 "text/json",
2954 "application/xml",
2955 "text/xml"
2956 ],
2957 "parameters": [
2958 {
2959 "name": "documentId",
2960 "in": "path",
2961 "required": true,
2962 "type": "integer",
2963 "format": "int32",
2964 "title": "Int32"
2965 },
2966 {
2967 "name": "id",
2968 "in": "path",
2969 "required": true,
2970 "type": "integer",
2971 "format": "int32",
2972 "title": "Int32"
2973 },
2974 {
2975 "name": "businessId",
2976 "in": "path",
2977 "required": true,
2978 "type": "string"
2979 },
2980 {
2981 "name": "employeeId",
2982 "in": "path",
2983 "required": true,
2984 "type": "string"
2985 }
2986 ],
2987 "responses": {
2988 "200": {
2989 "description": "OK"
2990 }
2991 }
2992 },
2993 "delete": {
2994 "tags": [
2995 "EmployeeDocument"
2996 ],
2997 "summary": "Unlink Employee Document from Timesheet",
2998 "description": "If the specified employee document is attached to the specified timesheet, unattach it.",
2999 "operationId": "EmployeeDocumentTimesheetLink_RemoveLink",
3000 "consumes": [],
3001 "produces": [
3002 "application/json",
3003 "text/json",
3004 "application/xml",
3005 "text/xml"
3006 ],
3007 "parameters": [
3008 {
3009 "name": "documentId",
3010 "in": "path",
3011 "required": true,
3012 "type": "integer",
3013 "format": "int32",
3014 "title": "Int32"
3015 },
3016 {
3017 "name": "id",
3018 "in": "path",
3019 "required": true,
3020 "type": "integer",
3021 "format": "int32",
3022 "title": "Int32"
3023 },
3024 {
3025 "name": "businessId",
3026 "in": "path",
3027 "required": true,
3028 "type": "string"
3029 },
3030 {
3031 "name": "employeeId",
3032 "in": "path",
3033 "required": true,
3034 "type": "string"
3035 }
3036 ],
3037 "responses": {
3038 "200": {
3039 "description": "OK"
3040 }
3041 }
3042 }
3043 },
3044 "/api/v2/business/{businessId}/employee/{employeeId}/document": {
3045 "get": {
3046 "tags": [
3047 "EmployeeDocument"
3048 ],
3049 "summary": "List Employee Documents",
3050 "description": "Lists all the documents for this employee.",
3051 "operationId": "EmployeeDocument_List",
3052 "consumes": [],
3053 "produces": [
3054 "application/json",
3055 "text/json",
3056 "application/xml",
3057 "text/xml"
3058 ],
3059 "parameters": [
3060 {
3061 "name": "businessId",
3062 "in": "path",
3063 "required": true,
3064 "type": "string"
3065 },
3066 {
3067 "name": "employeeId",
3068 "in": "path",
3069 "required": true,
3070 "type": "string"
3071 }
3072 ],
3073 "responses": {
3074 "200": {
3075 "description": "OK",
3076 "schema": {
3077 "type": "array",
3078 "items": {
3079 "$ref": "#/definitions/EmployeeDocumentModel"
3080 },
3081 "xml": {
3082 "name": "EmployeeDocumentModel",
3083 "wrapped": true
3084 },
3085 "title": "List<EmployeeDocumentModel>"
3086 }
3087 }
3088 }
3089 },
3090 "put": {
3091 "tags": [
3092 "EmployeeDocument"
3093 ],
3094 "summary": "Update Employee Document Permissions",
3095 "description": "Updates permissions for the employee document with the specified ID.",
3096 "operationId": "EmployeeDocument_UpdatePermissions",
3097 "consumes": [
3098 "application/json",
3099 "text/json",
3100 "application/xml",
3101 "text/xml",
3102 "application/x-www-form-urlencoded"
3103 ],
3104 "produces": [
3105 "application/json",
3106 "text/json",
3107 "application/xml",
3108 "text/xml"
3109 ],
3110 "parameters": [
3111 {
3112 "name": "model",
3113 "in": "body",
3114 "required": true,
3115 "schema": {
3116 "$ref": "#/definitions/UpdateEmployeeDocumentPermissionsModel"
3117 }
3118 },
3119 {
3120 "name": "businessId",
3121 "in": "path",
3122 "required": true,
3123 "type": "string"
3124 },
3125 {
3126 "name": "employeeId",
3127 "in": "path",
3128 "required": true,
3129 "type": "string"
3130 }
3131 ],
3132 "responses": {
3133 "200": {
3134 "description": "OK",
3135 "schema": {
3136 "$ref": "#/definitions/EmployeeDocumentModel"
3137 }
3138 }
3139 }
3140 },
3141 "post": {
3142 "tags": [
3143 "EmployeeDocument"
3144 ],
3145 "summary": "Create Employee Document",
3146 "description": "Uploads new document(s) for this employee. The request should be a MIME multipart file upload request.",
3147 "operationId": "EmployeeDocument_Upload",
3148 "consumes": [],
3149 "produces": [
3150 "application/json",
3151 "text/json",
3152 "application/xml",
3153 "text/xml"
3154 ],
3155 "parameters": [
3156 {
3157 "name": "visible",
3158 "in": "query",
3159 "required": false,
3160 "type": "boolean",
3161 "default": false,
3162 "title": "Boolean"
3163 },
3164 {
3165 "name": "businessId",
3166 "in": "path",
3167 "required": true,
3168 "type": "string"
3169 },
3170 {
3171 "name": "employeeId",
3172 "in": "path",
3173 "required": true,
3174 "type": "string"
3175 }
3176 ],
3177 "responses": {
3178 "200": {
3179 "description": "OK",
3180 "schema": {
3181 "type": "array",
3182 "items": {
3183 "$ref": "#/definitions/EmployeeDocumentModel"
3184 },
3185 "xml": {
3186 "name": "EmployeeDocumentModel",
3187 "wrapped": true
3188 },
3189 "title": "List<EmployeeDocumentModel>"
3190 }
3191 }
3192 }
3193 }
3194 },
3195 "/api/v2/business/{businessId}/employee/{employeeId}/document/{id}": {
3196 "get": {
3197 "tags": [
3198 "EmployeeDocument"
3199 ],
3200 "summary": "Get Employee Document Details",
3201 "description": "Gets the details for the employee document with the specified ID.",
3202 "operationId": "EmployeeDocument_Get",
3203 "consumes": [],
3204 "produces": [
3205 "application/json",
3206 "text/json",
3207 "application/xml",
3208 "text/xml"
3209 ],
3210 "parameters": [
3211 {
3212 "name": "id",
3213 "in": "path",
3214 "required": true,
3215 "type": "integer",
3216 "format": "int32",
3217 "title": "Int32"
3218 },
3219 {
3220 "name": "businessId",
3221 "in": "path",
3222 "required": true,
3223 "type": "string"
3224 },
3225 {
3226 "name": "employeeId",
3227 "in": "path",
3228 "required": true,
3229 "type": "string"
3230 }
3231 ],
3232 "responses": {
3233 "200": {
3234 "description": "OK",
3235 "schema": {
3236 "$ref": "#/definitions/EmployeeDocumentModel"
3237 }
3238 }
3239 }
3240 },
3241 "delete": {
3242 "tags": [
3243 "EmployeeDocument"
3244 ],
3245 "summary": "Delete Employee Document",
3246 "description": "Deletes the employee document with the specified ID.",
3247 "operationId": "EmployeeDocument_Delete",
3248 "consumes": [],
3249 "produces": [
3250 "application/json",
3251 "text/json",
3252 "application/xml",
3253 "text/xml"
3254 ],
3255 "parameters": [
3256 {
3257 "name": "id",
3258 "in": "path",
3259 "required": true,
3260 "type": "integer",
3261 "format": "int32",
3262 "title": "Int32"
3263 },
3264 {
3265 "name": "businessId",
3266 "in": "path",
3267 "required": true,
3268 "type": "string"
3269 },
3270 {
3271 "name": "employeeId",
3272 "in": "path",
3273 "required": true,
3274 "type": "string"
3275 }
3276 ],
3277 "responses": {
3278 "200": {
3279 "description": "OK"
3280 }
3281 }
3282 }
3283 },
3284 "/api/v2/business/{businessId}/employee/{employeeId}/document/{id}/content": {
3285 "get": {
3286 "tags": [
3287 "EmployeeDocument"
3288 ],
3289 "summary": "Get Employee Document Content",
3290 "description": "Get the file content for the employee document with the specified ID.",
3291 "operationId": "EmployeeDocument_Content",
3292 "consumes": [],
3293 "produces": [
3294 "application/json",
3295 "text/json",
3296 "application/xml",
3297 "text/xml"
3298 ],
3299 "parameters": [
3300 {
3301 "name": "id",
3302 "in": "path",
3303 "required": true,
3304 "type": "integer",
3305 "format": "int32",
3306 "title": "Int32"
3307 },
3308 {
3309 "name": "businessId",
3310 "in": "path",
3311 "required": true,
3312 "type": "string"
3313 },
3314 {
3315 "name": "employeeId",
3316 "in": "path",
3317 "required": true,
3318 "type": "string"
3319 }
3320 ],
3321 "responses": {
3322 "200": {
3323 "description": "OK",
3324 "schema": {
3325 "$ref": "#/definitions/DocumentFile"
3326 }
3327 }
3328 }
3329 }
3330 },
3331 "/api/v2/business/{businessId}/employee/{employeeId}/document/{documentId}/leave/{id}": {
3332 "post": {
3333 "tags": [
3334 "EmployeeDocument"
3335 ],
3336 "summary": "Link Employee Document to Leave Request",
3337 "description": "Takes the specified employee document and adds it as an attachment to the leave request with the specified ID.",
3338 "operationId": "EmployeeDocumentLeaveLink_CreateLink",
3339 "consumes": [],
3340 "produces": [
3341 "application/json",
3342 "text/json",
3343 "application/xml",
3344 "text/xml"
3345 ],
3346 "parameters": [
3347 {
3348 "name": "documentId",
3349 "in": "path",
3350 "required": true,
3351 "type": "integer",
3352 "format": "int32",
3353 "title": "Int32"
3354 },
3355 {
3356 "name": "id",
3357 "in": "path",
3358 "required": true,
3359 "type": "integer",
3360 "format": "int32",
3361 "title": "Int32"
3362 },
3363 {
3364 "name": "businessId",
3365 "in": "path",
3366 "required": true,
3367 "type": "string"
3368 },
3369 {
3370 "name": "employeeId",
3371 "in": "path",
3372 "required": true,
3373 "type": "string"
3374 }
3375 ],
3376 "responses": {
3377 "200": {
3378 "description": "OK"
3379 }
3380 }
3381 },
3382 "delete": {
3383 "tags": [
3384 "EmployeeDocument"
3385 ],
3386 "summary": "Unlink Employee Document from Leave Request",
3387 "description": "If the specified employee document is attached to the specified leave request, unattach it.",
3388 "operationId": "EmployeeDocumentLeaveLink_RemoveLink",
3389 "consumes": [],
3390 "produces": [
3391 "application/json",
3392 "text/json",
3393 "application/xml",
3394 "text/xml"
3395 ],
3396 "parameters": [
3397 {
3398 "name": "documentId",
3399 "in": "path",
3400 "required": true,
3401 "type": "integer",
3402 "format": "int32",
3403 "title": "Int32"
3404 },
3405 {
3406 "name": "id",
3407 "in": "path",
3408 "required": true,
3409 "type": "integer",
3410 "format": "int32",
3411 "title": "Int32"
3412 },
3413 {
3414 "name": "businessId",
3415 "in": "path",
3416 "required": true,
3417 "type": "string"
3418 },
3419 {
3420 "name": "employeeId",
3421 "in": "path",
3422 "required": true,
3423 "type": "string"
3424 }
3425 ],
3426 "responses": {
3427 "200": {
3428 "description": "OK"
3429 }
3430 }
3431 }
3432 },
3433 "/api/v2/business/{businessId}/employeeexpensecategory": {
3434 "get": {
3435 "tags": [
3436 "EmployeeExpenseCategories"
3437 ],
3438 "summary": "List Employee Expense Categories",
3439 "description": "Lists all the employee expense categories for the business.\n\nThis operation supports OData queries.",
3440 "operationId": "EmployeeExpenseCategory_GetEmployeeExpenseCategories",
3441 "consumes": [],
3442 "produces": [
3443 "application/json",
3444 "text/json",
3445 "application/xml",
3446 "text/xml"
3447 ],
3448 "parameters": [
3449 {
3450 "name": "businessId",
3451 "in": "path",
3452 "required": true,
3453 "type": "string"
3454 }
3455 ],
3456 "responses": {
3457 "200": {
3458 "description": "OK",
3459 "schema": {
3460 "type": "array",
3461 "items": {
3462 "$ref": "#/definitions/EmployeeExpenseCategoryModel"
3463 },
3464 "xml": {
3465 "name": "EmployeeExpenseCategoryModel",
3466 "wrapped": true
3467 },
3468 "title": "IEnumerable<EmployeeExpenseCategoryModel>"
3469 }
3470 }
3471 }
3472 },
3473 "post": {
3474 "tags": [
3475 "EmployeeExpenseCategories"
3476 ],
3477 "summary": "Create Employee Expense Category",
3478 "description": "Creates an employee expense category for the business.",
3479 "operationId": "EmployeeExpenseCategory_Post",
3480 "consumes": [
3481 "application/json",
3482 "text/json",
3483 "application/xml",
3484 "text/xml",
3485 "application/x-www-form-urlencoded"
3486 ],
3487 "produces": [
3488 "application/json",
3489 "text/json",
3490 "application/xml",
3491 "text/xml"
3492 ],
3493 "parameters": [
3494 {
3495 "name": "employeeExpenseCategory",
3496 "in": "body",
3497 "required": true,
3498 "schema": {
3499 "$ref": "#/definitions/EmployeeExpenseCategoryModel"
3500 }
3501 },
3502 {
3503 "name": "businessId",
3504 "in": "path",
3505 "required": true,
3506 "type": "string"
3507 }
3508 ],
3509 "responses": {
3510 "200": {
3511 "description": "OK"
3512 }
3513 }
3514 }
3515 },
3516 "/api/v2/business/{businessId}/employeeexpensecategory/{id}": {
3517 "get": {
3518 "tags": [
3519 "EmployeeExpenseCategories"
3520 ],
3521 "summary": "Get Employee Expense Category by ID",
3522 "description": "Gets the employee expense category with the specified ID.",
3523 "operationId": "EmployeeExpenseCategory_Get",
3524 "consumes": [],
3525 "produces": [
3526 "application/json",
3527 "text/json",
3528 "application/xml",
3529 "text/xml"
3530 ],
3531 "parameters": [
3532 {
3533 "name": "id",
3534 "in": "path",
3535 "required": true,
3536 "type": "integer",
3537 "format": "int32",
3538 "title": "Int32"
3539 },
3540 {
3541 "name": "businessId",
3542 "in": "path",
3543 "required": true,
3544 "type": "string"
3545 }
3546 ],
3547 "responses": {
3548 "200": {
3549 "description": "OK",
3550 "schema": {
3551 "$ref": "#/definitions/EmployeeExpenseCategoryModel"
3552 }
3553 }
3554 }
3555 },
3556 "put": {
3557 "tags": [
3558 "EmployeeExpenseCategories"
3559 ],
3560 "summary": "Update Employee Expense Category",
3561 "description": "Updates the employee expense category with the specified ID.",
3562 "operationId": "EmployeeExpenseCategory_Put",
3563 "consumes": [
3564 "application/json",
3565 "text/json",
3566 "application/xml",
3567 "text/xml",
3568 "application/x-www-form-urlencoded"
3569 ],
3570 "produces": [
3571 "application/json",
3572 "text/json",
3573 "application/xml",
3574 "text/xml"
3575 ],
3576 "parameters": [
3577 {
3578 "name": "id",
3579 "in": "path",
3580 "required": true,
3581 "type": "integer",
3582 "format": "int32",
3583 "title": "Int32"
3584 },
3585 {
3586 "name": "employeeExpenseCategory",
3587 "in": "body",
3588 "required": true,
3589 "schema": {
3590 "$ref": "#/definitions/EmployeeExpenseCategoryModel"
3591 }
3592 },
3593 {
3594 "name": "businessId",
3595 "in": "path",
3596 "required": true,
3597 "type": "string"
3598 }
3599 ],
3600 "responses": {
3601 "200": {
3602 "description": "OK"
3603 }
3604 }
3605 },
3606 "delete": {
3607 "tags": [
3608 "EmployeeExpenseCategories"
3609 ],
3610 "summary": "Delete Employee Expense Category",
3611 "description": "Deletes the employee expense category with the specified ID.",
3612 "operationId": "EmployeeExpenseCategory_Delete",
3613 "consumes": [],
3614 "produces": [
3615 "application/json",
3616 "text/json",
3617 "application/xml",
3618 "text/xml"
3619 ],
3620 "parameters": [
3621 {
3622 "name": "id",
3623 "in": "path",
3624 "required": true,
3625 "type": "integer",
3626 "format": "int32",
3627 "title": "Int32"
3628 },
3629 {
3630 "name": "businessId",
3631 "in": "path",
3632 "required": true,
3633 "type": "string"
3634 }
3635 ],
3636 "responses": {
3637 "200": {
3638 "description": "OK"
3639 }
3640 }
3641 }
3642 },
3643 "/api/v2/business/{businessId}/employeeexpensecategory/taxcodes": {
3644 "get": {
3645 "tags": [
3646 "EmployeeExpenseCategories"
3647 ],
3648 "summary": "Get Tax Codes",
3649 "description": "Gets a list of the business' tax codes.",
3650 "operationId": "EmployeeExpenseCategory_TaxCodes",
3651 "consumes": [],
3652 "produces": [
3653 "application/json",
3654 "text/json",
3655 "application/xml",
3656 "text/xml"
3657 ],
3658 "parameters": [
3659 {
3660 "name": "businessId",
3661 "in": "path",
3662 "required": true,
3663 "type": "string"
3664 }
3665 ],
3666 "responses": {
3667 "200": {
3668 "description": "OK",
3669 "schema": {
3670 "type": "array",
3671 "items": {
3672 "$ref": "#/definitions/JournalServiceTaxCode"
3673 },
3674 "xml": {
3675 "name": "JournalServiceTaxCode",
3676 "wrapped": true
3677 },
3678 "title": "IList<JournalServiceTaxCode>"
3679 }
3680 }
3681 }
3682 }
3683 },
3684 "/api/v2/business/{businessId}/employee/{employeeId}/expenserequest": {
3685 "get": {
3686 "tags": [
3687 "EmployeeExpenseRequest"
3688 ],
3689 "summary": "List Expense Requests",
3690 "description": "Lists all of the expense requests for this employee.\n\nThis operation supports OData queries.",
3691 "operationId": "ExpenseRequest_GetExpenseRequests",
3692 "consumes": [],
3693 "produces": [
3694 "application/json",
3695 "text/json",
3696 "application/xml",
3697 "text/xml"
3698 ],
3699 "parameters": [
3700 {
3701 "name": "businessId",
3702 "in": "path",
3703 "required": true,
3704 "type": "string"
3705 },
3706 {
3707 "name": "employeeId",
3708 "in": "path",
3709 "required": true,
3710 "type": "string"
3711 }
3712 ],
3713 "responses": {
3714 "200": {
3715 "description": "OK",
3716 "schema": {
3717 "type": "array",
3718 "items": {
3719 "$ref": "#/definitions/ExpenseRequestResponseModel"
3720 },
3721 "xml": {
3722 "name": "ExpenseRequestResponseModel",
3723 "wrapped": true
3724 },
3725 "title": "IEnumerable<ExpenseRequestResponseModel>"
3726 }
3727 }
3728 }
3729 },
3730 "post": {
3731 "tags": [
3732 "EmployeeExpenseRequest"
3733 ],
3734 "summary": "Create Expense Request",
3735 "description": "Creates a new expense request for this employee.",
3736 "operationId": "ExpenseRequest_Post",
3737 "consumes": [
3738 "application/json",
3739 "text/json",
3740 "application/xml",
3741 "text/xml",
3742 "application/x-www-form-urlencoded"
3743 ],
3744 "produces": [
3745 "application/json",
3746 "text/json",
3747 "application/xml",
3748 "text/xml"
3749 ],
3750 "parameters": [
3751 {
3752 "name": "model",
3753 "in": "body",
3754 "required": true,
3755 "schema": {
3756 "$ref": "#/definitions/ExpenseRequestEditModel"
3757 }
3758 },
3759 {
3760 "name": "businessId",
3761 "in": "path",
3762 "required": true,
3763 "type": "string"
3764 },
3765 {
3766 "name": "employeeId",
3767 "in": "path",
3768 "required": true,
3769 "type": "string"
3770 }
3771 ],
3772 "responses": {
3773 "200": {
3774 "description": "OK"
3775 }
3776 }
3777 }
3778 },
3779 "/api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}": {
3780 "get": {
3781 "tags": [
3782 "EmployeeExpenseRequest"
3783 ],
3784 "summary": "Get Expense Request by ID",
3785 "description": "Gets the expense request with the specified ID.",
3786 "operationId": "ExpenseRequest_Get",
3787 "consumes": [],
3788 "produces": [
3789 "application/json",
3790 "text/json",
3791 "application/xml",
3792 "text/xml"
3793 ],
3794 "parameters": [
3795 {
3796 "name": "employeeId",
3797 "in": "path",
3798 "required": true,
3799 "type": "integer",
3800 "format": "int32",
3801 "title": "Int32"
3802 },
3803 {
3804 "name": "expenseRequestId",
3805 "in": "path",
3806 "required": true,
3807 "type": "integer",
3808 "format": "int32",
3809 "title": "Int32"
3810 },
3811 {
3812 "name": "businessId",
3813 "in": "path",
3814 "required": true,
3815 "type": "string"
3816 }
3817 ],
3818 "responses": {
3819 "200": {
3820 "description": "OK",
3821 "schema": {
3822 "$ref": "#/definitions/ExpenseRequestResponseModel"
3823 }
3824 }
3825 }
3826 },
3827 "put": {
3828 "tags": [
3829 "EmployeeExpenseRequest"
3830 ],
3831 "summary": "Update Expense Request",
3832 "description": "Updates the expense request with the specified ID.",
3833 "operationId": "ExpenseRequest_Put",
3834 "consumes": [
3835 "application/json",
3836 "text/json",
3837 "application/xml",
3838 "text/xml",
3839 "application/x-www-form-urlencoded"
3840 ],
3841 "produces": [
3842 "application/json",
3843 "text/json",
3844 "application/xml",
3845 "text/xml"
3846 ],
3847 "parameters": [
3848 {
3849 "name": "expenseRequestId",
3850 "in": "path",
3851 "required": true,
3852 "type": "integer",
3853 "format": "int32",
3854 "title": "Int32"
3855 },
3856 {
3857 "name": "model",
3858 "in": "body",
3859 "required": true,
3860 "schema": {
3861 "$ref": "#/definitions/ExpenseRequestEditModel"
3862 }
3863 },
3864 {
3865 "name": "businessId",
3866 "in": "path",
3867 "required": true,
3868 "type": "string"
3869 },
3870 {
3871 "name": "employeeId",
3872 "in": "path",
3873 "required": true,
3874 "type": "string"
3875 }
3876 ],
3877 "responses": {
3878 "200": {
3879 "description": "OK"
3880 }
3881 }
3882 },
3883 "delete": {
3884 "tags": [
3885 "EmployeeExpenseRequest"
3886 ],
3887 "summary": "Delete Expense Request",
3888 "description": "Deletes the expense request with the specified ID.",
3889 "operationId": "ExpenseRequest_Delete",
3890 "consumes": [],
3891 "produces": [
3892 "application/json",
3893 "text/json",
3894 "application/xml",
3895 "text/xml"
3896 ],
3897 "parameters": [
3898 {
3899 "name": "expenseRequestId",
3900 "in": "path",
3901 "required": true,
3902 "type": "integer",
3903 "format": "int32",
3904 "title": "Int32"
3905 },
3906 {
3907 "name": "businessId",
3908 "in": "path",
3909 "required": true,
3910 "type": "string"
3911 },
3912 {
3913 "name": "employeeId",
3914 "in": "path",
3915 "required": true,
3916 "type": "string"
3917 }
3918 ],
3919 "responses": {
3920 "200": {
3921 "description": "OK"
3922 }
3923 }
3924 }
3925 },
3926 "/api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}/approve": {
3927 "post": {
3928 "tags": [
3929 "EmployeeExpenseRequest"
3930 ],
3931 "summary": "Approve Expense Request",
3932 "description": "Approves the expense request with the specified ID.",
3933 "operationId": "ExpenseRequest_Approve",
3934 "consumes": [],
3935 "produces": [
3936 "application/json",
3937 "text/json",
3938 "application/xml",
3939 "text/xml"
3940 ],
3941 "parameters": [
3942 {
3943 "name": "expenseRequestId",
3944 "in": "path",
3945 "required": true,
3946 "type": "integer",
3947 "format": "int32",
3948 "title": "Int32"
3949 },
3950 {
3951 "name": "businessId",
3952 "in": "path",
3953 "required": true,
3954 "type": "string"
3955 },
3956 {
3957 "name": "employeeId",
3958 "in": "path",
3959 "required": true,
3960 "type": "string"
3961 }
3962 ],
3963 "responses": {
3964 "200": {
3965 "description": "OK"
3966 }
3967 }
3968 }
3969 },
3970 "/api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}/decline": {
3971 "post": {
3972 "tags": [
3973 "EmployeeExpenseRequest"
3974 ],
3975 "summary": "Decline Expense Request",
3976 "description": "Declines the expense request with the specified ID.",
3977 "operationId": "ExpenseRequest_Decline",
3978 "consumes": [
3979 "application/json",
3980 "text/json",
3981 "application/xml",
3982 "text/xml",
3983 "application/x-www-form-urlencoded"
3984 ],
3985 "produces": [
3986 "application/json",
3987 "text/json",
3988 "application/xml",
3989 "text/xml"
3990 ],
3991 "parameters": [
3992 {
3993 "name": "expenseRequestId",
3994 "in": "path",
3995 "required": true,
3996 "type": "integer",
3997 "format": "int32",
3998 "title": "Int32"
3999 },
4000 {
4001 "name": "reason",
4002 "in": "body",
4003 "required": true,
4004 "schema": {
4005 "type": "string",
4006 "title": "String"
4007 }
4008 },
4009 {
4010 "name": "businessId",
4011 "in": "path",
4012 "required": true,
4013 "type": "string"
4014 },
4015 {
4016 "name": "employeeId",
4017 "in": "path",
4018 "required": true,
4019 "type": "string"
4020 }
4021 ],
4022 "responses": {
4023 "200": {
4024 "description": "OK"
4025 }
4026 }
4027 }
4028 },
4029 "/api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}/attachment": {
4030 "put": {
4031 "tags": [
4032 "EmployeeExpenseRequest"
4033 ],
4034 "summary": "Upload Attachment to Expense Request",
4035 "description": "Uploads an attachment to the expense request with the specified ID. \r\nThe request should be a MIME multipart file upload request.",
4036 "operationId": "ExpenseRequest_UploadAttachment",
4037 "consumes": [],
4038 "produces": [
4039 "application/json",
4040 "text/json",
4041 "application/xml",
4042 "text/xml"
4043 ],
4044 "parameters": [
4045 {
4046 "name": "expenseRequestId",
4047 "in": "path",
4048 "required": true,
4049 "type": "integer",
4050 "format": "int32",
4051 "title": "Int32"
4052 },
4053 {
4054 "name": "businessId",
4055 "in": "path",
4056 "required": true,
4057 "type": "string"
4058 },
4059 {
4060 "name": "employeeId",
4061 "in": "path",
4062 "required": true,
4063 "type": "string"
4064 }
4065 ],
4066 "responses": {
4067 "200": {
4068 "description": "OK",
4069 "schema": {
4070 "type": "object",
4071 "title": "IHttpActionResult"
4072 }
4073 }
4074 }
4075 }
4076 },
4077 "/api/v2/business/{businessId}/employeegroup": {
4078 "get": {
4079 "tags": [
4080 "EmployeeGroups"
4081 ],
4082 "summary": "List Employee Groups",
4083 "description": "Lists all the employee groups for the business.\n\nThis operation supports OData queries.",
4084 "operationId": "EmployeeGroup_GetGroups",
4085 "consumes": [],
4086 "produces": [
4087 "application/json",
4088 "text/json",
4089 "application/xml",
4090 "text/xml"
4091 ],
4092 "parameters": [
4093 {
4094 "name": "businessId",
4095 "in": "path",
4096 "required": true,
4097 "type": "string"
4098 }
4099 ],
4100 "responses": {
4101 "200": {
4102 "description": "OK",
4103 "schema": {
4104 "type": "array",
4105 "items": {
4106 "$ref": "#/definitions/EmployeeGroupModel"
4107 },
4108 "xml": {
4109 "name": "EmployeeGroupModel",
4110 "wrapped": true
4111 },
4112 "title": "IQueryable<EmployeeGroupModel>"
4113 }
4114 }
4115 }
4116 },
4117 "post": {
4118 "tags": [
4119 "EmployeeGroups"
4120 ],
4121 "summary": "Create Employee Group",
4122 "description": "Creates a new employee group for the business.",
4123 "operationId": "EmployeeGroup_Post",
4124 "consumes": [
4125 "application/json",
4126 "text/json",
4127 "application/xml",
4128 "text/xml",
4129 "application/x-www-form-urlencoded"
4130 ],
4131 "produces": [
4132 "application/json",
4133 "text/json",
4134 "application/xml",
4135 "text/xml"
4136 ],
4137 "parameters": [
4138 {
4139 "name": "employeeGroup",
4140 "in": "body",
4141 "required": true,
4142 "schema": {
4143 "$ref": "#/definitions/EmployeeGroupModel"
4144 }
4145 },
4146 {
4147 "name": "businessId",
4148 "in": "path",
4149 "required": true,
4150 "type": "string"
4151 }
4152 ],
4153 "responses": {
4154 "200": {
4155 "description": "OK"
4156 }
4157 }
4158 }
4159 },
4160 "/api/v2/business/{businessId}/employeegroup/{id}": {
4161 "get": {
4162 "tags": [
4163 "EmployeeGroups"
4164 ],
4165 "summary": "Get Employee Group by ID",
4166 "description": "Gets the employee group with the specified ID.",
4167 "operationId": "EmployeeGroup_Get",
4168 "consumes": [],
4169 "produces": [
4170 "application/json",
4171 "text/json",
4172 "application/xml",
4173 "text/xml"
4174 ],
4175 "parameters": [
4176 {
4177 "name": "id",
4178 "in": "path",
4179 "required": true,
4180 "type": "integer",
4181 "format": "int32",
4182 "title": "Int32"
4183 },
4184 {
4185 "name": "businessId",
4186 "in": "path",
4187 "required": true,
4188 "type": "string"
4189 }
4190 ],
4191 "responses": {
4192 "200": {
4193 "description": "OK",
4194 "schema": {
4195 "$ref": "#/definitions/DetailedEmployeeGroupModel"
4196 }
4197 }
4198 }
4199 },
4200 "put": {
4201 "tags": [
4202 "EmployeeGroups"
4203 ],
4204 "summary": "Update Employee Group",
4205 "description": "Updates the specified employee group.",
4206 "operationId": "EmployeeGroup_Put",
4207 "consumes": [
4208 "application/json",
4209 "text/json",
4210 "application/xml",
4211 "text/xml",
4212 "application/x-www-form-urlencoded"
4213 ],
4214 "produces": [
4215 "application/json",
4216 "text/json",
4217 "application/xml",
4218 "text/xml"
4219 ],
4220 "parameters": [
4221 {
4222 "name": "id",
4223 "in": "path",
4224 "required": true,
4225 "type": "integer",
4226 "format": "int32",
4227 "title": "Int32"
4228 },
4229 {
4230 "name": "employeeGroup",
4231 "in": "body",
4232 "required": true,
4233 "schema": {
4234 "$ref": "#/definitions/EmployeeGroupModel"
4235 }
4236 },
4237 {
4238 "name": "businessId",
4239 "in": "path",
4240 "required": true,
4241 "type": "string"
4242 }
4243 ],
4244 "responses": {
4245 "200": {
4246 "description": "OK"
4247 }
4248 }
4249 },
4250 "delete": {
4251 "tags": [
4252 "EmployeeGroups"
4253 ],
4254 "summary": "Delete Employee Group",
4255 "description": "Deletes the employee group with the specified ID.",
4256 "operationId": "EmployeeGroup_Delete",
4257 "consumes": [],
4258 "produces": [
4259 "application/json",
4260 "text/json",
4261 "application/xml",
4262 "text/xml"
4263 ],
4264 "parameters": [
4265 {
4266 "name": "id",
4267 "in": "path",
4268 "required": true,
4269 "type": "integer",
4270 "format": "int32",
4271 "title": "Int32"
4272 },
4273 {
4274 "name": "businessId",
4275 "in": "path",
4276 "required": true,
4277 "type": "string"
4278 }
4279 ],
4280 "responses": {
4281 "200": {
4282 "description": "OK"
4283 }
4284 }
4285 }
4286 },
4287 "/api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document": {
4288 "get": {
4289 "tags": [
4290 "EmployeeQualifications"
4291 ],
4292 "summary": "List Documents for Employee Qualification",
4293 "description": "Lists all the documents associated with a specific employee qualification.",
4294 "operationId": "EmployeeQualificationDocument_Get",
4295 "consumes": [],
4296 "produces": [
4297 "application/json",
4298 "text/json",
4299 "application/xml",
4300 "text/xml"
4301 ],
4302 "parameters": [
4303 {
4304 "name": "qualificationId",
4305 "in": "path",
4306 "required": true,
4307 "type": "integer",
4308 "format": "int32",
4309 "title": "Int32"
4310 },
4311 {
4312 "name": "businessId",
4313 "in": "path",
4314 "required": true,
4315 "type": "string"
4316 },
4317 {
4318 "name": "employeeId",
4319 "in": "path",
4320 "required": true,
4321 "type": "string"
4322 }
4323 ],
4324 "responses": {
4325 "200": {
4326 "description": "OK",
4327 "schema": {
4328 "type": "array",
4329 "items": {
4330 "$ref": "#/definitions/EmployeeQualificationDocumentModel"
4331 },
4332 "xml": {
4333 "name": "EmployeeQualificationDocumentModel",
4334 "wrapped": true
4335 },
4336 "title": "List<EmployeeQualificationDocumentModel>"
4337 }
4338 }
4339 }
4340 },
4341 "post": {
4342 "tags": [
4343 "EmployeeQualifications"
4344 ],
4345 "summary": "Create Employee Qualification Document",
4346 "description": "Uploads an employee qualification document. Note: the request should be a MIME multipart file upload request.",
4347 "operationId": "EmployeeQualificationDocument_Post",
4348 "consumes": [],
4349 "produces": [
4350 "application/json",
4351 "text/json",
4352 "application/xml",
4353 "text/xml"
4354 ],
4355 "parameters": [
4356 {
4357 "name": "qualificationId",
4358 "in": "path",
4359 "required": true,
4360 "type": "integer",
4361 "format": "int32",
4362 "title": "Int32"
4363 },
4364 {
4365 "name": "visible",
4366 "in": "query",
4367 "required": false,
4368 "type": "boolean",
4369 "default": false,
4370 "title": "Boolean"
4371 },
4372 {
4373 "name": "businessId",
4374 "in": "path",
4375 "required": true,
4376 "type": "string"
4377 },
4378 {
4379 "name": "employeeId",
4380 "in": "path",
4381 "required": true,
4382 "type": "string"
4383 }
4384 ],
4385 "responses": {
4386 "200": {
4387 "description": "OK",
4388 "schema": {
4389 "type": "array",
4390 "items": {
4391 "$ref": "#/definitions/EmployeeQualificationDocumentModel"
4392 },
4393 "xml": {
4394 "name": "EmployeeQualificationDocumentModel",
4395 "wrapped": true
4396 },
4397 "title": "List<EmployeeQualificationDocumentModel>"
4398 }
4399 }
4400 }
4401 }
4402 },
4403 "/api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document/{id}": {
4404 "get": {
4405 "tags": [
4406 "EmployeeQualifications"
4407 ],
4408 "summary": "Get Qualification Document by ID",
4409 "description": "Gets the details for a qualification document by ID.",
4410 "operationId": "EmployeeQualificationDocument_GetApiV2BusinessByBusinessIdEmployeeByEmployeeIdQualificationByQualificationIdDocumentById",
4411 "consumes": [],
4412 "produces": [
4413 "application/json",
4414 "text/json",
4415 "application/xml",
4416 "text/xml"
4417 ],
4418 "parameters": [
4419 {
4420 "name": "qualificationId",
4421 "in": "path",
4422 "required": true,
4423 "type": "integer",
4424 "format": "int32",
4425 "title": "Int32"
4426 },
4427 {
4428 "name": "id",
4429 "in": "path",
4430 "required": true,
4431 "type": "integer",
4432 "format": "int32",
4433 "title": "Int32"
4434 },
4435 {
4436 "name": "businessId",
4437 "in": "path",
4438 "required": true,
4439 "type": "string"
4440 },
4441 {
4442 "name": "employeeId",
4443 "in": "path",
4444 "required": true,
4445 "type": "string"
4446 }
4447 ],
4448 "responses": {
4449 "200": {
4450 "description": "OK",
4451 "schema": {
4452 "$ref": "#/definitions/EmployeeQualificationDocumentModel"
4453 }
4454 }
4455 }
4456 },
4457 "delete": {
4458 "tags": [
4459 "EmployeeQualifications"
4460 ],
4461 "summary": "Delete Employee Qualification Document",
4462 "description": "Deletes a specific employee qualification document.",
4463 "operationId": "EmployeeQualificationDocument_Delete",
4464 "consumes": [],
4465 "produces": [
4466 "application/json",
4467 "text/json",
4468 "application/xml",
4469 "text/xml"
4470 ],
4471 "parameters": [
4472 {
4473 "name": "qualificationId",
4474 "in": "path",
4475 "required": true,
4476 "type": "integer",
4477 "format": "int32",
4478 "title": "Int32"
4479 },
4480 {
4481 "name": "id",
4482 "in": "path",
4483 "required": true,
4484 "type": "integer",
4485 "format": "int32",
4486 "title": "Int32"
4487 },
4488 {
4489 "name": "businessId",
4490 "in": "path",
4491 "required": true,
4492 "type": "string"
4493 },
4494 {
4495 "name": "employeeId",
4496 "in": "path",
4497 "required": true,
4498 "type": "string"
4499 }
4500 ],
4501 "responses": {
4502 "200": {
4503 "description": "OK"
4504 }
4505 }
4506 }
4507 },
4508 "/api/v2/business/{businessId}/employee/{employeeId}/qualification/{qualificationId}/document/{id}/content": {
4509 "get": {
4510 "tags": [
4511 "EmployeeQualifications"
4512 ],
4513 "summary": "Get Qualification Document File",
4514 "description": "Gets the file for an employee qualification document by ID.",
4515 "operationId": "EmployeeQualificationDocument_Content",
4516 "consumes": [],
4517 "produces": [
4518 "application/json",
4519 "text/json",
4520 "application/xml",
4521 "text/xml"
4522 ],
4523 "parameters": [
4524 {
4525 "name": "qualificationId",
4526 "in": "path",
4527 "required": true,
4528 "type": "integer",
4529 "format": "int32",
4530 "title": "Int32"
4531 },
4532 {
4533 "name": "id",
4534 "in": "path",
4535 "required": true,
4536 "type": "integer",
4537 "format": "int32",
4538 "title": "Int32"
4539 },
4540 {
4541 "name": "businessId",
4542 "in": "path",
4543 "required": true,
4544 "type": "string"
4545 },
4546 {
4547 "name": "employeeId",
4548 "in": "path",
4549 "required": true,
4550 "type": "string"
4551 }
4552 ],
4553 "responses": {
4554 "200": {
4555 "description": "OK",
4556 "schema": {
4557 "$ref": "#/definitions/DocumentFile"
4558 }
4559 }
4560 }
4561 }
4562 },
4563 "/api/v2/business/{businessId}/employee/{employeeId}/qualification": {
4564 "get": {
4565 "tags": [
4566 "EmployeeQualifications"
4567 ],
4568 "summary": "Get Qualifications for Employee",
4569 "description": "Retrieves the qualification details for a single employee.",
4570 "operationId": "EmployeeQualification_GetQualifications",
4571 "consumes": [],
4572 "produces": [
4573 "application/json",
4574 "text/json",
4575 "application/xml",
4576 "text/xml"
4577 ],
4578 "parameters": [
4579 {
4580 "name": "businessId",
4581 "in": "path",
4582 "required": true,
4583 "type": "string"
4584 },
4585 {
4586 "name": "employeeId",
4587 "in": "path",
4588 "required": true,
4589 "type": "string"
4590 }
4591 ],
4592 "responses": {
4593 "200": {
4594 "description": "OK",
4595 "schema": {
4596 "type": "array",
4597 "items": {
4598 "$ref": "#/definitions/EmployeeQualificationModel"
4599 },
4600 "xml": {
4601 "name": "EmployeeQualificationModel",
4602 "wrapped": true
4603 },
4604 "title": "IQueryable<EmployeeQualificationModel>"
4605 }
4606 }
4607 }
4608 },
4609 "post": {
4610 "tags": [
4611 "EmployeeQualifications"
4612 ],
4613 "summary": "Add/Update Employee Qualification",
4614 "description": "Adds or updates a qualification for an employee.",
4615 "operationId": "EmployeeQualification_Post",
4616 "consumes": [
4617 "application/json",
4618 "text/json",
4619 "application/xml",
4620 "text/xml",
4621 "application/x-www-form-urlencoded"
4622 ],
4623 "produces": [
4624 "application/json",
4625 "text/json",
4626 "application/xml",
4627 "text/xml"
4628 ],
4629 "parameters": [
4630 {
4631 "name": "qualification",
4632 "in": "body",
4633 "required": true,
4634 "schema": {
4635 "$ref": "#/definitions/EmployeeQualificationModel"
4636 }
4637 },
4638 {
4639 "name": "businessId",
4640 "in": "path",
4641 "required": true,
4642 "type": "string"
4643 },
4644 {
4645 "name": "employeeId",
4646 "in": "path",
4647 "required": true,
4648 "type": "string"
4649 }
4650 ],
4651 "responses": {
4652 "200": {
4653 "description": "OK"
4654 }
4655 }
4656 },
4657 "delete": {
4658 "tags": [
4659 "EmployeeQualifications"
4660 ],
4661 "summary": "Delete Employee Qualification",
4662 "description": "Deletes an employee qualification. Denotes that the employee is no longer qualified for the specified qualification.",
4663 "operationId": "EmployeeQualification_Delete",
4664 "consumes": [],
4665 "produces": [
4666 "application/json",
4667 "text/json",
4668 "application/xml",
4669 "text/xml"
4670 ],
4671 "parameters": [
4672 {
4673 "name": "id",
4674 "in": "query",
4675 "required": true,
4676 "type": "integer",
4677 "format": "int32",
4678 "title": "Int32"
4679 },
4680 {
4681 "name": "businessId",
4682 "in": "path",
4683 "required": true,
4684 "type": "string"
4685 },
4686 {
4687 "name": "employeeId",
4688 "in": "path",
4689 "required": true,
4690 "type": "string"
4691 }
4692 ],
4693 "responses": {
4694 "200": {
4695 "description": "OK"
4696 }
4697 }
4698 }
4699 },
4700 "/api/v2/business/{businessId}/employee/{employeeId}/qualification/{id}": {
4701 "get": {
4702 "tags": [
4703 "EmployeeQualifications"
4704 ],
4705 "summary": "Get Qualification Details",
4706 "description": "Gets the details for the qualification with a specific ID.",
4707 "operationId": "EmployeeQualification_Get",
4708 "consumes": [],
4709 "produces": [
4710 "application/json",
4711 "text/json",
4712 "application/xml",
4713 "text/xml"
4714 ],
4715 "parameters": [
4716 {
4717 "name": "id",
4718 "in": "path",
4719 "required": true,
4720 "type": "integer",
4721 "format": "int32",
4722 "title": "Int32"
4723 },
4724 {
4725 "name": "businessId",
4726 "in": "path",
4727 "required": true,
4728 "type": "string"
4729 },
4730 {
4731 "name": "employeeId",
4732 "in": "path",
4733 "required": true,
4734 "type": "string"
4735 }
4736 ],
4737 "responses": {
4738 "200": {
4739 "description": "OK",
4740 "schema": {
4741 "$ref": "#/definitions/EmployeeQualificationModel"
4742 }
4743 }
4744 }
4745 }
4746 },
4747 "/api/v2/business/{businessId}/employee/{employeeId}/taxadjustment": {
4748 "get": {
4749 "tags": [
4750 "EmployeeRecurringTransactions"
4751 ],
4752 "summary": "List Employee Tax Adjustments",
4753 "description": "Lists all the recurring employee tax adjustments for the employee",
4754 "operationId": "EmployeeRecurringTaxAdjustment_List",
4755 "consumes": [],
4756 "produces": [
4757 "application/json",
4758 "text/json",
4759 "application/xml",
4760 "text/xml"
4761 ],
4762 "parameters": [
4763 {
4764 "name": "businessId",
4765 "in": "path",
4766 "required": true,
4767 "type": "string"
4768 },
4769 {
4770 "name": "employeeId",
4771 "in": "path",
4772 "required": true,
4773 "type": "string"
4774 }
4775 ],
4776 "responses": {
4777 "200": {
4778 "description": "OK",
4779 "schema": {
4780 "type": "array",
4781 "items": {
4782 "$ref": "#/definitions/EmployeeRecurringTaxAdjustmentModel"
4783 },
4784 "xml": {
4785 "name": "EmployeeRecurringTaxAdjustmentModel",
4786 "wrapped": true
4787 },
4788 "title": "IEnumerable<EmployeeRecurringTaxAdjustmentModel>"
4789 }
4790 }
4791 }
4792 },
4793 "post": {
4794 "tags": [
4795 "EmployeeRecurringTransactions"
4796 ],
4797 "summary": "Create Employee Tax Adjustment",
4798 "description": "Creates a new recurring tax adjustment for the employee.",
4799 "operationId": "EmployeeRecurringTaxAdjustment_Post",
4800 "consumes": [
4801 "application/json",
4802 "text/json",
4803 "application/xml",
4804 "text/xml",
4805 "application/x-www-form-urlencoded"
4806 ],
4807 "produces": [
4808 "application/json",
4809 "text/json",
4810 "application/xml",
4811 "text/xml"
4812 ],
4813 "parameters": [
4814 {
4815 "name": "model",
4816 "in": "body",
4817 "required": true,
4818 "schema": {
4819 "$ref": "#/definitions/EmployeeRecurringTaxAdjustmentModel"
4820 }
4821 },
4822 {
4823 "name": "businessId",
4824 "in": "path",
4825 "required": true,
4826 "type": "string"
4827 },
4828 {
4829 "name": "employeeId",
4830 "in": "path",
4831 "required": true,
4832 "type": "string"
4833 }
4834 ],
4835 "responses": {
4836 "200": {
4837 "description": "OK",
4838 "schema": {
4839 "$ref": "#/definitions/EmployeeRecurringTaxAdjustmentModel"
4840 }
4841 }
4842 }
4843 }
4844 },
4845 "/api/v2/business/{businessId}/employee/{employeeId}/taxadjustment/{id}": {
4846 "get": {
4847 "tags": [
4848 "EmployeeRecurringTransactions"
4849 ],
4850 "summary": "Get Employee Tax Adjustment by ID",
4851 "description": "Gets the employee's recurring tax adjustment with the specified ID.",
4852 "operationId": "EmployeeRecurringTaxAdjustment_Get",
4853 "consumes": [],
4854 "produces": [
4855 "application/json",
4856 "text/json",
4857 "application/xml",
4858 "text/xml"
4859 ],
4860 "parameters": [
4861 {
4862 "name": "id",
4863 "in": "path",
4864 "required": true,
4865 "type": "integer",
4866 "format": "int32",
4867 "title": "Int32"
4868 },
4869 {
4870 "name": "businessId",
4871 "in": "path",
4872 "required": true,
4873 "type": "string"
4874 },
4875 {
4876 "name": "employeeId",
4877 "in": "path",
4878 "required": true,
4879 "type": "string"
4880 }
4881 ],
4882 "responses": {
4883 "200": {
4884 "description": "OK",
4885 "schema": {
4886 "$ref": "#/definitions/EmployeeRecurringTaxAdjustmentModel"
4887 }
4888 }
4889 }
4890 },
4891 "put": {
4892 "tags": [
4893 "EmployeeRecurringTransactions"
4894 ],
4895 "summary": "Update Employee Tax Adjustment",
4896 "description": "Updates the employee's recurring tax adjustment with the specified ID.",
4897 "operationId": "EmployeeRecurringTaxAdjustment_Put",
4898 "consumes": [
4899 "application/json",
4900 "text/json",
4901 "application/xml",
4902 "text/xml",
4903 "application/x-www-form-urlencoded"
4904 ],
4905 "produces": [
4906 "application/json",
4907 "text/json",
4908 "application/xml",
4909 "text/xml"
4910 ],
4911 "parameters": [
4912 {
4913 "name": "id",
4914 "in": "path",
4915 "required": true,
4916 "type": "integer",
4917 "format": "int32",
4918 "title": "Int32"
4919 },
4920 {
4921 "name": "model",
4922 "in": "body",
4923 "required": true,
4924 "schema": {
4925 "$ref": "#/definitions/EmployeeRecurringTaxAdjustmentModel"
4926 }
4927 },
4928 {
4929 "name": "businessId",
4930 "in": "path",
4931 "required": true,
4932 "type": "string"
4933 },
4934 {
4935 "name": "employeeId",
4936 "in": "path",
4937 "required": true,
4938 "type": "string"
4939 }
4940 ],
4941 "responses": {
4942 "200": {
4943 "description": "OK",
4944 "schema": {
4945 "$ref": "#/definitions/EmployeeRecurringTaxAdjustmentModel"
4946 }
4947 }
4948 }
4949 },
4950 "delete": {
4951 "tags": [
4952 "EmployeeRecurringTransactions"
4953 ],
4954 "summary": "Delete Employee Tax Adjustment",
4955 "description": "Deletes the employee recurring tax adjustment with the specified ID.",
4956 "operationId": "EmployeeRecurringTaxAdjustment_Delete",
4957 "consumes": [],
4958 "produces": [
4959 "application/json",
4960 "text/json",
4961 "application/xml",
4962 "text/xml"
4963 ],
4964 "parameters": [
4965 {
4966 "name": "id",
4967 "in": "path",
4968 "required": true,
4969 "type": "integer",
4970 "format": "int32",
4971 "title": "Int32"
4972 },
4973 {
4974 "name": "businessId",
4975 "in": "path",
4976 "required": true,
4977 "type": "string"
4978 },
4979 {
4980 "name": "employeeId",
4981 "in": "path",
4982 "required": true,
4983 "type": "string"
4984 }
4985 ],
4986 "responses": {
4987 "200": {
4988 "description": "OK"
4989 }
4990 }
4991 }
4992 },
4993 "/api/v2/business/{businessId}/employee/{employeeId}/superadjustment": {
4994 "get": {
4995 "tags": [
4996 "EmployeeRecurringTransactions"
4997 ],
4998 "summary": "List Employee Super Adjustments",
4999 "description": "Lists all the recurring employee super adjustments for the employee",
5000 "operationId": "EmployeeRecurringSuperAdjustment_List",
5001 "consumes": [],
5002 "produces": [
5003 "application/json",
5004 "text/json",
5005 "application/xml",
5006 "text/xml"
5007 ],
5008 "parameters": [
5009 {
5010 "name": "businessId",
5011 "in": "path",
5012 "required": true,
5013 "type": "string"
5014 },
5015 {
5016 "name": "employeeId",
5017 "in": "path",
5018 "required": true,
5019 "type": "string"
5020 }
5021 ],
5022 "responses": {
5023 "200": {
5024 "description": "OK",
5025 "schema": {
5026 "type": "array",
5027 "items": {
5028 "$ref": "#/definitions/EmployeeRecurringSuperAdjustmentModel"
5029 },
5030 "xml": {
5031 "name": "EmployeeRecurringSuperAdjustmentModel",
5032 "wrapped": true
5033 },
5034 "title": "IEnumerable<EmployeeRecurringSuperAdjustmentModel>"
5035 }
5036 }
5037 }
5038 },
5039 "post": {
5040 "tags": [
5041 "EmployeeRecurringTransactions"
5042 ],
5043 "summary": "Create Employee Super Adjustment",
5044 "description": "Creates a new recurring super adjustment for the employee.",
5045 "operationId": "EmployeeRecurringSuperAdjustment_Post",
5046 "consumes": [
5047 "application/json",
5048 "text/json",
5049 "application/xml",
5050 "text/xml",
5051 "application/x-www-form-urlencoded"
5052 ],
5053 "produces": [
5054 "application/json",
5055 "text/json",
5056 "application/xml",
5057 "text/xml"
5058 ],
5059 "parameters": [
5060 {
5061 "name": "model",
5062 "in": "body",
5063 "required": true,
5064 "schema": {
5065 "$ref": "#/definitions/EmployeeRecurringSuperAdjustmentModel"
5066 }
5067 },
5068 {
5069 "name": "businessId",
5070 "in": "path",
5071 "required": true,
5072 "type": "string"
5073 },
5074 {
5075 "name": "employeeId",
5076 "in": "path",
5077 "required": true,
5078 "type": "string"
5079 }
5080 ],
5081 "responses": {
5082 "200": {
5083 "description": "OK",
5084 "schema": {
5085 "$ref": "#/definitions/EmployeeRecurringSuperAdjustmentModel"
5086 }
5087 }
5088 }
5089 }
5090 },
5091 "/api/v2/business/{businessId}/employee/{employeeId}/superadjustment/{id}": {
5092 "get": {
5093 "tags": [
5094 "EmployeeRecurringTransactions"
5095 ],
5096 "summary": "Get Employee Super Adjustment by ID",
5097 "description": "Gets the employee's recurring super adjustment with the specified ID.",
5098 "operationId": "EmployeeRecurringSuperAdjustment_Get",
5099 "consumes": [],
5100 "produces": [
5101 "application/json",
5102 "text/json",
5103 "application/xml",
5104 "text/xml"
5105 ],
5106 "parameters": [
5107 {
5108 "name": "id",
5109 "in": "path",
5110 "required": true,
5111 "type": "integer",
5112 "format": "int32",
5113 "title": "Int32"
5114 },
5115 {
5116 "name": "businessId",
5117 "in": "path",
5118 "required": true,
5119 "type": "string"
5120 },
5121 {
5122 "name": "employeeId",
5123 "in": "path",
5124 "required": true,
5125 "type": "string"
5126 }
5127 ],
5128 "responses": {
5129 "200": {
5130 "description": "OK",
5131 "schema": {
5132 "$ref": "#/definitions/EmployeeRecurringSuperAdjustmentModel"
5133 }
5134 }
5135 }
5136 },
5137 "put": {
5138 "tags": [
5139 "EmployeeRecurringTransactions"
5140 ],
5141 "summary": "Update Employee Super Adjustment",
5142 "description": "Updates the employee's recurring super adjustment with the specified ID.",
5143 "operationId": "EmployeeRecurringSuperAdjustment_Put",
5144 "consumes": [
5145 "application/json",
5146 "text/json",
5147 "application/xml",
5148 "text/xml",
5149 "application/x-www-form-urlencoded"
5150 ],
5151 "produces": [
5152 "application/json",
5153 "text/json",
5154 "application/xml",
5155 "text/xml"
5156 ],
5157 "parameters": [
5158 {
5159 "name": "id",
5160 "in": "path",
5161 "required": true,
5162 "type": "integer",
5163 "format": "int32",
5164 "title": "Int32"
5165 },
5166 {
5167 "name": "model",
5168 "in": "body",
5169 "required": true,
5170 "schema": {
5171 "$ref": "#/definitions/EmployeeRecurringSuperAdjustmentModel"
5172 }
5173 },
5174 {
5175 "name": "businessId",
5176 "in": "path",
5177 "required": true,
5178 "type": "string"
5179 },
5180 {
5181 "name": "employeeId",
5182 "in": "path",
5183 "required": true,
5184 "type": "string"
5185 }
5186 ],
5187 "responses": {
5188 "200": {
5189 "description": "OK",
5190 "schema": {
5191 "$ref": "#/definitions/EmployeeRecurringSuperAdjustmentModel"
5192 }
5193 }
5194 }
5195 },
5196 "delete": {
5197 "tags": [
5198 "EmployeeRecurringTransactions"
5199 ],
5200 "summary": "Delete Employee Super Adjustment",
5201 "description": "Deletes the employee recurring super adjustment with the specified ID.",
5202 "operationId": "EmployeeRecurringSuperAdjustment_Delete",
5203 "consumes": [],
5204 "produces": [
5205 "application/json",
5206 "text/json",
5207 "application/xml",
5208 "text/xml"
5209 ],
5210 "parameters": [
5211 {
5212 "name": "id",
5213 "in": "path",
5214 "required": true,
5215 "type": "integer",
5216 "format": "int32",
5217 "title": "Int32"
5218 },
5219 {
5220 "name": "businessId",
5221 "in": "path",
5222 "required": true,
5223 "type": "string"
5224 },
5225 {
5226 "name": "employeeId",
5227 "in": "path",
5228 "required": true,
5229 "type": "string"
5230 }
5231 ],
5232 "responses": {
5233 "200": {
5234 "description": "OK"
5235 }
5236 }
5237 }
5238 },
5239 "/api/v2/business/{businessId}/employee/{employeeId}/employerliability": {
5240 "get": {
5241 "tags": [
5242 "EmployeeRecurringTransactions"
5243 ],
5244 "summary": "List Employer liabilities",
5245 "description": "Lists all the recurring employer liabilities for the employee",
5246 "operationId": "Employerrecurringliability_List",
5247 "consumes": [],
5248 "produces": [
5249 "application/json",
5250 "text/json",
5251 "application/xml",
5252 "text/xml"
5253 ],
5254 "parameters": [
5255 {
5256 "name": "businessId",
5257 "in": "path",
5258 "required": true,
5259 "type": "string"
5260 },
5261 {
5262 "name": "employeeId",
5263 "in": "path",
5264 "required": true,
5265 "type": "string"
5266 }
5267 ],
5268 "responses": {
5269 "200": {
5270 "description": "OK",
5271 "schema": {
5272 "type": "array",
5273 "items": {
5274 "$ref": "#/definitions/EmployerRecurringLiabilityModel"
5275 },
5276 "xml": {
5277 "name": "EmployerRecurringLiabilityModel",
5278 "wrapped": true
5279 },
5280 "title": "IEnumerable<EmployerRecurringLiabilityModel>"
5281 }
5282 }
5283 }
5284 },
5285 "post": {
5286 "tags": [
5287 "EmployeeRecurringTransactions"
5288 ],
5289 "summary": "Create Employer liability",
5290 "description": "Creates a new recurring employer liability for the employee.",
5291 "operationId": "Employerrecurringliability_Post",
5292 "consumes": [
5293 "application/json",
5294 "text/json",
5295 "application/xml",
5296 "text/xml",
5297 "application/x-www-form-urlencoded"
5298 ],
5299 "produces": [
5300 "application/json",
5301 "text/json",
5302 "application/xml",
5303 "text/xml"
5304 ],
5305 "parameters": [
5306 {
5307 "name": "model",
5308 "in": "body",
5309 "required": true,
5310 "schema": {
5311 "$ref": "#/definitions/EmployerRecurringLiabilityModel"
5312 }
5313 },
5314 {
5315 "name": "businessId",
5316 "in": "path",
5317 "required": true,
5318 "type": "string"
5319 },
5320 {
5321 "name": "employeeId",
5322 "in": "path",
5323 "required": true,
5324 "type": "string"
5325 }
5326 ],
5327 "responses": {
5328 "200": {
5329 "description": "OK",
5330 "schema": {
5331 "$ref": "#/definitions/EmployerRecurringLiabilityModel"
5332 }
5333 }
5334 }
5335 }
5336 },
5337 "/api/v2/business/{businessId}/employee/{employeeId}/employerliability/{id}": {
5338 "get": {
5339 "tags": [
5340 "EmployeeRecurringTransactions"
5341 ],
5342 "summary": "Get Employer liability by ID",
5343 "description": "Gets the employee's recurring employer liabilities with the specified ID.",
5344 "operationId": "Employerrecurringliability_Get",
5345 "consumes": [],
5346 "produces": [
5347 "application/json",
5348 "text/json",
5349 "application/xml",
5350 "text/xml"
5351 ],
5352 "parameters": [
5353 {
5354 "name": "id",
5355 "in": "path",
5356 "required": true,
5357 "type": "integer",
5358 "format": "int32",
5359 "title": "Int32"
5360 },
5361 {
5362 "name": "businessId",
5363 "in": "path",
5364 "required": true,
5365 "type": "string"
5366 },
5367 {
5368 "name": "employeeId",
5369 "in": "path",
5370 "required": true,
5371 "type": "string"
5372 }
5373 ],
5374 "responses": {
5375 "200": {
5376 "description": "OK",
5377 "schema": {
5378 "$ref": "#/definitions/EmployerRecurringLiabilityModel"
5379 }
5380 }
5381 }
5382 },
5383 "put": {
5384 "tags": [
5385 "EmployeeRecurringTransactions"
5386 ],
5387 "summary": "Update Employer liability",
5388 "description": "Updates the employee's recurring employer liability with the specified ID.",
5389 "operationId": "Employerrecurringliability_Put",
5390 "consumes": [
5391 "application/json",
5392 "text/json",
5393 "application/xml",
5394 "text/xml",
5395 "application/x-www-form-urlencoded"
5396 ],
5397 "produces": [
5398 "application/json",
5399 "text/json",
5400 "application/xml",
5401 "text/xml"
5402 ],
5403 "parameters": [
5404 {
5405 "name": "id",
5406 "in": "path",
5407 "required": true,
5408 "type": "integer",
5409 "format": "int32",
5410 "title": "Int32"
5411 },
5412 {
5413 "name": "model",
5414 "in": "body",
5415 "required": true,
5416 "schema": {
5417 "$ref": "#/definitions/EmployerRecurringLiabilityModel"
5418 }
5419 },
5420 {
5421 "name": "businessId",
5422 "in": "path",
5423 "required": true,
5424 "type": "string"
5425 },
5426 {
5427 "name": "employeeId",
5428 "in": "path",
5429 "required": true,
5430 "type": "string"
5431 }
5432 ],
5433 "responses": {
5434 "200": {
5435 "description": "OK",
5436 "schema": {
5437 "$ref": "#/definitions/EmployerRecurringLiabilityModel"
5438 }
5439 }
5440 }
5441 },
5442 "delete": {
5443 "tags": [
5444 "EmployeeRecurringTransactions"
5445 ],
5446 "summary": "Delete Employer liability",
5447 "description": "Deletes the recurring employer liability with the specified ID.",
5448 "operationId": "Employerrecurringliability_Delete",
5449 "consumes": [],
5450 "produces": [
5451 "application/json",
5452 "text/json",
5453 "application/xml",
5454 "text/xml"
5455 ],
5456 "parameters": [
5457 {
5458 "name": "id",
5459 "in": "path",
5460 "required": true,
5461 "type": "integer",
5462 "format": "int32",
5463 "title": "Int32"
5464 },
5465 {
5466 "name": "businessId",
5467 "in": "path",
5468 "required": true,
5469 "type": "string"
5470 },
5471 {
5472 "name": "employeeId",
5473 "in": "path",
5474 "required": true,
5475 "type": "string"
5476 }
5477 ],
5478 "responses": {
5479 "200": {
5480 "description": "OK"
5481 }
5482 }
5483 }
5484 },
5485 "/api/v2/business/{businessId}/employee/{employeeId}/deduction": {
5486 "get": {
5487 "tags": [
5488 "EmployeeRecurringTransactions"
5489 ],
5490 "summary": "List Employee Deductions",
5491 "description": "Lists all the recurring employee deductions for the employee",
5492 "operationId": "EmployeeRecurringDeduction_List",
5493 "consumes": [],
5494 "produces": [
5495 "application/json",
5496 "text/json",
5497 "application/xml",
5498 "text/xml"
5499 ],
5500 "parameters": [
5501 {
5502 "name": "businessId",
5503 "in": "path",
5504 "required": true,
5505 "type": "string"
5506 },
5507 {
5508 "name": "employeeId",
5509 "in": "path",
5510 "required": true,
5511 "type": "string"
5512 }
5513 ],
5514 "responses": {
5515 "200": {
5516 "description": "OK",
5517 "schema": {
5518 "type": "array",
5519 "items": {
5520 "$ref": "#/definitions/EmployeeRecurringDeductionModel"
5521 },
5522 "xml": {
5523 "name": "EmployeeRecurringDeductionModel",
5524 "wrapped": true
5525 },
5526 "title": "IEnumerable<EmployeeRecurringDeductionModel>"
5527 }
5528 }
5529 }
5530 },
5531 "post": {
5532 "tags": [
5533 "EmployeeRecurringTransactions"
5534 ],
5535 "summary": "Create Employee Deduction",
5536 "description": "Creates a new recurring deduction for the employee.",
5537 "operationId": "EmployeeRecurringDeduction_Post",
5538 "consumes": [
5539 "application/json",
5540 "text/json",
5541 "application/xml",
5542 "text/xml",
5543 "application/x-www-form-urlencoded"
5544 ],
5545 "produces": [
5546 "application/json",
5547 "text/json",
5548 "application/xml",
5549 "text/xml"
5550 ],
5551 "parameters": [
5552 {
5553 "name": "model",
5554 "in": "body",
5555 "required": true,
5556 "schema": {
5557 "$ref": "#/definitions/EmployeeRecurringDeductionModel"
5558 }
5559 },
5560 {
5561 "name": "businessId",
5562 "in": "path",
5563 "required": true,
5564 "type": "string"
5565 },
5566 {
5567 "name": "employeeId",
5568 "in": "path",
5569 "required": true,
5570 "type": "string"
5571 }
5572 ],
5573 "responses": {
5574 "200": {
5575 "description": "OK",
5576 "schema": {
5577 "$ref": "#/definitions/EmployeeRecurringDeductionModel"
5578 }
5579 }
5580 }
5581 }
5582 },
5583 "/api/v2/business/{businessId}/employee/{employeeId}/deduction/{id}": {
5584 "get": {
5585 "tags": [
5586 "EmployeeRecurringTransactions"
5587 ],
5588 "summary": "Get Employee Deduction by ID",
5589 "description": "Gets the employee's recurring deduction with the specified ID.",
5590 "operationId": "EmployeeRecurringDeduction_Get",
5591 "consumes": [],
5592 "produces": [
5593 "application/json",
5594 "text/json",
5595 "application/xml",
5596 "text/xml"
5597 ],
5598 "parameters": [
5599 {
5600 "name": "id",
5601 "in": "path",
5602 "required": true,
5603 "type": "integer",
5604 "format": "int32",
5605 "title": "Int32"
5606 },
5607 {
5608 "name": "businessId",
5609 "in": "path",
5610 "required": true,
5611 "type": "string"
5612 },
5613 {
5614 "name": "employeeId",
5615 "in": "path",
5616 "required": true,
5617 "type": "string"
5618 }
5619 ],
5620 "responses": {
5621 "200": {
5622 "description": "OK",
5623 "schema": {
5624 "$ref": "#/definitions/EmployeeRecurringDeductionModel"
5625 }
5626 }
5627 }
5628 },
5629 "put": {
5630 "tags": [
5631 "EmployeeRecurringTransactions"
5632 ],
5633 "summary": "Update Employee Deduction",
5634 "description": "Updates the employee's recurring deduction with the specified ID.",
5635 "operationId": "EmployeeRecurringDeduction_Put",
5636 "consumes": [
5637 "application/json",
5638 "text/json",
5639 "application/xml",
5640 "text/xml",
5641 "application/x-www-form-urlencoded"
5642 ],
5643 "produces": [
5644 "application/json",
5645 "text/json",
5646 "application/xml",
5647 "text/xml"
5648 ],
5649 "parameters": [
5650 {
5651 "name": "id",
5652 "in": "path",
5653 "required": true,
5654 "type": "integer",
5655 "format": "int32",
5656 "title": "Int32"
5657 },
5658 {
5659 "name": "model",
5660 "in": "body",
5661 "required": true,
5662 "schema": {
5663 "$ref": "#/definitions/EmployeeRecurringDeductionModel"
5664 }
5665 },
5666 {
5667 "name": "businessId",
5668 "in": "path",
5669 "required": true,
5670 "type": "string"
5671 },
5672 {
5673 "name": "employeeId",
5674 "in": "path",
5675 "required": true,
5676 "type": "string"
5677 }
5678 ],
5679 "responses": {
5680 "200": {
5681 "description": "OK",
5682 "schema": {
5683 "$ref": "#/definitions/EmployeeRecurringDeductionModel"
5684 }
5685 }
5686 }
5687 },
5688 "delete": {
5689 "tags": [
5690 "EmployeeRecurringTransactions"
5691 ],
5692 "summary": "Delete Employee Deduction",
5693 "description": "Deletes the employee recurring deduction with the specified ID.",
5694 "operationId": "EmployeeRecurringDeduction_Delete",
5695 "consumes": [],
5696 "produces": [
5697 "application/json",
5698 "text/json",
5699 "application/xml",
5700 "text/xml"
5701 ],
5702 "parameters": [
5703 {
5704 "name": "id",
5705 "in": "path",
5706 "required": true,
5707 "type": "integer",
5708 "format": "int32",
5709 "title": "Int32"
5710 },
5711 {
5712 "name": "businessId",
5713 "in": "path",
5714 "required": true,
5715 "type": "string"
5716 },
5717 {
5718 "name": "employeeId",
5719 "in": "path",
5720 "required": true,
5721 "type": "string"
5722 }
5723 ],
5724 "responses": {
5725 "200": {
5726 "description": "OK"
5727 }
5728 }
5729 }
5730 },
5731 "/api/v2/business/{businessId}/employee/{employeeId}/expense": {
5732 "get": {
5733 "tags": [
5734 "EmployeeRecurringTransactions"
5735 ],
5736 "summary": "List Employee Expenses",
5737 "description": "Lists all the recurring employee expenses for the employee",
5738 "operationId": "EmployeeRecurringExpense_List",
5739 "consumes": [],
5740 "produces": [
5741 "application/json",
5742 "text/json",
5743 "application/xml",
5744 "text/xml"
5745 ],
5746 "parameters": [
5747 {
5748 "name": "businessId",
5749 "in": "path",
5750 "required": true,
5751 "type": "string"
5752 },
5753 {
5754 "name": "employeeId",
5755 "in": "path",
5756 "required": true,
5757 "type": "string"
5758 }
5759 ],
5760 "responses": {
5761 "200": {
5762 "description": "OK",
5763 "schema": {
5764 "type": "array",
5765 "items": {
5766 "$ref": "#/definitions/EmployeeRecurringExpenseModel"
5767 },
5768 "xml": {
5769 "name": "EmployeeRecurringExpenseModel",
5770 "wrapped": true
5771 },
5772 "title": "IEnumerable<EmployeeRecurringExpenseModel>"
5773 }
5774 }
5775 }
5776 },
5777 "post": {
5778 "tags": [
5779 "EmployeeRecurringTransactions"
5780 ],
5781 "summary": "Create Employee Expense",
5782 "description": "Creates a new recurring expense for the employee.",
5783 "operationId": "EmployeeRecurringExpense_Post",
5784 "consumes": [
5785 "application/json",
5786 "text/json",
5787 "application/xml",
5788 "text/xml",
5789 "application/x-www-form-urlencoded"
5790 ],
5791 "produces": [
5792 "application/json",
5793 "text/json",
5794 "application/xml",
5795 "text/xml"
5796 ],
5797 "parameters": [
5798 {
5799 "name": "model",
5800 "in": "body",
5801 "required": true,
5802 "schema": {
5803 "$ref": "#/definitions/EmployeeRecurringExpenseModel"
5804 }
5805 },
5806 {
5807 "name": "businessId",
5808 "in": "path",
5809 "required": true,
5810 "type": "string"
5811 },
5812 {
5813 "name": "employeeId",
5814 "in": "path",
5815 "required": true,
5816 "type": "string"
5817 }
5818 ],
5819 "responses": {
5820 "200": {
5821 "description": "OK",
5822 "schema": {
5823 "$ref": "#/definitions/EmployeeRecurringExpenseModel"
5824 }
5825 }
5826 }
5827 }
5828 },
5829 "/api/v2/business/{businessId}/employee/{employeeId}/expense/{id}": {
5830 "get": {
5831 "tags": [
5832 "EmployeeRecurringTransactions"
5833 ],
5834 "summary": "Get Employee Expense by ID",
5835 "description": "Gets the employee's recurring expense with the specified ID.",
5836 "operationId": "EmployeeRecurringExpense_Get",
5837 "consumes": [],
5838 "produces": [
5839 "application/json",
5840 "text/json",
5841 "application/xml",
5842 "text/xml"
5843 ],
5844 "parameters": [
5845 {
5846 "name": "id",
5847 "in": "path",
5848 "required": true,
5849 "type": "integer",
5850 "format": "int32",
5851 "title": "Int32"
5852 },
5853 {
5854 "name": "businessId",
5855 "in": "path",
5856 "required": true,
5857 "type": "string"
5858 },
5859 {
5860 "name": "employeeId",
5861 "in": "path",
5862 "required": true,
5863 "type": "string"
5864 }
5865 ],
5866 "responses": {
5867 "200": {
5868 "description": "OK",
5869 "schema": {
5870 "$ref": "#/definitions/EmployeeRecurringExpenseModel"
5871 }
5872 }
5873 }
5874 },
5875 "put": {
5876 "tags": [
5877 "EmployeeRecurringTransactions"
5878 ],
5879 "summary": "Update Employee Expense",
5880 "description": "Updates the employee's recurring expense with the specified ID.",
5881 "operationId": "EmployeeRecurringExpense_Put",
5882 "consumes": [
5883 "application/json",
5884 "text/json",
5885 "application/xml",
5886 "text/xml",
5887 "application/x-www-form-urlencoded"
5888 ],
5889 "produces": [
5890 "application/json",
5891 "text/json",
5892 "application/xml",
5893 "text/xml"
5894 ],
5895 "parameters": [
5896 {
5897 "name": "id",
5898 "in": "path",
5899 "required": true,
5900 "type": "integer",
5901 "format": "int32",
5902 "title": "Int32"
5903 },
5904 {
5905 "name": "model",
5906 "in": "body",
5907 "required": true,
5908 "schema": {
5909 "$ref": "#/definitions/EmployeeRecurringExpenseModel"
5910 }
5911 },
5912 {
5913 "name": "businessId",
5914 "in": "path",
5915 "required": true,
5916 "type": "string"
5917 },
5918 {
5919 "name": "employeeId",
5920 "in": "path",
5921 "required": true,
5922 "type": "string"
5923 }
5924 ],
5925 "responses": {
5926 "200": {
5927 "description": "OK",
5928 "schema": {
5929 "$ref": "#/definitions/EmployeeRecurringExpenseModel"
5930 }
5931 }
5932 }
5933 },
5934 "delete": {
5935 "tags": [
5936 "EmployeeRecurringTransactions"
5937 ],
5938 "summary": "Delete Employee Expense",
5939 "description": "Deletes the employee recurring expense with the specified ID.",
5940 "operationId": "EmployeeRecurringExpense_Delete",
5941 "consumes": [],
5942 "produces": [
5943 "application/json",
5944 "text/json",
5945 "application/xml",
5946 "text/xml"
5947 ],
5948 "parameters": [
5949 {
5950 "name": "id",
5951 "in": "path",
5952 "required": true,
5953 "type": "integer",
5954 "format": "int32",
5955 "title": "Int32"
5956 },
5957 {
5958 "name": "businessId",
5959 "in": "path",
5960 "required": true,
5961 "type": "string"
5962 },
5963 {
5964 "name": "employeeId",
5965 "in": "path",
5966 "required": true,
5967 "type": "string"
5968 }
5969 ],
5970 "responses": {
5971 "200": {
5972 "description": "OK"
5973 }
5974 }
5975 }
5976 },
5977 "/api/v2/business/{businessId}/employee/{employeeId}/superfund": {
5978 "get": {
5979 "tags": [
5980 "EmployeeSuperFund"
5981 ],
5982 "summary": "List Super Funds",
5983 "description": "Lists all of the super funds for this employee.",
5984 "operationId": "EmployeeSuperFund_List",
5985 "consumes": [],
5986 "produces": [
5987 "application/json",
5988 "text/json",
5989 "application/xml",
5990 "text/xml"
5991 ],
5992 "parameters": [
5993 {
5994 "name": "businessId",
5995 "in": "path",
5996 "required": true,
5997 "type": "string"
5998 },
5999 {
6000 "name": "employeeId",
6001 "in": "path",
6002 "required": true,
6003 "type": "string"
6004 }
6005 ],
6006 "responses": {
6007 "200": {
6008 "description": "OK",
6009 "schema": {
6010 "type": "array",
6011 "items": {
6012 "$ref": "#/definitions/SuperFundModel"
6013 },
6014 "xml": {
6015 "name": "SuperFundModel",
6016 "wrapped": true
6017 },
6018 "title": "IEnumerable<SuperFundModel>"
6019 }
6020 }
6021 }
6022 },
6023 "post": {
6024 "tags": [
6025 "EmployeeSuperFund"
6026 ],
6027 "summary": "Create Super Fund",
6028 "description": "Creates a new super fund for the employee.",
6029 "operationId": "EmployeeSuperFund_Post",
6030 "consumes": [
6031 "application/json",
6032 "text/json",
6033 "application/xml",
6034 "text/xml",
6035 "application/x-www-form-urlencoded"
6036 ],
6037 "produces": [
6038 "application/json",
6039 "text/json",
6040 "application/xml",
6041 "text/xml"
6042 ],
6043 "parameters": [
6044 {
6045 "name": "model",
6046 "in": "body",
6047 "required": true,
6048 "schema": {
6049 "$ref": "#/definitions/SaveSuperFundModel"
6050 }
6051 },
6052 {
6053 "name": "businessId",
6054 "in": "path",
6055 "required": true,
6056 "type": "string"
6057 },
6058 {
6059 "name": "employeeId",
6060 "in": "path",
6061 "required": true,
6062 "type": "string"
6063 }
6064 ],
6065 "responses": {
6066 "200": {
6067 "description": "OK",
6068 "schema": {
6069 "$ref": "#/definitions/SaveSuperFundResponseModel"
6070 }
6071 }
6072 }
6073 }
6074 },
6075 "/api/v2/business/{businessId}/employee/{employeeId}/superfund/{superFundId}": {
6076 "get": {
6077 "tags": [
6078 "EmployeeSuperFund"
6079 ],
6080 "summary": "Get Super Fund by ID",
6081 "description": "Gets the super fund for this employee with the specified ID.",
6082 "operationId": "EmployeeSuperFund_Get",
6083 "consumes": [],
6084 "produces": [
6085 "application/json",
6086 "text/json",
6087 "application/xml",
6088 "text/xml"
6089 ],
6090 "parameters": [
6091 {
6092 "name": "superFundId",
6093 "in": "path",
6094 "required": true,
6095 "type": "integer",
6096 "format": "int32",
6097 "title": "Int32"
6098 },
6099 {
6100 "name": "businessId",
6101 "in": "path",
6102 "required": true,
6103 "type": "string"
6104 },
6105 {
6106 "name": "employeeId",
6107 "in": "path",
6108 "required": true,
6109 "type": "string"
6110 }
6111 ],
6112 "responses": {
6113 "200": {
6114 "description": "OK",
6115 "schema": {
6116 "$ref": "#/definitions/SuperFundModel"
6117 }
6118 }
6119 }
6120 }
6121 },
6122 "/api/v2/business/{businessId}/employee/{employeeId}/superfund/{id}": {
6123 "put": {
6124 "tags": [
6125 "EmployeeSuperFund"
6126 ],
6127 "summary": "Update Super Fund",
6128 "description": "Updates the employee's super fund with the specified ID.",
6129 "operationId": "EmployeeSuperFund_Put",
6130 "consumes": [
6131 "application/json",
6132 "text/json",
6133 "application/xml",
6134 "text/xml",
6135 "application/x-www-form-urlencoded"
6136 ],
6137 "produces": [
6138 "application/json",
6139 "text/json",
6140 "application/xml",
6141 "text/xml"
6142 ],
6143 "parameters": [
6144 {
6145 "name": "id",
6146 "in": "path",
6147 "required": true,
6148 "type": "integer",
6149 "format": "int32",
6150 "title": "Int32"
6151 },
6152 {
6153 "name": "model",
6154 "in": "body",
6155 "required": true,
6156 "schema": {
6157 "$ref": "#/definitions/SaveSuperFundModel"
6158 }
6159 },
6160 {
6161 "name": "businessId",
6162 "in": "path",
6163 "required": true,
6164 "type": "string"
6165 },
6166 {
6167 "name": "employeeId",
6168 "in": "path",
6169 "required": true,
6170 "type": "string"
6171 }
6172 ],
6173 "responses": {
6174 "200": {
6175 "description": "OK",
6176 "schema": {
6177 "$ref": "#/definitions/SaveSuperFundResponseModel"
6178 }
6179 }
6180 }
6181 }
6182 },
6183 "/api/v2/business/{businessId}/employee/{employeeId}/superfund/{superfundId}": {
6184 "delete": {
6185 "tags": [
6186 "EmployeeSuperFund"
6187 ],
6188 "summary": "Delete Super Fund",
6189 "description": "Deletes the employee's super fund with the specified ID.",
6190 "operationId": "EmployeeSuperFund_Delete",
6191 "consumes": [],
6192 "produces": [
6193 "application/json",
6194 "text/json",
6195 "application/xml",
6196 "text/xml"
6197 ],
6198 "parameters": [
6199 {
6200 "name": "superfundId",
6201 "in": "path",
6202 "required": true,
6203 "type": "integer",
6204 "format": "int32",
6205 "title": "Int32"
6206 },
6207 {
6208 "name": "businessId",
6209 "in": "path",
6210 "required": true,
6211 "type": "string"
6212 },
6213 {
6214 "name": "employeeId",
6215 "in": "path",
6216 "required": true,
6217 "type": "string"
6218 }
6219 ],
6220 "responses": {
6221 "200": {
6222 "description": "OK",
6223 "schema": {
6224 "$ref": "#/definitions/SaveSuperFundResponseModel"
6225 }
6226 }
6227 }
6228 }
6229 },
6230 "/api/v2/business/{businessId}/employerliabilitycategory": {
6231 "get": {
6232 "tags": [
6233 "EmployerLiabilityCategories"
6234 ],
6235 "summary": "List Employer Liability Categories",
6236 "description": "Lists all the employer liability categories for this business.\n\nThis operation supports OData queries.",
6237 "operationId": "EmployerLiabilityCategory_GetEmployerLiabilityCategories",
6238 "consumes": [],
6239 "produces": [
6240 "application/json",
6241 "text/json",
6242 "application/xml",
6243 "text/xml"
6244 ],
6245 "parameters": [
6246 {
6247 "name": "businessId",
6248 "in": "path",
6249 "required": true,
6250 "type": "string"
6251 }
6252 ],
6253 "responses": {
6254 "200": {
6255 "description": "OK",
6256 "schema": {
6257 "type": "array",
6258 "items": {
6259 "$ref": "#/definitions/EmployerLiabilityCategoryModel"
6260 },
6261 "xml": {
6262 "name": "EmployerLiabilityCategoryModel",
6263 "wrapped": true
6264 },
6265 "title": "IEnumerable<EmployerLiabilityCategoryModel>"
6266 }
6267 }
6268 }
6269 },
6270 "post": {
6271 "tags": [
6272 "EmployerLiabilityCategories"
6273 ],
6274 "summary": "Create Employer Liability Category",
6275 "description": "Creates an employer liability category for the business.",
6276 "operationId": "EmployerLiabilityCategory_Post",
6277 "consumes": [
6278 "application/json",
6279 "text/json",
6280 "application/xml",
6281 "text/xml",
6282 "application/x-www-form-urlencoded"
6283 ],
6284 "produces": [
6285 "application/json",
6286 "text/json",
6287 "application/xml",
6288 "text/xml"
6289 ],
6290 "parameters": [
6291 {
6292 "name": "employerLiabilityCategory",
6293 "in": "body",
6294 "required": true,
6295 "schema": {
6296 "$ref": "#/definitions/EmployerLiabilityCategoryModel"
6297 }
6298 },
6299 {
6300 "name": "businessId",
6301 "in": "path",
6302 "required": true,
6303 "type": "string"
6304 }
6305 ],
6306 "responses": {
6307 "200": {
6308 "description": "OK"
6309 }
6310 }
6311 }
6312 },
6313 "/api/v2/business/{businessId}/employerliabilitycategory/{id}": {
6314 "get": {
6315 "tags": [
6316 "EmployerLiabilityCategories"
6317 ],
6318 "summary": "Get Employer Liability Category",
6319 "description": "Gets the employer liability category with the specified ID.",
6320 "operationId": "EmployerLiabilityCategory_Get",
6321 "consumes": [],
6322 "produces": [
6323 "application/json",
6324 "text/json",
6325 "application/xml",
6326 "text/xml"
6327 ],
6328 "parameters": [
6329 {
6330 "name": "id",
6331 "in": "path",
6332 "required": true,
6333 "type": "integer",
6334 "format": "int32",
6335 "title": "Int32"
6336 },
6337 {
6338 "name": "businessId",
6339 "in": "path",
6340 "required": true,
6341 "type": "string"
6342 }
6343 ],
6344 "responses": {
6345 "200": {
6346 "description": "OK",
6347 "schema": {
6348 "$ref": "#/definitions/EmployerLiabilityCategoryModel"
6349 }
6350 }
6351 }
6352 },
6353 "put": {
6354 "tags": [
6355 "EmployerLiabilityCategories"
6356 ],
6357 "summary": "Update Employer Liability Category",
6358 "description": "Updates the employer liability category with the specified ID.",
6359 "operationId": "EmployerLiabilityCategory_Put",
6360 "consumes": [
6361 "application/json",
6362 "text/json",
6363 "application/xml",
6364 "text/xml",
6365 "application/x-www-form-urlencoded"
6366 ],
6367 "produces": [
6368 "application/json",
6369 "text/json",
6370 "application/xml",
6371 "text/xml"
6372 ],
6373 "parameters": [
6374 {
6375 "name": "id",
6376 "in": "path",
6377 "required": true,
6378 "type": "integer",
6379 "format": "int32",
6380 "title": "Int32"
6381 },
6382 {
6383 "name": "employerLiabilityCategory",
6384 "in": "body",
6385 "required": true,
6386 "schema": {
6387 "$ref": "#/definitions/EmployerLiabilityCategoryModel"
6388 }
6389 },
6390 {
6391 "name": "businessId",
6392 "in": "path",
6393 "required": true,
6394 "type": "string"
6395 }
6396 ],
6397 "responses": {
6398 "200": {
6399 "description": "OK"
6400 }
6401 }
6402 },
6403 "delete": {
6404 "tags": [
6405 "EmployerLiabilityCategories"
6406 ],
6407 "summary": "Delete Employer Liability Category",
6408 "description": "Deletes the employer liability category with the specified ID.",
6409 "operationId": "EmployerLiabilityCategory_Delete",
6410 "consumes": [],
6411 "produces": [
6412 "application/json",
6413 "text/json",
6414 "application/xml",
6415 "text/xml"
6416 ],
6417 "parameters": [
6418 {
6419 "name": "id",
6420 "in": "path",
6421 "required": true,
6422 "type": "integer",
6423 "format": "int32",
6424 "title": "Int32"
6425 },
6426 {
6427 "name": "businessId",
6428 "in": "path",
6429 "required": true,
6430 "type": "string"
6431 }
6432 ],
6433 "responses": {
6434 "200": {
6435 "description": "OK"
6436 }
6437 }
6438 }
6439 },
6440 "/api/v2/business/{businessId}/employingentity": {
6441 "get": {
6442 "tags": [
6443 "EmployingEntities"
6444 ],
6445 "summary": "List Employing Entities",
6446 "description": "Lists all the employing entities for the business.\n\nThis operation supports OData queries.",
6447 "operationId": "EmployingEntity_GetEmployingEntities",
6448 "consumes": [],
6449 "produces": [
6450 "application/json",
6451 "text/json",
6452 "application/xml",
6453 "text/xml"
6454 ],
6455 "parameters": [
6456 {
6457 "name": "businessId",
6458 "in": "path",
6459 "required": true,
6460 "type": "string"
6461 }
6462 ],
6463 "responses": {
6464 "200": {
6465 "description": "OK",
6466 "schema": {
6467 "type": "array",
6468 "items": {
6469 "$ref": "#/definitions/EmployingEntityModel"
6470 },
6471 "xml": {
6472 "name": "EmployingEntityModel",
6473 "wrapped": true
6474 },
6475 "title": "IEnumerable<EmployingEntityModel>"
6476 }
6477 }
6478 }
6479 },
6480 "post": {
6481 "tags": [
6482 "EmployingEntities"
6483 ],
6484 "summary": "Create Employing Entity",
6485 "description": "Creates a new employing entity for the business.",
6486 "operationId": "EmployingEntity_Post",
6487 "consumes": [
6488 "application/json",
6489 "text/json",
6490 "application/xml",
6491 "text/xml",
6492 "application/x-www-form-urlencoded"
6493 ],
6494 "produces": [
6495 "application/json",
6496 "text/json",
6497 "application/xml",
6498 "text/xml"
6499 ],
6500 "parameters": [
6501 {
6502 "name": "employingEntity",
6503 "in": "body",
6504 "required": true,
6505 "schema": {
6506 "$ref": "#/definitions/EmployingEntityModel"
6507 }
6508 },
6509 {
6510 "name": "businessId",
6511 "in": "path",
6512 "required": true,
6513 "type": "string"
6514 }
6515 ],
6516 "responses": {
6517 "200": {
6518 "description": "OK"
6519 }
6520 }
6521 }
6522 },
6523 "/api/v2/business/{businessId}/employingentity/{id}": {
6524 "get": {
6525 "tags": [
6526 "EmployingEntities"
6527 ],
6528 "summary": "Get Employing Entity By ID",
6529 "description": "Gets the employing entity with the specified ID.",
6530 "operationId": "EmployingEntity_Get",
6531 "consumes": [],
6532 "produces": [
6533 "application/json",
6534 "text/json",
6535 "application/xml",
6536 "text/xml"
6537 ],
6538 "parameters": [
6539 {
6540 "name": "id",
6541 "in": "path",
6542 "required": true,
6543 "type": "integer",
6544 "format": "int32",
6545 "title": "Int32"
6546 },
6547 {
6548 "name": "businessId",
6549 "in": "path",
6550 "required": true,
6551 "type": "string"
6552 }
6553 ],
6554 "responses": {
6555 "200": {
6556 "description": "OK",
6557 "schema": {
6558 "$ref": "#/definitions/EmployingEntityModel"
6559 }
6560 }
6561 }
6562 },
6563 "put": {
6564 "tags": [
6565 "EmployingEntities"
6566 ],
6567 "summary": "Update Employing Entity",
6568 "description": "Updates the employing entity with the specified ID.",
6569 "operationId": "EmployingEntity_Put",
6570 "consumes": [
6571 "application/json",
6572 "text/json",
6573 "application/xml",
6574 "text/xml",
6575 "application/x-www-form-urlencoded"
6576 ],
6577 "produces": [
6578 "application/json",
6579 "text/json",
6580 "application/xml",
6581 "text/xml"
6582 ],
6583 "parameters": [
6584 {
6585 "name": "id",
6586 "in": "path",
6587 "required": true,
6588 "type": "integer",
6589 "format": "int32",
6590 "title": "Int32"
6591 },
6592 {
6593 "name": "employingEntity",
6594 "in": "body",
6595 "required": true,
6596 "schema": {
6597 "$ref": "#/definitions/EmployingEntityModel"
6598 }
6599 },
6600 {
6601 "name": "businessId",
6602 "in": "path",
6603 "required": true,
6604 "type": "string"
6605 }
6606 ],
6607 "responses": {
6608 "200": {
6609 "description": "OK"
6610 }
6611 }
6612 },
6613 "delete": {
6614 "tags": [
6615 "EmployingEntities"
6616 ],
6617 "summary": "Delete Employing Entity",
6618 "description": "Deletes the employing entity with the specified ID.",
6619 "operationId": "EmployingEntity_Delete",
6620 "consumes": [],
6621 "produces": [
6622 "application/json",
6623 "text/json",
6624 "application/xml",
6625 "text/xml"
6626 ],
6627 "parameters": [
6628 {
6629 "name": "id",
6630 "in": "path",
6631 "required": true,
6632 "type": "integer",
6633 "format": "int32",
6634 "title": "Int32"
6635 },
6636 {
6637 "name": "businessId",
6638 "in": "path",
6639 "required": true,
6640 "type": "string"
6641 }
6642 ],
6643 "responses": {
6644 "200": {
6645 "description": "OK"
6646 }
6647 }
6648 }
6649 },
6650 "/api/v2/business/{businessId}/employmentagreement": {
6651 "get": {
6652 "tags": [
6653 "EmploymentAgreement"
6654 ],
6655 "summary": "List Employment Agreements",
6656 "description": "Lists all of the employment agreements for the business.\n\nThis operation supports OData queries.",
6657 "operationId": "EmploymentAgreement_GetAll",
6658 "consumes": [],
6659 "produces": [
6660 "application/json",
6661 "text/json",
6662 "application/xml",
6663 "text/xml"
6664 ],
6665 "parameters": [
6666 {
6667 "name": "businessId",
6668 "in": "path",
6669 "required": true,
6670 "type": "string"
6671 }
6672 ],
6673 "responses": {
6674 "200": {
6675 "description": "OK",
6676 "schema": {
6677 "type": "array",
6678 "items": {
6679 "$ref": "#/definitions/BasicEmploymentAgreementModel"
6680 },
6681 "xml": {
6682 "name": "BasicEmploymentAgreementModel",
6683 "wrapped": true
6684 },
6685 "title": "IQueryable<BasicEmploymentAgreementModel>"
6686 }
6687 }
6688 }
6689 }
6690 },
6691 "/api/v2/business/{businessId}/employmentagreement/{id}": {
6692 "get": {
6693 "tags": [
6694 "EmploymentAgreement"
6695 ],
6696 "summary": "Get Employment Agreement by ID",
6697 "description": "Gets the employment agreement with the specified ID.",
6698 "operationId": "EmploymentAgreement_Get",
6699 "consumes": [],
6700 "produces": [
6701 "application/json",
6702 "text/json",
6703 "application/xml",
6704 "text/xml"
6705 ],
6706 "parameters": [
6707 {
6708 "name": "id",
6709 "in": "path",
6710 "required": true,
6711 "type": "integer",
6712 "format": "int32",
6713 "title": "Int32"
6714 },
6715 {
6716 "name": "businessId",
6717 "in": "path",
6718 "required": true,
6719 "type": "string"
6720 }
6721 ],
6722 "responses": {
6723 "200": {
6724 "description": "OK",
6725 "schema": {
6726 "$ref": "#/definitions/EmploymentAgreementModel"
6727 }
6728 }
6729 }
6730 }
6731 },
6732 "/api/v2/business/{businessId}/employmentagreement/{id}/shiftperiods": {
6733 "post": {
6734 "tags": [
6735 "EmploymentAgreement"
6736 ],
6737 "summary": "Get Shift Periods",
6738 "description": "Gets all the shift periods for the employment agreement with the specified ID.",
6739 "operationId": "EmploymentAgreement_ShiftPeriods",
6740 "consumes": [
6741 "application/json",
6742 "text/json",
6743 "application/xml",
6744 "text/xml",
6745 "application/x-www-form-urlencoded"
6746 ],
6747 "produces": [
6748 "application/json",
6749 "text/json",
6750 "application/xml",
6751 "text/xml"
6752 ],
6753 "parameters": [
6754 {
6755 "name": "id",
6756 "in": "path",
6757 "required": true,
6758 "type": "integer",
6759 "format": "int32",
6760 "title": "Int32"
6761 },
6762 {
6763 "name": "model",
6764 "in": "body",
6765 "required": true,
6766 "schema": {
6767 "$ref": "#/definitions/GetShiftPeriodsModel"
6768 }
6769 },
6770 {
6771 "name": "businessId",
6772 "in": "path",
6773 "required": true,
6774 "type": "string"
6775 }
6776 ],
6777 "responses": {
6778 "200": {
6779 "description": "OK",
6780 "schema": {
6781 "type": "array",
6782 "items": {
6783 "$ref": "#/definitions/ShiftPeriodModel"
6784 },
6785 "xml": {
6786 "name": "ShiftPeriodModel",
6787 "wrapped": true
6788 },
6789 "title": "IList<ShiftPeriodModel>"
6790 }
6791 }
6792 }
6793 }
6794 },
6795 "/api/v2/business/{businessId}/employmentagreement/{id}/shiftcosting": {
6796 "post": {
6797 "tags": [
6798 "EmploymentAgreement"
6799 ],
6800 "summary": "Evaluate Shift Costings",
6801 "description": "Evaluates shift costings for the employment agreement with the specified ID.",
6802 "operationId": "EmploymentAgreement_Evaluate",
6803 "consumes": [
6804 "application/json",
6805 "text/json",
6806 "application/xml",
6807 "text/xml",
6808 "application/x-www-form-urlencoded"
6809 ],
6810 "produces": [
6811 "application/json",
6812 "text/json",
6813 "application/xml",
6814 "text/xml"
6815 ],
6816 "parameters": [
6817 {
6818 "name": "id",
6819 "in": "path",
6820 "required": true,
6821 "type": "integer",
6822 "format": "int32",
6823 "title": "Int32"
6824 },
6825 {
6826 "name": "model",
6827 "in": "body",
6828 "required": true,
6829 "schema": {
6830 "$ref": "#/definitions/ShiftCostingsRequestModel"
6831 }
6832 },
6833 {
6834 "name": "businessId",
6835 "in": "path",
6836 "required": true,
6837 "type": "string"
6838 }
6839 ],
6840 "responses": {
6841 "200": {
6842 "description": "OK",
6843 "schema": {
6844 "$ref": "#/definitions/ShiftCostingsResponseModel"
6845 }
6846 }
6847 }
6848 }
6849 },
6850 "/api/v2/business/{businessId}/employee/{employeeId}/timesheet/shiftperiods": {
6851 "post": {
6852 "tags": [
6853 "EmploymentAgreement"
6854 ],
6855 "summary": "Get Shift Periods for Employee",
6856 "description": "Gets the shift periods for the specified employee.",
6857 "operationId": "EmploymentAgreement_EmployeeShiftPeriods",
6858 "consumes": [
6859 "application/json",
6860 "text/json",
6861 "application/xml",
6862 "text/xml",
6863 "application/x-www-form-urlencoded"
6864 ],
6865 "produces": [
6866 "application/json",
6867 "text/json",
6868 "application/xml",
6869 "text/xml"
6870 ],
6871 "parameters": [
6872 {
6873 "name": "model",
6874 "in": "body",
6875 "required": true,
6876 "schema": {
6877 "$ref": "#/definitions/GetShiftPeriodsModel"
6878 }
6879 },
6880 {
6881 "name": "businessId",
6882 "in": "path",
6883 "required": true,
6884 "type": "string"
6885 },
6886 {
6887 "name": "employeeId",
6888 "in": "path",
6889 "required": true,
6890 "type": "string"
6891 }
6892 ],
6893 "responses": {
6894 "200": {
6895 "description": "OK",
6896 "schema": {
6897 "type": "array",
6898 "items": {
6899 "$ref": "#/definitions/ShiftPeriodModel"
6900 },
6901 "xml": {
6902 "name": "ShiftPeriodModel",
6903 "wrapped": true
6904 },
6905 "title": "IList<ShiftPeriodModel>"
6906 }
6907 }
6908 }
6909 }
6910 },
6911 "/api/v2/business/{businessId}/employee/{employeeId}/timesheet/shiftcosting": {
6912 "post": {
6913 "tags": [
6914 "EmploymentAgreement"
6915 ],
6916 "summary": "Get Shift Costings for Employee",
6917 "description": "Gets the shift costings for the specified employee.",
6918 "operationId": "EmploymentAgreement_EvaluateEmployee",
6919 "consumes": [
6920 "application/json",
6921 "text/json",
6922 "application/xml",
6923 "text/xml",
6924 "application/x-www-form-urlencoded"
6925 ],
6926 "produces": [
6927 "application/json",
6928 "text/json",
6929 "application/xml",
6930 "text/xml"
6931 ],
6932 "parameters": [
6933 {
6934 "name": "model",
6935 "in": "body",
6936 "required": true,
6937 "schema": {
6938 "$ref": "#/definitions/ShiftCostingsRequestModel"
6939 }
6940 },
6941 {
6942 "name": "businessId",
6943 "in": "path",
6944 "required": true,
6945 "type": "string"
6946 },
6947 {
6948 "name": "employeeId",
6949 "in": "path",
6950 "required": true,
6951 "type": "string"
6952 }
6953 ],
6954 "responses": {
6955 "200": {
6956 "description": "OK",
6957 "schema": {
6958 "$ref": "#/definitions/ShiftCostingsResponseModel"
6959 }
6960 }
6961 }
6962 }
6963 },
6964 "/api/v2/ess/{employeeId}/leave": {
6965 "get": {
6966 "tags": [
6967 "Ess"
6968 ],
6969 "summary": "List Leave Requests",
6970 "description": "Lists all leave requests for this employee, with optional filters",
6971 "operationId": "EssLeave_LeaveRequests",
6972 "consumes": [],
6973 "produces": [
6974 "application/json",
6975 "text/json",
6976 "application/xml",
6977 "text/xml"
6978 ],
6979 "parameters": [
6980 {
6981 "name": "employeeId",
6982 "in": "path",
6983 "required": true,
6984 "type": "string"
6985 },
6986 {
6987 "name": "filter.showOtherEmployees",
6988 "in": "query",
6989 "required": false,
6990 "type": "boolean",
6991 "title": "Boolean"
6992 },
6993 {
6994 "name": "filter.fromDate",
6995 "in": "query",
6996 "required": false,
6997 "type": "string",
6998 "format": "date-time",
6999 "title": "Nullable<DateTime>"
7000 },
7001 {
7002 "name": "filter.toDate",
7003 "in": "query",
7004 "required": false,
7005 "type": "string",
7006 "format": "date-time",
7007 "title": "Nullable<DateTime>"
7008 }
7009 ],
7010 "responses": {
7011 "200": {
7012 "description": "OK",
7013 "schema": {
7014 "type": "array",
7015 "items": {
7016 "$ref": "#/definitions/EssLeaveRequestModel"
7017 },
7018 "xml": {
7019 "name": "EssLeaveRequestModel",
7020 "wrapped": true
7021 },
7022 "title": "List<EssLeaveRequestModel>"
7023 }
7024 }
7025 }
7026 },
7027 "post": {
7028 "tags": [
7029 "Ess"
7030 ],
7031 "summary": "Create Leave Request",
7032 "description": "Creates a new leave request for the employee.",
7033 "operationId": "EssLeave_ApplyForLeave",
7034 "consumes": [
7035 "application/json",
7036 "text/json",
7037 "application/xml",
7038 "text/xml",
7039 "application/x-www-form-urlencoded"
7040 ],
7041 "produces": [
7042 "application/json",
7043 "text/json",
7044 "application/xml",
7045 "text/xml"
7046 ],
7047 "parameters": [
7048 {
7049 "name": "leaveApplication",
7050 "in": "body",
7051 "required": true,
7052 "schema": {
7053 "$ref": "#/definitions/EssLeaveApplicationModel"
7054 }
7055 },
7056 {
7057 "name": "employeeId",
7058 "in": "path",
7059 "required": true,
7060 "type": "string"
7061 }
7062 ],
7063 "responses": {
7064 "200": {
7065 "description": "OK"
7066 }
7067 }
7068 }
7069 },
7070 "/api/v2/ess/{employeeId}/leave/{leaveRequestId}": {
7071 "get": {
7072 "tags": [
7073 "Ess"
7074 ],
7075 "summary": "Get Leave Request by ID",
7076 "description": "Gets the details for a leave request with the specified ID.",
7077 "operationId": "EssLeave_LeaveRequest",
7078 "consumes": [],
7079 "produces": [
7080 "application/json",
7081 "text/json",
7082 "application/xml",
7083 "text/xml"
7084 ],
7085 "parameters": [
7086 {
7087 "name": "leaveRequestId",
7088 "in": "path",
7089 "required": true,
7090 "type": "integer",
7091 "format": "int32",
7092 "title": "Int32"
7093 },
7094 {
7095 "name": "employeeId",
7096 "in": "path",
7097 "required": true,
7098 "type": "string"
7099 }
7100 ],
7101 "responses": {
7102 "200": {
7103 "description": "OK",
7104 "schema": {
7105 "$ref": "#/definitions/EssLeaveRequestModel"
7106 }
7107 }
7108 }
7109 },
7110 "post": {
7111 "tags": [
7112 "Ess"
7113 ],
7114 "summary": "Update Leave Request",
7115 "description": "Updates the leave request with the specified ID.",
7116 "operationId": "EssLeave_EditLeave",
7117 "consumes": [
7118 "application/json",
7119 "text/json",
7120 "application/xml",
7121 "text/xml",
7122 "application/x-www-form-urlencoded"
7123 ],
7124 "produces": [
7125 "application/json",
7126 "text/json",
7127 "application/xml",
7128 "text/xml"
7129 ],
7130 "parameters": [
7131 {
7132 "name": "leaveRequestId",
7133 "in": "path",
7134 "required": true,
7135 "type": "integer",
7136 "format": "int32",
7137 "title": "Int32"
7138 },
7139 {
7140 "name": "leaveApplication",
7141 "in": "body",
7142 "required": true,
7143 "schema": {
7144 "$ref": "#/definitions/EssLeaveApplicationModel"
7145 }
7146 },
7147 {
7148 "name": "employeeId",
7149 "in": "path",
7150 "required": true,
7151 "type": "string"
7152 }
7153 ],
7154 "responses": {
7155 "200": {
7156 "description": "OK"
7157 }
7158 }
7159 },
7160 "delete": {
7161 "tags": [
7162 "Ess"
7163 ],
7164 "summary": "Delete Leave Request",
7165 "description": "Deletes the leave request with the specified ID.",
7166 "operationId": "EssLeave_Cancel",
7167 "consumes": [],
7168 "produces": [
7169 "application/json",
7170 "text/json",
7171 "application/xml",
7172 "text/xml"
7173 ],
7174 "parameters": [
7175 {
7176 "name": "leaveRequestId",
7177 "in": "path",
7178 "required": true,
7179 "type": "integer",
7180 "format": "int32",
7181 "title": "Int32"
7182 },
7183 {
7184 "name": "employeeId",
7185 "in": "path",
7186 "required": true,
7187 "type": "string"
7188 }
7189 ],
7190 "responses": {
7191 "200": {
7192 "description": "OK"
7193 }
7194 }
7195 }
7196 },
7197 "/api/v2/ess/{employeeId}/leave/{leaveRequestId}/attachment": {
7198 "put": {
7199 "tags": [
7200 "Ess"
7201 ],
7202 "summary": "Upload Attachment to Leave Request",
7203 "description": "Uploads a file as a new employee document, and attaches it to the leave request with the specified ID. \r\nThe request should be a MIME multipart file upload request.",
7204 "operationId": "EssLeave_Upload",
7205 "consumes": [],
7206 "produces": [
7207 "application/json",
7208 "text/json",
7209 "application/xml",
7210 "text/xml"
7211 ],
7212 "parameters": [
7213 {
7214 "name": "leaveRequestId",
7215 "in": "path",
7216 "required": true,
7217 "type": "integer",
7218 "format": "int32",
7219 "title": "Int32"
7220 },
7221 {
7222 "name": "employeeId",
7223 "in": "path",
7224 "required": true,
7225 "type": "string"
7226 }
7227 ],
7228 "responses": {
7229 "200": {
7230 "description": "OK",
7231 "schema": {
7232 "type": "object",
7233 "title": "IHttpActionResult"
7234 }
7235 }
7236 }
7237 },
7238 "delete": {
7239 "tags": [
7240 "Ess"
7241 ],
7242 "summary": "Delete Attachment from Leave Request",
7243 "description": "Deletes the attachment on the leave request with the specified ID.",
7244 "operationId": "EssLeave_DeleteAttachment",
7245 "consumes": [],
7246 "produces": [
7247 "application/json",
7248 "text/json",
7249 "application/xml",
7250 "text/xml"
7251 ],
7252 "parameters": [
7253 {
7254 "name": "leaveRequestId",
7255 "in": "path",
7256 "required": true,
7257 "type": "integer",
7258 "format": "int32",
7259 "title": "Int32"
7260 },
7261 {
7262 "name": "employeeId",
7263 "in": "path",
7264 "required": true,
7265 "type": "string"
7266 }
7267 ],
7268 "responses": {
7269 "200": {
7270 "description": "OK"
7271 }
7272 }
7273 }
7274 },
7275 "/api/v2/ess/{employeeId}/leave/balances": {
7276 "get": {
7277 "tags": [
7278 "Ess"
7279 ],
7280 "summary": "Get Leave Balances",
7281 "description": "Gets the leave balances for the employee.",
7282 "operationId": "EssLeave_Balances",
7283 "consumes": [],
7284 "produces": [
7285 "application/json",
7286 "text/json",
7287 "application/xml",
7288 "text/xml"
7289 ],
7290 "parameters": [
7291 {
7292 "name": "asAtDate",
7293 "in": "query",
7294 "required": false,
7295 "type": "string",
7296 "format": "date-time",
7297 "title": "Nullable<DateTime>"
7298 },
7299 {
7300 "name": "employeeId",
7301 "in": "path",
7302 "required": true,
7303 "type": "string"
7304 }
7305 ],
7306 "responses": {
7307 "200": {
7308 "description": "OK",
7309 "schema": {
7310 "type": "array",
7311 "items": {
7312 "$ref": "#/definitions/LeaveBalanceModel"
7313 },
7314 "xml": {
7315 "name": "LeaveBalanceModel",
7316 "wrapped": true
7317 },
7318 "title": "IList<LeaveBalanceModel>"
7319 }
7320 }
7321 }
7322 }
7323 },
7324 "/api/v2/ess/{employeeId}/leave/leavecategories": {
7325 "get": {
7326 "tags": [
7327 "Ess"
7328 ],
7329 "summary": "Get Leave Categories",
7330 "description": "Gets the available leave categories for the employee.",
7331 "operationId": "EssLeave_LeaveCategories",
7332 "consumes": [],
7333 "produces": [
7334 "application/json",
7335 "text/json",
7336 "application/xml",
7337 "text/xml"
7338 ],
7339 "parameters": [
7340 {
7341 "name": "employeeId",
7342 "in": "path",
7343 "required": true,
7344 "type": "string"
7345 }
7346 ],
7347 "responses": {
7348 "200": {
7349 "description": "OK",
7350 "schema": {
7351 "type": "array",
7352 "items": {
7353 "$ref": "#/definitions/EssLeaveCategoryModel"
7354 },
7355 "xml": {
7356 "name": "EssLeaveCategoryModel",
7357 "wrapped": true
7358 },
7359 "title": "IList<EssLeaveCategoryModel>"
7360 }
7361 }
7362 }
7363 }
7364 },
7365 "/api/v2/ess/{employeeId}/leave/estimate": {
7366 "get": {
7367 "tags": [
7368 "Ess"
7369 ],
7370 "summary": "Estimate Leave Hours",
7371 "description": "Estimates the number of hours of leave required based on date and leave category.",
7372 "operationId": "EssLeave_Estimate",
7373 "consumes": [],
7374 "produces": [
7375 "application/json",
7376 "text/json",
7377 "application/xml",
7378 "text/xml"
7379 ],
7380 "parameters": [
7381 {
7382 "name": "employeeId",
7383 "in": "path",
7384 "required": true,
7385 "type": "string"
7386 },
7387 {
7388 "name": "filter.leaveCategoryId",
7389 "in": "query",
7390 "required": false,
7391 "type": "integer",
7392 "format": "int32",
7393 "title": "Int32"
7394 },
7395 {
7396 "name": "filter.fromDate",
7397 "in": "query",
7398 "required": true,
7399 "type": "string",
7400 "format": "date-time",
7401 "title": "DateTime"
7402 },
7403 {
7404 "name": "filter.toDate",
7405 "in": "query",
7406 "required": true,
7407 "type": "string",
7408 "format": "date-time",
7409 "title": "DateTime"
7410 }
7411 ],
7412 "responses": {
7413 "200": {
7414 "description": "OK",
7415 "schema": {
7416 "$ref": "#/definitions/EssLeaveEstimate"
7417 }
7418 }
7419 }
7420 }
7421 },
7422 "/api/v2/ess/{employeeId}/profileimage": {
7423 "get": {
7424 "tags": [
7425 "Ess"
7426 ],
7427 "summary": "Get Employee Profile Image",
7428 "description": "Returns the file content for the employee's current profile image.",
7429 "operationId": "EssProfileImage_GetImage",
7430 "consumes": [],
7431 "produces": [
7432 "application/json",
7433 "text/json",
7434 "application/xml",
7435 "text/xml"
7436 ],
7437 "parameters": [
7438 {
7439 "name": "employeeId",
7440 "in": "path",
7441 "required": true,
7442 "type": "string"
7443 }
7444 ],
7445 "responses": {
7446 "200": {
7447 "description": "OK"
7448 }
7449 }
7450 },
7451 "post": {
7452 "tags": [
7453 "Ess"
7454 ],
7455 "summary": "Set Employee Profile Image",
7456 "description": "Uploads a new employee profile image. The request should be a MIME multipart file upload request.",
7457 "operationId": "EssProfileImage_Post",
7458 "consumes": [],
7459 "produces": [
7460 "application/json",
7461 "text/json",
7462 "application/xml",
7463 "text/xml"
7464 ],
7465 "parameters": [
7466 {
7467 "name": "employeeId",
7468 "in": "path",
7469 "required": true,
7470 "type": "string"
7471 }
7472 ],
7473 "responses": {
7474 "200": {
7475 "description": "OK",
7476 "schema": {
7477 "$ref": "#/definitions/ProfileImageMetadata"
7478 }
7479 }
7480 }
7481 },
7482 "delete": {
7483 "tags": [
7484 "Ess"
7485 ],
7486 "summary": "Delete Employee Profile Image",
7487 "description": "Delete's the employee's profile image.",
7488 "operationId": "EssProfileImage_Delete",
7489 "consumes": [],
7490 "produces": [
7491 "application/json",
7492 "text/json",
7493 "application/xml",
7494 "text/xml"
7495 ],
7496 "parameters": [
7497 {
7498 "name": "employeeId",
7499 "in": "path",
7500 "required": true,
7501 "type": "string"
7502 }
7503 ],
7504 "responses": {
7505 "200": {
7506 "description": "OK"
7507 }
7508 }
7509 }
7510 },
7511 "/api/v2/ess/{employeeId}/details": {
7512 "get": {
7513 "tags": [
7514 "Ess"
7515 ],
7516 "summary": "Get Details",
7517 "description": "Gets ESS details for the specified employee.",
7518 "operationId": "EssEmployee_GetDetails",
7519 "consumes": [],
7520 "produces": [
7521 "application/json",
7522 "text/json",
7523 "application/xml",
7524 "text/xml"
7525 ],
7526 "parameters": [
7527 {
7528 "name": "employeeId",
7529 "in": "path",
7530 "required": true,
7531 "type": "string"
7532 }
7533 ],
7534 "responses": {
7535 "200": {
7536 "description": "OK",
7537 "schema": {
7538 "$ref": "#/definitions/EssEmployeeDetailsModel"
7539 }
7540 }
7541 }
7542 },
7543 "post": {
7544 "tags": [
7545 "Ess"
7546 ],
7547 "summary": "Save Details",
7548 "description": "Saves any employee details that the employee is allowed to set.",
7549 "operationId": "EssEmployee_SaveDetails",
7550 "consumes": [
7551 "application/json",
7552 "text/json",
7553 "application/xml",
7554 "text/xml",
7555 "application/x-www-form-urlencoded"
7556 ],
7557 "produces": [
7558 "application/json",
7559 "text/json",
7560 "application/xml",
7561 "text/xml"
7562 ],
7563 "parameters": [
7564 {
7565 "name": "model",
7566 "in": "body",
7567 "required": true,
7568 "schema": {
7569 "$ref": "#/definitions/EmployeePartialEditModel"
7570 }
7571 },
7572 {
7573 "name": "employeeId",
7574 "in": "path",
7575 "required": true,
7576 "type": "string"
7577 }
7578 ],
7579 "responses": {
7580 "200": {
7581 "description": "OK"
7582 }
7583 }
7584 }
7585 },
7586 "/api/v2/ess/{employeeId}/emergencycontacts": {
7587 "get": {
7588 "tags": [
7589 "Ess"
7590 ],
7591 "summary": "Get Emergency Contacts",
7592 "description": "Gets emergency contacts for the specified employee.",
7593 "operationId": "EssEmployee_GetEmergencyContacts",
7594 "consumes": [],
7595 "produces": [
7596 "application/json",
7597 "text/json",
7598 "application/xml",
7599 "text/xml"
7600 ],
7601 "parameters": [
7602 {
7603 "name": "employeeId",
7604 "in": "path",
7605 "required": true,
7606 "type": "string"
7607 }
7608 ],
7609 "responses": {
7610 "200": {
7611 "description": "OK",
7612 "schema": {
7613 "$ref": "#/definitions/EmployeeEmergencyContactsEditModel"
7614 }
7615 }
7616 }
7617 },
7618 "post": {
7619 "tags": [
7620 "Ess"
7621 ],
7622 "summary": "Save Emergency Contacts",
7623 "description": "Saves the employee's emergency contact details.",
7624 "operationId": "EssEmployee_SaveEmergencyContacts",
7625 "consumes": [
7626 "application/json",
7627 "text/json",
7628 "application/xml",
7629 "text/xml",
7630 "application/x-www-form-urlencoded"
7631 ],
7632 "produces": [
7633 "application/json",
7634 "text/json",
7635 "application/xml",
7636 "text/xml"
7637 ],
7638 "parameters": [
7639 {
7640 "name": "model",
7641 "in": "body",
7642 "required": true,
7643 "schema": {
7644 "$ref": "#/definitions/EmployeeEmergencyContactsEditModel"
7645 }
7646 },
7647 {
7648 "name": "employeeId",
7649 "in": "path",
7650 "required": true,
7651 "type": "string"
7652 }
7653 ],
7654 "responses": {
7655 "200": {
7656 "description": "OK"
7657 }
7658 }
7659 }
7660 },
7661 "/api/v2/ess/{employeeId}/security/features": {
7662 "get": {
7663 "tags": [
7664 "Ess"
7665 ],
7666 "summary": "Get Enabled Features",
7667 "description": "Gets details as to which ESS features are enabled for the business.",
7668 "operationId": "EssEmployee_Features",
7669 "consumes": [],
7670 "produces": [
7671 "application/json",
7672 "text/json",
7673 "application/xml",
7674 "text/xml"
7675 ],
7676 "parameters": [
7677 {
7678 "name": "employeeId",
7679 "in": "path",
7680 "required": true,
7681 "type": "string"
7682 }
7683 ],
7684 "responses": {
7685 "200": {
7686 "description": "OK",
7687 "schema": {
7688 "$ref": "#/definitions/FeaturesModel"
7689 }
7690 }
7691 }
7692 }
7693 },
7694 "/api/v2/ess/{employeeId}/dashboard": {
7695 "get": {
7696 "tags": [
7697 "Ess"
7698 ],
7699 "summary": "Get Dashboard",
7700 "description": "Gets a set of useful information that the employee may need for self service tasks.",
7701 "operationId": "EssEmployee_GetDashboard",
7702 "consumes": [],
7703 "produces": [
7704 "application/json",
7705 "text/json",
7706 "application/xml",
7707 "text/xml"
7708 ],
7709 "parameters": [
7710 {
7711 "name": "employeeId",
7712 "in": "path",
7713 "required": true,
7714 "type": "string"
7715 }
7716 ],
7717 "responses": {
7718 "200": {
7719 "description": "OK",
7720 "schema": {
7721 "$ref": "#/definitions/DashboardModel"
7722 }
7723 }
7724 }
7725 }
7726 },
7727 "/api/v2/ess/{employeeId}/location": {
7728 "get": {
7729 "tags": [
7730 "Ess"
7731 ],
7732 "summary": "Get Locations",
7733 "description": "Gets all the locations for the employee.",
7734 "operationId": "EssEmployee_Locations",
7735 "consumes": [],
7736 "produces": [
7737 "application/json",
7738 "text/json",
7739 "application/xml",
7740 "text/xml"
7741 ],
7742 "parameters": [
7743 {
7744 "name": "employeeId",
7745 "in": "path",
7746 "required": true,
7747 "type": "string"
7748 }
7749 ],
7750 "responses": {
7751 "200": {
7752 "description": "OK",
7753 "schema": {
7754 "type": "array",
7755 "items": {
7756 "$ref": "#/definitions/LocationModel"
7757 },
7758 "xml": {
7759 "name": "LocationModel",
7760 "wrapped": true
7761 },
7762 "title": "List<LocationModel>"
7763 }
7764 }
7765 }
7766 }
7767 },
7768 "/api/v2/ess/{employeeId}/satisfaction": {
7769 "get": {
7770 "tags": [
7771 "Ess"
7772 ],
7773 "summary": "Get Satisfaction Survey Results",
7774 "description": "Gets satisfaction survey results for the employee",
7775 "operationId": "EssEmployee_GetSatisfactionSurveys",
7776 "consumes": [],
7777 "produces": [
7778 "application/json",
7779 "text/json",
7780 "application/xml",
7781 "text/xml"
7782 ],
7783 "parameters": [
7784 {
7785 "name": "fromDate",
7786 "in": "query",
7787 "required": false,
7788 "type": "string",
7789 "format": "date-time",
7790 "title": "Nullable<DateTime>"
7791 },
7792 {
7793 "name": "toDate",
7794 "in": "query",
7795 "required": false,
7796 "type": "string",
7797 "format": "date-time",
7798 "title": "Nullable<DateTime>"
7799 },
7800 {
7801 "name": "employeeId",
7802 "in": "path",
7803 "required": true,
7804 "type": "string"
7805 }
7806 ],
7807 "responses": {
7808 "200": {
7809 "description": "OK",
7810 "schema": {
7811 "type": "array",
7812 "items": {
7813 "$ref": "#/definitions/EssSatisfactionSurvey"
7814 },
7815 "xml": {
7816 "name": "EssSatisfactionSurvey",
7817 "wrapped": true
7818 },
7819 "title": "IList<EssSatisfactionSurvey>"
7820 }
7821 }
7822 }
7823 },
7824 "post": {
7825 "tags": [
7826 "Ess"
7827 ],
7828 "summary": "Submit Satisfaction Survey",
7829 "description": "Submit a satisfaction survey for this employee.",
7830 "operationId": "EssEmployee_SaveSatisfaction",
7831 "consumes": [
7832 "application/json",
7833 "text/json",
7834 "application/xml",
7835 "text/xml",
7836 "application/x-www-form-urlencoded"
7837 ],
7838 "produces": [
7839 "application/json",
7840 "text/json",
7841 "application/xml",
7842 "text/xml"
7843 ],
7844 "parameters": [
7845 {
7846 "name": "survey",
7847 "in": "body",
7848 "required": true,
7849 "schema": {
7850 "$ref": "#/definitions/EssSatisfactionSurvey"
7851 }
7852 },
7853 {
7854 "name": "employeeId",
7855 "in": "path",
7856 "required": true,
7857 "type": "string"
7858 }
7859 ],
7860 "responses": {
7861 "200": {
7862 "description": "OK"
7863 }
7864 }
7865 }
7866 },
7867 "/api/v2/ess/{employeeId}/timesheet": {
7868 "get": {
7869 "tags": [
7870 "Ess"
7871 ],
7872 "summary": "List Timesheets",
7873 "description": "Lists timesheets for the employee.",
7874 "operationId": "EssTimesheet_List",
7875 "consumes": [],
7876 "produces": [
7877 "application/json",
7878 "text/json",
7879 "application/xml",
7880 "text/xml"
7881 ],
7882 "parameters": [
7883 {
7884 "name": "employeeId",
7885 "in": "path",
7886 "required": true,
7887 "type": "string"
7888 },
7889 {
7890 "name": "filter.fromDate",
7891 "in": "query",
7892 "required": true,
7893 "type": "string",
7894 "format": "date-time",
7895 "title": "DateTime"
7896 },
7897 {
7898 "name": "filter.toDate",
7899 "in": "query",
7900 "required": true,
7901 "type": "string",
7902 "format": "date-time",
7903 "title": "DateTime"
7904 }
7905 ],
7906 "responses": {
7907 "200": {
7908 "description": "OK",
7909 "schema": {
7910 "type": "array",
7911 "items": {
7912 "$ref": "#/definitions/EssTimesheetModel"
7913 },
7914 "xml": {
7915 "name": "EssTimesheetModel",
7916 "wrapped": true
7917 },
7918 "title": "IList<EssTimesheetModel>"
7919 }
7920 }
7921 }
7922 },
7923 "post": {
7924 "tags": [
7925 "Ess"
7926 ],
7927 "summary": "Submit or Update Timesheet",
7928 "description": "If no ID is specified, create a new timesheet for the employee. \r\nOtherwise, update the timesheet with the specified ID.",
7929 "operationId": "EssTimesheet_Save",
7930 "consumes": [
7931 "application/json",
7932 "text/json",
7933 "application/xml",
7934 "text/xml",
7935 "application/x-www-form-urlencoded"
7936 ],
7937 "produces": [
7938 "application/json",
7939 "text/json",
7940 "application/xml",
7941 "text/xml"
7942 ],
7943 "parameters": [
7944 {
7945 "name": "timesheet",
7946 "in": "body",
7947 "required": true,
7948 "schema": {
7949 "$ref": "#/definitions/TimesheetLineViewModel"
7950 }
7951 },
7952 {
7953 "name": "employeeId",
7954 "in": "path",
7955 "required": true,
7956 "type": "string"
7957 }
7958 ],
7959 "responses": {
7960 "200": {
7961 "description": "OK"
7962 }
7963 }
7964 }
7965 },
7966 "/api/v2/ess/{employeeId}/timesheet/{timesheetId}": {
7967 "post": {
7968 "tags": [
7969 "Ess"
7970 ],
7971 "summary": "Edit Timesheet",
7972 "description": "Edits the timesheet with the specified ID.",
7973 "operationId": "EssTimesheet_Edit",
7974 "consumes": [
7975 "application/json",
7976 "text/json",
7977 "application/xml",
7978 "text/xml",
7979 "application/x-www-form-urlencoded"
7980 ],
7981 "produces": [
7982 "application/json",
7983 "text/json",
7984 "application/xml",
7985 "text/xml"
7986 ],
7987 "parameters": [
7988 {
7989 "name": "timesheetId",
7990 "in": "path",
7991 "required": true,
7992 "type": "integer",
7993 "format": "int32",
7994 "title": "Int32"
7995 },
7996 {
7997 "name": "timesheet",
7998 "in": "body",
7999 "required": true,
8000 "schema": {
8001 "$ref": "#/definitions/TimesheetLineViewModel"
8002 }
8003 },
8004 {
8005 "name": "employeeId",
8006 "in": "path",
8007 "required": true,
8008 "type": "string"
8009 }
8010 ],
8011 "responses": {
8012 "200": {
8013 "description": "OK"
8014 }
8015 }
8016 },
8017 "delete": {
8018 "tags": [
8019 "Ess"
8020 ],
8021 "summary": "Delete Timesheet",
8022 "description": "Deletes the timesheet with the specified ID.",
8023 "operationId": "EssTimesheet_Delete",
8024 "consumes": [],
8025 "produces": [
8026 "application/json",
8027 "text/json",
8028 "application/xml",
8029 "text/xml"
8030 ],
8031 "parameters": [
8032 {
8033 "name": "timesheetId",
8034 "in": "path",
8035 "required": true,
8036 "type": "integer",
8037 "format": "int32",
8038 "title": "Int32"
8039 },
8040 {
8041 "name": "employeeId",
8042 "in": "path",
8043 "required": true,
8044 "type": "string"
8045 }
8046 ],
8047 "responses": {
8048 "200": {
8049 "description": "OK"
8050 }
8051 }
8052 }
8053 },
8054 "/api/v2/ess/{employeeId}/lookup/title": {
8055 "get": {
8056 "tags": [
8057 "Ess"
8058 ],
8059 "summary": "Get Business Titles",
8060 "description": "Gets all the titles for the business.",
8061 "operationId": "EssLookup_Title",
8062 "consumes": [],
8063 "produces": [
8064 "application/json",
8065 "text/json",
8066 "application/xml",
8067 "text/xml"
8068 ],
8069 "parameters": [
8070 {
8071 "name": "employeeId",
8072 "in": "path",
8073 "required": true,
8074 "type": "string"
8075 }
8076 ],
8077 "responses": {
8078 "200": {
8079 "description": "OK",
8080 "schema": {
8081 "type": "array",
8082 "items": {
8083 "$ref": "#/definitions/TitleViewModel"
8084 },
8085 "xml": {
8086 "name": "TitleViewModel",
8087 "wrapped": true
8088 },
8089 "title": "List<TitleViewModel>"
8090 }
8091 }
8092 }
8093 }
8094 },
8095 "/api/v2/ess/{employeeId}/lookup/worktype": {
8096 "get": {
8097 "tags": [
8098 "Ess"
8099 ],
8100 "summary": "Get Work Types",
8101 "description": "Gets all the work types for the employee.",
8102 "operationId": "EssLookup_WorkType",
8103 "consumes": [],
8104 "produces": [
8105 "application/json",
8106 "text/json",
8107 "application/xml",
8108 "text/xml"
8109 ],
8110 "parameters": [
8111 {
8112 "name": "employeeId",
8113 "in": "path",
8114 "required": true,
8115 "type": "string"
8116 }
8117 ],
8118 "responses": {
8119 "200": {
8120 "description": "OK",
8121 "schema": {
8122 "type": "array",
8123 "items": {
8124 "$ref": "#/definitions/WorkTypeModel"
8125 },
8126 "xml": {
8127 "name": "WorkTypeModel",
8128 "wrapped": true
8129 },
8130 "title": "List<WorkTypeModel>"
8131 }
8132 }
8133 }
8134 }
8135 },
8136 "/api/v2/ess/{employeeId}/lookup/shiftcondition": {
8137 "get": {
8138 "tags": [
8139 "Ess"
8140 ],
8141 "summary": "Get Shift Conditions",
8142 "description": "Gets all the shift conditions for the employee.",
8143 "operationId": "EssLookup_ShiftCondition",
8144 "consumes": [],
8145 "produces": [
8146 "application/json",
8147 "text/json",
8148 "application/xml",
8149 "text/xml"
8150 ],
8151 "parameters": [
8152 {
8153 "name": "employeeId",
8154 "in": "path",
8155 "required": true,
8156 "type": "string"
8157 }
8158 ],
8159 "responses": {
8160 "200": {
8161 "description": "OK",
8162 "schema": {
8163 "type": "array",
8164 "items": {
8165 "$ref": "#/definitions/WorkTypeModel"
8166 },
8167 "xml": {
8168 "name": "WorkTypeModel",
8169 "wrapped": true
8170 },
8171 "title": "List<WorkTypeModel>"
8172 }
8173 }
8174 }
8175 }
8176 },
8177 "/api/v2/ess/{employeeId}/lookup/location": {
8178 "get": {
8179 "tags": [
8180 "Ess"
8181 ],
8182 "summary": "Get Locations",
8183 "description": "Gets all the locations for the employee.",
8184 "operationId": "EssLookup_Location",
8185 "consumes": [],
8186 "produces": [
8187 "application/json",
8188 "text/json",
8189 "application/xml",
8190 "text/xml"
8191 ],
8192 "parameters": [
8193 {
8194 "name": "employeeId",
8195 "in": "path",
8196 "required": true,
8197 "type": "string"
8198 }
8199 ],
8200 "responses": {
8201 "200": {
8202 "description": "OK",
8203 "schema": {
8204 "type": "array",
8205 "items": {
8206 "$ref": "#/definitions/LocationModel"
8207 },
8208 "xml": {
8209 "name": "LocationModel",
8210 "wrapped": true
8211 },
8212 "title": "List<LocationModel>"
8213 }
8214 }
8215 }
8216 }
8217 },
8218 "/api/v2/ess/devicetoken/register": {
8219 "post": {
8220 "tags": [
8221 "Ess"
8222 ],
8223 "summary": "Register Device Token",
8224 "description": "Registers a device token.",
8225 "operationId": "EssDeviceToken_Register",
8226 "consumes": [
8227 "application/json",
8228 "text/json",
8229 "application/xml",
8230 "text/xml",
8231 "application/x-www-form-urlencoded"
8232 ],
8233 "produces": [
8234 "application/json",
8235 "text/json",
8236 "application/xml",
8237 "text/xml"
8238 ],
8239 "parameters": [
8240 {
8241 "name": "model",
8242 "in": "body",
8243 "required": true,
8244 "schema": {
8245 "$ref": "#/definitions/DeviceTokenModel"
8246 }
8247 }
8248 ],
8249 "responses": {
8250 "200": {
8251 "description": "OK"
8252 }
8253 }
8254 }
8255 },
8256 "/api/v2/ess/devicetoken/unregister": {
8257 "post": {
8258 "tags": [
8259 "Ess"
8260 ],
8261 "summary": "Unregister Device Token",
8262 "description": "Unregisters a device token.",
8263 "operationId": "EssDeviceToken_Unregister",
8264 "consumes": [
8265 "application/json",
8266 "text/json",
8267 "application/xml",
8268 "text/xml",
8269 "application/x-www-form-urlencoded"
8270 ],
8271 "produces": [
8272 "application/json",
8273 "text/json",
8274 "application/xml",
8275 "text/xml"
8276 ],
8277 "parameters": [
8278 {
8279 "name": "model",
8280 "in": "body",
8281 "required": true,
8282 "schema": {
8283 "$ref": "#/definitions/DeviceTokenModel"
8284 }
8285 }
8286 ],
8287 "responses": {
8288 "200": {
8289 "description": "OK"
8290 }
8291 }
8292 }
8293 },
8294 "/api/v2/ess/{employeeId}/timeandattendance/lookupdata": {
8295 "get": {
8296 "tags": [
8297 "Ess"
8298 ],
8299 "summary": "Get Lookup Data",
8300 "description": "Gets relevant lookup data for the employee in relation to a kiosk.",
8301 "operationId": "EssTimeAndAttendance_GetLookupData",
8302 "consumes": [],
8303 "produces": [
8304 "application/json",
8305 "text/json",
8306 "application/xml",
8307 "text/xml"
8308 ],
8309 "parameters": [
8310 {
8311 "name": "employeeId",
8312 "in": "path",
8313 "required": true,
8314 "type": "integer",
8315 "format": "int32",
8316 "title": "Int32"
8317 }
8318 ],
8319 "responses": {
8320 "200": {
8321 "description": "OK",
8322 "schema": {
8323 "$ref": "#/definitions/TimeAndAttendanceLookupDataModel"
8324 }
8325 }
8326 }
8327 }
8328 },
8329 "/api/v2/ess/{employeeId}/timeandattendance/clockon": {
8330 "post": {
8331 "tags": [
8332 "Ess"
8333 ],
8334 "summary": "Clock In Employee",
8335 "description": "Clocks in an employee for a new shift.",
8336 "operationId": "EssTimeAndAttendance_ClockOn",
8337 "consumes": [
8338 "application/json",
8339 "text/json",
8340 "application/xml",
8341 "text/xml",
8342 "application/x-www-form-urlencoded"
8343 ],
8344 "produces": [
8345 "application/json",
8346 "text/json",
8347 "application/xml",
8348 "text/xml"
8349 ],
8350 "parameters": [
8351 {
8352 "name": "employeeId",
8353 "in": "path",
8354 "required": true,
8355 "type": "integer",
8356 "format": "int32",
8357 "title": "Int32"
8358 },
8359 {
8360 "name": "request",
8361 "in": "body",
8362 "required": true,
8363 "schema": {
8364 "$ref": "#/definitions/ClockOnModel"
8365 }
8366 }
8367 ],
8368 "responses": {
8369 "200": {
8370 "description": "OK"
8371 }
8372 }
8373 }
8374 },
8375 "/api/v2/ess/{employeeId}/timeandattendance/clockoff": {
8376 "post": {
8377 "tags": [
8378 "Ess"
8379 ],
8380 "summary": "Clock Out Employee",
8381 "description": "Clocks out the employee from their existing shift. \r\nIf they are on a break, it will be ended automatically.",
8382 "operationId": "EssTimeAndAttendance_ClockOff",
8383 "consumes": [
8384 "application/json",
8385 "text/json",
8386 "application/xml",
8387 "text/xml",
8388 "application/x-www-form-urlencoded"
8389 ],
8390 "produces": [
8391 "application/json",
8392 "text/json",
8393 "application/xml",
8394 "text/xml"
8395 ],
8396 "parameters": [
8397 {
8398 "name": "employeeId",
8399 "in": "path",
8400 "required": true,
8401 "type": "integer",
8402 "format": "int32",
8403 "title": "Int32"
8404 },
8405 {
8406 "name": "request",
8407 "in": "body",
8408 "required": true,
8409 "schema": {
8410 "$ref": "#/definitions/ClockOffModel"
8411 }
8412 }
8413 ],
8414 "responses": {
8415 "200": {
8416 "description": "OK"
8417 }
8418 }
8419 }
8420 },
8421 "/api/v2/ess/{employeeId}/timeandattendance/startbreak": {
8422 "post": {
8423 "tags": [
8424 "Ess"
8425 ],
8426 "summary": "Start Break",
8427 "description": "Starts a break for the employee who is clocked on for a shift.",
8428 "operationId": "EssTimeAndAttendance_StartBreak",
8429 "consumes": [
8430 "application/json",
8431 "text/json",
8432 "application/xml",
8433 "text/xml",
8434 "application/x-www-form-urlencoded"
8435 ],
8436 "produces": [
8437 "application/json",
8438 "text/json",
8439 "application/xml",
8440 "text/xml"
8441 ],
8442 "parameters": [
8443 {
8444 "name": "employeeId",
8445 "in": "path",
8446 "required": true,
8447 "type": "integer",
8448 "format": "int32",
8449 "title": "Int32"
8450 },
8451 {
8452 "name": "request",
8453 "in": "body",
8454 "required": true,
8455 "schema": {
8456 "$ref": "#/definitions/StartBreakModel"
8457 }
8458 }
8459 ],
8460 "responses": {
8461 "200": {
8462 "description": "OK"
8463 }
8464 }
8465 }
8466 },
8467 "/api/v2/ess/{employeeId}/timeandattendance/endbreak": {
8468 "post": {
8469 "tags": [
8470 "Ess"
8471 ],
8472 "summary": "End Break",
8473 "description": "Ends the employee's current break.",
8474 "operationId": "EssTimeAndAttendance_EndBreak",
8475 "consumes": [
8476 "application/json",
8477 "text/json",
8478 "application/xml",
8479 "text/xml",
8480 "application/x-www-form-urlencoded"
8481 ],
8482 "produces": [
8483 "application/json",
8484 "text/json",
8485 "application/xml",
8486 "text/xml"
8487 ],
8488 "parameters": [
8489 {
8490 "name": "employeeId",
8491 "in": "path",
8492 "required": true,
8493 "type": "integer",
8494 "format": "int32",
8495 "title": "Int32"
8496 },
8497 {
8498 "name": "request",
8499 "in": "body",
8500 "required": true,
8501 "schema": {
8502 "$ref": "#/definitions/EndBreakModel"
8503 }
8504 }
8505 ],
8506 "responses": {
8507 "200": {
8508 "description": "OK"
8509 }
8510 }
8511 }
8512 },
8513 "/api/v2/ess/{employeeId}/timeandattendance/discard": {
8514 "post": {
8515 "tags": [
8516 "Ess"
8517 ],
8518 "summary": "Discard current shift",
8519 "description": "Discards the current shift for an employee. \r\nIf they are on a break, it will be ended automatically.",
8520 "operationId": "EssTimeAndAttendance_DiscardShift",
8521 "consumes": [
8522 "application/json",
8523 "text/json",
8524 "application/xml",
8525 "text/xml",
8526 "application/x-www-form-urlencoded"
8527 ],
8528 "produces": [
8529 "application/json",
8530 "text/json",
8531 "application/xml",
8532 "text/xml"
8533 ],
8534 "parameters": [
8535 {
8536 "name": "employeeId",
8537 "in": "path",
8538 "required": true,
8539 "type": "integer",
8540 "format": "int32",
8541 "title": "Int32"
8542 },
8543 {
8544 "name": "request",
8545 "in": "body",
8546 "required": true,
8547 "schema": {
8548 "$ref": "#/definitions/ClockOffModel"
8549 }
8550 }
8551 ],
8552 "responses": {
8553 "200": {
8554 "description": "OK"
8555 }
8556 }
8557 }
8558 },
8559 "/api/v2/ess/{employeeId}/timeandattendance/shifts": {
8560 "post": {
8561 "tags": [
8562 "Ess"
8563 ],
8564 "summary": "Shifts",
8565 "description": "Gets shifts based on certain optional criteria.",
8566 "operationId": "EssTimeAndAttendance_Shifts",
8567 "consumes": [
8568 "application/json",
8569 "text/json",
8570 "application/xml",
8571 "text/xml",
8572 "application/x-www-form-urlencoded"
8573 ],
8574 "produces": [
8575 "application/json",
8576 "text/json",
8577 "application/xml",
8578 "text/xml"
8579 ],
8580 "parameters": [
8581 {
8582 "name": "employeeId",
8583 "in": "path",
8584 "required": true,
8585 "type": "integer",
8586 "format": "int32",
8587 "title": "Int32"
8588 },
8589 {
8590 "name": "model",
8591 "in": "body",
8592 "required": true,
8593 "schema": {
8594 "$ref": "#/definitions/GetShiftsModel"
8595 }
8596 }
8597 ],
8598 "responses": {
8599 "200": {
8600 "description": "OK",
8601 "schema": {
8602 "type": "array",
8603 "items": {
8604 "$ref": "#/definitions/TimeAndAttendanceShiftModel"
8605 },
8606 "xml": {
8607 "name": "TimeAndAttendanceShiftModel",
8608 "wrapped": true
8609 },
8610 "title": "IList<TimeAndAttendanceShiftModel>"
8611 }
8612 }
8613 }
8614 }
8615 },
8616 "/api/v2/ess/{employeeId}/timeandattendance/shift/{shiftId}/notes": {
8617 "get": {
8618 "tags": [
8619 "Ess"
8620 ],
8621 "summary": "Get Shift Notes",
8622 "description": "Gets shifts based on certain optional criteria.",
8623 "operationId": "EssTimeAndAttendance_GetShiftNotes",
8624 "consumes": [],
8625 "produces": [
8626 "application/json",
8627 "text/json",
8628 "application/xml",
8629 "text/xml"
8630 ],
8631 "parameters": [
8632 {
8633 "name": "employeeId",
8634 "in": "path",
8635 "required": true,
8636 "type": "integer",
8637 "format": "int32",
8638 "title": "Int32"
8639 },
8640 {
8641 "name": "shiftId",
8642 "in": "path",
8643 "required": true,
8644 "type": "integer",
8645 "format": "int32",
8646 "title": "Int32"
8647 },
8648 {
8649 "name": "model.employeeId",
8650 "in": "query",
8651 "required": false,
8652 "type": "integer",
8653 "format": "int32",
8654 "title": "Int32"
8655 },
8656 {
8657 "name": "model.isAdminInitiated",
8658 "in": "query",
8659 "required": false,
8660 "type": "boolean",
8661 "title": "Boolean"
8662 },
8663 {
8664 "name": "model.type",
8665 "in": "query",
8666 "required": false,
8667 "type": "string",
8668 "enum": [
8669 "Shift",
8670 "ClockOn",
8671 "ClockOff"
8672 ],
8673 "title": "Nullable<TimeAttendanceShiftNoteType>"
8674 },
8675 {
8676 "name": "model.visibility",
8677 "in": "query",
8678 "required": false,
8679 "type": "string",
8680 "enum": [
8681 "Hidden",
8682 "Visible"
8683 ],
8684 "title": "Nullable<TimeAttendanceShiftNoteVisibility>"
8685 }
8686 ],
8687 "responses": {
8688 "200": {
8689 "description": "OK"
8690 }
8691 }
8692 },
8693 "post": {
8694 "tags": [
8695 "Ess"
8696 ],
8697 "summary": "Add Note to Shift",
8698 "description": "Adds a note to an existing shift.",
8699 "operationId": "EssTimeAndAttendance_AddNote",
8700 "consumes": [
8701 "application/json",
8702 "text/json",
8703 "application/xml",
8704 "text/xml",
8705 "application/x-www-form-urlencoded"
8706 ],
8707 "produces": [
8708 "application/json",
8709 "text/json",
8710 "application/xml",
8711 "text/xml"
8712 ],
8713 "parameters": [
8714 {
8715 "name": "employeeId",
8716 "in": "path",
8717 "required": true,
8718 "type": "integer",
8719 "format": "int32",
8720 "title": "Int32"
8721 },
8722 {
8723 "name": "shiftId",
8724 "in": "path",
8725 "required": true,
8726 "type": "integer",
8727 "format": "int32",
8728 "title": "Int32"
8729 },
8730 {
8731 "name": "model",
8732 "in": "body",
8733 "required": true,
8734 "schema": {
8735 "$ref": "#/definitions/AddNoteModel"
8736 }
8737 }
8738 ],
8739 "responses": {
8740 "200": {
8741 "description": "OK"
8742 }
8743 }
8744 }
8745 },
8746 "/api/v2/ess/{employeeId}/timeandattendance/shift/{shiftId}/notes/read-state": {
8747 "post": {
8748 "tags": [
8749 "Ess"
8750 ],
8751 "summary": "Mark Shift Notes Read",
8752 "description": "Marks some shift notes as either read or unread.",
8753 "operationId": "EssTimeAndAttendance_MarkNotesRead",
8754 "consumes": [
8755 "application/json",
8756 "text/json",
8757 "application/xml",
8758 "text/xml",
8759 "application/x-www-form-urlencoded"
8760 ],
8761 "produces": [
8762 "application/json",
8763 "text/json",
8764 "application/xml",
8765 "text/xml"
8766 ],
8767 "parameters": [
8768 {
8769 "name": "employeeId",
8770 "in": "path",
8771 "required": true,
8772 "type": "integer",
8773 "format": "int32",
8774 "title": "Int32"
8775 },
8776 {
8777 "name": "model",
8778 "in": "body",
8779 "required": true,
8780 "schema": {
8781 "$ref": "#/definitions/MarkNotesReadViewModel"
8782 }
8783 },
8784 {
8785 "name": "shiftId",
8786 "in": "path",
8787 "required": true,
8788 "type": "string"
8789 }
8790 ],
8791 "responses": {
8792 "200": {
8793 "description": "OK"
8794 }
8795 }
8796 }
8797 },
8798 "/api/v2/ess/{employeeId}/superfunds": {
8799 "get": {
8800 "tags": [
8801 "Ess"
8802 ],
8803 "summary": "List Super Funds",
8804 "description": "Lists all of the super funds for this employee.",
8805 "operationId": "EssSuperFund_List",
8806 "consumes": [],
8807 "produces": [
8808 "application/json",
8809 "text/json",
8810 "application/xml",
8811 "text/xml"
8812 ],
8813 "parameters": [
8814 {
8815 "name": "employeeId",
8816 "in": "path",
8817 "required": true,
8818 "type": "string"
8819 }
8820 ],
8821 "responses": {
8822 "200": {
8823 "description": "OK",
8824 "schema": {
8825 "type": "array",
8826 "items": {
8827 "$ref": "#/definitions/SuperFundModel"
8828 },
8829 "xml": {
8830 "name": "SuperFundModel",
8831 "wrapped": true
8832 },
8833 "title": "IEnumerable<SuperFundModel>"
8834 }
8835 }
8836 }
8837 },
8838 "post": {
8839 "tags": [
8840 "Ess"
8841 ],
8842 "summary": "Create Super Fund",
8843 "description": "Creates a new super fund for the employee.",
8844 "operationId": "EssSuperFund_Post",
8845 "consumes": [
8846 "application/json",
8847 "text/json",
8848 "application/xml",
8849 "text/xml",
8850 "application/x-www-form-urlencoded"
8851 ],
8852 "produces": [
8853 "application/json",
8854 "text/json",
8855 "application/xml",
8856 "text/xml"
8857 ],
8858 "parameters": [
8859 {
8860 "name": "model",
8861 "in": "body",
8862 "required": true,
8863 "schema": {
8864 "$ref": "#/definitions/SaveSuperFundModel"
8865 }
8866 },
8867 {
8868 "name": "employeeId",
8869 "in": "path",
8870 "required": true,
8871 "type": "string"
8872 }
8873 ],
8874 "responses": {
8875 "200": {
8876 "description": "OK",
8877 "schema": {
8878 "$ref": "#/definitions/SaveSuperFundResponseModel"
8879 }
8880 }
8881 }
8882 }
8883 },
8884 "/api/v2/ess/{employeeId}/superfunds/{superFundId}": {
8885 "get": {
8886 "tags": [
8887 "Ess"
8888 ],
8889 "summary": "Get Super Fund by ID",
8890 "description": "Gets the super fund for this employee with the specified ID.",
8891 "operationId": "EssSuperFund_Get",
8892 "consumes": [],
8893 "produces": [
8894 "application/json",
8895 "text/json",
8896 "application/xml",
8897 "text/xml"
8898 ],
8899 "parameters": [
8900 {
8901 "name": "superFundId",
8902 "in": "path",
8903 "required": true,
8904 "type": "integer",
8905 "format": "int32",
8906 "title": "Int32"
8907 },
8908 {
8909 "name": "employeeId",
8910 "in": "path",
8911 "required": true,
8912 "type": "string"
8913 }
8914 ],
8915 "responses": {
8916 "200": {
8917 "description": "OK",
8918 "schema": {
8919 "$ref": "#/definitions/SuperFundModel"
8920 }
8921 }
8922 }
8923 }
8924 },
8925 "/api/v2/ess/{employeeId}/superfunds/{id}": {
8926 "put": {
8927 "tags": [
8928 "Ess"
8929 ],
8930 "summary": "Update Super Fund",
8931 "description": "Updates the employee's super fund with the specified ID.",
8932 "operationId": "EssSuperFund_Put",
8933 "consumes": [
8934 "application/json",
8935 "text/json",
8936 "application/xml",
8937 "text/xml",
8938 "application/x-www-form-urlencoded"
8939 ],
8940 "produces": [
8941 "application/json",
8942 "text/json",
8943 "application/xml",
8944 "text/xml"
8945 ],
8946 "parameters": [
8947 {
8948 "name": "id",
8949 "in": "path",
8950 "required": true,
8951 "type": "integer",
8952 "format": "int32",
8953 "title": "Int32"
8954 },
8955 {
8956 "name": "model",
8957 "in": "body",
8958 "required": true,
8959 "schema": {
8960 "$ref": "#/definitions/SaveSuperFundModel"
8961 }
8962 },
8963 {
8964 "name": "employeeId",
8965 "in": "path",
8966 "required": true,
8967 "type": "string"
8968 }
8969 ],
8970 "responses": {
8971 "200": {
8972 "description": "OK",
8973 "schema": {
8974 "$ref": "#/definitions/SaveSuperFundResponseModel"
8975 }
8976 }
8977 }
8978 }
8979 },
8980 "/api/v2/ess/{employeeId}/superfunds/{superfundId}": {
8981 "delete": {
8982 "tags": [
8983 "Ess"
8984 ],
8985 "summary": "Delete Super Fund",
8986 "description": "Deletes the employee's super fund with the specified ID.",
8987 "operationId": "EssSuperFund_Delete",
8988 "consumes": [],
8989 "produces": [
8990 "application/json",
8991 "text/json",
8992 "application/xml",
8993 "text/xml"
8994 ],
8995 "parameters": [
8996 {
8997 "name": "superfundId",
8998 "in": "path",
8999 "required": true,
9000 "type": "integer",
9001 "format": "int32",
9002 "title": "Int32"
9003 },
9004 {
9005 "name": "employeeId",
9006 "in": "path",
9007 "required": true,
9008 "type": "string"
9009 }
9010 ],
9011 "responses": {
9012 "200": {
9013 "description": "OK",
9014 "schema": {
9015 "$ref": "#/definitions/SaveSuperFundResponseModel"
9016 }
9017 }
9018 }
9019 }
9020 },
9021 "/api/v2/ess/{employeeId}/document/payslip": {
9022 "get": {
9023 "tags": [
9024 "Ess"
9025 ],
9026 "summary": "List Pay Slips",
9027 "description": "Lists all pay slips for the employee.",
9028 "operationId": "EssDocument_Payslips",
9029 "consumes": [],
9030 "produces": [
9031 "application/json",
9032 "text/json",
9033 "application/xml",
9034 "text/xml"
9035 ],
9036 "parameters": [
9037 {
9038 "name": "employeeId",
9039 "in": "path",
9040 "required": true,
9041 "type": "string"
9042 }
9043 ],
9044 "responses": {
9045 "200": {
9046 "description": "OK",
9047 "schema": {
9048 "type": "array",
9049 "items": {
9050 "$ref": "#/definitions/EssPayslipModel"
9051 },
9052 "xml": {
9053 "name": "EssPayslipModel",
9054 "wrapped": true
9055 },
9056 "title": "List<EssPayslipModel>"
9057 }
9058 }
9059 }
9060 }
9061 },
9062 "/api/v2/ess/{employeeId}/document/payslip/{payrunId}": {
9063 "get": {
9064 "tags": [
9065 "Ess"
9066 ],
9067 "summary": "Get Pay Slip by Pay Run ID",
9068 "description": "Gets the pay slip for the pay run with the specified ID.",
9069 "operationId": "EssDocument_Payslip",
9070 "consumes": [],
9071 "produces": [
9072 "application/json",
9073 "text/json",
9074 "application/xml",
9075 "text/xml"
9076 ],
9077 "parameters": [
9078 {
9079 "name": "payrunId",
9080 "in": "path",
9081 "required": true,
9082 "type": "integer",
9083 "format": "int32",
9084 "title": "Int32"
9085 },
9086 {
9087 "name": "employeeId",
9088 "in": "path",
9089 "required": true,
9090 "type": "string"
9091 }
9092 ],
9093 "responses": {
9094 "200": {
9095 "description": "OK"
9096 }
9097 }
9098 }
9099 },
9100 "/api/v2/ess/{employeeId}/document/paymentsummaries": {
9101 "get": {
9102 "tags": [
9103 "Ess"
9104 ],
9105 "summary": "Get Payment Summaries",
9106 "description": "List all the employee's payment summaries.",
9107 "operationId": "EssDocument_PaymentSummaries",
9108 "consumes": [],
9109 "produces": [
9110 "application/json",
9111 "text/json",
9112 "application/xml",
9113 "text/xml"
9114 ],
9115 "parameters": [
9116 {
9117 "name": "employeeId",
9118 "in": "path",
9119 "required": true,
9120 "type": "string"
9121 }
9122 ],
9123 "responses": {
9124 "200": {
9125 "description": "OK",
9126 "schema": {
9127 "type": "array",
9128 "items": {
9129 "$ref": "#/definitions/EssPaymentSummaryModel"
9130 },
9131 "xml": {
9132 "name": "EssPaymentSummaryModel",
9133 "wrapped": true
9134 },
9135 "title": "List<EssPaymentSummaryModel>"
9136 }
9137 }
9138 }
9139 }
9140 },
9141 "/api/v2/ess/{employeeId}/document/paymentsummary/{documentId}": {
9142 "get": {
9143 "tags": [
9144 "Ess"
9145 ],
9146 "summary": "Get Payment Summary PDF",
9147 "description": "Gets the PDF for the payment summary with the specified ID.",
9148 "operationId": "EssDocument_PaymentSummary",
9149 "consumes": [],
9150 "produces": [
9151 "application/json",
9152 "text/json",
9153 "application/xml",
9154 "text/xml"
9155 ],
9156 "parameters": [
9157 {
9158 "name": "documentId",
9159 "in": "path",
9160 "required": true,
9161 "type": "integer",
9162 "format": "int32",
9163 "title": "Int32"
9164 },
9165 {
9166 "name": "employeeId",
9167 "in": "path",
9168 "required": true,
9169 "type": "string"
9170 }
9171 ],
9172 "responses": {
9173 "200": {
9174 "description": "OK"
9175 }
9176 }
9177 }
9178 },
9179 "/api/v2/ess/{employeeId}/document": {
9180 "get": {
9181 "tags": [
9182 "Ess"
9183 ],
9184 "summary": "List all Documents",
9185 "description": "Lists all documents visible to this employee, including both business and employee documents.",
9186 "operationId": "EssDocument_List",
9187 "consumes": [],
9188 "produces": [
9189 "application/json",
9190 "text/json",
9191 "application/xml",
9192 "text/xml"
9193 ],
9194 "parameters": [
9195 {
9196 "name": "employeeId",
9197 "in": "path",
9198 "required": true,
9199 "type": "string"
9200 }
9201 ],
9202 "responses": {
9203 "200": {
9204 "description": "OK",
9205 "schema": {
9206 "type": "array",
9207 "items": {
9208 "$ref": "#/definitions/EssDocumentModel"
9209 },
9210 "xml": {
9211 "name": "EssDocumentModel",
9212 "wrapped": true
9213 },
9214 "title": "List<EssDocumentModel>"
9215 }
9216 }
9217 }
9218 }
9219 },
9220 "/api/v2/ess/{employeeId}/document/{documentId}": {
9221 "get": {
9222 "tags": [
9223 "Ess"
9224 ],
9225 "summary": "Get Document Details by ID",
9226 "description": "Gets details for the specified document which is visible to the employee.",
9227 "operationId": "EssDocument_GetDocument",
9228 "consumes": [],
9229 "produces": [
9230 "application/json",
9231 "text/json",
9232 "application/xml",
9233 "text/xml"
9234 ],
9235 "parameters": [
9236 {
9237 "name": "documentId",
9238 "in": "path",
9239 "required": true,
9240 "type": "string",
9241 "title": "String"
9242 },
9243 {
9244 "name": "employeeId",
9245 "in": "path",
9246 "required": true,
9247 "type": "string"
9248 }
9249 ],
9250 "responses": {
9251 "200": {
9252 "description": "OK"
9253 }
9254 }
9255 }
9256 },
9257 "/api/v2/ess/{employeeId}/document/download/{documentId}": {
9258 "get": {
9259 "tags": [
9260 "Ess"
9261 ],
9262 "summary": "Download Document",
9263 "description": "Downloads the document with the specified ID so long as it is visible to the employee.",
9264 "operationId": "EssDocument_Download",
9265 "consumes": [],
9266 "produces": [
9267 "application/json",
9268 "text/json",
9269 "application/xml",
9270 "text/xml"
9271 ],
9272 "parameters": [
9273 {
9274 "name": "documentId",
9275 "in": "path",
9276 "required": true,
9277 "type": "string",
9278 "title": "String"
9279 },
9280 {
9281 "name": "employeeId",
9282 "in": "path",
9283 "required": true,
9284 "type": "string"
9285 }
9286 ],
9287 "responses": {
9288 "200": {
9289 "description": "OK"
9290 }
9291 }
9292 }
9293 },
9294 "/api/v2/ess/{employeeId}/unavailability": {
9295 "get": {
9296 "tags": [
9297 "Ess"
9298 ],
9299 "summary": "List Unavailabilities",
9300 "description": "Lists all of the unavailabilities for this employee, with optional filters.",
9301 "operationId": "EssUnavailability_List",
9302 "consumes": [],
9303 "produces": [
9304 "application/json",
9305 "text/json",
9306 "application/xml",
9307 "text/xml"
9308 ],
9309 "parameters": [
9310 {
9311 "name": "employeeId",
9312 "in": "path",
9313 "required": true,
9314 "type": "string"
9315 },
9316 {
9317 "name": "filter.fromDate",
9318 "in": "query",
9319 "required": false,
9320 "type": "string",
9321 "format": "date-time",
9322 "title": "Nullable<DateTime>"
9323 },
9324 {
9325 "name": "filter.toDate",
9326 "in": "query",
9327 "required": false,
9328 "type": "string",
9329 "format": "date-time",
9330 "title": "Nullable<DateTime>"
9331 }
9332 ],
9333 "responses": {
9334 "200": {
9335 "description": "OK",
9336 "schema": {
9337 "type": "array",
9338 "items": {
9339 "$ref": "#/definitions/EssUnavailabilityModel"
9340 },
9341 "xml": {
9342 "name": "EssUnavailabilityModel",
9343 "wrapped": true
9344 },
9345 "title": "IList<EssUnavailabilityModel>"
9346 }
9347 }
9348 }
9349 },
9350 "post": {
9351 "tags": [
9352 "Ess"
9353 ],
9354 "summary": "Create Unavailability",
9355 "description": "Creates a new unavailability for the employee.",
9356 "operationId": "EssUnavailability_Create",
9357 "consumes": [
9358 "application/json",
9359 "text/json",
9360 "application/xml",
9361 "text/xml",
9362 "application/x-www-form-urlencoded"
9363 ],
9364 "produces": [
9365 "application/json",
9366 "text/json",
9367 "application/xml",
9368 "text/xml"
9369 ],
9370 "parameters": [
9371 {
9372 "name": "unavailability",
9373 "in": "body",
9374 "required": true,
9375 "schema": {
9376 "$ref": "#/definitions/UnavailabilityEditModel"
9377 }
9378 },
9379 {
9380 "name": "employeeId",
9381 "in": "path",
9382 "required": true,
9383 "type": "string"
9384 }
9385 ],
9386 "responses": {
9387 "200": {
9388 "description": "OK",
9389 "schema": {
9390 "$ref": "#/definitions/EssUnavailabilityModel"
9391 }
9392 }
9393 }
9394 }
9395 },
9396 "/api/v2/ess/{employeeId}/unavailability/{unavailabilityId}": {
9397 "get": {
9398 "tags": [
9399 "Ess"
9400 ],
9401 "summary": "Get unavailability by ID",
9402 "description": "Gets the unavailability with the specified ID (so long as the unavailability is from the specified employee).",
9403 "operationId": "EssUnavailability_Get",
9404 "consumes": [],
9405 "produces": [
9406 "application/json",
9407 "text/json",
9408 "application/xml",
9409 "text/xml"
9410 ],
9411 "parameters": [
9412 {
9413 "name": "unavailabilityId",
9414 "in": "path",
9415 "required": true,
9416 "type": "integer",
9417 "format": "int32",
9418 "title": "Int32"
9419 },
9420 {
9421 "name": "employeeId",
9422 "in": "path",
9423 "required": true,
9424 "type": "string"
9425 }
9426 ],
9427 "responses": {
9428 "200": {
9429 "description": "OK",
9430 "schema": {
9431 "$ref": "#/definitions/EssUnavailabilityModel"
9432 }
9433 }
9434 }
9435 },
9436 "put": {
9437 "tags": [
9438 "Ess"
9439 ],
9440 "summary": "Update Unavailability",
9441 "description": "Updates the unavailability with the specified ID.",
9442 "operationId": "EssUnavailability_Save",
9443 "consumes": [
9444 "application/json",
9445 "text/json",
9446 "application/xml",
9447 "text/xml",
9448 "application/x-www-form-urlencoded"
9449 ],
9450 "produces": [
9451 "application/json",
9452 "text/json",
9453 "application/xml",
9454 "text/xml"
9455 ],
9456 "parameters": [
9457 {
9458 "name": "unavailabilityId",
9459 "in": "path",
9460 "required": true,
9461 "type": "integer",
9462 "format": "int32",
9463 "title": "Int32"
9464 },
9465 {
9466 "name": "unavailability",
9467 "in": "body",
9468 "required": true,
9469 "schema": {
9470 "$ref": "#/definitions/UnavailabilityEditModel"
9471 }
9472 },
9473 {
9474 "name": "employeeId",
9475 "in": "path",
9476 "required": true,
9477 "type": "string"
9478 }
9479 ],
9480 "responses": {
9481 "200": {
9482 "description": "OK"
9483 }
9484 }
9485 },
9486 "delete": {
9487 "tags": [
9488 "Ess"
9489 ],
9490 "summary": "Delete Unavailability",
9491 "description": "Deletes the unavailability with the specified ID.",
9492 "operationId": "EssUnavailability_Delete",
9493 "consumes": [],
9494 "produces": [
9495 "application/json",
9496 "text/json",
9497 "application/xml",
9498 "text/xml"
9499 ],
9500 "parameters": [
9501 {
9502 "name": "unavailabilityId",
9503 "in": "path",
9504 "required": true,
9505 "type": "integer",
9506 "format": "int32",
9507 "title": "Int32"
9508 },
9509 {
9510 "name": "employeeId",
9511 "in": "path",
9512 "required": true,
9513 "type": "string"
9514 }
9515 ],
9516 "responses": {
9517 "200": {
9518 "description": "OK"
9519 }
9520 }
9521 }
9522 },
9523 "/api/v2/ess/{employeeId}/bankaccounts": {
9524 "get": {
9525 "tags": [
9526 "Ess"
9527 ],
9528 "summary": "List Bank Accounts",
9529 "description": "Lists all of the bank accounts for this employee.",
9530 "operationId": "EssBankAccount_List",
9531 "consumes": [],
9532 "produces": [
9533 "application/json",
9534 "text/json",
9535 "application/xml",
9536 "text/xml"
9537 ],
9538 "parameters": [
9539 {
9540 "name": "employeeId",
9541 "in": "path",
9542 "required": true,
9543 "type": "string"
9544 }
9545 ],
9546 "responses": {
9547 "200": {
9548 "description": "OK",
9549 "schema": {
9550 "type": "array",
9551 "items": {
9552 "$ref": "#/definitions/BankAccountModel"
9553 },
9554 "xml": {
9555 "name": "BankAccountModel",
9556 "wrapped": true
9557 },
9558 "title": "IEnumerable<BankAccountModel>"
9559 }
9560 }
9561 }
9562 },
9563 "post": {
9564 "tags": [
9565 "Ess"
9566 ],
9567 "summary": "Create Bank Account",
9568 "description": "Creates a new bank account for the employee.",
9569 "operationId": "EssBankAccount_Post",
9570 "consumes": [
9571 "application/json",
9572 "text/json",
9573 "application/xml",
9574 "text/xml",
9575 "application/x-www-form-urlencoded"
9576 ],
9577 "produces": [
9578 "application/json",
9579 "text/json",
9580 "application/xml",
9581 "text/xml"
9582 ],
9583 "parameters": [
9584 {
9585 "name": "model",
9586 "in": "body",
9587 "required": true,
9588 "schema": {
9589 "$ref": "#/definitions/BankAccountModel"
9590 }
9591 },
9592 {
9593 "name": "employeeId",
9594 "in": "path",
9595 "required": true,
9596 "type": "string"
9597 }
9598 ],
9599 "responses": {
9600 "200": {
9601 "description": "OK",
9602 "schema": {
9603 "$ref": "#/definitions/SaveBankAccountResponseModel"
9604 }
9605 }
9606 }
9607 }
9608 },
9609 "/api/v2/ess/{employeeId}/bankaccounts/{bankAccountId}": {
9610 "get": {
9611 "tags": [
9612 "Ess"
9613 ],
9614 "summary": "Get Bank Account by ID",
9615 "description": "Gets the bank account for this employee with the specified ID.",
9616 "operationId": "EssBankAccount_Get",
9617 "consumes": [],
9618 "produces": [
9619 "application/json",
9620 "text/json",
9621 "application/xml",
9622 "text/xml"
9623 ],
9624 "parameters": [
9625 {
9626 "name": "bankAccountId",
9627 "in": "path",
9628 "required": true,
9629 "type": "integer",
9630 "format": "int32",
9631 "title": "Int32"
9632 },
9633 {
9634 "name": "employeeId",
9635 "in": "path",
9636 "required": true,
9637 "type": "string"
9638 }
9639 ],
9640 "responses": {
9641 "200": {
9642 "description": "OK",
9643 "schema": {
9644 "$ref": "#/definitions/BankAccountModel"
9645 }
9646 }
9647 }
9648 },
9649 "delete": {
9650 "tags": [
9651 "Ess"
9652 ],
9653 "summary": "Delete Bank Account",
9654 "description": "Deletes the employee's bank account with the specified ID.",
9655 "operationId": "EssBankAccount_Delete",
9656 "consumes": [],
9657 "produces": [
9658 "application/json",
9659 "text/json",
9660 "application/xml",
9661 "text/xml"
9662 ],
9663 "parameters": [
9664 {
9665 "name": "bankAccountId",
9666 "in": "path",
9667 "required": true,
9668 "type": "integer",
9669 "format": "int32",
9670 "title": "Int32"
9671 },
9672 {
9673 "name": "employeeId",
9674 "in": "path",
9675 "required": true,
9676 "type": "string"
9677 }
9678 ],
9679 "responses": {
9680 "200": {
9681 "description": "OK",
9682 "schema": {
9683 "$ref": "#/definitions/SaveBankAccountResponseModel"
9684 }
9685 }
9686 }
9687 }
9688 },
9689 "/api/v2/ess/{employeeId}/bankaccounts/{id}": {
9690 "put": {
9691 "tags": [
9692 "Ess"
9693 ],
9694 "summary": "Update Bank Account",
9695 "description": "Updates the employee's bank account with the specified ID.",
9696 "operationId": "EssBankAccount_Put",
9697 "consumes": [
9698 "application/json",
9699 "text/json",
9700 "application/xml",
9701 "text/xml",
9702 "application/x-www-form-urlencoded"
9703 ],
9704 "produces": [
9705 "application/json",
9706 "text/json",
9707 "application/xml",
9708 "text/xml"
9709 ],
9710 "parameters": [
9711 {
9712 "name": "id",
9713 "in": "path",
9714 "required": true,
9715 "type": "integer",
9716 "format": "int32",
9717 "title": "Int32"
9718 },
9719 {
9720 "name": "model",
9721 "in": "body",
9722 "required": true,
9723 "schema": {
9724 "$ref": "#/definitions/BankAccountModel"
9725 }
9726 },
9727 {
9728 "name": "employeeId",
9729 "in": "path",
9730 "required": true,
9731 "type": "string"
9732 }
9733 ],
9734 "responses": {
9735 "200": {
9736 "description": "OK",
9737 "schema": {
9738 "$ref": "#/definitions/SaveBankAccountResponseModel"
9739 }
9740 }
9741 }
9742 }
9743 },
9744 "/api/v2/ess/security/employees": {
9745 "get": {
9746 "tags": [
9747 "Ess"
9748 ],
9749 "summary": "Get Employees",
9750 "description": "Returns all the employees the user can access.",
9751 "operationId": "EssSecurity_Employees",
9752 "consumes": [],
9753 "produces": [
9754 "application/json",
9755 "text/json",
9756 "application/xml",
9757 "text/xml"
9758 ],
9759 "responses": {
9760 "200": {
9761 "description": "OK",
9762 "schema": {
9763 "type": "array",
9764 "items": {
9765 "$ref": "#/definitions/AvailableEmployeeModel"
9766 },
9767 "xml": {
9768 "name": "AvailableEmployeeModel",
9769 "wrapped": true
9770 },
9771 "title": "List<AvailableEmployeeModel>"
9772 }
9773 }
9774 }
9775 }
9776 },
9777 "/api/v2/ess/security/forgottenpassword": {
9778 "post": {
9779 "tags": [
9780 "Ess"
9781 ],
9782 "summary": "Recover Forgotten Password",
9783 "description": "Sends an email so that the user can reset their password",
9784 "operationId": "EssSecurity_ForgottenPassword",
9785 "consumes": [
9786 "application/json",
9787 "text/json",
9788 "application/xml",
9789 "text/xml",
9790 "application/x-www-form-urlencoded"
9791 ],
9792 "produces": [
9793 "application/json",
9794 "text/json",
9795 "application/xml",
9796 "text/xml"
9797 ],
9798 "parameters": [
9799 {
9800 "name": "model",
9801 "in": "body",
9802 "required": true,
9803 "schema": {
9804 "$ref": "#/definitions/RecoverPasswordModel"
9805 }
9806 }
9807 ],
9808 "responses": {
9809 "200": {
9810 "description": "OK"
9811 }
9812 }
9813 }
9814 },
9815 "/api/v2/ess/{employeeId}/expense/summary": {
9816 "get": {
9817 "tags": [
9818 "Ess"
9819 ],
9820 "summary": "Get Expense Payment Summary",
9821 "description": "Gets a summary of the employee's expense payments.",
9822 "operationId": "EssExpense_Summary",
9823 "consumes": [],
9824 "produces": [
9825 "application/json",
9826 "text/json",
9827 "application/xml",
9828 "text/xml"
9829 ],
9830 "parameters": [
9831 {
9832 "name": "employeeId",
9833 "in": "path",
9834 "required": true,
9835 "type": "string"
9836 }
9837 ],
9838 "responses": {
9839 "200": {
9840 "description": "OK",
9841 "schema": {
9842 "type": "array",
9843 "items": {
9844 "$ref": "#/definitions/EmployeeExpensePaymentSummaryModel"
9845 },
9846 "xml": {
9847 "name": "EmployeeExpensePaymentSummaryModel",
9848 "wrapped": true
9849 },
9850 "title": "IList<EmployeeExpensePaymentSummaryModel>"
9851 }
9852 }
9853 }
9854 }
9855 },
9856 "/api/v2/ess/{employeeId}/expense/categories": {
9857 "get": {
9858 "tags": [
9859 "Ess"
9860 ],
9861 "summary": "Get Expense Categories",
9862 "description": "Gets all the expense categories for the employee.",
9863 "operationId": "EssExpense_ExpenseCategories",
9864 "consumes": [],
9865 "produces": [
9866 "application/json",
9867 "text/json",
9868 "application/xml",
9869 "text/xml"
9870 ],
9871 "parameters": [
9872 {
9873 "name": "employeeId",
9874 "in": "path",
9875 "required": true,
9876 "type": "string"
9877 }
9878 ],
9879 "responses": {
9880 "200": {
9881 "description": "OK",
9882 "schema": {
9883 "type": "array",
9884 "items": {
9885 "$ref": "#/definitions/ExpenseCategoryResponseModel"
9886 },
9887 "xml": {
9888 "name": "ExpenseCategoryResponseModel",
9889 "wrapped": true
9890 },
9891 "title": "IList<ExpenseCategoryResponseModel>"
9892 }
9893 }
9894 }
9895 }
9896 },
9897 "/api/v2/ess/{employeeId}/expense/taxcodes": {
9898 "get": {
9899 "tags": [
9900 "Ess"
9901 ],
9902 "summary": "Get Tax Codes",
9903 "description": "Gets all the tax codes for the employee.",
9904 "operationId": "EssExpense_TaxCodes",
9905 "consumes": [],
9906 "produces": [
9907 "application/json",
9908 "text/json",
9909 "application/xml",
9910 "text/xml"
9911 ],
9912 "parameters": [
9913 {
9914 "name": "employeeId",
9915 "in": "path",
9916 "required": true,
9917 "type": "string"
9918 }
9919 ],
9920 "responses": {
9921 "200": {
9922 "description": "OK",
9923 "schema": {
9924 "type": "array",
9925 "items": {
9926 "$ref": "#/definitions/JournalServiceTaxCode"
9927 },
9928 "xml": {
9929 "name": "JournalServiceTaxCode",
9930 "wrapped": true
9931 },
9932 "title": "IList<JournalServiceTaxCode>"
9933 }
9934 }
9935 }
9936 }
9937 },
9938 "/api/v2/ess/{employeeId}/expense": {
9939 "get": {
9940 "tags": [
9941 "Ess"
9942 ],
9943 "summary": "Get Expense Requests",
9944 "description": "Gets a paged view of expense requests for this employee.",
9945 "operationId": "EssExpense_GetExpenseRequests",
9946 "consumes": [],
9947 "produces": [
9948 "application/json",
9949 "text/json",
9950 "application/xml",
9951 "text/xml"
9952 ],
9953 "parameters": [
9954 {
9955 "name": "currentPage",
9956 "in": "query",
9957 "required": false,
9958 "type": "integer",
9959 "format": "int32",
9960 "default": 1,
9961 "title": "Int32"
9962 },
9963 {
9964 "name": "pageSize",
9965 "in": "query",
9966 "required": false,
9967 "type": "integer",
9968 "format": "int32",
9969 "default": 100,
9970 "title": "Int32"
9971 },
9972 {
9973 "name": "employeeId",
9974 "in": "path",
9975 "required": true,
9976 "type": "string"
9977 }
9978 ],
9979 "responses": {
9980 "200": {
9981 "description": "OK",
9982 "schema": {
9983 "type": "array",
9984 "items": {
9985 "$ref": "#/definitions/EssExpenseRequestResponseModel"
9986 },
9987 "xml": {
9988 "name": "EssExpenseRequestResponseModel",
9989 "wrapped": true
9990 },
9991 "title": "IList<EssExpenseRequestResponseModel>"
9992 }
9993 }
9994 }
9995 },
9996 "post": {
9997 "tags": [
9998 "Ess"
9999 ],
10000 "summary": "Create Expense Request",
10001 "description": "Creates a new expense request for the employee.",
10002 "operationId": "EssExpense_CreateExpenseRequest",
10003 "consumes": [
10004 "application/json",
10005 "text/json",
10006 "application/xml",
10007 "text/xml",
10008 "application/x-www-form-urlencoded"
10009 ],
10010 "produces": [
10011 "application/json",
10012 "text/json",
10013 "application/xml",
10014 "text/xml"
10015 ],
10016 "parameters": [
10017 {
10018 "name": "model",
10019 "in": "body",
10020 "required": true,
10021 "schema": {
10022 "$ref": "#/definitions/ExpenseRequestEditModel"
10023 }
10024 },
10025 {
10026 "name": "employeeId",
10027 "in": "path",
10028 "required": true,
10029 "type": "string"
10030 }
10031 ],
10032 "responses": {
10033 "200": {
10034 "description": "OK"
10035 }
10036 }
10037 }
10038 },
10039 "/api/v2/ess/{employeeId}/expense/{expenseRequestId}": {
10040 "get": {
10041 "tags": [
10042 "Ess"
10043 ],
10044 "summary": "Get Expense Request by ID",
10045 "description": "Gets the expense request with the specified ID.",
10046 "operationId": "EssExpense_GetExpenseRequest",
10047 "consumes": [],
10048 "produces": [
10049 "application/json",
10050 "text/json",
10051 "application/xml",
10052 "text/xml"
10053 ],
10054 "parameters": [
10055 {
10056 "name": "expenseRequestId",
10057 "in": "path",
10058 "required": true,
10059 "type": "integer",
10060 "format": "int32",
10061 "title": "Int32"
10062 },
10063 {
10064 "name": "employeeId",
10065 "in": "path",
10066 "required": true,
10067 "type": "string"
10068 }
10069 ],
10070 "responses": {
10071 "200": {
10072 "description": "OK",
10073 "schema": {
10074 "$ref": "#/definitions/EssExpenseRequestResponseModel"
10075 }
10076 }
10077 }
10078 },
10079 "put": {
10080 "tags": [
10081 "Ess"
10082 ],
10083 "summary": "Update Expense Request",
10084 "description": "Updates the expense request with the specified ID.",
10085 "operationId": "EssExpense_UpdateExpenseRequest",
10086 "consumes": [
10087 "application/json",
10088 "text/json",
10089 "application/xml",
10090 "text/xml",
10091 "application/x-www-form-urlencoded"
10092 ],
10093 "produces": [
10094 "application/json",
10095 "text/json",
10096 "application/xml",
10097 "text/xml"
10098 ],
10099 "parameters": [
10100 {
10101 "name": "expenseRequestId",
10102 "in": "path",
10103 "required": true,
10104 "type": "integer",
10105 "format": "int32",
10106 "title": "Int32"
10107 },
10108 {
10109 "name": "model",
10110 "in": "body",
10111 "required": true,
10112 "schema": {
10113 "$ref": "#/definitions/ExpenseRequestEditModel"
10114 }
10115 },
10116 {
10117 "name": "employeeId",
10118 "in": "path",
10119 "required": true,
10120 "type": "string"
10121 }
10122 ],
10123 "responses": {
10124 "200": {
10125 "description": "OK"
10126 }
10127 }
10128 },
10129 "delete": {
10130 "tags": [
10131 "Ess"
10132 ],
10133 "summary": "Delete Expense Request",
10134 "description": "Deletes the expense request with the specified ID.",
10135 "operationId": "EssExpense_CancelExpenseRequest",
10136 "consumes": [],
10137 "produces": [
10138 "application/json",
10139 "text/json",
10140 "application/xml",
10141 "text/xml"
10142 ],
10143 "parameters": [
10144 {
10145 "name": "expenseRequestId",
10146 "in": "path",
10147 "required": true,
10148 "type": "integer",
10149 "format": "int32",
10150 "title": "Int32"
10151 },
10152 {
10153 "name": "employeeId",
10154 "in": "path",
10155 "required": true,
10156 "type": "string"
10157 }
10158 ],
10159 "responses": {
10160 "200": {
10161 "description": "OK",
10162 "schema": {
10163 "$ref": "#/definitions/EssExpenseRequestResponseModel"
10164 }
10165 }
10166 }
10167 }
10168 },
10169 "/api/v2/ess/{employeeId}/expense/{expenseRequestId}/attachment": {
10170 "put": {
10171 "tags": [
10172 "Ess"
10173 ],
10174 "summary": "Upload Attachment to Expense Request",
10175 "description": "Uploads an attachment to the expense request with the specified ID. \r\nThe request should be a MIME multipart file upload request.",
10176 "operationId": "EssExpense_UploadAttachment",
10177 "consumes": [],
10178 "produces": [
10179 "application/json",
10180 "text/json",
10181 "application/xml",
10182 "text/xml"
10183 ],
10184 "parameters": [
10185 {
10186 "name": "expenseRequestId",
10187 "in": "path",
10188 "required": true,
10189 "type": "integer",
10190 "format": "int32",
10191 "title": "Int32"
10192 },
10193 {
10194 "name": "employeeId",
10195 "in": "path",
10196 "required": true,
10197 "type": "string"
10198 }
10199 ],
10200 "responses": {
10201 "200": {
10202 "description": "OK",
10203 "schema": {
10204 "type": "object",
10205 "title": "IHttpActionResult"
10206 }
10207 }
10208 }
10209 }
10210 },
10211 "/api/v2/business/{businessId}/leaveallowances": {
10212 "get": {
10213 "tags": [
10214 "LeaveAllowance"
10215 ],
10216 "summary": "Get Leave Allowances",
10217 "description": "Creates a deduction category for the business.",
10218 "operationId": "LeaveAllowances_Get",
10219 "consumes": [],
10220 "produces": [
10221 "application/json",
10222 "text/json",
10223 "application/xml",
10224 "text/xml"
10225 ],
10226 "parameters": [
10227 {
10228 "name": "businessId",
10229 "in": "path",
10230 "required": true,
10231 "type": "string"
10232 }
10233 ],
10234 "responses": {
10235 "200": {
10236 "description": "OK",
10237 "schema": {
10238 "type": "object",
10239 "additionalProperties": {
10240 "type": "array",
10241 "items": {
10242 "$ref": "#/definitions/LeaveAllowanceModel"
10243 },
10244 "xml": {
10245 "name": "LeaveAllowanceModel",
10246 "wrapped": true
10247 },
10248 "title": "List<LeaveAllowanceModel>"
10249 },
10250 "title": "Dictionary<String,List`1>"
10251 }
10252 }
10253 }
10254 },
10255 "post": {
10256 "tags": [
10257 "LeaveAllowance"
10258 ],
10259 "summary": "Create Leave Allowances",
10260 "description": "Create leave allowances for specific employees (dictionary keyed by employee ID).",
10261 "operationId": "LeaveAllowances_Post",
10262 "consumes": [
10263 "application/json",
10264 "text/json",
10265 "application/xml",
10266 "text/xml",
10267 "application/x-www-form-urlencoded"
10268 ],
10269 "produces": [
10270 "application/json",
10271 "text/json",
10272 "application/xml",
10273 "text/xml"
10274 ],
10275 "parameters": [
10276 {
10277 "name": "request",
10278 "in": "body",
10279 "required": true,
10280 "schema": {
10281 "$ref": "#/definitions/SubmitEmployeeLeaveAllowancesRequest"
10282 }
10283 },
10284 {
10285 "name": "businessId",
10286 "in": "path",
10287 "required": true,
10288 "type": "string"
10289 }
10290 ],
10291 "responses": {
10292 "200": {
10293 "description": "OK"
10294 }
10295 }
10296 }
10297 },
10298 "/api/v2/business/{businessId}/leaveallowancetemplate": {
10299 "get": {
10300 "tags": [
10301 "LeaveAllowance"
10302 ],
10303 "summary": "List Leave Allowance Templates",
10304 "description": "Lists all the leave allowance templates for this business.\n\nThis operation supports OData queries.",
10305 "operationId": "LeaveAllowanceTemplate_GetLeaveAllowanceTemplates",
10306 "consumes": [],
10307 "produces": [
10308 "application/json",
10309 "text/json",
10310 "application/xml",
10311 "text/xml"
10312 ],
10313 "parameters": [
10314 {
10315 "name": "businessId",
10316 "in": "path",
10317 "required": true,
10318 "type": "string"
10319 }
10320 ],
10321 "responses": {
10322 "200": {
10323 "description": "OK",
10324 "schema": {
10325 "type": "array",
10326 "items": {
10327 "$ref": "#/definitions/LeaveAllowanceTemplateModel"
10328 },
10329 "xml": {
10330 "name": "LeaveAllowanceTemplateModel",
10331 "wrapped": true
10332 },
10333 "title": "IEnumerable<LeaveAllowanceTemplateModel>"
10334 }
10335 }
10336 }
10337 },
10338 "post": {
10339 "tags": [
10340 "LeaveAllowance"
10341 ],
10342 "summary": "Create Leave Allowance Template",
10343 "description": "Creates a new leave allowance template for the business.",
10344 "operationId": "LeaveAllowanceTemplate_Post",
10345 "consumes": [
10346 "application/json",
10347 "text/json",
10348 "application/xml",
10349 "text/xml",
10350 "application/x-www-form-urlencoded"
10351 ],
10352 "produces": [
10353 "application/json",
10354 "text/json",
10355 "application/xml",
10356 "text/xml"
10357 ],
10358 "parameters": [
10359 {
10360 "name": "leaveAllowanceTemplate",
10361 "in": "body",
10362 "required": true,
10363 "schema": {
10364 "$ref": "#/definitions/LeaveAllowanceTemplateModel"
10365 }
10366 },
10367 {
10368 "name": "businessId",
10369 "in": "path",
10370 "required": true,
10371 "type": "string"
10372 }
10373 ],
10374 "responses": {
10375 "200": {
10376 "description": "OK"
10377 }
10378 }
10379 }
10380 },
10381 "/api/v2/business/{businessId}/leaveallowancetemplate/{id}": {
10382 "get": {
10383 "tags": [
10384 "LeaveAllowance"
10385 ],
10386 "summary": "Get Leave Allowance Template by ID",
10387 "description": "Gets the details for the leave allowance template with the specified ID.",
10388 "operationId": "LeaveAllowanceTemplate_Get",
10389 "consumes": [],
10390 "produces": [
10391 "application/json",
10392 "text/json",
10393 "application/xml",
10394 "text/xml"
10395 ],
10396 "parameters": [
10397 {
10398 "name": "id",
10399 "in": "path",
10400 "required": true,
10401 "type": "integer",
10402 "format": "int32",
10403 "title": "Int32"
10404 },
10405 {
10406 "name": "businessId",
10407 "in": "path",
10408 "required": true,
10409 "type": "string"
10410 }
10411 ],
10412 "responses": {
10413 "200": {
10414 "description": "OK",
10415 "schema": {
10416 "$ref": "#/definitions/LeaveAllowanceTemplateModel"
10417 }
10418 }
10419 }
10420 },
10421 "put": {
10422 "tags": [
10423 "LeaveAllowance"
10424 ],
10425 "summary": "Update Leave Allowance Template",
10426 "description": "Updates the leave allowance template with the specified ID.",
10427 "operationId": "LeaveAllowanceTemplate_Put",
10428 "consumes": [
10429 "application/json",
10430 "text/json",
10431 "application/xml",
10432 "text/xml",
10433 "application/x-www-form-urlencoded"
10434 ],
10435 "produces": [
10436 "application/json",
10437 "text/json",
10438 "application/xml",
10439 "text/xml"
10440 ],
10441 "parameters": [
10442 {
10443 "name": "id",
10444 "in": "path",
10445 "required": true,
10446 "type": "integer",
10447 "format": "int32",
10448 "title": "Int32"
10449 },
10450 {
10451 "name": "leaveAllowanceTemplate",
10452 "in": "body",
10453 "required": true,
10454 "schema": {
10455 "$ref": "#/definitions/LeaveAllowanceTemplateModel"
10456 }
10457 },
10458 {
10459 "name": "businessId",
10460 "in": "path",
10461 "required": true,
10462 "type": "string"
10463 }
10464 ],
10465 "responses": {
10466 "200": {
10467 "description": "OK"
10468 }
10469 }
10470 },
10471 "delete": {
10472 "tags": [
10473 "LeaveAllowance"
10474 ],
10475 "summary": "Delete Leave Allowance Template",
10476 "description": "Deletes the leave allowance template with the specified ID.",
10477 "operationId": "LeaveAllowanceTemplate_Delete",
10478 "consumes": [],
10479 "produces": [
10480 "application/json",
10481 "text/json",
10482 "application/xml",
10483 "text/xml"
10484 ],
10485 "parameters": [
10486 {
10487 "name": "id",
10488 "in": "path",
10489 "required": true,
10490 "type": "integer",
10491 "format": "int32",
10492 "title": "Int32"
10493 },
10494 {
10495 "name": "businessId",
10496 "in": "path",
10497 "required": true,
10498 "type": "string"
10499 }
10500 ],
10501 "responses": {
10502 "200": {
10503 "description": "OK"
10504 }
10505 }
10506 }
10507 },
10508 "/api/v2/business/{businessId}/leavecategory": {
10509 "get": {
10510 "tags": [
10511 "LeaveCategories"
10512 ],
10513 "summary": "List Leave Categories",
10514 "description": "Lists all of the leave categories for the business.\n\nThis operation supports OData queries.",
10515 "operationId": "LeaveCategory_GetLeaveCategories",
10516 "consumes": [],
10517 "produces": [
10518 "application/json",
10519 "text/json",
10520 "application/xml",
10521 "text/xml"
10522 ],
10523 "parameters": [
10524 {
10525 "name": "businessId",
10526 "in": "path",
10527 "required": true,
10528 "type": "string"
10529 }
10530 ],
10531 "responses": {
10532 "200": {
10533 "description": "OK",
10534 "schema": {
10535 "type": "array",
10536 "items": {
10537 "$ref": "#/definitions/LeaveCategoryModel"
10538 },
10539 "xml": {
10540 "name": "LeaveCategoryModel",
10541 "wrapped": true
10542 },
10543 "title": "IEnumerable<LeaveCategoryModel>"
10544 }
10545 }
10546 }
10547 },
10548 "post": {
10549 "tags": [
10550 "LeaveCategories"
10551 ],
10552 "summary": "Create Leave Category",
10553 "description": "Creates a new leave category for the business.",
10554 "operationId": "LeaveCategory_Post",
10555 "consumes": [
10556 "application/json",
10557 "text/json",
10558 "application/xml",
10559 "text/xml",
10560 "application/x-www-form-urlencoded"
10561 ],
10562 "produces": [
10563 "application/json",
10564 "text/json",
10565 "application/xml",
10566 "text/xml"
10567 ],
10568 "parameters": [
10569 {
10570 "name": "leaveCategory",
10571 "in": "body",
10572 "required": true,
10573 "schema": {
10574 "$ref": "#/definitions/LeaveCategoryModel"
10575 }
10576 },
10577 {
10578 "name": "businessId",
10579 "in": "path",
10580 "required": true,
10581 "type": "string"
10582 }
10583 ],
10584 "responses": {
10585 "200": {
10586 "description": "OK"
10587 }
10588 }
10589 }
10590 },
10591 "/api/v2/business/{businessId}/leavecategory/{id}": {
10592 "get": {
10593 "tags": [
10594 "LeaveCategories"
10595 ],
10596 "summary": "Get Leave Category by ID",
10597 "description": "Gets the leave category with the specified ID.",
10598 "operationId": "LeaveCategory_Get",
10599 "consumes": [],
10600 "produces": [
10601 "application/json",
10602 "text/json",
10603 "application/xml",
10604 "text/xml"
10605 ],
10606 "parameters": [
10607 {
10608 "name": "id",
10609 "in": "path",
10610 "required": true,
10611 "type": "integer",
10612 "format": "int32",
10613 "title": "Int32"
10614 },
10615 {
10616 "name": "businessId",
10617 "in": "path",
10618 "required": true,
10619 "type": "string"
10620 }
10621 ],
10622 "responses": {
10623 "200": {
10624 "description": "OK",
10625 "schema": {
10626 "$ref": "#/definitions/LeaveCategoryModel"
10627 }
10628 }
10629 }
10630 },
10631 "put": {
10632 "tags": [
10633 "LeaveCategories"
10634 ],
10635 "summary": "Update Leave Category",
10636 "description": "Updates the leave category with the specified ID.",
10637 "operationId": "LeaveCategory_Put",
10638 "consumes": [
10639 "application/json",
10640 "text/json",
10641 "application/xml",
10642 "text/xml",
10643 "application/x-www-form-urlencoded"
10644 ],
10645 "produces": [
10646 "application/json",
10647 "text/json",
10648 "application/xml",
10649 "text/xml"
10650 ],
10651 "parameters": [
10652 {
10653 "name": "id",
10654 "in": "path",
10655 "required": true,
10656 "type": "integer",
10657 "format": "int32",
10658 "title": "Int32"
10659 },
10660 {
10661 "name": "leaveCategory",
10662 "in": "body",
10663 "required": true,
10664 "schema": {
10665 "$ref": "#/definitions/LeaveCategoryModel"
10666 }
10667 },
10668 {
10669 "name": "businessId",
10670 "in": "path",
10671 "required": true,
10672 "type": "string"
10673 }
10674 ],
10675 "responses": {
10676 "200": {
10677 "description": "OK"
10678 }
10679 }
10680 },
10681 "delete": {
10682 "tags": [
10683 "LeaveCategories"
10684 ],
10685 "summary": "Delete Leave Category",
10686 "description": "Deletes the leave category with the specified ID.",
10687 "operationId": "LeaveCategory_Delete",
10688 "consumes": [],
10689 "produces": [
10690 "application/json",
10691 "text/json",
10692 "application/xml",
10693 "text/xml"
10694 ],
10695 "parameters": [
10696 {
10697 "name": "id",
10698 "in": "path",
10699 "required": true,
10700 "type": "integer",
10701 "format": "int32",
10702 "title": "Int32"
10703 },
10704 {
10705 "name": "businessId",
10706 "in": "path",
10707 "required": true,
10708 "type": "string"
10709 }
10710 ],
10711 "responses": {
10712 "200": {
10713 "description": "OK"
10714 }
10715 }
10716 }
10717 },
10718 "/api/v2/business/{businessId}/leaverequest": {
10719 "get": {
10720 "tags": [
10721 "LeaveRequests"
10722 ],
10723 "summary": "List Leave Requests",
10724 "description": "Lists all the leave requests for the business.",
10725 "operationId": "BusinessLeaveRequest_ListLeaveRequests",
10726 "consumes": [],
10727 "produces": [
10728 "application/json",
10729 "text/json",
10730 "application/xml",
10731 "text/xml"
10732 ],
10733 "parameters": [
10734 {
10735 "name": "businessId",
10736 "in": "path",
10737 "required": true,
10738 "type": "integer",
10739 "format": "int32",
10740 "title": "Int32"
10741 },
10742 {
10743 "name": "filter.status",
10744 "in": "query",
10745 "required": false,
10746 "type": "string",
10747 "enum": [
10748 "Pending",
10749 "Approved",
10750 "Cancelled",
10751 "Rejected"
10752 ],
10753 "title": "Nullable<LeaveRequestStatus>"
10754 },
10755 {
10756 "name": "filter.fromDate",
10757 "in": "query",
10758 "required": false,
10759 "type": "string",
10760 "format": "date-time",
10761 "title": "Nullable<DateTime>"
10762 },
10763 {
10764 "name": "filter.toDate",
10765 "in": "query",
10766 "required": false,
10767 "type": "string",
10768 "format": "date-time",
10769 "title": "Nullable<DateTime>"
10770 },
10771 {
10772 "name": "filter.leaveCategoryId",
10773 "in": "query",
10774 "required": false,
10775 "type": "integer",
10776 "format": "int32",
10777 "title": "Nullable<Int32>"
10778 },
10779 {
10780 "name": "filter.locationId",
10781 "in": "query",
10782 "required": false,
10783 "type": "integer",
10784 "format": "int32",
10785 "title": "Nullable<Int32>"
10786 },
10787 {
10788 "name": "filter.employeeId",
10789 "in": "query",
10790 "required": false,
10791 "type": "integer",
10792 "format": "int32",
10793 "title": "Nullable<Int32>"
10794 },
10795 {
10796 "name": "filter.groupBy",
10797 "in": "query",
10798 "required": false,
10799 "type": "string",
10800 "enum": [
10801 "Employee",
10802 "LeaveType"
10803 ],
10804 "title": "LeaveRequestGroupBy"
10805 },
10806 {
10807 "name": "filter.restrictOverlappingLeave",
10808 "in": "query",
10809 "required": false,
10810 "type": "boolean",
10811 "title": "Boolean"
10812 }
10813 ],
10814 "responses": {
10815 "200": {
10816 "description": "OK",
10817 "schema": {
10818 "type": "array",
10819 "items": {
10820 "$ref": "#/definitions/LeaveRequestResponseModel"
10821 },
10822 "xml": {
10823 "name": "LeaveRequestResponseModel",
10824 "wrapped": true
10825 },
10826 "title": "IEnumerable<LeaveRequestResponseModel>"
10827 }
10828 }
10829 }
10830 }
10831 },
10832 "/api/v2/business/{businessId}/employee/{employeeId}/leaverequest": {
10833 "get": {
10834 "tags": [
10835 "LeaveRequests"
10836 ],
10837 "summary": "Get Leave Requests for Employee",
10838 "description": "Returns all leave requests for this employee, optionally filtered by OData parameters.\n\nThis operation supports OData queries.",
10839 "operationId": "LeaveRequest_GetLeaveRequests",
10840 "consumes": [],
10841 "produces": [
10842 "application/json",
10843 "text/json",
10844 "application/xml",
10845 "text/xml"
10846 ],
10847 "parameters": [
10848 {
10849 "name": "businessId",
10850 "in": "path",
10851 "required": true,
10852 "type": "string"
10853 },
10854 {
10855 "name": "employeeId",
10856 "in": "path",
10857 "required": true,
10858 "type": "string"
10859 }
10860 ],
10861 "responses": {
10862 "200": {
10863 "description": "OK",
10864 "schema": {
10865 "type": "array",
10866 "items": {
10867 "$ref": "#/definitions/LeaveRequestResponseModel"
10868 },
10869 "xml": {
10870 "name": "LeaveRequestResponseModel",
10871 "wrapped": true
10872 },
10873 "title": "IEnumerable<LeaveRequestResponseModel>"
10874 }
10875 }
10876 }
10877 },
10878 "post": {
10879 "tags": [
10880 "LeaveRequests"
10881 ],
10882 "summary": "Create Leave Request",
10883 "description": "Creates a new leave request for an employee.",
10884 "operationId": "LeaveRequest_Post",
10885 "consumes": [
10886 "application/json",
10887 "text/json",
10888 "application/xml",
10889 "text/xml",
10890 "application/x-www-form-urlencoded"
10891 ],
10892 "produces": [
10893 "application/json",
10894 "text/json",
10895 "application/xml",
10896 "text/xml"
10897 ],
10898 "parameters": [
10899 {
10900 "name": "model",
10901 "in": "body",
10902 "required": true,
10903 "schema": {
10904 "$ref": "#/definitions/ApiLeaveApplicationModel"
10905 }
10906 },
10907 {
10908 "name": "businessId",
10909 "in": "path",
10910 "required": true,
10911 "type": "string"
10912 },
10913 {
10914 "name": "employeeId",
10915 "in": "path",
10916 "required": true,
10917 "type": "string"
10918 }
10919 ],
10920 "responses": {
10921 "200": {
10922 "description": "OK"
10923 }
10924 }
10925 }
10926 },
10927 "/api/v2/business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}": {
10928 "get": {
10929 "tags": [
10930 "LeaveRequests"
10931 ],
10932 "summary": "Get Leave Request by ID",
10933 "description": "Gets the details for a leave request with the specified ID.",
10934 "operationId": "LeaveRequest_Get",
10935 "consumes": [],
10936 "produces": [
10937 "application/json",
10938 "text/json",
10939 "application/xml",
10940 "text/xml"
10941 ],
10942 "parameters": [
10943 {
10944 "name": "employeeId",
10945 "in": "path",
10946 "required": true,
10947 "type": "integer",
10948 "format": "int32",
10949 "title": "Int32"
10950 },
10951 {
10952 "name": "leaveRequestId",
10953 "in": "path",
10954 "required": true,
10955 "type": "integer",
10956 "format": "int32",
10957 "title": "Int32"
10958 },
10959 {
10960 "name": "businessId",
10961 "in": "path",
10962 "required": true,
10963 "type": "string"
10964 }
10965 ],
10966 "responses": {
10967 "200": {
10968 "description": "OK",
10969 "schema": {
10970 "$ref": "#/definitions/LeaveRequestResponseModel"
10971 }
10972 }
10973 }
10974 },
10975 "put": {
10976 "tags": [
10977 "LeaveRequests"
10978 ],
10979 "summary": "Update Leave Request",
10980 "description": "Updates the leave request with the specified ID.",
10981 "operationId": "LeaveRequest_Put",
10982 "consumes": [
10983 "application/json",
10984 "text/json",
10985 "application/xml",
10986 "text/xml",
10987 "application/x-www-form-urlencoded"
10988 ],
10989 "produces": [
10990 "application/json",
10991 "text/json",
10992 "application/xml",
10993 "text/xml"
10994 ],
10995 "parameters": [
10996 {
10997 "name": "leaveRequestId",
10998 "in": "path",
10999 "required": true,
11000 "type": "integer",
11001 "format": "int32",
11002 "title": "Int32"
11003 },
11004 {
11005 "name": "model",
11006 "in": "body",
11007 "required": true,
11008 "schema": {
11009 "$ref": "#/definitions/ApiLeaveApplicationModel"
11010 }
11011 },
11012 {
11013 "name": "businessId",
11014 "in": "path",
11015 "required": true,
11016 "type": "string"
11017 },
11018 {
11019 "name": "employeeId",
11020 "in": "path",
11021 "required": true,
11022 "type": "string"
11023 }
11024 ],
11025 "responses": {
11026 "200": {
11027 "description": "OK"
11028 }
11029 }
11030 },
11031 "delete": {
11032 "tags": [
11033 "LeaveRequests"
11034 ],
11035 "summary": "Delete Leave Request",
11036 "description": "Deletes the leave request with the specified ID.",
11037 "operationId": "LeaveRequest_Delete",
11038 "consumes": [],
11039 "produces": [
11040 "application/json",
11041 "text/json",
11042 "application/xml",
11043 "text/xml"
11044 ],
11045 "parameters": [
11046 {
11047 "name": "employeeId",
11048 "in": "path",
11049 "required": true,
11050 "type": "integer",
11051 "format": "int32",
11052 "title": "Int32"
11053 },
11054 {
11055 "name": "leaveRequestId",
11056 "in": "path",
11057 "required": true,
11058 "type": "integer",
11059 "format": "int32",
11060 "title": "Int32"
11061 },
11062 {
11063 "name": "businessId",
11064 "in": "path",
11065 "required": true,
11066 "type": "string"
11067 }
11068 ],
11069 "responses": {
11070 "200": {
11071 "description": "OK"
11072 }
11073 }
11074 }
11075 },
11076 "/api/v2/business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}/approve": {
11077 "post": {
11078 "tags": [
11079 "LeaveRequests"
11080 ],
11081 "summary": "Approve Leave Request",
11082 "description": "Approves the leave request with the specified ID.",
11083 "operationId": "LeaveRequest_Approve",
11084 "consumes": [],
11085 "produces": [
11086 "application/json",
11087 "text/json",
11088 "application/xml",
11089 "text/xml"
11090 ],
11091 "parameters": [
11092 {
11093 "name": "employeeId",
11094 "in": "path",
11095 "required": true,
11096 "type": "integer",
11097 "format": "int32",
11098 "title": "Int32"
11099 },
11100 {
11101 "name": "leaveRequestId",
11102 "in": "path",
11103 "required": true,
11104 "type": "integer",
11105 "format": "int32",
11106 "title": "Int32"
11107 },
11108 {
11109 "name": "businessId",
11110 "in": "path",
11111 "required": true,
11112 "type": "string"
11113 }
11114 ],
11115 "responses": {
11116 "200": {
11117 "description": "OK"
11118 }
11119 }
11120 }
11121 },
11122 "/api/v2/business/{businessId}/employee/{employeeId}/leaverequest/{leaveRequestId}/decline": {
11123 "post": {
11124 "tags": [
11125 "LeaveRequests"
11126 ],
11127 "summary": "Decline Leave Request",
11128 "description": "Declines the leave request with the specified ID.",
11129 "operationId": "LeaveRequest_Decline",
11130 "consumes": [
11131 "application/json",
11132 "text/json",
11133 "application/xml",
11134 "text/xml",
11135 "application/x-www-form-urlencoded"
11136 ],
11137 "produces": [
11138 "application/json",
11139 "text/json",
11140 "application/xml",
11141 "text/xml"
11142 ],
11143 "parameters": [
11144 {
11145 "name": "employeeId",
11146 "in": "path",
11147 "required": true,
11148 "type": "integer",
11149 "format": "int32",
11150 "title": "Int32"
11151 },
11152 {
11153 "name": "leaveRequestId",
11154 "in": "path",
11155 "required": true,
11156 "type": "integer",
11157 "format": "int32",
11158 "title": "Int32"
11159 },
11160 {
11161 "name": "decline",
11162 "in": "body",
11163 "required": true,
11164 "schema": {
11165 "$ref": "#/definitions/DeclineLeaveRequest"
11166 }
11167 },
11168 {
11169 "name": "businessId",
11170 "in": "path",
11171 "required": true,
11172 "type": "string"
11173 }
11174 ],
11175 "responses": {
11176 "200": {
11177 "description": "OK"
11178 }
11179 }
11180 }
11181 },
11182 "/api/v2/business/{businessId}/employee/{employeeId}/leaverequest/estimate": {
11183 "get": {
11184 "tags": [
11185 "LeaveRequests"
11186 ],
11187 "summary": "Estimate Leave Hours",
11188 "description": "Estimates the leave hours required for a leave request between fromDate and toDate.",
11189 "operationId": "LeaveRequest_Estimate",
11190 "consumes": [],
11191 "produces": [
11192 "application/json",
11193 "text/json",
11194 "application/xml",
11195 "text/xml"
11196 ],
11197 "parameters": [
11198 {
11199 "name": "businessId",
11200 "in": "path",
11201 "required": true,
11202 "type": "integer",
11203 "format": "int32",
11204 "title": "Int32"
11205 },
11206 {
11207 "name": "fromDate",
11208 "in": "query",
11209 "required": true,
11210 "type": "string",
11211 "format": "date-time",
11212 "title": "DateTime"
11213 },
11214 {
11215 "name": "toDate",
11216 "in": "query",
11217 "required": true,
11218 "type": "string",
11219 "format": "date-time",
11220 "title": "DateTime"
11221 },
11222 {
11223 "name": "employeeId",
11224 "in": "path",
11225 "required": true,
11226 "type": "string"
11227 }
11228 ],
11229 "responses": {
11230 "200": {
11231 "description": "OK",
11232 "schema": {
11233 "$ref": "#/definitions/LeaveEstimate"
11234 }
11235 }
11236 }
11237 }
11238 },
11239 "/api/v2/business/{businessId}/location": {
11240 "get": {
11241 "tags": [
11242 "Location"
11243 ],
11244 "summary": "List Business Locations",
11245 "description": "Lists all the locations for a business.\n\nThis operation supports OData queries.",
11246 "operationId": "Location_GetLocations",
11247 "consumes": [],
11248 "produces": [
11249 "application/json",
11250 "text/json",
11251 "application/xml",
11252 "text/xml"
11253 ],
11254 "parameters": [
11255 {
11256 "name": "businessId",
11257 "in": "path",
11258 "required": true,
11259 "type": "string"
11260 }
11261 ],
11262 "responses": {
11263 "200": {
11264 "description": "OK",
11265 "schema": {
11266 "type": "array",
11267 "items": {
11268 "$ref": "#/definitions/LocationModel"
11269 },
11270 "xml": {
11271 "name": "LocationModel",
11272 "wrapped": true
11273 },
11274 "title": "IEnumerable<LocationModel>"
11275 }
11276 }
11277 }
11278 },
11279 "post": {
11280 "tags": [
11281 "Location"
11282 ],
11283 "summary": "Create Location",
11284 "description": "Creates a business location.",
11285 "operationId": "Location_Post",
11286 "consumes": [
11287 "application/json",
11288 "text/json",
11289 "application/xml",
11290 "text/xml",
11291 "application/x-www-form-urlencoded"
11292 ],
11293 "produces": [
11294 "application/json",
11295 "text/json",
11296 "application/xml",
11297 "text/xml"
11298 ],
11299 "parameters": [
11300 {
11301 "name": "location",
11302 "in": "body",
11303 "required": true,
11304 "schema": {
11305 "$ref": "#/definitions/LocationModel"
11306 }
11307 },
11308 {
11309 "name": "businessId",
11310 "in": "path",
11311 "required": true,
11312 "type": "string"
11313 }
11314 ],
11315 "responses": {
11316 "200": {
11317 "description": "OK"
11318 }
11319 }
11320 }
11321 },
11322 "/api/v2/business/{businessId}/employee/{employeeId}/location": {
11323 "get": {
11324 "tags": [
11325 "Location"
11326 ],
11327 "summary": "List Business Locations",
11328 "description": "Lists all the locations for a business.\n\nThis operation supports OData queries.",
11329 "operationId": "Location_GetApiV2BusinessByBusinessIdEmployeeByEmployeeIdLocation",
11330 "consumes": [],
11331 "produces": [
11332 "application/json",
11333 "text/json",
11334 "application/xml",
11335 "text/xml"
11336 ],
11337 "parameters": [
11338 {
11339 "name": "businessId",
11340 "in": "path",
11341 "required": true,
11342 "type": "string"
11343 },
11344 {
11345 "name": "employeeId",
11346 "in": "path",
11347 "required": true,
11348 "type": "string"
11349 }
11350 ],
11351 "responses": {
11352 "200": {
11353 "description": "OK",
11354 "schema": {
11355 "type": "array",
11356 "items": {
11357 "$ref": "#/definitions/LocationModel"
11358 },
11359 "xml": {
11360 "name": "LocationModel",
11361 "wrapped": true
11362 },
11363 "title": "IEnumerable<LocationModel>"
11364 }
11365 }
11366 }
11367 }
11368 },
11369 "/api/v2/business/{businessId}/location/{id}": {
11370 "get": {
11371 "tags": [
11372 "Location"
11373 ],
11374 "summary": "Get Location By Id",
11375 "description": "Retrieves the details of the location with the specified ID.",
11376 "operationId": "Location_Get",
11377 "consumes": [],
11378 "produces": [
11379 "application/json",
11380 "text/json",
11381 "application/xml",
11382 "text/xml"
11383 ],
11384 "parameters": [
11385 {
11386 "name": "id",
11387 "in": "path",
11388 "required": true,
11389 "type": "integer",
11390 "format": "int32",
11391 "title": "Int32"
11392 },
11393 {
11394 "name": "businessId",
11395 "in": "path",
11396 "required": true,
11397 "type": "string"
11398 }
11399 ],
11400 "responses": {
11401 "200": {
11402 "description": "OK",
11403 "schema": {
11404 "$ref": "#/definitions/LocationModel"
11405 }
11406 }
11407 }
11408 },
11409 "put": {
11410 "tags": [
11411 "Location"
11412 ],
11413 "summary": "Update Location",
11414 "description": "Updates the business location with the specified ID.",
11415 "operationId": "Location_Put",
11416 "consumes": [
11417 "application/json",
11418 "text/json",
11419 "application/xml",
11420 "text/xml",
11421 "application/x-www-form-urlencoded"
11422 ],
11423 "produces": [
11424 "application/json",
11425 "text/json",
11426 "application/xml",
11427 "text/xml"
11428 ],
11429 "parameters": [
11430 {
11431 "name": "id",
11432 "in": "path",
11433 "required": true,
11434 "type": "integer",
11435 "format": "int32",
11436 "title": "Int32"
11437 },
11438 {
11439 "name": "location",
11440 "in": "body",
11441 "required": true,
11442 "schema": {
11443 "$ref": "#/definitions/LocationModel"
11444 }
11445 },
11446 {
11447 "name": "businessId",
11448 "in": "path",
11449 "required": true,
11450 "type": "string"
11451 }
11452 ],
11453 "responses": {
11454 "200": {
11455 "description": "OK"
11456 }
11457 }
11458 },
11459 "delete": {
11460 "tags": [
11461 "Location"
11462 ],
11463 "summary": "Delete Location",
11464 "description": "Deletes the location with the specified ID.",
11465 "operationId": "Location_Delete",
11466 "consumes": [],
11467 "produces": [
11468 "application/json",
11469 "text/json",
11470 "application/xml",
11471 "text/xml"
11472 ],
11473 "parameters": [
11474 {
11475 "name": "id",
11476 "in": "path",
11477 "required": true,
11478 "type": "integer",
11479 "format": "int32",
11480 "title": "Int32"
11481 },
11482 {
11483 "name": "businessId",
11484 "in": "path",
11485 "required": true,
11486 "type": "string"
11487 }
11488 ],
11489 "responses": {
11490 "200": {
11491 "description": "OK"
11492 }
11493 }
11494 }
11495 },
11496 "/api/v2/business/{businessId}/lookupdata/reports": {
11497 "get": {
11498 "tags": [
11499 "LookupData"
11500 ],
11501 "summary": "List Report Types",
11502 "description": "Lists all of the report types.",
11503 "operationId": "LookupData_Reports",
11504 "consumes": [],
11505 "produces": [
11506 "application/json",
11507 "text/json",
11508 "application/xml",
11509 "text/xml"
11510 ],
11511 "parameters": [
11512 {
11513 "name": "businessId",
11514 "in": "path",
11515 "required": true,
11516 "type": "string"
11517 }
11518 ],
11519 "responses": {
11520 "200": {
11521 "description": "OK",
11522 "schema": {
11523 "type": "array",
11524 "items": {
11525 "$ref": "#/definitions/NameIdPair"
11526 },
11527 "xml": {
11528 "name": "NameIdPair",
11529 "wrapped": true
11530 },
11531 "title": "List<NameIdPair>"
11532 }
11533 }
11534 }
11535 }
11536 },
11537 "/api/v2/business/{businessId}/lookupdata/employeegrouppermissions": {
11538 "get": {
11539 "tags": [
11540 "LookupData"
11541 ],
11542 "summary": "List Employee Group Permission Types",
11543 "description": "Lists all of the employee group permission types.",
11544 "operationId": "LookupData_EmployeeGroupPermissions",
11545 "consumes": [],
11546 "produces": [
11547 "application/json",
11548 "text/json",
11549 "application/xml",
11550 "text/xml"
11551 ],
11552 "parameters": [
11553 {
11554 "name": "businessId",
11555 "in": "path",
11556 "required": true,
11557 "type": "string"
11558 }
11559 ],
11560 "responses": {
11561 "200": {
11562 "description": "OK",
11563 "schema": {
11564 "type": "array",
11565 "items": {
11566 "$ref": "#/definitions/NameIdPair"
11567 },
11568 "xml": {
11569 "name": "NameIdPair",
11570 "wrapped": true
11571 },
11572 "title": "List<NameIdPair>"
11573 }
11574 }
11575 }
11576 }
11577 },
11578 "/api/v2/business/{businessId}/lookupdata/timezones": {
11579 "get": {
11580 "tags": [
11581 "LookupData"
11582 ],
11583 "summary": "List Time Zone Types",
11584 "description": "Lists all of the time zone types.",
11585 "operationId": "LookupData_TimeZones",
11586 "consumes": [],
11587 "produces": [
11588 "application/json",
11589 "text/json",
11590 "application/xml",
11591 "text/xml"
11592 ],
11593 "parameters": [
11594 {
11595 "name": "businessId",
11596 "in": "path",
11597 "required": true,
11598 "type": "string"
11599 }
11600 ],
11601 "responses": {
11602 "200": {
11603 "description": "OK",
11604 "schema": {
11605 "type": "array",
11606 "items": {
11607 "$ref": "#/definitions/NameIdPair"
11608 },
11609 "xml": {
11610 "name": "NameIdPair",
11611 "wrapped": true
11612 },
11613 "title": "List<NameIdPair>"
11614 }
11615 }
11616 }
11617 }
11618 },
11619 "/api/v2/ess/{employeeId}/shift": {
11620 "get": {
11621 "tags": [
11622 "Other"
11623 ],
11624 "summary": "List Roster Shifts",
11625 "description": "Gets the employee's roster shifts within the date range.",
11626 "operationId": "EssShift_Shifts",
11627 "consumes": [],
11628 "produces": [
11629 "application/json",
11630 "text/json",
11631 "application/xml",
11632 "text/xml"
11633 ],
11634 "parameters": [
11635 {
11636 "name": "fromDate",
11637 "in": "query",
11638 "required": true,
11639 "type": "string",
11640 "format": "date-time",
11641 "title": "DateTime"
11642 },
11643 {
11644 "name": "toDate",
11645 "in": "query",
11646 "required": true,
11647 "type": "string",
11648 "format": "date-time",
11649 "title": "DateTime"
11650 },
11651 {
11652 "name": "employeeId",
11653 "in": "path",
11654 "required": true,
11655 "type": "string"
11656 }
11657 ],
11658 "responses": {
11659 "200": {
11660 "description": "OK",
11661 "schema": {
11662 "type": "array",
11663 "items": {
11664 "$ref": "#/definitions/EssRosterShiftModel"
11665 },
11666 "xml": {
11667 "name": "EssRosterShiftModel",
11668 "wrapped": true
11669 },
11670 "title": "List<EssRosterShiftModel>"
11671 }
11672 }
11673 }
11674 }
11675 },
11676 "/api/v2/ess/{employeeId}/shift/{shiftId}": {
11677 "get": {
11678 "tags": [
11679 "Other"
11680 ],
11681 "summary": "Get Roster Shift by ID",
11682 "description": "Gets the roster shift with the specified ID (as long as it is assigned to this employee).",
11683 "operationId": "EssShift_Shift",
11684 "consumes": [],
11685 "produces": [
11686 "application/json",
11687 "text/json",
11688 "application/xml",
11689 "text/xml"
11690 ],
11691 "parameters": [
11692 {
11693 "name": "shiftId",
11694 "in": "path",
11695 "required": true,
11696 "type": "integer",
11697 "format": "int32",
11698 "title": "Int32"
11699 },
11700 {
11701 "name": "employeeId",
11702 "in": "path",
11703 "required": true,
11704 "type": "string"
11705 }
11706 ],
11707 "responses": {
11708 "200": {
11709 "description": "OK",
11710 "schema": {
11711 "$ref": "#/definitions/EssRosterShiftModel"
11712 }
11713 }
11714 }
11715 }
11716 },
11717 "/api/v2/ess/{employeeId}/shift/{shiftId}/decline": {
11718 "post": {
11719 "tags": [
11720 "Other"
11721 ],
11722 "summary": "Decline Roster Shift",
11723 "description": "Declines the roster shift with the specified ID.",
11724 "operationId": "EssShift_DeclineShift",
11725 "consumes": [
11726 "application/json",
11727 "text/json",
11728 "application/xml",
11729 "text/xml",
11730 "application/x-www-form-urlencoded"
11731 ],
11732 "produces": [
11733 "application/json",
11734 "text/json",
11735 "application/xml",
11736 "text/xml"
11737 ],
11738 "parameters": [
11739 {
11740 "name": "shiftId",
11741 "in": "path",
11742 "required": true,
11743 "type": "integer",
11744 "format": "int32",
11745 "title": "Int32"
11746 },
11747 {
11748 "name": "model",
11749 "in": "body",
11750 "required": true,
11751 "schema": {
11752 "$ref": "#/definitions/EssDeclineRosterShiftModel"
11753 }
11754 },
11755 {
11756 "name": "employeeId",
11757 "in": "path",
11758 "required": true,
11759 "type": "string"
11760 }
11761 ],
11762 "responses": {
11763 "200": {
11764 "description": "OK"
11765 }
11766 }
11767 }
11768 },
11769 "/api/v2/ess/{employeeId}/shift/{shiftId}/accept": {
11770 "post": {
11771 "tags": [
11772 "Other"
11773 ],
11774 "summary": "Accept Roster Shift",
11775 "description": "Accepts the roster shift with the specified ID.",
11776 "operationId": "EssShift_AcceptShift",
11777 "consumes": [],
11778 "produces": [
11779 "application/json",
11780 "text/json",
11781 "application/xml",
11782 "text/xml"
11783 ],
11784 "parameters": [
11785 {
11786 "name": "shiftId",
11787 "in": "path",
11788 "required": true,
11789 "type": "integer",
11790 "format": "int32",
11791 "title": "Int32"
11792 },
11793 {
11794 "name": "employeeId",
11795 "in": "path",
11796 "required": true,
11797 "type": "string"
11798 }
11799 ],
11800 "responses": {
11801 "200": {
11802 "description": "OK"
11803 }
11804 }
11805 }
11806 },
11807 "/api/v2/ess/{employeeId}/shift/accept": {
11808 "post": {
11809 "tags": [
11810 "Other"
11811 ],
11812 "summary": "Bulk Accept Roster Shifts",
11813 "description": "Accepts a number of roster shifts by ID.",
11814 "operationId": "EssShift_AcceptShifts",
11815 "consumes": [
11816 "application/json",
11817 "text/json",
11818 "application/xml",
11819 "text/xml",
11820 "application/x-www-form-urlencoded"
11821 ],
11822 "produces": [
11823 "application/json",
11824 "text/json",
11825 "application/xml",
11826 "text/xml"
11827 ],
11828 "parameters": [
11829 {
11830 "name": "model",
11831 "in": "body",
11832 "required": true,
11833 "schema": {
11834 "$ref": "#/definitions/EssBulkAcceptRosterShiftsModel"
11835 }
11836 },
11837 {
11838 "name": "employeeId",
11839 "in": "path",
11840 "required": true,
11841 "type": "string"
11842 }
11843 ],
11844 "responses": {
11845 "200": {
11846 "description": "OK"
11847 }
11848 }
11849 }
11850 },
11851 "/api/v2/ess/{employeeId}/shift/decline": {
11852 "post": {
11853 "tags": [
11854 "Other"
11855 ],
11856 "summary": "Bulk Decline Roster Shifts",
11857 "description": "Declines a number of roster shifts by ID.",
11858 "operationId": "EssShift_DeclineShifts",
11859 "consumes": [
11860 "application/json",
11861 "text/json",
11862 "application/xml",
11863 "text/xml",
11864 "application/x-www-form-urlencoded"
11865 ],
11866 "produces": [
11867 "application/json",
11868 "text/json",
11869 "application/xml",
11870 "text/xml"
11871 ],
11872 "parameters": [
11873 {
11874 "name": "model",
11875 "in": "body",
11876 "required": true,
11877 "schema": {
11878 "$ref": "#/definitions/EssBulkDeclineRosterShiftsModel"
11879 }
11880 },
11881 {
11882 "name": "employeeId",
11883 "in": "path",
11884 "required": true,
11885 "type": "string"
11886 }
11887 ],
11888 "responses": {
11889 "200": {
11890 "description": "OK"
11891 }
11892 }
11893 }
11894 },
11895 "/api/v2/ess/{employeeId}/shift/nearby": {
11896 "get": {
11897 "tags": [
11898 "Other"
11899 ],
11900 "summary": "Find Nearby Roster Shifts",
11901 "description": "Finds any of the employee's roster shifts that are nearby to the specified local time.",
11902 "operationId": "EssShift_NearbyRosterShifts",
11903 "consumes": [],
11904 "produces": [
11905 "application/json",
11906 "text/json",
11907 "application/xml",
11908 "text/xml"
11909 ],
11910 "parameters": [
11911 {
11912 "name": "localTime",
11913 "in": "query",
11914 "required": true,
11915 "type": "string",
11916 "format": "date-time",
11917 "title": "DateTime"
11918 },
11919 {
11920 "name": "employeeId",
11921 "in": "path",
11922 "required": true,
11923 "type": "string"
11924 }
11925 ],
11926 "responses": {
11927 "200": {
11928 "description": "OK",
11929 "schema": {
11930 "type": "array",
11931 "items": {
11932 "$ref": "#/definitions/EssRosterShiftModel"
11933 },
11934 "xml": {
11935 "name": "EssRosterShiftModel",
11936 "wrapped": true
11937 },
11938 "title": "IList<EssRosterShiftModel>"
11939 }
11940 }
11941 }
11942 }
11943 },
11944 "/api/v2/ess/{employeeId}/shift/matchingclockon": {
11945 "get": {
11946 "tags": [
11947 "Other"
11948 ],
11949 "summary": "Find Matching Clock On Roster Shift",
11950 "description": "If a roster shift exists that could match for this employee to clock on at this time \r\ngiven ESS settings for shift matching, returns that shift.\r\nOtherwise, the Shift result will be null.\r\nNote that if the time matches a shift exactly, the Shift result will also be null.",
11951 "operationId": "EssShift_MatchingClockOnRosterShift",
11952 "consumes": [],
11953 "produces": [
11954 "application/json",
11955 "text/json",
11956 "application/xml",
11957 "text/xml"
11958 ],
11959 "parameters": [
11960 {
11961 "name": "localTime",
11962 "in": "query",
11963 "required": true,
11964 "type": "string",
11965 "format": "date-time",
11966 "title": "DateTime"
11967 },
11968 {
11969 "name": "employeeId",
11970 "in": "path",
11971 "required": true,
11972 "type": "string"
11973 }
11974 ],
11975 "responses": {
11976 "200": {
11977 "description": "OK",
11978 "schema": {
11979 "$ref": "#/definitions/RosterShiftMatchingResultModel"
11980 }
11981 }
11982 }
11983 }
11984 },
11985 "/api/v2/ess/{employeeId}/shift/matchingclockoff": {
11986 "get": {
11987 "tags": [
11988 "Other"
11989 ],
11990 "summary": "Find Matching Clock Off Roster Shift",
11991 "description": "If a roster shift exists that could match for this employee to clock off at this time \r\ngiven ESS settings for shift matching, returns that shift.\r\nOtherwise, the Shift result will be null.\r\nNote that if the time matches a shift exactly, the Shift result will also be null.",
11992 "operationId": "EssShift_MatchingClockOffRosterShift",
11993 "consumes": [],
11994 "produces": [
11995 "application/json",
11996 "text/json",
11997 "application/xml",
11998 "text/xml"
11999 ],
12000 "parameters": [
12001 {
12002 "name": "localTime",
12003 "in": "query",
12004 "required": true,
12005 "type": "string",
12006 "format": "date-time",
12007 "title": "DateTime"
12008 },
12009 {
12010 "name": "employeeId",
12011 "in": "path",
12012 "required": true,
12013 "type": "string"
12014 }
12015 ],
12016 "responses": {
12017 "200": {
12018 "description": "OK",
12019 "schema": {
12020 "$ref": "#/definitions/RosterShiftMatchingResultModel"
12021 }
12022 }
12023 }
12024 }
12025 },
12026 "/api/v2/ess/{employeeId}/shift/{shiftId}/swap/candidates": {
12027 "get": {
12028 "tags": [
12029 "Other"
12030 ],
12031 "operationId": "EssShift_EmployeesEligibleForSwap",
12032 "consumes": [],
12033 "produces": [
12034 "application/json",
12035 "text/json",
12036 "application/xml",
12037 "text/xml"
12038 ],
12039 "parameters": [
12040 {
12041 "name": "shiftId",
12042 "in": "path",
12043 "required": true,
12044 "type": "integer",
12045 "format": "int32",
12046 "title": "Int32"
12047 },
12048 {
12049 "name": "employeeId",
12050 "in": "path",
12051 "required": true,
12052 "type": "string"
12053 }
12054 ],
12055 "responses": {
12056 "200": {
12057 "description": "OK"
12058 }
12059 }
12060 }
12061 },
12062 "/api/v2/ess/{employeeId}/shift/swap/propose": {
12063 "post": {
12064 "tags": [
12065 "Other"
12066 ],
12067 "operationId": "EssShift_ProposeShiftSwap",
12068 "consumes": [
12069 "application/json",
12070 "text/json",
12071 "application/xml",
12072 "text/xml",
12073 "application/x-www-form-urlencoded"
12074 ],
12075 "produces": [
12076 "application/json",
12077 "text/json",
12078 "application/xml",
12079 "text/xml"
12080 ],
12081 "parameters": [
12082 {
12083 "name": "model",
12084 "in": "body",
12085 "required": true,
12086 "schema": {
12087 "$ref": "#/definitions/SwapShiftModel"
12088 }
12089 },
12090 {
12091 "name": "employeeId",
12092 "in": "path",
12093 "required": true,
12094 "type": "string"
12095 }
12096 ],
12097 "responses": {
12098 "200": {
12099 "description": "OK"
12100 }
12101 }
12102 }
12103 },
12104 "/api/v2/ess/{employeeId}/shift/{shiftId}/swap/cancel": {
12105 "post": {
12106 "tags": [
12107 "Other"
12108 ],
12109 "operationId": "EssShift_CancelShiftSwap",
12110 "consumes": [],
12111 "produces": [
12112 "application/json",
12113 "text/json",
12114 "application/xml",
12115 "text/xml"
12116 ],
12117 "parameters": [
12118 {
12119 "name": "shiftId",
12120 "in": "path",
12121 "required": true,
12122 "type": "integer",
12123 "format": "int32",
12124 "title": "Int32"
12125 },
12126 {
12127 "name": "employeeId",
12128 "in": "path",
12129 "required": true,
12130 "type": "string"
12131 }
12132 ],
12133 "responses": {
12134 "200": {
12135 "description": "OK"
12136 }
12137 }
12138 }
12139 },
12140 "/api/v2/ess/{employeeId}/shift/{shiftId}/swap/accept": {
12141 "post": {
12142 "tags": [
12143 "Other"
12144 ],
12145 "operationId": "EssShift_AcceptShiftSwap",
12146 "consumes": [],
12147 "produces": [
12148 "application/json",
12149 "text/json",
12150 "application/xml",
12151 "text/xml"
12152 ],
12153 "parameters": [
12154 {
12155 "name": "shiftId",
12156 "in": "path",
12157 "required": true,
12158 "type": "integer",
12159 "format": "int32",
12160 "title": "Int32"
12161 },
12162 {
12163 "name": "employeeId",
12164 "in": "path",
12165 "required": true,
12166 "type": "string"
12167 }
12168 ],
12169 "responses": {
12170 "200": {
12171 "description": "OK"
12172 }
12173 }
12174 }
12175 },
12176 "/api/v2/ess/{employeeId}/shift/{shiftId}/swap/decline": {
12177 "post": {
12178 "tags": [
12179 "Other"
12180 ],
12181 "operationId": "EssShift_DeclineShiftSwap",
12182 "consumes": [],
12183 "produces": [
12184 "application/json",
12185 "text/json",
12186 "application/xml",
12187 "text/xml"
12188 ],
12189 "parameters": [
12190 {
12191 "name": "shiftId",
12192 "in": "path",
12193 "required": true,
12194 "type": "integer",
12195 "format": "int32",
12196 "title": "Int32"
12197 },
12198 {
12199 "name": "employeeId",
12200 "in": "path",
12201 "required": true,
12202 "type": "string"
12203 }
12204 ],
12205 "responses": {
12206 "200": {
12207 "description": "OK"
12208 }
12209 }
12210 }
12211 },
12212 "/api/v2/ess/{employeeId}/shift/swap/accept": {
12213 "post": {
12214 "tags": [
12215 "Other"
12216 ],
12217 "summary": "Bulk Accept Roster Shift Swaps",
12218 "description": "Accepts a number of roster shift swaps by shift ID.",
12219 "operationId": "EssShift_AcceptShiftSwaps",
12220 "consumes": [
12221 "application/json",
12222 "text/json",
12223 "application/xml",
12224 "text/xml",
12225 "application/x-www-form-urlencoded"
12226 ],
12227 "produces": [
12228 "application/json",
12229 "text/json",
12230 "application/xml",
12231 "text/xml"
12232 ],
12233 "parameters": [
12234 {
12235 "name": "model",
12236 "in": "body",
12237 "required": true,
12238 "schema": {
12239 "$ref": "#/definitions/EssBulkRosterShiftSwapModel"
12240 }
12241 },
12242 {
12243 "name": "employeeId",
12244 "in": "path",
12245 "required": true,
12246 "type": "string"
12247 }
12248 ],
12249 "responses": {
12250 "200": {
12251 "description": "OK"
12252 }
12253 }
12254 }
12255 },
12256 "/api/v2/ess/{employeeId}/shift/swap/decline": {
12257 "post": {
12258 "tags": [
12259 "Other"
12260 ],
12261 "summary": "Bulk Decline Roster Shift Swaps",
12262 "description": "Declines a number of roster shift swaps by shift ID.",
12263 "operationId": "EssShift_DeclineShiftSwaps",
12264 "consumes": [
12265 "application/json",
12266 "text/json",
12267 "application/xml",
12268 "text/xml",
12269 "application/x-www-form-urlencoded"
12270 ],
12271 "produces": [
12272 "application/json",
12273 "text/json",
12274 "application/xml",
12275 "text/xml"
12276 ],
12277 "parameters": [
12278 {
12279 "name": "model",
12280 "in": "body",
12281 "required": true,
12282 "schema": {
12283 "$ref": "#/definitions/EssBulkRosterShiftSwapModel"
12284 }
12285 },
12286 {
12287 "name": "employeeId",
12288 "in": "path",
12289 "required": true,
12290 "type": "string"
12291 }
12292 ],
12293 "responses": {
12294 "200": {
12295 "description": "OK"
12296 }
12297 }
12298 }
12299 },
12300 "/api/v2/ess/{employeeId}/shift/swap/cancel": {
12301 "post": {
12302 "tags": [
12303 "Other"
12304 ],
12305 "summary": "Bulk Cancel Roster Shift Swaps",
12306 "description": "Cancels a number of roster shift swaps by shift ID.",
12307 "operationId": "EssShift_CancelShiftSwaps",
12308 "consumes": [
12309 "application/json",
12310 "text/json",
12311 "application/xml",
12312 "text/xml",
12313 "application/x-www-form-urlencoded"
12314 ],
12315 "produces": [
12316 "application/json",
12317 "text/json",
12318 "application/xml",
12319 "text/xml"
12320 ],
12321 "parameters": [
12322 {
12323 "name": "model",
12324 "in": "body",
12325 "required": true,
12326 "schema": {
12327 "$ref": "#/definitions/EssBulkRosterShiftSwapModel"
12328 }
12329 },
12330 {
12331 "name": "employeeId",
12332 "in": "path",
12333 "required": true,
12334 "type": "string"
12335 }
12336 ],
12337 "responses": {
12338 "200": {
12339 "description": "OK"
12340 }
12341 }
12342 }
12343 },
12344 "/api/v2/business/{businessId}/report/tasks": {
12345 "get": {
12346 "tags": [
12347 "Other"
12348 ],
12349 "operationId": "ReportsTasksReport_Get",
12350 "consumes": [],
12351 "produces": [
12352 "application/json",
12353 "text/json",
12354 "application/xml",
12355 "text/xml"
12356 ],
12357 "parameters": [
12358 {
12359 "name": "businessId",
12360 "in": "path",
12361 "required": true,
12362 "type": "string"
12363 },
12364 {
12365 "name": "request.employeeId",
12366 "in": "query",
12367 "required": false,
12368 "type": "integer",
12369 "format": "int32",
12370 "title": "Int32"
12371 },
12372 {
12373 "name": "request.payRunId",
12374 "in": "query",
12375 "required": false,
12376 "type": "integer",
12377 "format": "int32",
12378 "title": "Int32"
12379 },
12380 {
12381 "name": "request.fromDate",
12382 "in": "query",
12383 "required": false,
12384 "type": "string",
12385 "format": "date-time",
12386 "title": "Nullable<DateTime>"
12387 },
12388 {
12389 "name": "request.toDate",
12390 "in": "query",
12391 "required": false,
12392 "type": "string",
12393 "format": "date-time",
12394 "title": "Nullable<DateTime>"
12395 },
12396 {
12397 "name": "request.payScheduleId",
12398 "in": "query",
12399 "required": false,
12400 "type": "integer",
12401 "format": "int32",
12402 "title": "Int32"
12403 },
12404 {
12405 "name": "request.status",
12406 "in": "query",
12407 "required": false,
12408 "type": "string",
12409 "enum": [
12410 "All",
12411 "Completed",
12412 "NotCompleted"
12413 ],
12414 "title": "TasksReportStatusEnum"
12415 }
12416 ],
12417 "responses": {
12418 "200": {
12419 "description": "OK",
12420 "schema": {
12421 "type": "array",
12422 "items": {
12423 "$ref": "#/definitions/TasksReportExportModel"
12424 },
12425 "xml": {
12426 "name": "TasksReportExportModel",
12427 "wrapped": true
12428 },
12429 "title": "IList<TasksReportExportModel>"
12430 }
12431 }
12432 }
12433 }
12434 },
12435 "/api/v2/business/{businessId}/report/shiftswapping": {
12436 "get": {
12437 "tags": [
12438 "Other"
12439 ],
12440 "operationId": "ReportsShiftSwapping_Get",
12441 "consumes": [],
12442 "produces": [
12443 "application/json",
12444 "text/json",
12445 "application/xml",
12446 "text/xml"
12447 ],
12448 "parameters": [
12449 {
12450 "name": "businessId",
12451 "in": "path",
12452 "required": true,
12453 "type": "string"
12454 },
12455 {
12456 "name": "request.fromEmployeeId",
12457 "in": "query",
12458 "required": false,
12459 "type": "integer",
12460 "format": "int32",
12461 "title": "Nullable<Int32>"
12462 },
12463 {
12464 "name": "request.toEmployeeId",
12465 "in": "query",
12466 "required": false,
12467 "type": "integer",
12468 "format": "int32",
12469 "title": "Nullable<Int32>"
12470 },
12471 {
12472 "name": "request.includeCosts",
12473 "in": "query",
12474 "required": false,
12475 "type": "boolean",
12476 "title": "Boolean"
12477 },
12478 {
12479 "name": "request.statuses",
12480 "in": "query",
12481 "required": false,
12482 "type": "array",
12483 "items": {
12484 "type": "string",
12485 "enum": [
12486 "Created",
12487 "Cancelled",
12488 "Accepted",
12489 "Declined",
12490 "AwaitingManagerApproval",
12491 "ApprovedByManager",
12492 "RejectedByManager"
12493 ],
12494 "title": "RosterShiftSwapStatusEnum"
12495 },
12496 "collectionFormat": "multi",
12497 "title": "IList<RosterShiftSwapStatusEnum>"
12498 },
12499 {
12500 "name": "request.fromDate",
12501 "in": "query",
12502 "required": false,
12503 "type": "string",
12504 "format": "date-time",
12505 "title": "DateTime"
12506 },
12507 {
12508 "name": "request.toDate",
12509 "in": "query",
12510 "required": false,
12511 "type": "string",
12512 "format": "date-time",
12513 "title": "DateTime"
12514 },
12515 {
12516 "name": "request.locationId",
12517 "in": "query",
12518 "required": false,
12519 "type": "integer",
12520 "format": "int32",
12521 "title": "Int32"
12522 },
12523 {
12524 "name": "request.employingEntityId",
12525 "in": "query",
12526 "required": false,
12527 "type": "integer",
12528 "format": "int32",
12529 "title": "Nullable<Int32>"
12530 }
12531 ],
12532 "responses": {
12533 "200": {
12534 "description": "OK",
12535 "schema": {
12536 "type": "array",
12537 "items": {
12538 "$ref": "#/definitions/ShiftSwappingReportExportModel"
12539 },
12540 "xml": {
12541 "name": "ShiftSwappingReportExportModel",
12542 "wrapped": true
12543 },
12544 "title": "IList<ShiftSwappingReportExportModel>"
12545 }
12546 }
12547 }
12548 }
12549 },
12550 "/api/v2/business/{businessId}/paycategory": {
12551 "get": {
12552 "tags": [
12553 "PayCategory"
12554 ],
12555 "summary": "List Pay Categories",
12556 "description": "Lists all the pay categories for the business\n\nThis operation supports OData queries.",
12557 "operationId": "PayCategory_GetPayCategories",
12558 "consumes": [],
12559 "produces": [
12560 "application/json",
12561 "text/json",
12562 "application/xml",
12563 "text/xml"
12564 ],
12565 "parameters": [
12566 {
12567 "name": "businessId",
12568 "in": "path",
12569 "required": true,
12570 "type": "string"
12571 }
12572 ],
12573 "responses": {
12574 "200": {
12575 "description": "OK",
12576 "schema": {
12577 "type": "array",
12578 "items": {
12579 "$ref": "#/definitions/PayCategoryModel"
12580 },
12581 "xml": {
12582 "name": "PayCategoryModel",
12583 "wrapped": true
12584 },
12585 "title": "IEnumerable<PayCategoryModel>"
12586 }
12587 }
12588 }
12589 },
12590 "post": {
12591 "tags": [
12592 "PayCategory"
12593 ],
12594 "summary": "Create Pay Category",
12595 "description": "Creates a new pay category for the business.",
12596 "operationId": "PayCategory_Post",
12597 "consumes": [
12598 "application/json",
12599 "text/json",
12600 "application/xml",
12601 "text/xml",
12602 "application/x-www-form-urlencoded"
12603 ],
12604 "produces": [
12605 "application/json",
12606 "text/json",
12607 "application/xml",
12608 "text/xml"
12609 ],
12610 "parameters": [
12611 {
12612 "name": "payCategory",
12613 "in": "body",
12614 "required": true,
12615 "schema": {
12616 "$ref": "#/definitions/PayCategoryModel"
12617 }
12618 },
12619 {
12620 "name": "businessId",
12621 "in": "path",
12622 "required": true,
12623 "type": "string"
12624 }
12625 ],
12626 "responses": {
12627 "200": {
12628 "description": "OK"
12629 }
12630 }
12631 }
12632 },
12633 "/api/v2/business/{businessId}/paycategory/{id}": {
12634 "get": {
12635 "tags": [
12636 "PayCategory"
12637 ],
12638 "summary": "Get Pay Category by ID",
12639 "description": "Gets the pay category with the specified ID.",
12640 "operationId": "PayCategory_Get",
12641 "consumes": [],
12642 "produces": [
12643 "application/json",
12644 "text/json",
12645 "application/xml",
12646 "text/xml"
12647 ],
12648 "parameters": [
12649 {
12650 "name": "id",
12651 "in": "path",
12652 "required": true,
12653 "type": "integer",
12654 "format": "int32",
12655 "title": "Int32"
12656 },
12657 {
12658 "name": "businessId",
12659 "in": "path",
12660 "required": true,
12661 "type": "string"
12662 }
12663 ],
12664 "responses": {
12665 "200": {
12666 "description": "OK",
12667 "schema": {
12668 "$ref": "#/definitions/PayCategoryModel"
12669 }
12670 }
12671 }
12672 },
12673 "put": {
12674 "tags": [
12675 "PayCategory"
12676 ],
12677 "summary": "Update Pay Category",
12678 "description": "Updates the pay category with the specified ID.",
12679 "operationId": "PayCategory_Put",
12680 "consumes": [
12681 "application/json",
12682 "text/json",
12683 "application/xml",
12684 "text/xml",
12685 "application/x-www-form-urlencoded"
12686 ],
12687 "produces": [
12688 "application/json",
12689 "text/json",
12690 "application/xml",
12691 "text/xml"
12692 ],
12693 "parameters": [
12694 {
12695 "name": "id",
12696 "in": "path",
12697 "required": true,
12698 "type": "integer",
12699 "format": "int32",
12700 "title": "Int32"
12701 },
12702 {
12703 "name": "payCategory",
12704 "in": "body",
12705 "required": true,
12706 "schema": {
12707 "$ref": "#/definitions/PayCategoryModel"
12708 }
12709 },
12710 {
12711 "name": "businessId",
12712 "in": "path",
12713 "required": true,
12714 "type": "string"
12715 }
12716 ],
12717 "responses": {
12718 "200": {
12719 "description": "OK"
12720 }
12721 }
12722 },
12723 "delete": {
12724 "tags": [
12725 "PayCategory"
12726 ],
12727 "summary": "Delete Pay Category",
12728 "description": "Deletes the pay category with the specified ID.",
12729 "operationId": "PayCategory_Delete",
12730 "consumes": [],
12731 "produces": [
12732 "application/json",
12733 "text/json",
12734 "application/xml",
12735 "text/xml"
12736 ],
12737 "parameters": [
12738 {
12739 "name": "id",
12740 "in": "path",
12741 "required": true,
12742 "type": "integer",
12743 "format": "int32",
12744 "title": "Int32"
12745 },
12746 {
12747 "name": "businessId",
12748 "in": "path",
12749 "required": true,
12750 "type": "string"
12751 }
12752 ],
12753 "responses": {
12754 "200": {
12755 "description": "OK"
12756 }
12757 }
12758 }
12759 },
12760 "/api/v2/business/{businessId}/paymentsummary/{financialYearEnding}": {
12761 "get": {
12762 "tags": [
12763 "PaymentSummary"
12764 ],
12765 "summary": "List Payment Summaries",
12766 "description": "Lists all the payment summaries for the specified financial year.\n\nThis operation supports OData queries.",
12767 "operationId": "PaymentSummary_Get",
12768 "consumes": [],
12769 "produces": [
12770 "application/json",
12771 "text/json",
12772 "application/xml",
12773 "text/xml"
12774 ],
12775 "parameters": [
12776 {
12777 "name": "financialYearEnding",
12778 "in": "path",
12779 "required": true,
12780 "type": "integer",
12781 "format": "int32",
12782 "title": "Int32"
12783 },
12784 {
12785 "name": "businessId",
12786 "in": "path",
12787 "required": true,
12788 "type": "string"
12789 }
12790 ],
12791 "responses": {
12792 "200": {
12793 "description": "OK",
12794 "schema": {
12795 "type": "array",
12796 "items": {
12797 "$ref": "#/definitions/PaygPaymentSummaryModel"
12798 },
12799 "xml": {
12800 "name": "PaygPaymentSummaryModel",
12801 "wrapped": true
12802 },
12803 "title": "IEnumerable<PaygPaymentSummaryModel>"
12804 }
12805 }
12806 }
12807 },
12808 "put": {
12809 "tags": [
12810 "PaymentSummary"
12811 ],
12812 "summary": "Generate Payment Summaries",
12813 "description": "Generates (or regenerates) payment summaries for the specified financial year/business. Only unpublished payment summaries will be regenerated.",
12814 "operationId": "PaymentSummary_Put",
12815 "consumes": [],
12816 "produces": [
12817 "application/json",
12818 "text/json",
12819 "application/xml",
12820 "text/xml"
12821 ],
12822 "parameters": [
12823 {
12824 "name": "financialYearEnding",
12825 "in": "path",
12826 "required": true,
12827 "type": "integer",
12828 "format": "int32",
12829 "title": "Int32"
12830 },
12831 {
12832 "name": "employeeId",
12833 "in": "query",
12834 "required": false,
12835 "type": "integer",
12836 "format": "int32",
12837 "title": "Nullable<Int32>"
12838 },
12839 {
12840 "name": "employingEntityId",
12841 "in": "query",
12842 "required": false,
12843 "type": "integer",
12844 "format": "int32",
12845 "title": "Nullable<Int32>"
12846 },
12847 {
12848 "name": "locationId",
12849 "in": "query",
12850 "required": false,
12851 "type": "integer",
12852 "format": "int32",
12853 "title": "Nullable<Int32>"
12854 },
12855 {
12856 "name": "businessId",
12857 "in": "path",
12858 "required": true,
12859 "type": "string"
12860 }
12861 ],
12862 "responses": {
12863 "200": {
12864 "description": "OK"
12865 }
12866 }
12867 },
12868 "post": {
12869 "tags": [
12870 "PaymentSummary"
12871 ],
12872 "summary": "Publish Payment Summaries",
12873 "description": "Publish payment summaries for the specified financial year.",
12874 "operationId": "PaymentSummary_Post",
12875 "consumes": [],
12876 "produces": [
12877 "application/json",
12878 "text/json",
12879 "application/xml",
12880 "text/xml"
12881 ],
12882 "parameters": [
12883 {
12884 "name": "financialYearEnding",
12885 "in": "path",
12886 "required": true,
12887 "type": "integer",
12888 "format": "int32",
12889 "title": "Int32"
12890 },
12891 {
12892 "name": "employeeId",
12893 "in": "query",
12894 "required": false,
12895 "type": "integer",
12896 "format": "int32",
12897 "title": "Nullable<Int32>"
12898 },
12899 {
12900 "name": "employingEntityId",
12901 "in": "query",
12902 "required": false,
12903 "type": "integer",
12904 "format": "int32",
12905 "title": "Nullable<Int32>"
12906 },
12907 {
12908 "name": "locationId",
12909 "in": "query",
12910 "required": false,
12911 "type": "integer",
12912 "format": "int32",
12913 "title": "Nullable<Int32>"
12914 },
12915 {
12916 "name": "businessId",
12917 "in": "path",
12918 "required": true,
12919 "type": "string"
12920 }
12921 ],
12922 "responses": {
12923 "200": {
12924 "description": "OK"
12925 }
12926 }
12927 },
12928 "delete": {
12929 "tags": [
12930 "PaymentSummary"
12931 ],
12932 "summary": "Unpublish Payment Summaries",
12933 "description": "Unpublish payment summaries for the specified financial year.",
12934 "operationId": "PaymentSummary_Delete",
12935 "consumes": [],
12936 "produces": [
12937 "application/json",
12938 "text/json",
12939 "application/xml",
12940 "text/xml"
12941 ],
12942 "parameters": [
12943 {
12944 "name": "financialYearEnding",
12945 "in": "path",
12946 "required": true,
12947 "type": "integer",
12948 "format": "int32",
12949 "title": "Int32"
12950 },
12951 {
12952 "name": "employeeId",
12953 "in": "query",
12954 "required": false,
12955 "type": "integer",
12956 "format": "int32",
12957 "title": "Nullable<Int32>"
12958 },
12959 {
12960 "name": "employingEntityId",
12961 "in": "query",
12962 "required": false,
12963 "type": "integer",
12964 "format": "int32",
12965 "title": "Nullable<Int32>"
12966 },
12967 {
12968 "name": "locationId",
12969 "in": "query",
12970 "required": false,
12971 "type": "integer",
12972 "format": "int32",
12973 "title": "Nullable<Int32>"
12974 },
12975 {
12976 "name": "businessId",
12977 "in": "path",
12978 "required": true,
12979 "type": "string"
12980 }
12981 ],
12982 "responses": {
12983 "200": {
12984 "description": "OK"
12985 }
12986 }
12987 }
12988 },
12989 "/api/v2/business/{businessId}/payratetemplate": {
12990 "get": {
12991 "tags": [
12992 "PayRateTemplate"
12993 ],
12994 "summary": "List Pay Rate Templates",
12995 "description": "Lists all the pay rate templates for the business.\n\nThis operation supports OData queries.",
12996 "operationId": "PayRateTemplate_GetPayRateTemplates",
12997 "consumes": [],
12998 "produces": [
12999 "application/json",
13000 "text/json",
13001 "application/xml",
13002 "text/xml"
13003 ],
13004 "parameters": [
13005 {
13006 "name": "businessId",
13007 "in": "path",
13008 "required": true,
13009 "type": "string"
13010 }
13011 ],
13012 "responses": {
13013 "200": {
13014 "description": "OK",
13015 "schema": {
13016 "type": "array",
13017 "items": {
13018 "$ref": "#/definitions/PayRateTemplateModel"
13019 },
13020 "xml": {
13021 "name": "PayRateTemplateModel",
13022 "wrapped": true
13023 },
13024 "title": "IEnumerable<PayRateTemplateModel>"
13025 }
13026 }
13027 }
13028 },
13029 "post": {
13030 "tags": [
13031 "PayRateTemplate"
13032 ],
13033 "summary": "Create Pay Rate Template",
13034 "description": "Creates a new pay rate template for the business.",
13035 "operationId": "PayRateTemplate_Post",
13036 "consumes": [
13037 "application/json",
13038 "text/json",
13039 "application/xml",
13040 "text/xml",
13041 "application/x-www-form-urlencoded"
13042 ],
13043 "produces": [
13044 "application/json",
13045 "text/json",
13046 "application/xml",
13047 "text/xml"
13048 ],
13049 "parameters": [
13050 {
13051 "name": "payRateTemplate",
13052 "in": "body",
13053 "required": true,
13054 "schema": {
13055 "$ref": "#/definitions/PayRateTemplateModel"
13056 }
13057 },
13058 {
13059 "name": "businessId",
13060 "in": "path",
13061 "required": true,
13062 "type": "string"
13063 }
13064 ],
13065 "responses": {
13066 "200": {
13067 "description": "OK"
13068 }
13069 }
13070 }
13071 },
13072 "/api/v2/business/{businessId}/payratetemplate/{id}": {
13073 "get": {
13074 "tags": [
13075 "PayRateTemplate"
13076 ],
13077 "summary": "Get Pay Rate Template by ID",
13078 "description": "Gets the pay rate template with the specified ID.",
13079 "operationId": "PayRateTemplate_Get",
13080 "consumes": [],
13081 "produces": [
13082 "application/json",
13083 "text/json",
13084 "application/xml",
13085 "text/xml"
13086 ],
13087 "parameters": [
13088 {
13089 "name": "id",
13090 "in": "path",
13091 "required": true,
13092 "type": "integer",
13093 "format": "int32",
13094 "title": "Int32"
13095 },
13096 {
13097 "name": "businessId",
13098 "in": "path",
13099 "required": true,
13100 "type": "string"
13101 }
13102 ],
13103 "responses": {
13104 "200": {
13105 "description": "OK",
13106 "schema": {
13107 "$ref": "#/definitions/PayRateTemplateModel"
13108 }
13109 }
13110 }
13111 },
13112 "put": {
13113 "tags": [
13114 "PayRateTemplate"
13115 ],
13116 "summary": "Update Pay Rate Template",
13117 "description": "Updates the pay rate template with the specified ID.",
13118 "operationId": "PayRateTemplate_Put",
13119 "consumes": [
13120 "application/json",
13121 "text/json",
13122 "application/xml",
13123 "text/xml",
13124 "application/x-www-form-urlencoded"
13125 ],
13126 "produces": [
13127 "application/json",
13128 "text/json",
13129 "application/xml",
13130 "text/xml"
13131 ],
13132 "parameters": [
13133 {
13134 "name": "id",
13135 "in": "path",
13136 "required": true,
13137 "type": "integer",
13138 "format": "int32",
13139 "title": "Int32"
13140 },
13141 {
13142 "name": "payRateTemplate",
13143 "in": "body",
13144 "required": true,
13145 "schema": {
13146 "$ref": "#/definitions/PayRateTemplateModel"
13147 }
13148 },
13149 {
13150 "name": "businessId",
13151 "in": "path",
13152 "required": true,
13153 "type": "string"
13154 }
13155 ],
13156 "responses": {
13157 "200": {
13158 "description": "OK"
13159 }
13160 }
13161 },
13162 "delete": {
13163 "tags": [
13164 "PayRateTemplate"
13165 ],
13166 "summary": "Delete Pay Rate Template",
13167 "description": "Deletes the pay rate template with the specified ID.",
13168 "operationId": "PayRateTemplate_Delete",
13169 "consumes": [],
13170 "produces": [
13171 "application/json",
13172 "text/json",
13173 "application/xml",
13174 "text/xml"
13175 ],
13176 "parameters": [
13177 {
13178 "name": "id",
13179 "in": "path",
13180 "required": true,
13181 "type": "integer",
13182 "format": "int32",
13183 "title": "Int32"
13184 },
13185 {
13186 "name": "businessId",
13187 "in": "path",
13188 "required": true,
13189 "type": "string"
13190 }
13191 ],
13192 "responses": {
13193 "200": {
13194 "description": "OK"
13195 }
13196 }
13197 }
13198 },
13199 "/api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses": {
13200 "get": {
13201 "tags": [
13202 "PayRun"
13203 ],
13204 "summary": "List Employee Expenses",
13205 "description": "Lists all the employee expenses for a pay run.",
13206 "operationId": "PayRunEmployeeExpenses_Get",
13207 "consumes": [],
13208 "produces": [
13209 "application/json",
13210 "text/json",
13211 "application/xml",
13212 "text/xml"
13213 ],
13214 "parameters": [
13215 {
13216 "name": "payRunId",
13217 "in": "path",
13218 "required": true,
13219 "type": "integer",
13220 "format": "int32",
13221 "title": "Int32"
13222 },
13223 {
13224 "name": "businessId",
13225 "in": "path",
13226 "required": true,
13227 "type": "string"
13228 }
13229 ],
13230 "responses": {
13231 "200": {
13232 "description": "OK",
13233 "schema": {
13234 "$ref": "#/definitions/PayRunEmployeeExpenseResponse"
13235 }
13236 }
13237 }
13238 },
13239 "post": {
13240 "tags": [
13241 "PayRun"
13242 ],
13243 "summary": "Create Employee Expenses",
13244 "description": "Add employee expenses to the specified pay run.",
13245 "operationId": "PayRunEmployeeExpenses_Post",
13246 "consumes": [
13247 "application/json",
13248 "text/json",
13249 "application/xml",
13250 "text/xml",
13251 "application/x-www-form-urlencoded"
13252 ],
13253 "produces": [
13254 "application/json",
13255 "text/json",
13256 "application/xml",
13257 "text/xml"
13258 ],
13259 "parameters": [
13260 {
13261 "name": "payRunId",
13262 "in": "path",
13263 "required": true,
13264 "type": "integer",
13265 "format": "int32",
13266 "title": "Int32"
13267 },
13268 {
13269 "name": "request",
13270 "in": "body",
13271 "required": true,
13272 "schema": {
13273 "$ref": "#/definitions/SubmitPayRunEmployeeExpenseRequest"
13274 }
13275 },
13276 {
13277 "name": "businessId",
13278 "in": "path",
13279 "required": true,
13280 "type": "string"
13281 }
13282 ],
13283 "responses": {
13284 "200": {
13285 "description": "OK"
13286 }
13287 }
13288 },
13289 "delete": {
13290 "tags": [
13291 "PayRun"
13292 ],
13293 "summary": "Delete Employee Expense",
13294 "description": "Deletes the employee expense with the specified ID from the pay run.",
13295 "operationId": "PayRunEmployeeExpenses_Delete",
13296 "consumes": [],
13297 "produces": [
13298 "application/json",
13299 "text/json",
13300 "application/xml",
13301 "text/xml"
13302 ],
13303 "parameters": [
13304 {
13305 "name": "payRunId",
13306 "in": "path",
13307 "required": true,
13308 "type": "integer",
13309 "format": "int32",
13310 "title": "Int32"
13311 },
13312 {
13313 "name": "id",
13314 "in": "query",
13315 "required": true,
13316 "type": "integer",
13317 "format": "int32",
13318 "title": "Int32"
13319 },
13320 {
13321 "name": "businessId",
13322 "in": "path",
13323 "required": true,
13324 "type": "string"
13325 }
13326 ],
13327 "responses": {
13328 "200": {
13329 "description": "OK"
13330 }
13331 }
13332 }
13333 },
13334 "/api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses/{employeeId}": {
13335 "get": {
13336 "tags": [
13337 "PayRun"
13338 ],
13339 "summary": "Get Employee Expenses by Employee ID",
13340 "description": "Gets all the employee expenses for a specific employee in a pay run.",
13341 "operationId": "PayRunEmployeeExpenses_GetApiV2BusinessByBusinessIdPayrunByPayRunIdEmployeeExpensesByEmployeeId",
13342 "consumes": [],
13343 "produces": [
13344 "application/json",
13345 "text/json",
13346 "application/xml",
13347 "text/xml"
13348 ],
13349 "parameters": [
13350 {
13351 "name": "payRunId",
13352 "in": "path",
13353 "required": true,
13354 "type": "integer",
13355 "format": "int32",
13356 "title": "Int32"
13357 },
13358 {
13359 "name": "employeeId",
13360 "in": "path",
13361 "required": true,
13362 "type": "integer",
13363 "format": "int32",
13364 "title": "Int32"
13365 },
13366 {
13367 "name": "businessId",
13368 "in": "path",
13369 "required": true,
13370 "type": "string"
13371 }
13372 ],
13373 "responses": {
13374 "200": {
13375 "description": "OK",
13376 "schema": {
13377 "$ref": "#/definitions/PayRunEmployeeExpenseResponse"
13378 }
13379 }
13380 }
13381 }
13382 },
13383 "/api/v2/business/{businessId}/payrun/{payRunId}/details": {
13384 "get": {
13385 "tags": [
13386 "PayRun"
13387 ],
13388 "summary": "Get Pay Run Details",
13389 "description": "Gets the details for the specified pay run.",
13390 "operationId": "PayRunDetails_Get",
13391 "consumes": [],
13392 "produces": [
13393 "application/json",
13394 "text/json",
13395 "application/xml",
13396 "text/xml"
13397 ],
13398 "parameters": [
13399 {
13400 "name": "payRunId",
13401 "in": "path",
13402 "required": true,
13403 "type": "integer",
13404 "format": "int32",
13405 "title": "Int32"
13406 },
13407 {
13408 "name": "businessId",
13409 "in": "path",
13410 "required": true,
13411 "type": "string"
13412 }
13413 ],
13414 "responses": {
13415 "200": {
13416 "description": "OK",
13417 "schema": {
13418 "$ref": "#/definitions/PayRunDetailsModel"
13419 }
13420 }
13421 }
13422 }
13423 },
13424 "/api/v2/business/{businessId}/payrun/{payRunId}/terminate": {
13425 "post": {
13426 "tags": [
13427 "PayRun"
13428 ],
13429 "summary": "Terminate Employee in Pay Run",
13430 "description": "Terminates an employee in the specified pay run.",
13431 "operationId": "PayRunTerminate_Post",
13432 "consumes": [
13433 "application/json",
13434 "text/json",
13435 "application/xml",
13436 "text/xml",
13437 "application/x-www-form-urlencoded"
13438 ],
13439 "produces": [
13440 "application/json",
13441 "text/json",
13442 "application/xml",
13443 "text/xml"
13444 ],
13445 "parameters": [
13446 {
13447 "name": "payRunId",
13448 "in": "path",
13449 "required": true,
13450 "type": "integer",
13451 "format": "int32",
13452 "title": "Int32"
13453 },
13454 {
13455 "name": "request",
13456 "in": "body",
13457 "required": true,
13458 "schema": {
13459 "$ref": "#/definitions/TerminateEmployeeRequest"
13460 }
13461 },
13462 {
13463 "name": "businessId",
13464 "in": "path",
13465 "required": true,
13466 "type": "string"
13467 }
13468 ],
13469 "responses": {
13470 "200": {
13471 "description": "OK"
13472 }
13473 }
13474 }
13475 },
13476 "/api/v2/business/{businessId}/payrun/{payRunId}/payslips": {
13477 "get": {
13478 "tags": [
13479 "PayRun"
13480 ],
13481 "summary": "List Pay Slip Data",
13482 "description": "Lists all the pay slips for the specified pay run.",
13483 "operationId": "PayRunPaySlip_Get",
13484 "consumes": [],
13485 "produces": [
13486 "application/json",
13487 "text/json",
13488 "application/xml",
13489 "text/xml"
13490 ],
13491 "parameters": [
13492 {
13493 "name": "payRunId",
13494 "in": "path",
13495 "required": true,
13496 "type": "integer",
13497 "format": "int32",
13498 "title": "Int32"
13499 },
13500 {
13501 "name": "showAllData",
13502 "in": "query",
13503 "required": false,
13504 "type": "boolean",
13505 "default": false,
13506 "title": "Boolean"
13507 },
13508 {
13509 "name": "businessId",
13510 "in": "path",
13511 "required": true,
13512 "type": "string"
13513 }
13514 ],
13515 "responses": {
13516 "200": {
13517 "description": "OK",
13518 "schema": {
13519 "type": "object",
13520 "additionalProperties": {
13521 "$ref": "#/definitions/ApiPaySlipModel"
13522 },
13523 "title": "Dictionary<String,ApiPaySlipModel>"
13524 }
13525 }
13526 }
13527 }
13528 },
13529 "/api/v2/business/{businessId}/payrun/{payRunId}/payslips/{employeeId}": {
13530 "get": {
13531 "tags": [
13532 "PayRun"
13533 ],
13534 "summary": "Get Pay Slip Data by Employee ID",
13535 "description": "Gets the pay slip data for an employee in a payrun.",
13536 "operationId": "PayRunPaySlip_GetApiV2BusinessByBusinessIdPayrunByPayRunIdPayslipsByEmployeeId",
13537 "consumes": [],
13538 "produces": [
13539 "application/json",
13540 "text/json",
13541 "application/xml",
13542 "text/xml"
13543 ],
13544 "parameters": [
13545 {
13546 "name": "payRunId",
13547 "in": "path",
13548 "required": true,
13549 "type": "integer",
13550 "format": "int32",
13551 "title": "Int32"
13552 },
13553 {
13554 "name": "employeeId",
13555 "in": "path",
13556 "required": true,
13557 "type": "integer",
13558 "format": "int32",
13559 "title": "Int32"
13560 },
13561 {
13562 "name": "showAllData",
13563 "in": "query",
13564 "required": false,
13565 "type": "boolean",
13566 "default": false,
13567 "title": "Boolean"
13568 },
13569 {
13570 "name": "businessId",
13571 "in": "path",
13572 "required": true,
13573 "type": "string"
13574 }
13575 ],
13576 "responses": {
13577 "200": {
13578 "description": "OK",
13579 "schema": {
13580 "$ref": "#/definitions/ApiPaySlipModel"
13581 }
13582 }
13583 }
13584 }
13585 },
13586 "/api/v2/business/{businessId}/payrun/{payRunId}/earningslines": {
13587 "get": {
13588 "tags": [
13589 "PayRun"
13590 ],
13591 "summary": "List Earnings Lines",
13592 "description": "Lists all the earnings lines for a pay run.",
13593 "operationId": "PayRunEarningsLine_Get",
13594 "consumes": [],
13595 "produces": [
13596 "application/json",
13597 "text/json",
13598 "application/xml",
13599 "text/xml"
13600 ],
13601 "parameters": [
13602 {
13603 "name": "payRunId",
13604 "in": "path",
13605 "required": true,
13606 "type": "integer",
13607 "format": "int32",
13608 "title": "Int32"
13609 },
13610 {
13611 "name": "businessId",
13612 "in": "path",
13613 "required": true,
13614 "type": "string"
13615 }
13616 ],
13617 "responses": {
13618 "200": {
13619 "description": "OK",
13620 "schema": {
13621 "$ref": "#/definitions/PayRunEarningsLineResponse"
13622 }
13623 }
13624 }
13625 },
13626 "post": {
13627 "tags": [
13628 "PayRun"
13629 ],
13630 "summary": "Create Earnings Lines",
13631 "description": "Adds earnings lines to the specified pay run.",
13632 "operationId": "PayRunEarningsLine_Post",
13633 "consumes": [
13634 "application/json",
13635 "text/json",
13636 "application/xml",
13637 "text/xml",
13638 "application/x-www-form-urlencoded"
13639 ],
13640 "produces": [
13641 "application/json",
13642 "text/json",
13643 "application/xml",
13644 "text/xml"
13645 ],
13646 "parameters": [
13647 {
13648 "name": "payRunId",
13649 "in": "path",
13650 "required": true,
13651 "type": "integer",
13652 "format": "int32",
13653 "title": "Int32"
13654 },
13655 {
13656 "name": "request",
13657 "in": "body",
13658 "required": true,
13659 "schema": {
13660 "$ref": "#/definitions/SubmitPayRunEarningsLineRequest"
13661 }
13662 },
13663 {
13664 "name": "businessId",
13665 "in": "path",
13666 "required": true,
13667 "type": "string"
13668 }
13669 ],
13670 "responses": {
13671 "200": {
13672 "description": "OK"
13673 }
13674 }
13675 },
13676 "delete": {
13677 "tags": [
13678 "PayRun"
13679 ],
13680 "summary": "Delete Earnings Line",
13681 "description": "Deletes the earnings with the specified ID from the pay run.",
13682 "operationId": "PayRunEarningsLine_Delete",
13683 "consumes": [],
13684 "produces": [
13685 "application/json",
13686 "text/json",
13687 "application/xml",
13688 "text/xml"
13689 ],
13690 "parameters": [
13691 {
13692 "name": "payRunId",
13693 "in": "path",
13694 "required": true,
13695 "type": "integer",
13696 "format": "int32",
13697 "title": "Int32"
13698 },
13699 {
13700 "name": "id",
13701 "in": "query",
13702 "required": true,
13703 "type": "integer",
13704 "format": "int32",
13705 "title": "Int32"
13706 },
13707 {
13708 "name": "businessId",
13709 "in": "path",
13710 "required": true,
13711 "type": "string"
13712 }
13713 ],
13714 "responses": {
13715 "200": {
13716 "description": "OK"
13717 }
13718 }
13719 }
13720 },
13721 "/api/v2/business/{businessId}/payrun/{payRunId}/earningslines/{employeeId}": {
13722 "get": {
13723 "tags": [
13724 "PayRun"
13725 ],
13726 "summary": "Get Earnings Lines by Employee ID",
13727 "description": "Gets all the earnings lines for a specific employee in a pay run.",
13728 "operationId": "PayRunEarningsLine_GetApiV2BusinessByBusinessIdPayrunByPayRunIdEarningslinesByEmployeeId",
13729 "consumes": [],
13730 "produces": [
13731 "application/json",
13732 "text/json",
13733 "application/xml",
13734 "text/xml"
13735 ],
13736 "parameters": [
13737 {
13738 "name": "payRunId",
13739 "in": "path",
13740 "required": true,
13741 "type": "integer",
13742 "format": "int32",
13743 "title": "Int32"
13744 },
13745 {
13746 "name": "employeeId",
13747 "in": "path",
13748 "required": true,
13749 "type": "integer",
13750 "format": "int32",
13751 "title": "Int32"
13752 },
13753 {
13754 "name": "businessId",
13755 "in": "path",
13756 "required": true,
13757 "type": "string"
13758 }
13759 ],
13760 "responses": {
13761 "200": {
13762 "description": "OK",
13763 "schema": {
13764 "$ref": "#/definitions/PayRunEarningsLineResponse"
13765 }
13766 }
13767 }
13768 }
13769 },
13770 "/api/v2/business/{businessId}/employee/{employeeId}/payruntotals": {
13771 "get": {
13772 "tags": [
13773 "PayRun"
13774 ],
13775 "summary": "List Pay Run Totals for Employee",
13776 "description": "Lists all the pay run totals for the employee with the specified ID.",
13777 "operationId": "EmployeePayRunTotal_Get",
13778 "consumes": [],
13779 "produces": [
13780 "application/json",
13781 "text/json",
13782 "application/xml",
13783 "text/xml"
13784 ],
13785 "parameters": [
13786 {
13787 "name": "employeeId",
13788 "in": "path",
13789 "required": true,
13790 "type": "integer",
13791 "format": "int32",
13792 "title": "Int32"
13793 },
13794 {
13795 "name": "businessId",
13796 "in": "path",
13797 "required": true,
13798 "type": "string"
13799 }
13800 ],
13801 "responses": {
13802 "200": {
13803 "description": "OK",
13804 "schema": {
13805 "type": "array",
13806 "items": {
13807 "$ref": "#/definitions/PayRunTotalModel"
13808 },
13809 "xml": {
13810 "name": "PayRunTotalModel",
13811 "wrapped": true
13812 },
13813 "title": "IList<PayRunTotalModel>"
13814 }
13815 }
13816 }
13817 }
13818 },
13819 "/api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued": {
13820 "get": {
13821 "tags": [
13822 "PayRun"
13823 ],
13824 "summary": "Get Leave Accruals",
13825 "description": "Lists all the leave accruals for the pay run.",
13826 "operationId": "PayRunLeaveAccrued_Get",
13827 "consumes": [],
13828 "produces": [
13829 "application/json",
13830 "text/json",
13831 "application/xml",
13832 "text/xml"
13833 ],
13834 "parameters": [
13835 {
13836 "name": "payRunId",
13837 "in": "path",
13838 "required": true,
13839 "type": "integer",
13840 "format": "int32",
13841 "title": "Int32"
13842 },
13843 {
13844 "name": "includeLeaveTaken",
13845 "in": "query",
13846 "required": false,
13847 "type": "boolean",
13848 "default": false,
13849 "title": "Boolean"
13850 },
13851 {
13852 "name": "businessId",
13853 "in": "path",
13854 "required": true,
13855 "type": "string"
13856 }
13857 ],
13858 "responses": {
13859 "200": {
13860 "description": "OK",
13861 "schema": {
13862 "$ref": "#/definitions/LeaveAccrualResponse"
13863 }
13864 }
13865 }
13866 },
13867 "post": {
13868 "tags": [
13869 "PayRun"
13870 ],
13871 "summary": "Save Leave Accruals",
13872 "description": "Saves a set of leave accruals for the pay run.",
13873 "operationId": "PayRunLeaveAccrued_Post",
13874 "consumes": [
13875 "application/json",
13876 "text/json",
13877 "application/xml",
13878 "text/xml",
13879 "application/x-www-form-urlencoded"
13880 ],
13881 "produces": [
13882 "application/json",
13883 "text/json",
13884 "application/xml",
13885 "text/xml"
13886 ],
13887 "parameters": [
13888 {
13889 "name": "payRunId",
13890 "in": "path",
13891 "required": true,
13892 "type": "integer",
13893 "format": "int32",
13894 "title": "Int32"
13895 },
13896 {
13897 "name": "model",
13898 "in": "body",
13899 "required": true,
13900 "schema": {
13901 "$ref": "#/definitions/SubmitLeaveAccrualsModel"
13902 }
13903 },
13904 {
13905 "name": "businessId",
13906 "in": "path",
13907 "required": true,
13908 "type": "string"
13909 }
13910 ],
13911 "responses": {
13912 "200": {
13913 "description": "OK"
13914 }
13915 }
13916 },
13917 "delete": {
13918 "tags": [
13919 "PayRun"
13920 ],
13921 "summary": "Delete Leave Accrual",
13922 "description": "Deletes the manually added leave accrual, leave taken or leave adjustment with the specified ID from the pay run.",
13923 "operationId": "PayRunLeaveAccrued_Delete",
13924 "consumes": [],
13925 "produces": [
13926 "application/json",
13927 "text/json",
13928 "application/xml",
13929 "text/xml"
13930 ],
13931 "parameters": [
13932 {
13933 "name": "payRunId",
13934 "in": "path",
13935 "required": true,
13936 "type": "integer",
13937 "format": "int32",
13938 "title": "Int32"
13939 },
13940 {
13941 "name": "id",
13942 "in": "query",
13943 "required": true,
13944 "type": "integer",
13945 "format": "int32",
13946 "title": "Int32"
13947 },
13948 {
13949 "name": "businessId",
13950 "in": "path",
13951 "required": true,
13952 "type": "string"
13953 }
13954 ],
13955 "responses": {
13956 "200": {
13957 "description": "OK"
13958 }
13959 }
13960 }
13961 },
13962 "/api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued/{employeeId}": {
13963 "get": {
13964 "tags": [
13965 "PayRun"
13966 ],
13967 "summary": "Get Leave Accruals for Employee",
13968 "description": "Gets the leave accruals for the specified employee in the pay run.",
13969 "operationId": "PayRunLeaveAccrued_GetApiV2BusinessByBusinessIdPayrunByPayRunIdLeaveaccruedByEmployeeId",
13970 "consumes": [],
13971 "produces": [
13972 "application/json",
13973 "text/json",
13974 "application/xml",
13975 "text/xml"
13976 ],
13977 "parameters": [
13978 {
13979 "name": "payRunId",
13980 "in": "path",
13981 "required": true,
13982 "type": "integer",
13983 "format": "int32",
13984 "title": "Int32"
13985 },
13986 {
13987 "name": "employeeId",
13988 "in": "path",
13989 "required": true,
13990 "type": "integer",
13991 "format": "int32",
13992 "title": "Int32"
13993 },
13994 {
13995 "name": "includeLeaveTaken",
13996 "in": "query",
13997 "required": false,
13998 "type": "boolean",
13999 "default": false,
14000 "title": "Boolean"
14001 },
14002 {
14003 "name": "businessId",
14004 "in": "path",
14005 "required": true,
14006 "type": "string"
14007 }
14008 ],
14009 "responses": {
14010 "200": {
14011 "description": "OK",
14012 "schema": {
14013 "$ref": "#/definitions/LeaveAccrualResponse"
14014 }
14015 }
14016 }
14017 }
14018 },
14019 "/api/v2/business/{businessId}/payrun/{payRunId}/paygadjustments": {
14020 "get": {
14021 "tags": [
14022 "PayRun"
14023 ],
14024 "summary": "List PAYG Adjustments",
14025 "description": "Lists all the PAYG adjustments for a pay run.",
14026 "operationId": "PayRunPaygAdjustments_Get",
14027 "consumes": [],
14028 "produces": [
14029 "application/json",
14030 "text/json",
14031 "application/xml",
14032 "text/xml"
14033 ],
14034 "parameters": [
14035 {
14036 "name": "payRunId",
14037 "in": "path",
14038 "required": true,
14039 "type": "integer",
14040 "format": "int32",
14041 "title": "Int32"
14042 },
14043 {
14044 "name": "businessId",
14045 "in": "path",
14046 "required": true,
14047 "type": "string"
14048 }
14049 ],
14050 "responses": {
14051 "200": {
14052 "description": "OK",
14053 "schema": {
14054 "$ref": "#/definitions/PayRunPaygAdjustmentResponse"
14055 }
14056 }
14057 }
14058 },
14059 "post": {
14060 "tags": [
14061 "PayRun"
14062 ],
14063 "summary": "Create PAYG Adjustments",
14064 "description": "Adds PAYG adjustments to the specified pay run.",
14065 "operationId": "PayRunPaygAdjustments_Post",
14066 "consumes": [
14067 "application/json",
14068 "text/json",
14069 "application/xml",
14070 "text/xml",
14071 "application/x-www-form-urlencoded"
14072 ],
14073 "produces": [
14074 "application/json",
14075 "text/json",
14076 "application/xml",
14077 "text/xml"
14078 ],
14079 "parameters": [
14080 {
14081 "name": "payRunId",
14082 "in": "path",
14083 "required": true,
14084 "type": "integer",
14085 "format": "int32",
14086 "title": "Int32"
14087 },
14088 {
14089 "name": "request",
14090 "in": "body",
14091 "required": true,
14092 "schema": {
14093 "$ref": "#/definitions/SubmitPayRunPaygAdjustmentRequest"
14094 }
14095 },
14096 {
14097 "name": "businessId",
14098 "in": "path",
14099 "required": true,
14100 "type": "string"
14101 }
14102 ],
14103 "responses": {
14104 "200": {
14105 "description": "OK"
14106 }
14107 }
14108 },
14109 "delete": {
14110 "tags": [
14111 "PayRun"
14112 ],
14113 "summary": "Delete PAYG Adjustment",
14114 "description": "Deletes the PAYG adjustment with the specified ID from the pay run.",
14115 "operationId": "PayRunPaygAdjustments_Delete",
14116 "consumes": [],
14117 "produces": [
14118 "application/json",
14119 "text/json",
14120 "application/xml",
14121 "text/xml"
14122 ],
14123 "parameters": [
14124 {
14125 "name": "payRunId",
14126 "in": "path",
14127 "required": true,
14128 "type": "integer",
14129 "format": "int32",
14130 "title": "Int32"
14131 },
14132 {
14133 "name": "id",
14134 "in": "query",
14135 "required": true,
14136 "type": "integer",
14137 "format": "int32",
14138 "title": "Int32"
14139 },
14140 {
14141 "name": "businessId",
14142 "in": "path",
14143 "required": true,
14144 "type": "string"
14145 }
14146 ],
14147 "responses": {
14148 "200": {
14149 "description": "OK"
14150 }
14151 }
14152 }
14153 },
14154 "/api/v2/business/{businessId}/payrun/{payRunId}/paygadjustments/{employeeId}": {
14155 "get": {
14156 "tags": [
14157 "PayRun"
14158 ],
14159 "summary": "Get PAYG Adjustments by Employee ID",
14160 "description": "Gets all the PAYG adjustments for a specific employee in a pay run.",
14161 "operationId": "PayRunPaygAdjustments_GetApiV2BusinessByBusinessIdPayrunByPayRunIdPaygadjustmentsByEmployeeId",
14162 "consumes": [],
14163 "produces": [
14164 "application/json",
14165 "text/json",
14166 "application/xml",
14167 "text/xml"
14168 ],
14169 "parameters": [
14170 {
14171 "name": "payRunId",
14172 "in": "path",
14173 "required": true,
14174 "type": "integer",
14175 "format": "int32",
14176 "title": "Int32"
14177 },
14178 {
14179 "name": "employeeId",
14180 "in": "path",
14181 "required": true,
14182 "type": "integer",
14183 "format": "int32",
14184 "title": "Int32"
14185 },
14186 {
14187 "name": "businessId",
14188 "in": "path",
14189 "required": true,
14190 "type": "string"
14191 }
14192 ],
14193 "responses": {
14194 "200": {
14195 "description": "OK",
14196 "schema": {
14197 "$ref": "#/definitions/PayRunPaygAdjustmentResponse"
14198 }
14199 }
14200 }
14201 }
14202 },
14203 "/api/v2/business/{businessId}/payrun/{payRunId}/superadjustments": {
14204 "get": {
14205 "tags": [
14206 "PayRun"
14207 ],
14208 "summary": "List Super Adjustments",
14209 "description": "Lists all the super adjustments for a pay run.",
14210 "operationId": "PayRunSuperAdjustments_GetAll",
14211 "consumes": [],
14212 "produces": [
14213 "application/json",
14214 "text/json",
14215 "application/xml",
14216 "text/xml"
14217 ],
14218 "parameters": [
14219 {
14220 "name": "payRunId",
14221 "in": "path",
14222 "required": true,
14223 "type": "integer",
14224 "format": "int32",
14225 "title": "Int32"
14226 },
14227 {
14228 "name": "businessId",
14229 "in": "path",
14230 "required": true,
14231 "type": "string"
14232 }
14233 ],
14234 "responses": {
14235 "200": {
14236 "description": "OK",
14237 "schema": {
14238 "$ref": "#/definitions/PayRunSuperAdjustmentResponse"
14239 }
14240 }
14241 }
14242 },
14243 "post": {
14244 "tags": [
14245 "PayRun"
14246 ],
14247 "summary": "Create Super Adjustments",
14248 "description": "Adds super adjustments to the specified pay run.",
14249 "operationId": "PayRunSuperAdjustments_Post",
14250 "consumes": [
14251 "application/json",
14252 "text/json",
14253 "application/xml",
14254 "text/xml",
14255 "application/x-www-form-urlencoded"
14256 ],
14257 "produces": [
14258 "application/json",
14259 "text/json",
14260 "application/xml",
14261 "text/xml"
14262 ],
14263 "parameters": [
14264 {
14265 "name": "payRunId",
14266 "in": "path",
14267 "required": true,
14268 "type": "integer",
14269 "format": "int32",
14270 "title": "Int32"
14271 },
14272 {
14273 "name": "request",
14274 "in": "body",
14275 "required": true,
14276 "schema": {
14277 "$ref": "#/definitions/SubmitPayRunSuperAdjustmentRequest"
14278 }
14279 },
14280 {
14281 "name": "businessId",
14282 "in": "path",
14283 "required": true,
14284 "type": "string"
14285 }
14286 ],
14287 "responses": {
14288 "200": {
14289 "description": "OK"
14290 }
14291 }
14292 },
14293 "delete": {
14294 "tags": [
14295 "PayRun"
14296 ],
14297 "summary": "Delete Super Adjustment",
14298 "description": "Deletes the super adjustment with the specified ID from the pay run.",
14299 "operationId": "PayRunSuperAdjustments_Delete",
14300 "consumes": [],
14301 "produces": [
14302 "application/json",
14303 "text/json",
14304 "application/xml",
14305 "text/xml"
14306 ],
14307 "parameters": [
14308 {
14309 "name": "payRunId",
14310 "in": "path",
14311 "required": true,
14312 "type": "integer",
14313 "format": "int32",
14314 "title": "Int32"
14315 },
14316 {
14317 "name": "id",
14318 "in": "query",
14319 "required": true,
14320 "type": "integer",
14321 "format": "int32",
14322 "title": "Int32"
14323 },
14324 {
14325 "name": "businessId",
14326 "in": "path",
14327 "required": true,
14328 "type": "string"
14329 }
14330 ],
14331 "responses": {
14332 "200": {
14333 "description": "OK"
14334 }
14335 }
14336 }
14337 },
14338 "/api/v2/business/{businessId}/payrun/{payRunId}/superadjustments/{employeeId}": {
14339 "get": {
14340 "tags": [
14341 "PayRun"
14342 ],
14343 "summary": "Get Super Adjustments by Employee ID",
14344 "description": "Gets all super adjustments for a specific employee in a pay run.",
14345 "operationId": "PayRunSuperAdjustments_Get",
14346 "consumes": [],
14347 "produces": [
14348 "application/json",
14349 "text/json",
14350 "application/xml",
14351 "text/xml"
14352 ],
14353 "parameters": [
14354 {
14355 "name": "payRunId",
14356 "in": "path",
14357 "required": true,
14358 "type": "integer",
14359 "format": "int32",
14360 "title": "Int32"
14361 },
14362 {
14363 "name": "employeeId",
14364 "in": "path",
14365 "required": true,
14366 "type": "integer",
14367 "format": "int32",
14368 "title": "Int32"
14369 },
14370 {
14371 "name": "businessId",
14372 "in": "path",
14373 "required": true,
14374 "type": "string"
14375 }
14376 ],
14377 "responses": {
14378 "200": {
14379 "description": "OK",
14380 "schema": {
14381 "$ref": "#/definitions/PayRunSuperAdjustmentResponse"
14382 }
14383 }
14384 }
14385 }
14386 },
14387 "/api/v2/business/{businessId}/payrun/{payRunId}/unlock": {
14388 "post": {
14389 "tags": [
14390 "PayRun"
14391 ],
14392 "summary": "Unlock Pay Run",
14393 "description": "Unlocks the specified pay run.",
14394 "operationId": "PayRunUnlock_Post",
14395 "consumes": [
14396 "application/json",
14397 "text/json",
14398 "application/xml",
14399 "text/xml",
14400 "application/x-www-form-urlencoded"
14401 ],
14402 "produces": [
14403 "application/json",
14404 "text/json",
14405 "application/xml",
14406 "text/xml"
14407 ],
14408 "parameters": [
14409 {
14410 "name": "payRunId",
14411 "in": "path",
14412 "required": true,
14413 "type": "integer",
14414 "format": "int32",
14415 "title": "Int32"
14416 },
14417 {
14418 "name": "request",
14419 "in": "body",
14420 "required": true,
14421 "schema": {
14422 "$ref": "#/definitions/PayRunUnlockRequest"
14423 }
14424 },
14425 {
14426 "name": "businessId",
14427 "in": "path",
14428 "required": true,
14429 "type": "string"
14430 }
14431 ],
14432 "responses": {
14433 "200": {
14434 "description": "OK"
14435 }
14436 }
14437 }
14438 },
14439 "/api/v2/business/{businessId}/payrun": {
14440 "get": {
14441 "tags": [
14442 "PayRun"
14443 ],
14444 "summary": "List Pay Runs",
14445 "description": "Get a list of pay runs associated with the business.\n\nThis operation supports OData queries.",
14446 "operationId": "PayRun_GetPayRuns",
14447 "consumes": [],
14448 "produces": [
14449 "application/json",
14450 "text/json",
14451 "application/xml",
14452 "text/xml"
14453 ],
14454 "parameters": [
14455 {
14456 "name": "businessId",
14457 "in": "path",
14458 "required": true,
14459 "type": "string"
14460 }
14461 ],
14462 "responses": {
14463 "200": {
14464 "description": "OK",
14465 "schema": {
14466 "type": "array",
14467 "items": {
14468 "$ref": "#/definitions/PayRunModel"
14469 },
14470 "xml": {
14471 "name": "PayRunModel",
14472 "wrapped": true
14473 },
14474 "title": "IEnumerable<PayRunModel>"
14475 }
14476 }
14477 }
14478 },
14479 "post": {
14480 "tags": [
14481 "PayRun"
14482 ],
14483 "summary": "Create Pay Run",
14484 "description": "Creates a new pay run for this business.",
14485 "operationId": "PayRun_Post",
14486 "consumes": [
14487 "application/json",
14488 "text/json",
14489 "application/xml",
14490 "text/xml",
14491 "application/x-www-form-urlencoded"
14492 ],
14493 "produces": [
14494 "application/json",
14495 "text/json",
14496 "application/xml",
14497 "text/xml"
14498 ],
14499 "parameters": [
14500 {
14501 "name": "request",
14502 "in": "body",
14503 "required": true,
14504 "schema": {
14505 "$ref": "#/definitions/PayRunCreateRequest"
14506 }
14507 },
14508 {
14509 "name": "businessId",
14510 "in": "path",
14511 "required": true,
14512 "type": "string"
14513 }
14514 ],
14515 "responses": {
14516 "200": {
14517 "description": "OK"
14518 }
14519 }
14520 }
14521 },
14522 "/api/v2/business/{businessId}/payrun/{payRunId}": {
14523 "get": {
14524 "tags": [
14525 "PayRun"
14526 ],
14527 "summary": "Get Pay Run",
14528 "description": "Gets the pay run with the specified ID.",
14529 "operationId": "PayRun_Get",
14530 "consumes": [],
14531 "produces": [
14532 "application/json",
14533 "text/json",
14534 "application/xml",
14535 "text/xml"
14536 ],
14537 "parameters": [
14538 {
14539 "name": "payRunId",
14540 "in": "path",
14541 "required": true,
14542 "type": "integer",
14543 "format": "int32",
14544 "title": "Int32"
14545 },
14546 {
14547 "name": "businessId",
14548 "in": "path",
14549 "required": true,
14550 "type": "string"
14551 }
14552 ],
14553 "responses": {
14554 "200": {
14555 "description": "OK",
14556 "schema": {
14557 "$ref": "#/definitions/PayRunModel"
14558 }
14559 }
14560 }
14561 },
14562 "delete": {
14563 "tags": [
14564 "PayRun"
14565 ],
14566 "summary": "Delete Pay Run",
14567 "description": "Deletes the pay run with the specified ID.",
14568 "operationId": "PayRun_Delete",
14569 "consumes": [],
14570 "produces": [
14571 "application/json",
14572 "text/json",
14573 "application/xml",
14574 "text/xml"
14575 ],
14576 "parameters": [
14577 {
14578 "name": "payRunId",
14579 "in": "path",
14580 "required": true,
14581 "type": "integer",
14582 "format": "int32",
14583 "title": "Int32"
14584 },
14585 {
14586 "name": "businessId",
14587 "in": "path",
14588 "required": true,
14589 "type": "string"
14590 }
14591 ],
14592 "responses": {
14593 "200": {
14594 "description": "OK"
14595 }
14596 }
14597 }
14598 },
14599 "/api/v2/business/{businessId}/payrun/async": {
14600 "post": {
14601 "tags": [
14602 "PayRun"
14603 ],
14604 "summary": "Create Pay Run (Async)",
14605 "description": "Creates a new pay run for this business asynchronously (the request will return before the pay run is created).",
14606 "operationId": "PayRun_Async",
14607 "consumes": [
14608 "application/json",
14609 "text/json",
14610 "application/xml",
14611 "text/xml",
14612 "application/x-www-form-urlencoded"
14613 ],
14614 "produces": [
14615 "application/json",
14616 "text/json",
14617 "application/xml",
14618 "text/xml"
14619 ],
14620 "parameters": [
14621 {
14622 "name": "request",
14623 "in": "body",
14624 "required": true,
14625 "schema": {
14626 "$ref": "#/definitions/PayRunCreateRequest"
14627 }
14628 },
14629 {
14630 "name": "businessId",
14631 "in": "path",
14632 "required": true,
14633 "type": "string"
14634 }
14635 ],
14636 "responses": {
14637 "200": {
14638 "description": "OK"
14639 }
14640 }
14641 }
14642 },
14643 "/api/v2/business/{businessId}/payrun/creationstatus/{jobId}": {
14644 "get": {
14645 "tags": [
14646 "PayRun"
14647 ],
14648 "summary": "Get Creation Status",
14649 "description": "Gets the creation status of a pay run that was created asynchronously.",
14650 "operationId": "PayRun_CreationStatus",
14651 "consumes": [],
14652 "produces": [
14653 "application/json",
14654 "text/json",
14655 "application/xml",
14656 "text/xml"
14657 ],
14658 "parameters": [
14659 {
14660 "name": "jobId",
14661 "in": "path",
14662 "required": true,
14663 "type": "string",
14664 "format": "uuid",
14665 "title": "Guid"
14666 },
14667 {
14668 "name": "businessId",
14669 "in": "path",
14670 "required": true,
14671 "type": "string"
14672 }
14673 ],
14674 "responses": {
14675 "200": {
14676 "description": "OK"
14677 }
14678 }
14679 }
14680 },
14681 "/api/v2/business/{businessId}/payrun/{payRunId}/file/aba/{abaId}": {
14682 "get": {
14683 "tags": [
14684 "PayRun"
14685 ],
14686 "summary": "Get ABA File",
14687 "description": "Gets an ABA file associated with a pay run.",
14688 "operationId": "PayRun_AbaFile",
14689 "consumes": [],
14690 "produces": [
14691 "application/json",
14692 "text/json",
14693 "application/xml",
14694 "text/xml"
14695 ],
14696 "parameters": [
14697 {
14698 "name": "payRunId",
14699 "in": "path",
14700 "required": true,
14701 "type": "integer",
14702 "format": "int32",
14703 "title": "Int32"
14704 },
14705 {
14706 "name": "abaId",
14707 "in": "path",
14708 "required": true,
14709 "type": "integer",
14710 "format": "int32",
14711 "title": "Int32"
14712 },
14713 {
14714 "name": "businessId",
14715 "in": "path",
14716 "required": true,
14717 "type": "string"
14718 }
14719 ],
14720 "responses": {
14721 "200": {
14722 "description": "OK"
14723 }
14724 }
14725 }
14726 },
14727 "/api/v2/business/{businessId}/payrun/{payRunId}/file/payslip/{employeeId}": {
14728 "get": {
14729 "tags": [
14730 "PayRun"
14731 ],
14732 "summary": "Get Pay Slip File",
14733 "description": "Gets the pay slip for an employee in a pay run.",
14734 "operationId": "PayRun_PaySlipFile",
14735 "consumes": [],
14736 "produces": [
14737 "application/json",
14738 "text/json",
14739 "application/xml",
14740 "text/xml"
14741 ],
14742 "parameters": [
14743 {
14744 "name": "payRunId",
14745 "in": "path",
14746 "required": true,
14747 "type": "integer",
14748 "format": "int32",
14749 "title": "Int32"
14750 },
14751 {
14752 "name": "employeeId",
14753 "in": "path",
14754 "required": true,
14755 "type": "integer",
14756 "format": "int32",
14757 "title": "Int32"
14758 },
14759 {
14760 "name": "businessId",
14761 "in": "path",
14762 "required": true,
14763 "type": "string"
14764 }
14765 ],
14766 "responses": {
14767 "200": {
14768 "description": "OK"
14769 }
14770 }
14771 }
14772 },
14773 "/api/v2/business/{businessId}/payrun/{payRunId}/recalculate": {
14774 "post": {
14775 "tags": [
14776 "PayRun"
14777 ],
14778 "summary": "Recalculate",
14779 "description": "Recalculates a pay run.",
14780 "operationId": "PayRun_Recalculate",
14781 "consumes": [],
14782 "produces": [
14783 "application/json",
14784 "text/json",
14785 "application/xml",
14786 "text/xml"
14787 ],
14788 "parameters": [
14789 {
14790 "name": "payRunId",
14791 "in": "path",
14792 "required": true,
14793 "type": "integer",
14794 "format": "int32",
14795 "title": "Int32"
14796 },
14797 {
14798 "name": "businessId",
14799 "in": "path",
14800 "required": true,
14801 "type": "string"
14802 }
14803 ],
14804 "responses": {
14805 "200": {
14806 "description": "OK"
14807 }
14808 }
14809 }
14810 },
14811 "/api/v2/business/{businessId}/payrun/{payRunId}/notation": {
14812 "post": {
14813 "tags": [
14814 "PayRun"
14815 ],
14816 "summary": "Set Pay Run Notation",
14817 "description": "Sets the notation for this pay run. The pay run notation is the message that is shown on all pay slips for this pay run.",
14818 "operationId": "PayRun_Notation",
14819 "consumes": [
14820 "application/json",
14821 "text/json",
14822 "application/xml",
14823 "text/xml",
14824 "application/x-www-form-urlencoded"
14825 ],
14826 "produces": [
14827 "application/json",
14828 "text/json",
14829 "application/xml",
14830 "text/xml"
14831 ],
14832 "parameters": [
14833 {
14834 "name": "payRunId",
14835 "in": "path",
14836 "required": true,
14837 "type": "integer",
14838 "format": "int32",
14839 "title": "Int32"
14840 },
14841 {
14842 "name": "model",
14843 "in": "body",
14844 "required": true,
14845 "schema": {
14846 "$ref": "#/definitions/PayRunNotationModel"
14847 }
14848 },
14849 {
14850 "name": "businessId",
14851 "in": "path",
14852 "required": true,
14853 "type": "string"
14854 }
14855 ],
14856 "responses": {
14857 "200": {
14858 "description": "OK"
14859 }
14860 }
14861 },
14862 "delete": {
14863 "tags": [
14864 "PayRun"
14865 ],
14866 "summary": "Delete Pay Run Notation",
14867 "description": "Deletes the notation for this pay run. The pay run notation is the message that is shown on all pay slips for this pay run.",
14868 "operationId": "PayRun_DeleteApiV2BusinessByBusinessIdPayrunByPayRunIdNotation",
14869 "consumes": [],
14870 "produces": [
14871 "application/json",
14872 "text/json",
14873 "application/xml",
14874 "text/xml"
14875 ],
14876 "parameters": [
14877 {
14878 "name": "payRunId",
14879 "in": "path",
14880 "required": true,
14881 "type": "integer",
14882 "format": "int32",
14883 "title": "Int32"
14884 },
14885 {
14886 "name": "businessId",
14887 "in": "path",
14888 "required": true,
14889 "type": "string"
14890 }
14891 ],
14892 "responses": {
14893 "200": {
14894 "description": "OK"
14895 }
14896 }
14897 }
14898 },
14899 "/api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities": {
14900 "get": {
14901 "tags": [
14902 "PayRun"
14903 ],
14904 "summary": "List Employer Liabilities",
14905 "description": "Lists all the employer liabilities for a pay run.",
14906 "operationId": "PayRunEmployerLiabilities_GetAll",
14907 "consumes": [],
14908 "produces": [
14909 "application/json",
14910 "text/json",
14911 "application/xml",
14912 "text/xml"
14913 ],
14914 "parameters": [
14915 {
14916 "name": "payRunId",
14917 "in": "path",
14918 "required": true,
14919 "type": "integer",
14920 "format": "int32",
14921 "title": "Int32"
14922 },
14923 {
14924 "name": "businessId",
14925 "in": "path",
14926 "required": true,
14927 "type": "string"
14928 }
14929 ],
14930 "responses": {
14931 "200": {
14932 "description": "OK",
14933 "schema": {
14934 "$ref": "#/definitions/PayRunEmployerLiabilityResponse"
14935 }
14936 }
14937 }
14938 },
14939 "post": {
14940 "tags": [
14941 "PayRun"
14942 ],
14943 "summary": "Create Employer Liabilities",
14944 "description": "Add employer liabilities to the specified pay run.",
14945 "operationId": "PayRunEmployerLiabilities_Post",
14946 "consumes": [
14947 "application/json",
14948 "text/json",
14949 "application/xml",
14950 "text/xml",
14951 "application/x-www-form-urlencoded"
14952 ],
14953 "produces": [
14954 "application/json",
14955 "text/json",
14956 "application/xml",
14957 "text/xml"
14958 ],
14959 "parameters": [
14960 {
14961 "name": "payRunId",
14962 "in": "path",
14963 "required": true,
14964 "type": "integer",
14965 "format": "int32",
14966 "title": "Int32"
14967 },
14968 {
14969 "name": "request",
14970 "in": "body",
14971 "required": true,
14972 "schema": {
14973 "$ref": "#/definitions/SubmitPayRunEmployerLiabilityRequest"
14974 }
14975 },
14976 {
14977 "name": "businessId",
14978 "in": "path",
14979 "required": true,
14980 "type": "string"
14981 }
14982 ],
14983 "responses": {
14984 "200": {
14985 "description": "OK"
14986 }
14987 }
14988 },
14989 "delete": {
14990 "tags": [
14991 "PayRun"
14992 ],
14993 "summary": "Delete Employer Liability",
14994 "description": "Deletes the employer liability with the specified ID from the pay run.",
14995 "operationId": "PayRunEmployerLiabilities_Delete",
14996 "consumes": [],
14997 "produces": [
14998 "application/json",
14999 "text/json",
15000 "application/xml",
15001 "text/xml"
15002 ],
15003 "parameters": [
15004 {
15005 "name": "payRunId",
15006 "in": "path",
15007 "required": true,
15008 "type": "integer",
15009 "format": "int32",
15010 "title": "Int32"
15011 },
15012 {
15013 "name": "id",
15014 "in": "query",
15015 "required": true,
15016 "type": "integer",
15017 "format": "int32",
15018 "title": "Int32"
15019 },
15020 {
15021 "name": "businessId",
15022 "in": "path",
15023 "required": true,
15024 "type": "string"
15025 }
15026 ],
15027 "responses": {
15028 "200": {
15029 "description": "OK"
15030 }
15031 }
15032 }
15033 },
15034 "/api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities/{employeeId}": {
15035 "get": {
15036 "tags": [
15037 "PayRun"
15038 ],
15039 "summary": "Get Employer Liabilities by Employee ID",
15040 "description": "Gets all the employer liabilities for a specific employee in a pay run.",
15041 "operationId": "PayRunEmployerLiabilities_Get",
15042 "consumes": [],
15043 "produces": [
15044 "application/json",
15045 "text/json",
15046 "application/xml",
15047 "text/xml"
15048 ],
15049 "parameters": [
15050 {
15051 "name": "payRunId",
15052 "in": "path",
15053 "required": true,
15054 "type": "integer",
15055 "format": "int32",
15056 "title": "Int32"
15057 },
15058 {
15059 "name": "employeeId",
15060 "in": "path",
15061 "required": true,
15062 "type": "integer",
15063 "format": "int32",
15064 "title": "Int32"
15065 },
15066 {
15067 "name": "businessId",
15068 "in": "path",
15069 "required": true,
15070 "type": "string"
15071 }
15072 ],
15073 "responses": {
15074 "200": {
15075 "description": "OK",
15076 "schema": {
15077 "$ref": "#/definitions/PayRunEmployerLiabilityResponse"
15078 }
15079 }
15080 }
15081 }
15082 },
15083 "/api/v2/business/{businessId}/payrun/{payRunId}/finalise": {
15084 "post": {
15085 "tags": [
15086 "PayRun"
15087 ],
15088 "summary": "Finalise Pay Run",
15089 "description": "Finalises the specified pay run. A pay run can only be finalised if there are no calculations in progress.",
15090 "operationId": "PayRunFinalise_Post",
15091 "consumes": [
15092 "application/json",
15093 "text/json",
15094 "application/xml",
15095 "text/xml",
15096 "application/x-www-form-urlencoded"
15097 ],
15098 "produces": [
15099 "application/json",
15100 "text/json",
15101 "application/xml",
15102 "text/xml"
15103 ],
15104 "parameters": [
15105 {
15106 "name": "payRunId",
15107 "in": "path",
15108 "required": true,
15109 "type": "integer",
15110 "format": "int32",
15111 "title": "Int32"
15112 },
15113 {
15114 "name": "options",
15115 "in": "body",
15116 "required": true,
15117 "schema": {
15118 "$ref": "#/definitions/FinalisePayRunOptions"
15119 }
15120 },
15121 {
15122 "name": "businessId",
15123 "in": "path",
15124 "required": true,
15125 "type": "string"
15126 }
15127 ],
15128 "responses": {
15129 "200": {
15130 "description": "OK",
15131 "schema": {
15132 "$ref": "#/definitions/PayRunFinaliseResult"
15133 }
15134 }
15135 }
15136 }
15137 },
15138 "/api/v2/business/{businessId}/journal/{payRunId}": {
15139 "get": {
15140 "tags": [
15141 "PayRun"
15142 ],
15143 "summary": "Get Journal Details",
15144 "description": "Gets the journal details for this pay run.",
15145 "operationId": "Journal_Get",
15146 "consumes": [],
15147 "produces": [
15148 "application/json",
15149 "text/json",
15150 "application/xml",
15151 "text/xml"
15152 ],
15153 "parameters": [
15154 {
15155 "name": "payRunId",
15156 "in": "path",
15157 "required": true,
15158 "type": "integer",
15159 "format": "int32",
15160 "title": "Int32"
15161 },
15162 {
15163 "name": "businessId",
15164 "in": "path",
15165 "required": true,
15166 "type": "string"
15167 }
15168 ],
15169 "responses": {
15170 "200": {
15171 "description": "OK",
15172 "schema": {
15173 "type": "array",
15174 "items": {
15175 "$ref": "#/definitions/JournalItemResponse"
15176 },
15177 "xml": {
15178 "name": "JournalItemResponse",
15179 "wrapped": true
15180 },
15181 "title": "IEnumerable<JournalItemResponse>"
15182 }
15183 }
15184 }
15185 }
15186 },
15187 "/api/v2/business/{businessId}/payrun/{payRunId}/setuiunlockstate": {
15188 "post": {
15189 "tags": [
15190 "PayRun"
15191 ],
15192 "summary": "Set UI Unlock enabled",
15193 "description": "Sets whether a pay run can be unlocked by the UI or not. Only applies to finalized pay runs.",
15194 "operationId": "PayRunUnlockState_Post",
15195 "consumes": [
15196 "application/json",
15197 "text/json",
15198 "application/xml",
15199 "text/xml",
15200 "application/x-www-form-urlencoded"
15201 ],
15202 "produces": [
15203 "application/json",
15204 "text/json",
15205 "application/xml",
15206 "text/xml"
15207 ],
15208 "parameters": [
15209 {
15210 "name": "payRunId",
15211 "in": "path",
15212 "required": true,
15213 "type": "integer",
15214 "format": "int32",
15215 "title": "Int32"
15216 },
15217 {
15218 "name": "request",
15219 "in": "body",
15220 "required": true,
15221 "schema": {
15222 "$ref": "#/definitions/SetPayRunUIUnlockStateRequest"
15223 }
15224 },
15225 {
15226 "name": "businessId",
15227 "in": "path",
15228 "required": true,
15229 "type": "string"
15230 }
15231 ],
15232 "responses": {
15233 "200": {
15234 "description": "OK"
15235 }
15236 }
15237 }
15238 },
15239 "/api/v2/business/{businessId}/payrun/{payRunId}/totals": {
15240 "get": {
15241 "tags": [
15242 "PayRun"
15243 ],
15244 "summary": "List Pay Run Totals",
15245 "description": "Lists all of the pay run totals in a pay run.",
15246 "operationId": "PayRunTotals_Get",
15247 "consumes": [],
15248 "produces": [
15249 "application/json",
15250 "text/json",
15251 "application/xml",
15252 "text/xml"
15253 ],
15254 "parameters": [
15255 {
15256 "name": "payRunId",
15257 "in": "path",
15258 "required": true,
15259 "type": "integer",
15260 "format": "int32",
15261 "title": "Int32"
15262 },
15263 {
15264 "name": "businessId",
15265 "in": "path",
15266 "required": true,
15267 "type": "string"
15268 }
15269 ],
15270 "responses": {
15271 "200": {
15272 "description": "OK",
15273 "schema": {
15274 "$ref": "#/definitions/PayRunTotalResponse"
15275 }
15276 }
15277 }
15278 }
15279 },
15280 "/api/v2/business/{businessId}/payrun/{payRunId}/totals/{employeeId}": {
15281 "get": {
15282 "tags": [
15283 "PayRun"
15284 ],
15285 "summary": "Get Pay Slip Data by Employee ID",
15286 "description": "Gets the pay run totals for a specific employee in a pay run.",
15287 "operationId": "PayRunTotals_GetApiV2BusinessByBusinessIdPayrunByPayRunIdTotalsByEmployeeId",
15288 "consumes": [],
15289 "produces": [
15290 "application/json",
15291 "text/json",
15292 "application/xml",
15293 "text/xml"
15294 ],
15295 "parameters": [
15296 {
15297 "name": "payRunId",
15298 "in": "path",
15299 "required": true,
15300 "type": "integer",
15301 "format": "int32",
15302 "title": "Int32"
15303 },
15304 {
15305 "name": "employeeId",
15306 "in": "path",
15307 "required": true,
15308 "type": "integer",
15309 "format": "int32",
15310 "title": "Int32"
15311 },
15312 {
15313 "name": "businessId",
15314 "in": "path",
15315 "required": true,
15316 "type": "string"
15317 }
15318 ],
15319 "responses": {
15320 "200": {
15321 "description": "OK",
15322 "schema": {
15323 "$ref": "#/definitions/PayRunTotalResponse"
15324 }
15325 }
15326 }
15327 }
15328 },
15329 "/api/v2/business/{businessId}/payrun/{payRunId}/notation/{employeeId}": {
15330 "post": {
15331 "tags": [
15332 "PayRun"
15333 ],
15334 "summary": "Create Note for Employee",
15335 "description": "Creates a note for an employee record in a pay run.",
15336 "operationId": "PayRunTotals_Notation",
15337 "consumes": [
15338 "application/json",
15339 "text/json",
15340 "application/xml",
15341 "text/xml",
15342 "application/x-www-form-urlencoded"
15343 ],
15344 "produces": [
15345 "application/json",
15346 "text/json",
15347 "application/xml",
15348 "text/xml"
15349 ],
15350 "parameters": [
15351 {
15352 "name": "payRunId",
15353 "in": "path",
15354 "required": true,
15355 "type": "integer",
15356 "format": "int32",
15357 "title": "Int32"
15358 },
15359 {
15360 "name": "employeeId",
15361 "in": "path",
15362 "required": true,
15363 "type": "integer",
15364 "format": "int32",
15365 "title": "Int32"
15366 },
15367 {
15368 "name": "model",
15369 "in": "body",
15370 "required": true,
15371 "schema": {
15372 "$ref": "#/definitions/PayRunTotalNotationModel"
15373 }
15374 },
15375 {
15376 "name": "businessId",
15377 "in": "path",
15378 "required": true,
15379 "type": "string"
15380 }
15381 ],
15382 "responses": {
15383 "200": {
15384 "description": "OK"
15385 }
15386 }
15387 },
15388 "delete": {
15389 "tags": [
15390 "PayRun"
15391 ],
15392 "summary": "Delete Note for Employee",
15393 "description": "Deletes the note for an employee record in a pay run.",
15394 "operationId": "PayRunTotals_DeleteApiV2BusinessByBusinessIdPayrunByPayRunIdNotationByEmployeeId",
15395 "consumes": [],
15396 "produces": [
15397 "application/json",
15398 "text/json",
15399 "application/xml",
15400 "text/xml"
15401 ],
15402 "parameters": [
15403 {
15404 "name": "payRunId",
15405 "in": "path",
15406 "required": true,
15407 "type": "integer",
15408 "format": "int32",
15409 "title": "Int32"
15410 },
15411 {
15412 "name": "employeeId",
15413 "in": "path",
15414 "required": true,
15415 "type": "integer",
15416 "format": "int32",
15417 "title": "Int32"
15418 },
15419 {
15420 "name": "businessId",
15421 "in": "path",
15422 "required": true,
15423 "type": "string"
15424 }
15425 ],
15426 "responses": {
15427 "200": {
15428 "description": "OK"
15429 }
15430 }
15431 }
15432 },
15433 "/api/v2/business/{businessId}/payrun/{payRunId}/deductions": {
15434 "get": {
15435 "tags": [
15436 "PayRun"
15437 ],
15438 "summary": "List Deductions",
15439 "description": "Gets all the deductions for a pay run.",
15440 "operationId": "PayRunDeductions_Get",
15441 "consumes": [],
15442 "produces": [
15443 "application/json",
15444 "text/json",
15445 "application/xml",
15446 "text/xml"
15447 ],
15448 "parameters": [
15449 {
15450 "name": "payRunId",
15451 "in": "path",
15452 "required": true,
15453 "type": "integer",
15454 "format": "int32",
15455 "title": "Int32"
15456 },
15457 {
15458 "name": "businessId",
15459 "in": "path",
15460 "required": true,
15461 "type": "string"
15462 }
15463 ],
15464 "responses": {
15465 "200": {
15466 "description": "OK",
15467 "schema": {
15468 "$ref": "#/definitions/PayRunDeductionResponse"
15469 }
15470 }
15471 }
15472 },
15473 "post": {
15474 "tags": [
15475 "PayRun"
15476 ],
15477 "summary": "Create Deductions",
15478 "description": "Add deductions to the specified pay run.",
15479 "operationId": "PayRunDeductions_Post",
15480 "consumes": [
15481 "application/json",
15482 "text/json",
15483 "application/xml",
15484 "text/xml",
15485 "application/x-www-form-urlencoded"
15486 ],
15487 "produces": [
15488 "application/json",
15489 "text/json",
15490 "application/xml",
15491 "text/xml"
15492 ],
15493 "parameters": [
15494 {
15495 "name": "payRunId",
15496 "in": "path",
15497 "required": true,
15498 "type": "integer",
15499 "format": "int32",
15500 "title": "Int32"
15501 },
15502 {
15503 "name": "request",
15504 "in": "body",
15505 "required": true,
15506 "schema": {
15507 "$ref": "#/definitions/SubmitPayRunDeductionRequest"
15508 }
15509 },
15510 {
15511 "name": "businessId",
15512 "in": "path",
15513 "required": true,
15514 "type": "string"
15515 }
15516 ],
15517 "responses": {
15518 "200": {
15519 "description": "OK"
15520 }
15521 }
15522 },
15523 "delete": {
15524 "tags": [
15525 "PayRun"
15526 ],
15527 "summary": "Delete Deduction",
15528 "description": "Deletes the deduction with the specified ID from the pay run.",
15529 "operationId": "PayRunDeductions_Delete",
15530 "consumes": [],
15531 "produces": [
15532 "application/json",
15533 "text/json",
15534 "application/xml",
15535 "text/xml"
15536 ],
15537 "parameters": [
15538 {
15539 "name": "payRunId",
15540 "in": "path",
15541 "required": true,
15542 "type": "integer",
15543 "format": "int32",
15544 "title": "Int32"
15545 },
15546 {
15547 "name": "id",
15548 "in": "query",
15549 "required": true,
15550 "type": "integer",
15551 "format": "int32",
15552 "title": "Int32"
15553 },
15554 {
15555 "name": "businessId",
15556 "in": "path",
15557 "required": true,
15558 "type": "string"
15559 }
15560 ],
15561 "responses": {
15562 "200": {
15563 "description": "OK"
15564 }
15565 }
15566 }
15567 },
15568 "/api/v2/business/{businessId}/payrun/{payRunId}/deductions/{employeeId}": {
15569 "get": {
15570 "tags": [
15571 "PayRun"
15572 ],
15573 "summary": "Get Deductions by Employee ID",
15574 "description": "Gets all the deductions for a specific employee in a pay run.",
15575 "operationId": "PayRunDeductions_GetApiV2BusinessByBusinessIdPayrunByPayRunIdDeductionsByEmployeeId",
15576 "consumes": [],
15577 "produces": [
15578 "application/json",
15579 "text/json",
15580 "application/xml",
15581 "text/xml"
15582 ],
15583 "parameters": [
15584 {
15585 "name": "payRunId",
15586 "in": "path",
15587 "required": true,
15588 "type": "integer",
15589 "format": "int32",
15590 "title": "Int32"
15591 },
15592 {
15593 "name": "employeeId",
15594 "in": "path",
15595 "required": true,
15596 "type": "integer",
15597 "format": "int32",
15598 "title": "Int32"
15599 },
15600 {
15601 "name": "businessId",
15602 "in": "path",
15603 "required": true,
15604 "type": "string"
15605 }
15606 ],
15607 "responses": {
15608 "200": {
15609 "description": "OK",
15610 "schema": {
15611 "$ref": "#/definitions/PayRunDeductionResponse"
15612 }
15613 }
15614 }
15615 }
15616 },
15617 "/api/v2/business/{businessId}/payschedule": {
15618 "get": {
15619 "tags": [
15620 "PaySchedule"
15621 ],
15622 "summary": "List Pay Schedules",
15623 "description": "Lists all the pay schedules for the business.\n\nThis operation supports OData queries.",
15624 "operationId": "PaySchedule_GetPaySchedules",
15625 "consumes": [],
15626 "produces": [
15627 "application/json",
15628 "text/json",
15629 "application/xml",
15630 "text/xml"
15631 ],
15632 "parameters": [
15633 {
15634 "name": "businessId",
15635 "in": "path",
15636 "required": true,
15637 "type": "string"
15638 }
15639 ],
15640 "responses": {
15641 "200": {
15642 "description": "OK",
15643 "schema": {
15644 "type": "array",
15645 "items": {
15646 "$ref": "#/definitions/PayScheduleModel"
15647 },
15648 "xml": {
15649 "name": "PayScheduleModel",
15650 "wrapped": true
15651 },
15652 "title": "IEnumerable<PayScheduleModel>"
15653 }
15654 }
15655 }
15656 },
15657 "post": {
15658 "tags": [
15659 "PaySchedule"
15660 ],
15661 "summary": "Create Pay Schedule",
15662 "description": "Creates a new pay schedule for the business.",
15663 "operationId": "PaySchedule_Post",
15664 "consumes": [
15665 "application/json",
15666 "text/json",
15667 "application/xml",
15668 "text/xml",
15669 "application/x-www-form-urlencoded"
15670 ],
15671 "produces": [
15672 "application/json",
15673 "text/json",
15674 "application/xml",
15675 "text/xml"
15676 ],
15677 "parameters": [
15678 {
15679 "name": "paySchedule",
15680 "in": "body",
15681 "required": true,
15682 "schema": {
15683 "$ref": "#/definitions/PayScheduleModel"
15684 }
15685 },
15686 {
15687 "name": "businessId",
15688 "in": "path",
15689 "required": true,
15690 "type": "string"
15691 }
15692 ],
15693 "responses": {
15694 "200": {
15695 "description": "OK"
15696 }
15697 }
15698 }
15699 },
15700 "/api/v2/business/{businessId}/payschedule/{id}": {
15701 "get": {
15702 "tags": [
15703 "PaySchedule"
15704 ],
15705 "summary": "Get Pay Schedule by ID",
15706 "description": "Gets the pay schedule with the specified ID.",
15707 "operationId": "PaySchedule_Get",
15708 "consumes": [],
15709 "produces": [
15710 "application/json",
15711 "text/json",
15712 "application/xml",
15713 "text/xml"
15714 ],
15715 "parameters": [
15716 {
15717 "name": "id",
15718 "in": "path",
15719 "required": true,
15720 "type": "integer",
15721 "format": "int32",
15722 "title": "Int32"
15723 },
15724 {
15725 "name": "businessId",
15726 "in": "path",
15727 "required": true,
15728 "type": "string"
15729 }
15730 ],
15731 "responses": {
15732 "200": {
15733 "description": "OK",
15734 "schema": {
15735 "$ref": "#/definitions/PayScheduleModel"
15736 }
15737 }
15738 }
15739 },
15740 "put": {
15741 "tags": [
15742 "PaySchedule"
15743 ],
15744 "summary": "Update Pay Schedule",
15745 "description": "Updates the pay schedule with the specified ID.",
15746 "operationId": "PaySchedule_Put",
15747 "consumes": [
15748 "application/json",
15749 "text/json",
15750 "application/xml",
15751 "text/xml",
15752 "application/x-www-form-urlencoded"
15753 ],
15754 "produces": [
15755 "application/json",
15756 "text/json",
15757 "application/xml",
15758 "text/xml"
15759 ],
15760 "parameters": [
15761 {
15762 "name": "id",
15763 "in": "path",
15764 "required": true,
15765 "type": "integer",
15766 "format": "int32",
15767 "title": "Int32"
15768 },
15769 {
15770 "name": "paySchedule",
15771 "in": "body",
15772 "required": true,
15773 "schema": {
15774 "$ref": "#/definitions/PayScheduleModel"
15775 }
15776 },
15777 {
15778 "name": "businessId",
15779 "in": "path",
15780 "required": true,
15781 "type": "string"
15782 }
15783 ],
15784 "responses": {
15785 "200": {
15786 "description": "OK"
15787 }
15788 }
15789 },
15790 "delete": {
15791 "tags": [
15792 "PaySchedule"
15793 ],
15794 "summary": "Delete Pay Schedule",
15795 "description": "Deletes the pay schedule with the specified ID.",
15796 "operationId": "PaySchedule_Delete",
15797 "consumes": [],
15798 "produces": [
15799 "application/json",
15800 "text/json",
15801 "application/xml",
15802 "text/xml"
15803 ],
15804 "parameters": [
15805 {
15806 "name": "id",
15807 "in": "path",
15808 "required": true,
15809 "type": "integer",
15810 "format": "int32",
15811 "title": "Int32"
15812 },
15813 {
15814 "name": "businessId",
15815 "in": "path",
15816 "required": true,
15817 "type": "string"
15818 }
15819 ],
15820 "responses": {
15821 "200": {
15822 "description": "OK"
15823 }
15824 }
15825 }
15826 },
15827 "/api/v2/business/{businessId}/publicholiday": {
15828 "get": {
15829 "tags": [
15830 "PublicHoliday"
15831 ],
15832 "summary": "Get Public Holidays for Year",
15833 "description": "Retrieves all the public holidays for a specific year.",
15834 "operationId": "PublicHoliday_GetPublicHolidays",
15835 "consumes": [],
15836 "produces": [
15837 "application/json",
15838 "text/json",
15839 "application/xml",
15840 "text/xml"
15841 ],
15842 "parameters": [
15843 {
15844 "name": "year",
15845 "in": "query",
15846 "required": true,
15847 "type": "integer",
15848 "format": "int32",
15849 "title": "Int32"
15850 },
15851 {
15852 "name": "businessId",
15853 "in": "path",
15854 "required": true,
15855 "type": "string"
15856 }
15857 ],
15858 "responses": {
15859 "200": {
15860 "description": "OK",
15861 "schema": {
15862 "type": "array",
15863 "items": {
15864 "$ref": "#/definitions/PublicHolidayModel"
15865 },
15866 "xml": {
15867 "name": "PublicHolidayModel",
15868 "wrapped": true
15869 },
15870 "title": "IEnumerable<PublicHolidayModel>"
15871 }
15872 }
15873 }
15874 },
15875 "post": {
15876 "tags": [
15877 "PublicHoliday"
15878 ],
15879 "summary": "Add a public holiday",
15880 "description": "Adds a new public holiday.",
15881 "operationId": "PublicHoliday_Post",
15882 "consumes": [
15883 "application/json",
15884 "text/json",
15885 "application/xml",
15886 "text/xml",
15887 "application/x-www-form-urlencoded"
15888 ],
15889 "produces": [
15890 "application/json",
15891 "text/json",
15892 "application/xml",
15893 "text/xml"
15894 ],
15895 "parameters": [
15896 {
15897 "name": "publicHoliday",
15898 "in": "body",
15899 "required": true,
15900 "schema": {
15901 "$ref": "#/definitions/PublicHolidayModel"
15902 }
15903 },
15904 {
15905 "name": "businessId",
15906 "in": "path",
15907 "required": true,
15908 "type": "string"
15909 }
15910 ],
15911 "responses": {
15912 "200": {
15913 "description": "OK"
15914 }
15915 }
15916 },
15917 "delete": {
15918 "tags": [
15919 "PublicHoliday"
15920 ],
15921 "summary": "Delete Public Holiday by Date",
15922 "description": "Deletes all the public holidays on a specific date.",
15923 "operationId": "PublicHoliday_Delete",
15924 "consumes": [],
15925 "produces": [
15926 "application/json",
15927 "text/json",
15928 "application/xml",
15929 "text/xml"
15930 ],
15931 "parameters": [
15932 {
15933 "name": "date",
15934 "in": "query",
15935 "required": true,
15936 "type": "string",
15937 "format": "date-time",
15938 "title": "DateTime"
15939 },
15940 {
15941 "name": "businessId",
15942 "in": "path",
15943 "required": true,
15944 "type": "string"
15945 }
15946 ],
15947 "responses": {
15948 "200": {
15949 "description": "OK"
15950 }
15951 }
15952 }
15953 },
15954 "/api/v2/business/{businessId}/publicholiday/{id}": {
15955 "get": {
15956 "tags": [
15957 "PublicHoliday"
15958 ],
15959 "summary": "Get Public Holiday Details",
15960 "description": "Gets the details for a public holiday with a specific ID",
15961 "operationId": "PublicHoliday_Get",
15962 "consumes": [],
15963 "produces": [
15964 "application/json",
15965 "text/json",
15966 "application/xml",
15967 "text/xml"
15968 ],
15969 "parameters": [
15970 {
15971 "name": "id",
15972 "in": "path",
15973 "required": true,
15974 "type": "integer",
15975 "format": "int32",
15976 "title": "Int32"
15977 },
15978 {
15979 "name": "businessId",
15980 "in": "path",
15981 "required": true,
15982 "type": "string"
15983 }
15984 ],
15985 "responses": {
15986 "200": {
15987 "description": "OK",
15988 "schema": {
15989 "$ref": "#/definitions/PublicHolidayModel"
15990 }
15991 }
15992 }
15993 },
15994 "put": {
15995 "tags": [
15996 "PublicHoliday"
15997 ],
15998 "summary": "Update Public Holiday",
15999 "description": "Updates the public holiday with the specific ID.",
16000 "operationId": "PublicHoliday_Put",
16001 "consumes": [
16002 "application/json",
16003 "text/json",
16004 "application/xml",
16005 "text/xml",
16006 "application/x-www-form-urlencoded"
16007 ],
16008 "produces": [
16009 "application/json",
16010 "text/json",
16011 "application/xml",
16012 "text/xml"
16013 ],
16014 "parameters": [
16015 {
16016 "name": "id",
16017 "in": "path",
16018 "required": true,
16019 "type": "integer",
16020 "format": "int32",
16021 "title": "Int32"
16022 },
16023 {
16024 "name": "publicHoliday",
16025 "in": "body",
16026 "required": true,
16027 "schema": {
16028 "$ref": "#/definitions/PublicHolidayModel"
16029 }
16030 },
16031 {
16032 "name": "businessId",
16033 "in": "path",
16034 "required": true,
16035 "type": "string"
16036 }
16037 ],
16038 "responses": {
16039 "200": {
16040 "description": "OK"
16041 }
16042 }
16043 },
16044 "delete": {
16045 "tags": [
16046 "PublicHoliday"
16047 ],
16048 "summary": "Delete Public Holiday",
16049 "description": "Deletes the public holiday with the specified ID.",
16050 "operationId": "PublicHoliday_DeleteApiV2BusinessByBusinessIdPublicholidayById",
16051 "consumes": [],
16052 "produces": [
16053 "application/json",
16054 "text/json",
16055 "application/xml",
16056 "text/xml"
16057 ],
16058 "parameters": [
16059 {
16060 "name": "id",
16061 "in": "path",
16062 "required": true,
16063 "type": "integer",
16064 "format": "int32",
16065 "title": "Int32"
16066 },
16067 {
16068 "name": "businessId",
16069 "in": "path",
16070 "required": true,
16071 "type": "string"
16072 }
16073 ],
16074 "responses": {
16075 "200": {
16076 "description": "OK"
16077 }
16078 }
16079 }
16080 },
16081 "/api/v2/business/{businessId}/qualification": {
16082 "get": {
16083 "tags": [
16084 "Qualifications"
16085 ],
16086 "summary": "List Qualifications",
16087 "description": "Lists all of the qualifications for the business.\n\nThis operation supports OData queries.",
16088 "operationId": "Qualification_GetQualifications",
16089 "consumes": [],
16090 "produces": [
16091 "application/json",
16092 "text/json",
16093 "application/xml",
16094 "text/xml"
16095 ],
16096 "parameters": [
16097 {
16098 "name": "businessId",
16099 "in": "path",
16100 "required": true,
16101 "type": "string"
16102 }
16103 ],
16104 "responses": {
16105 "200": {
16106 "description": "OK",
16107 "schema": {
16108 "type": "array",
16109 "items": {
16110 "$ref": "#/definitions/QualificationModel"
16111 },
16112 "xml": {
16113 "name": "QualificationModel",
16114 "wrapped": true
16115 },
16116 "title": "IEnumerable<QualificationModel>"
16117 }
16118 }
16119 }
16120 },
16121 "post": {
16122 "tags": [
16123 "Qualifications"
16124 ],
16125 "summary": "Create Qualification",
16126 "description": "Creates a new employee qualification for the business.",
16127 "operationId": "Qualification_Post",
16128 "consumes": [
16129 "application/json",
16130 "text/json",
16131 "application/xml",
16132 "text/xml",
16133 "application/x-www-form-urlencoded"
16134 ],
16135 "produces": [
16136 "application/json",
16137 "text/json",
16138 "application/xml",
16139 "text/xml"
16140 ],
16141 "parameters": [
16142 {
16143 "name": "qualification",
16144 "in": "body",
16145 "required": true,
16146 "schema": {
16147 "$ref": "#/definitions/QualificationModel"
16148 }
16149 },
16150 {
16151 "name": "businessId",
16152 "in": "path",
16153 "required": true,
16154 "type": "string"
16155 }
16156 ],
16157 "responses": {
16158 "200": {
16159 "description": "OK"
16160 }
16161 }
16162 }
16163 },
16164 "/api/v2/business/{businessId}/qualification/{id}": {
16165 "get": {
16166 "tags": [
16167 "Qualifications"
16168 ],
16169 "summary": "Get Qualification by ID",
16170 "description": "Gets the qualification with the specified ID.",
16171 "operationId": "Qualification_Get",
16172 "consumes": [],
16173 "produces": [
16174 "application/json",
16175 "text/json",
16176 "application/xml",
16177 "text/xml"
16178 ],
16179 "parameters": [
16180 {
16181 "name": "id",
16182 "in": "path",
16183 "required": true,
16184 "type": "integer",
16185 "format": "int32",
16186 "title": "Int32"
16187 },
16188 {
16189 "name": "businessId",
16190 "in": "path",
16191 "required": true,
16192 "type": "string"
16193 }
16194 ],
16195 "responses": {
16196 "200": {
16197 "description": "OK",
16198 "schema": {
16199 "$ref": "#/definitions/QualificationModel"
16200 }
16201 }
16202 }
16203 },
16204 "put": {
16205 "tags": [
16206 "Qualifications"
16207 ],
16208 "summary": "Update Qualification",
16209 "description": "Updates the qualification with the specified ID.",
16210 "operationId": "Qualification_Put",
16211 "consumes": [
16212 "application/json",
16213 "text/json",
16214 "application/xml",
16215 "text/xml",
16216 "application/x-www-form-urlencoded"
16217 ],
16218 "produces": [
16219 "application/json",
16220 "text/json",
16221 "application/xml",
16222 "text/xml"
16223 ],
16224 "parameters": [
16225 {
16226 "name": "id",
16227 "in": "path",
16228 "required": true,
16229 "type": "integer",
16230 "format": "int32",
16231 "title": "Int32"
16232 },
16233 {
16234 "name": "qualification",
16235 "in": "body",
16236 "required": true,
16237 "schema": {
16238 "$ref": "#/definitions/QualificationModel"
16239 }
16240 },
16241 {
16242 "name": "businessId",
16243 "in": "path",
16244 "required": true,
16245 "type": "string"
16246 }
16247 ],
16248 "responses": {
16249 "200": {
16250 "description": "OK"
16251 }
16252 }
16253 },
16254 "delete": {
16255 "tags": [
16256 "Qualifications"
16257 ],
16258 "summary": "Delete Qualification",
16259 "description": "Deletes the qualification with the specified ID.",
16260 "operationId": "Qualification_Delete",
16261 "consumes": [],
16262 "produces": [
16263 "application/json",
16264 "text/json",
16265 "application/xml",
16266 "text/xml"
16267 ],
16268 "parameters": [
16269 {
16270 "name": "id",
16271 "in": "path",
16272 "required": true,
16273 "type": "integer",
16274 "format": "int32",
16275 "title": "Int32"
16276 },
16277 {
16278 "name": "businessId",
16279 "in": "path",
16280 "required": true,
16281 "type": "string"
16282 }
16283 ],
16284 "responses": {
16285 "200": {
16286 "description": "OK"
16287 }
16288 }
16289 }
16290 },
16291 "/api/v2/business/{businessId}/report/supercontributions/byemployee": {
16292 "get": {
16293 "tags": [
16294 "Reporting"
16295 ],
16296 "summary": "Super Contribution Report (By Employee)",
16297 "description": "Generates a super contribution report by employee.",
16298 "operationId": "ReportsSuperContributions_ByEmployee",
16299 "consumes": [],
16300 "produces": [
16301 "application/json",
16302 "text/json",
16303 "application/xml",
16304 "text/xml"
16305 ],
16306 "parameters": [
16307 {
16308 "name": "businessId",
16309 "in": "path",
16310 "required": true,
16311 "type": "string"
16312 },
16313 {
16314 "name": "request.payScheduleId",
16315 "in": "query",
16316 "required": false,
16317 "type": "integer",
16318 "format": "int32",
16319 "title": "Int32"
16320 },
16321 {
16322 "name": "request.fromDate",
16323 "in": "query",
16324 "required": false,
16325 "type": "string",
16326 "format": "date-time",
16327 "title": "DateTime"
16328 },
16329 {
16330 "name": "request.toDate",
16331 "in": "query",
16332 "required": false,
16333 "type": "string",
16334 "format": "date-time",
16335 "title": "DateTime"
16336 },
16337 {
16338 "name": "request.locationId",
16339 "in": "query",
16340 "required": false,
16341 "type": "integer",
16342 "format": "int32",
16343 "title": "Int32"
16344 },
16345 {
16346 "name": "request.employingEntityId",
16347 "in": "query",
16348 "required": false,
16349 "type": "integer",
16350 "format": "int32",
16351 "title": "Nullable<Int32>"
16352 }
16353 ],
16354 "responses": {
16355 "200": {
16356 "description": "OK",
16357 "schema": {
16358 "type": "array",
16359 "items": {
16360 "$ref": "#/definitions/SuperAccrualExportModel"
16361 },
16362 "xml": {
16363 "name": "SuperAccrualExportModel",
16364 "wrapped": true
16365 },
16366 "title": "IEnumerable<SuperAccrualExportModel>"
16367 }
16368 }
16369 }
16370 }
16371 },
16372 "/api/v2/business/{businessId}/report/supercontributions/bysuperfund": {
16373 "get": {
16374 "tags": [
16375 "Reporting"
16376 ],
16377 "summary": "Super Contribution Report (By Super Fund)",
16378 "description": "Generates a super contribution report by super fund.",
16379 "operationId": "ReportsSuperContributions_BySuperFund",
16380 "consumes": [],
16381 "produces": [
16382 "application/json",
16383 "text/json",
16384 "application/xml",
16385 "text/xml"
16386 ],
16387 "parameters": [
16388 {
16389 "name": "businessId",
16390 "in": "path",
16391 "required": true,
16392 "type": "string"
16393 },
16394 {
16395 "name": "request.payScheduleId",
16396 "in": "query",
16397 "required": false,
16398 "type": "integer",
16399 "format": "int32",
16400 "title": "Int32"
16401 },
16402 {
16403 "name": "request.fromDate",
16404 "in": "query",
16405 "required": false,
16406 "type": "string",
16407 "format": "date-time",
16408 "title": "DateTime"
16409 },
16410 {
16411 "name": "request.toDate",
16412 "in": "query",
16413 "required": false,
16414 "type": "string",
16415 "format": "date-time",
16416 "title": "DateTime"
16417 },
16418 {
16419 "name": "request.locationId",
16420 "in": "query",
16421 "required": false,
16422 "type": "integer",
16423 "format": "int32",
16424 "title": "Int32"
16425 },
16426 {
16427 "name": "request.employingEntityId",
16428 "in": "query",
16429 "required": false,
16430 "type": "integer",
16431 "format": "int32",
16432 "title": "Nullable<Int32>"
16433 }
16434 ],
16435 "responses": {
16436 "200": {
16437 "description": "OK",
16438 "schema": {
16439 "type": "array",
16440 "items": {
16441 "$ref": "#/definitions/SuperContributionsReportExportModel"
16442 },
16443 "xml": {
16444 "name": "SuperContributionsReportExportModel",
16445 "wrapped": true
16446 },
16447 "title": "IEnumerable<SuperContributionsReportExportModel>"
16448 }
16449 }
16450 }
16451 }
16452 },
16453 "/api/v2/business/{businessId}/report/leavebalances": {
16454 "get": {
16455 "tags": [
16456 "Reporting"
16457 ],
16458 "summary": "Leave Balances Report",
16459 "description": "Generates a leave balances report.",
16460 "operationId": "ReportsLeaveBalances_Get",
16461 "consumes": [],
16462 "produces": [
16463 "application/json",
16464 "text/json",
16465 "application/xml",
16466 "text/xml"
16467 ],
16468 "parameters": [
16469 {
16470 "name": "businessId",
16471 "in": "path",
16472 "required": true,
16473 "type": "string"
16474 },
16475 {
16476 "name": "request.locationId",
16477 "in": "query",
16478 "required": false,
16479 "type": "integer",
16480 "format": "int32",
16481 "title": "Int32"
16482 },
16483 {
16484 "name": "request.leaveTypeId",
16485 "in": "query",
16486 "required": false,
16487 "type": "integer",
16488 "format": "int32",
16489 "title": "Int32"
16490 },
16491 {
16492 "name": "request.groupBy",
16493 "in": "query",
16494 "required": false,
16495 "type": "string",
16496 "enum": [
16497 "AccrualLocation",
16498 "DefaultLocation"
16499 ],
16500 "title": "LeaveReportDisplayEnum"
16501 },
16502 {
16503 "name": "request.employingEntityId",
16504 "in": "query",
16505 "required": false,
16506 "type": "integer",
16507 "format": "int32",
16508 "title": "Nullable<Int32>"
16509 },
16510 {
16511 "name": "request.asAtDate",
16512 "in": "query",
16513 "required": false,
16514 "type": "string",
16515 "format": "date-time",
16516 "title": "Nullable<DateTime>"
16517 }
16518 ],
16519 "responses": {
16520 "200": {
16521 "description": "OK",
16522 "schema": {
16523 "type": "array",
16524 "items": {
16525 "$ref": "#/definitions/LeaveBalancesReportExportModel"
16526 },
16527 "xml": {
16528 "name": "LeaveBalancesReportExportModel",
16529 "wrapped": true
16530 },
16531 "title": "IEnumerable<LeaveBalancesReportExportModel>"
16532 }
16533 }
16534 }
16535 }
16536 },
16537 "/api/v2/business/{businessId}/report/deductions": {
16538 "get": {
16539 "tags": [
16540 "Reporting"
16541 ],
16542 "summary": "Deductions Report",
16543 "description": "Generates a deductions report.",
16544 "operationId": "ReportsDeductions_Get",
16545 "consumes": [],
16546 "produces": [
16547 "application/json",
16548 "text/json",
16549 "application/xml",
16550 "text/xml"
16551 ],
16552 "parameters": [
16553 {
16554 "name": "businessId",
16555 "in": "path",
16556 "required": true,
16557 "type": "string"
16558 },
16559 {
16560 "name": "request.employeeId",
16561 "in": "query",
16562 "required": false,
16563 "type": "integer",
16564 "format": "int32",
16565 "title": "Int32"
16566 },
16567 {
16568 "name": "request.deductionCategoryId",
16569 "in": "query",
16570 "required": false,
16571 "type": "integer",
16572 "format": "int32",
16573 "title": "Int32"
16574 },
16575 {
16576 "name": "request.disableRollupReporting",
16577 "in": "query",
16578 "required": false,
16579 "type": "boolean",
16580 "title": "Boolean"
16581 },
16582 {
16583 "name": "request.payScheduleId",
16584 "in": "query",
16585 "required": false,
16586 "type": "integer",
16587 "format": "int32",
16588 "title": "Int32"
16589 },
16590 {
16591 "name": "request.fromDate",
16592 "in": "query",
16593 "required": false,
16594 "type": "string",
16595 "format": "date-time",
16596 "title": "DateTime"
16597 },
16598 {
16599 "name": "request.toDate",
16600 "in": "query",
16601 "required": false,
16602 "type": "string",
16603 "format": "date-time",
16604 "title": "DateTime"
16605 },
16606 {
16607 "name": "request.locationId",
16608 "in": "query",
16609 "required": false,
16610 "type": "integer",
16611 "format": "int32",
16612 "title": "Int32"
16613 },
16614 {
16615 "name": "request.employingEntityId",
16616 "in": "query",
16617 "required": false,
16618 "type": "integer",
16619 "format": "int32",
16620 "title": "Nullable<Int32>"
16621 }
16622 ],
16623 "responses": {
16624 "200": {
16625 "description": "OK",
16626 "schema": {
16627 "type": "array",
16628 "items": {
16629 "$ref": "#/definitions/DeductionsReportExportModel"
16630 },
16631 "xml": {
16632 "name": "DeductionsReportExportModel",
16633 "wrapped": true
16634 },
16635 "title": "IList<DeductionsReportExportModel>"
16636 }
16637 }
16638 }
16639 }
16640 },
16641 "/api/v2/business/{businessId}/report/payrunactivity": {
16642 "get": {
16643 "tags": [
16644 "Reporting"
16645 ],
16646 "summary": "Pay Run Activity Report",
16647 "description": "Generates a pay run activity report.",
16648 "operationId": "ReportsPayRunActivity_Get",
16649 "consumes": [],
16650 "produces": [
16651 "application/json",
16652 "text/json",
16653 "application/xml",
16654 "text/xml"
16655 ],
16656 "parameters": [
16657 {
16658 "name": "fromDate",
16659 "in": "query",
16660 "required": true,
16661 "type": "string",
16662 "format": "date-time",
16663 "title": "DateTime"
16664 },
16665 {
16666 "name": "toDate",
16667 "in": "query",
16668 "required": true,
16669 "type": "string",
16670 "format": "date-time",
16671 "title": "DateTime"
16672 },
16673 {
16674 "name": "payScheduleId",
16675 "in": "query",
16676 "required": false,
16677 "type": "integer",
16678 "format": "int32",
16679 "default": 0,
16680 "title": "Int32"
16681 },
16682 {
16683 "name": "locationId",
16684 "in": "query",
16685 "required": false,
16686 "type": "integer",
16687 "format": "int32",
16688 "default": 0,
16689 "title": "Int32"
16690 },
16691 {
16692 "name": "businessId",
16693 "in": "path",
16694 "required": true,
16695 "type": "string"
16696 }
16697 ],
16698 "responses": {
16699 "200": {
16700 "description": "OK",
16701 "schema": {
16702 "type": "array",
16703 "items": {
16704 "$ref": "#/definitions/ActivityReportExportModel"
16705 },
16706 "xml": {
16707 "name": "ActivityReportExportModel",
16708 "wrapped": true
16709 },
16710 "title": "IEnumerable<ActivityReportExportModel>"
16711 }
16712 }
16713 }
16714 }
16715 },
16716 "/api/v2/business/{businessId}/report/employeedetails": {
16717 "get": {
16718 "tags": [
16719 "Reporting"
16720 ],
16721 "summary": "Employee Details Report",
16722 "description": "Generates an employee details report.",
16723 "operationId": "ReportsEmployeeDetails_Get",
16724 "consumes": [],
16725 "produces": [
16726 "application/json",
16727 "text/json"
16728 ],
16729 "parameters": [
16730 {
16731 "name": "selectedColumns",
16732 "in": "query",
16733 "required": false,
16734 "type": "array",
16735 "items": {
16736 "type": "string",
16737 "title": "String"
16738 },
16739 "collectionFormat": "multi",
16740 "title": "List<String>"
16741 },
16742 {
16743 "name": "locationId",
16744 "in": "query",
16745 "required": false,
16746 "type": "integer",
16747 "format": "int32",
16748 "default": 0,
16749 "title": "Int32"
16750 },
16751 {
16752 "name": "employingEntityId",
16753 "in": "query",
16754 "required": false,
16755 "type": "integer",
16756 "format": "int32",
16757 "title": "Nullable<Int32>"
16758 },
16759 {
16760 "name": "includeActive",
16761 "in": "query",
16762 "required": false,
16763 "type": "boolean",
16764 "default": true,
16765 "title": "Boolean"
16766 },
16767 {
16768 "name": "includeInactive",
16769 "in": "query",
16770 "required": false,
16771 "type": "boolean",
16772 "default": true,
16773 "title": "Boolean"
16774 },
16775 {
16776 "name": "businessId",
16777 "in": "path",
16778 "required": true,
16779 "type": "string"
16780 }
16781 ],
16782 "responses": {
16783 "200": {
16784 "description": "OK",
16785 "schema": {
16786 "type": "array",
16787 "items": {
16788 "type": "object",
16789 "title": "JObject"
16790 },
16791 "xml": {
16792 "name": "JObject",
16793 "wrapped": true
16794 },
16795 "title": "IEnumerable<JObject>"
16796 }
16797 }
16798 }
16799 }
16800 },
16801 "/api/v2/business/{businessId}/report/leavehistory": {
16802 "get": {
16803 "tags": [
16804 "Reporting"
16805 ],
16806 "summary": "Leave History Report",
16807 "description": "Generates a leave history report.",
16808 "operationId": "ReportsLeaveHistoryReport_Get",
16809 "consumes": [],
16810 "produces": [
16811 "application/json",
16812 "text/json",
16813 "application/xml",
16814 "text/xml"
16815 ],
16816 "parameters": [
16817 {
16818 "name": "businessId",
16819 "in": "path",
16820 "required": true,
16821 "type": "string"
16822 },
16823 {
16824 "name": "model.fromDate",
16825 "in": "query",
16826 "required": false,
16827 "type": "string",
16828 "format": "date-time",
16829 "title": "DateTime"
16830 },
16831 {
16832 "name": "model.toDate",
16833 "in": "query",
16834 "required": false,
16835 "type": "string",
16836 "format": "date-time",
16837 "title": "DateTime"
16838 },
16839 {
16840 "name": "model.payScheduleId",
16841 "in": "query",
16842 "required": false,
16843 "type": "integer",
16844 "format": "int32",
16845 "title": "Int32"
16846 },
16847 {
16848 "name": "model.locationId",
16849 "in": "query",
16850 "required": false,
16851 "type": "integer",
16852 "format": "int32",
16853 "title": "Int32"
16854 },
16855 {
16856 "name": "model.employeeId",
16857 "in": "query",
16858 "required": false,
16859 "type": "array",
16860 "items": {
16861 "type": "string",
16862 "title": "String"
16863 },
16864 "collectionFormat": "multi",
16865 "title": "IList<String>"
16866 },
16867 {
16868 "name": "model.leaveCategoryId",
16869 "in": "query",
16870 "required": false,
16871 "type": "integer",
16872 "format": "int32",
16873 "title": "Int32"
16874 }
16875 ],
16876 "responses": {
16877 "200": {
16878 "description": "OK",
16879 "schema": {
16880 "type": "array",
16881 "items": {
16882 "$ref": "#/definitions/LeaveHistoryReportGroupModel"
16883 },
16884 "xml": {
16885 "name": "LeaveHistoryReportGroupModel",
16886 "wrapped": true
16887 },
16888 "title": "IEnumerable<LeaveHistoryReportGroupModel>"
16889 }
16890 }
16891 }
16892 }
16893 },
16894 "/api/v2/business/{businessId}/report/employeedetails/fields": {
16895 "get": {
16896 "tags": [
16897 "Reporting"
16898 ],
16899 "summary": "Get Employee Details Report Fields",
16900 "description": "Gets the fields for the Employee Details Report.",
16901 "operationId": "ReportsEmployeeDetailsFields_Get",
16902 "consumes": [],
16903 "produces": [
16904 "application/json",
16905 "text/json",
16906 "application/xml",
16907 "text/xml"
16908 ],
16909 "parameters": [
16910 {
16911 "name": "businessId",
16912 "in": "path",
16913 "required": true,
16914 "type": "string"
16915 }
16916 ],
16917 "responses": {
16918 "200": {
16919 "description": "OK",
16920 "schema": {
16921 "type": "array",
16922 "items": {
16923 "$ref": "#/definitions/EmployeeDetailsReportField"
16924 },
16925 "xml": {
16926 "name": "EmployeeDetailsReportField",
16927 "wrapped": true
16928 },
16929 "title": "List<EmployeeDetailsReportField>"
16930 }
16931 }
16932 }
16933 }
16934 },
16935 "/api/v2/business/{businessId}/report/paycategories": {
16936 "get": {
16937 "tags": [
16938 "Reporting"
16939 ],
16940 "summary": "Pay Categories Report",
16941 "description": "Generates a pay categories report.",
16942 "operationId": "ReportsPayCategories_Get",
16943 "consumes": [],
16944 "produces": [
16945 "application/json",
16946 "text/json",
16947 "application/xml",
16948 "text/xml"
16949 ],
16950 "parameters": [
16951 {
16952 "name": "businessId",
16953 "in": "path",
16954 "required": true,
16955 "type": "string"
16956 },
16957 {
16958 "name": "request.payScheduleId",
16959 "in": "query",
16960 "required": false,
16961 "type": "integer",
16962 "format": "int32",
16963 "title": "Int32"
16964 },
16965 {
16966 "name": "request.employeeId",
16967 "in": "query",
16968 "required": false,
16969 "type": "integer",
16970 "format": "int32",
16971 "title": "Int32"
16972 },
16973 {
16974 "name": "request.groupByEarningsLocation",
16975 "in": "query",
16976 "required": false,
16977 "type": "boolean",
16978 "title": "Boolean"
16979 },
16980 {
16981 "name": "request.fromDate",
16982 "in": "query",
16983 "required": false,
16984 "type": "string",
16985 "format": "date-time",
16986 "title": "DateTime"
16987 },
16988 {
16989 "name": "request.toDate",
16990 "in": "query",
16991 "required": false,
16992 "type": "string",
16993 "format": "date-time",
16994 "title": "DateTime"
16995 },
16996 {
16997 "name": "request.locationId",
16998 "in": "query",
16999 "required": false,
17000 "type": "integer",
17001 "format": "int32",
17002 "title": "Int32"
17003 },
17004 {
17005 "name": "request.employingEntityId",
17006 "in": "query",
17007 "required": false,
17008 "type": "integer",
17009 "format": "int32",
17010 "title": "Nullable<Int32>"
17011 }
17012 ],
17013 "responses": {
17014 "200": {
17015 "description": "OK",
17016 "schema": {
17017 "type": "array",
17018 "items": {
17019 "$ref": "#/definitions/PayCategoriesReportExportModel"
17020 },
17021 "xml": {
17022 "name": "PayCategoriesReportExportModel",
17023 "wrapped": true
17024 },
17025 "title": "IEnumerable<PayCategoriesReportExportModel>"
17026 }
17027 }
17028 }
17029 }
17030 },
17031 "/api/v2/business/{businessId}/report/payg": {
17032 "get": {
17033 "tags": [
17034 "Reporting"
17035 ],
17036 "summary": "PAYG Report",
17037 "description": "Generates a PAYG report.",
17038 "operationId": "ReportsPayg_Get",
17039 "consumes": [],
17040 "produces": [
17041 "application/json",
17042 "text/json",
17043 "application/xml",
17044 "text/xml"
17045 ],
17046 "parameters": [
17047 {
17048 "name": "businessId",
17049 "in": "path",
17050 "required": true,
17051 "type": "string"
17052 },
17053 {
17054 "name": "request.state",
17055 "in": "query",
17056 "required": false,
17057 "type": "string",
17058 "title": "String"
17059 },
17060 {
17061 "name": "request.fromDate",
17062 "in": "query",
17063 "required": false,
17064 "type": "string",
17065 "format": "date-time",
17066 "title": "DateTime"
17067 },
17068 {
17069 "name": "request.toDate",
17070 "in": "query",
17071 "required": false,
17072 "type": "string",
17073 "format": "date-time",
17074 "title": "DateTime"
17075 },
17076 {
17077 "name": "request.locationId",
17078 "in": "query",
17079 "required": false,
17080 "type": "integer",
17081 "format": "int32",
17082 "title": "Int32"
17083 },
17084 {
17085 "name": "request.employingEntityId",
17086 "in": "query",
17087 "required": false,
17088 "type": "integer",
17089 "format": "int32",
17090 "title": "Nullable<Int32>"
17091 }
17092 ],
17093 "responses": {
17094 "200": {
17095 "description": "OK",
17096 "schema": {
17097 "type": "array",
17098 "items": {
17099 "$ref": "#/definitions/PaygReportExportModel"
17100 },
17101 "xml": {
17102 "name": "PaygReportExportModel",
17103 "wrapped": true
17104 },
17105 "title": "IList<PaygReportExportModel>"
17106 }
17107 }
17108 }
17109 }
17110 },
17111 "/api/v2/business/{businessId}/report/detailedactivity": {
17112 "get": {
17113 "tags": [
17114 "Reporting"
17115 ],
17116 "summary": "Detailed Activity Report",
17117 "description": "Generates a detailed activity report.",
17118 "operationId": "ReportsDetailedActivity_Get",
17119 "consumes": [],
17120 "produces": [
17121 "application/json",
17122 "text/json",
17123 "application/xml",
17124 "text/xml"
17125 ],
17126 "parameters": [
17127 {
17128 "name": "businessId",
17129 "in": "path",
17130 "required": true,
17131 "type": "string"
17132 },
17133 {
17134 "name": "request.payScheduleId",
17135 "in": "query",
17136 "required": false,
17137 "type": "integer",
17138 "format": "int32",
17139 "title": "Int32"
17140 },
17141 {
17142 "name": "request.fromDate",
17143 "in": "query",
17144 "required": false,
17145 "type": "string",
17146 "format": "date-time",
17147 "title": "DateTime"
17148 },
17149 {
17150 "name": "request.toDate",
17151 "in": "query",
17152 "required": false,
17153 "type": "string",
17154 "format": "date-time",
17155 "title": "DateTime"
17156 },
17157 {
17158 "name": "request.locationId",
17159 "in": "query",
17160 "required": false,
17161 "type": "integer",
17162 "format": "int32",
17163 "title": "Int32"
17164 },
17165 {
17166 "name": "request.employingEntityId",
17167 "in": "query",
17168 "required": false,
17169 "type": "integer",
17170 "format": "int32",
17171 "title": "Nullable<Int32>"
17172 }
17173 ],
17174 "responses": {
17175 "200": {
17176 "description": "OK",
17177 "schema": {
17178 "type": "array",
17179 "items": {
17180 "$ref": "#/definitions/DetailedActivityReportExportModel"
17181 },
17182 "xml": {
17183 "name": "DetailedActivityReportExportModel",
17184 "wrapped": true
17185 },
17186 "title": "IEnumerable<DetailedActivityReportExportModel>"
17187 }
17188 }
17189 }
17190 }
17191 },
17192 "/api/v2/business/{businessId}/report/payrolltax": {
17193 "get": {
17194 "tags": [
17195 "Reporting"
17196 ],
17197 "summary": "Payroll Tax Report",
17198 "description": "Generates a payroll tax report.",
17199 "operationId": "ReportsPayrollTax_Get",
17200 "consumes": [],
17201 "produces": [
17202 "application/json",
17203 "text/json",
17204 "application/xml",
17205 "text/xml"
17206 ],
17207 "parameters": [
17208 {
17209 "name": "businessId",
17210 "in": "path",
17211 "required": true,
17212 "type": "string"
17213 },
17214 {
17215 "name": "request.groupBy",
17216 "in": "query",
17217 "required": false,
17218 "type": "string",
17219 "enum": [
17220 "EarningsLocation",
17221 "DefaultLocation"
17222 ],
17223 "title": "PayrollTaxGroupByEnum"
17224 },
17225 {
17226 "name": "request.fromDate",
17227 "in": "query",
17228 "required": false,
17229 "type": "string",
17230 "format": "date-time",
17231 "title": "DateTime"
17232 },
17233 {
17234 "name": "request.toDate",
17235 "in": "query",
17236 "required": false,
17237 "type": "string",
17238 "format": "date-time",
17239 "title": "DateTime"
17240 },
17241 {
17242 "name": "request.locationId",
17243 "in": "query",
17244 "required": false,
17245 "type": "integer",
17246 "format": "int32",
17247 "title": "Int32"
17248 },
17249 {
17250 "name": "request.employingEntityId",
17251 "in": "query",
17252 "required": false,
17253 "type": "integer",
17254 "format": "int32",
17255 "title": "Nullable<Int32>"
17256 }
17257 ],
17258 "responses": {
17259 "200": {
17260 "description": "OK",
17261 "schema": {
17262 "type": "array",
17263 "items": {
17264 "$ref": "#/definitions/PayrollTaxReportExportModel"
17265 },
17266 "xml": {
17267 "name": "PayrollTaxReportExportModel",
17268 "wrapped": true
17269 },
17270 "title": "IList<PayrollTaxReportExportModel>"
17271 }
17272 }
17273 }
17274 }
17275 },
17276 "/api/v2/business/{businessId}/report/timesheet": {
17277 "get": {
17278 "tags": [
17279 "Reporting"
17280 ],
17281 "summary": "Timesheet report",
17282 "description": "Generates a timesheet report.",
17283 "operationId": "ReportsTimesheet_Get",
17284 "consumes": [],
17285 "produces": [
17286 "application/json",
17287 "text/json",
17288 "application/xml",
17289 "text/xml"
17290 ],
17291 "parameters": [
17292 {
17293 "name": "businessId",
17294 "in": "path",
17295 "required": true,
17296 "type": "string"
17297 },
17298 {
17299 "name": "request.employeeId",
17300 "in": "query",
17301 "required": false,
17302 "type": "integer",
17303 "format": "int32",
17304 "title": "Nullable<Int32>"
17305 },
17306 {
17307 "name": "request.includeCosts",
17308 "in": "query",
17309 "required": false,
17310 "type": "boolean",
17311 "title": "Boolean"
17312 },
17313 {
17314 "name": "request.statuses",
17315 "in": "query",
17316 "required": false,
17317 "type": "array",
17318 "items": {
17319 "type": "string",
17320 "enum": [
17321 "Missing",
17322 "Submitted",
17323 "Approved",
17324 "Rejected",
17325 "Processed"
17326 ],
17327 "title": "TimesheetLineStatusType"
17328 },
17329 "collectionFormat": "multi",
17330 "title": "IList<TimesheetLineStatusType>"
17331 },
17332 {
17333 "name": "request.workTypeId",
17334 "in": "query",
17335 "required": false,
17336 "type": "integer",
17337 "format": "int32",
17338 "title": "Nullable<Int32>"
17339 },
17340 {
17341 "name": "request.payScheduleId",
17342 "in": "query",
17343 "required": false,
17344 "type": "integer",
17345 "format": "int32",
17346 "title": "Int32"
17347 },
17348 {
17349 "name": "request.fromDate",
17350 "in": "query",
17351 "required": false,
17352 "type": "string",
17353 "format": "date-time",
17354 "title": "DateTime"
17355 },
17356 {
17357 "name": "request.toDate",
17358 "in": "query",
17359 "required": false,
17360 "type": "string",
17361 "format": "date-time",
17362 "title": "DateTime"
17363 },
17364 {
17365 "name": "request.locationId",
17366 "in": "query",
17367 "required": false,
17368 "type": "integer",
17369 "format": "int32",
17370 "title": "Int32"
17371 },
17372 {
17373 "name": "request.employingEntityId",
17374 "in": "query",
17375 "required": false,
17376 "type": "integer",
17377 "format": "int32",
17378 "title": "Nullable<Int32>"
17379 }
17380 ],
17381 "responses": {
17382 "200": {
17383 "description": "OK",
17384 "schema": {
17385 "type": "array",
17386 "items": {
17387 "$ref": "#/definitions/TimesheetReportExportModel"
17388 },
17389 "xml": {
17390 "name": "TimesheetReportExportModel",
17391 "wrapped": true
17392 },
17393 "title": "IList<TimesheetReportExportModel>"
17394 }
17395 }
17396 }
17397 }
17398 },
17399 "/api/v2/business/{businessId}/report/paymenthistory": {
17400 "get": {
17401 "tags": [
17402 "Reporting"
17403 ],
17404 "summary": "Employee Payment History Report",
17405 "description": "Generates an employee payment history report.",
17406 "operationId": "ReportsEmployeePaymentHistory_Get",
17407 "consumes": [],
17408 "produces": [
17409 "application/json",
17410 "text/json",
17411 "application/xml",
17412 "text/xml"
17413 ],
17414 "parameters": [
17415 {
17416 "name": "businessId",
17417 "in": "path",
17418 "required": true,
17419 "type": "string"
17420 },
17421 {
17422 "name": "request.employeeId",
17423 "in": "query",
17424 "required": false,
17425 "type": "integer",
17426 "format": "int32",
17427 "title": "Nullable<Int32>"
17428 },
17429 {
17430 "name": "request.fromDate",
17431 "in": "query",
17432 "required": false,
17433 "type": "string",
17434 "format": "date-time",
17435 "title": "DateTime"
17436 },
17437 {
17438 "name": "request.toDate",
17439 "in": "query",
17440 "required": false,
17441 "type": "string",
17442 "format": "date-time",
17443 "title": "DateTime"
17444 },
17445 {
17446 "name": "request.locationId",
17447 "in": "query",
17448 "required": false,
17449 "type": "integer",
17450 "format": "int32",
17451 "title": "Int32"
17452 },
17453 {
17454 "name": "request.employingEntityId",
17455 "in": "query",
17456 "required": false,
17457 "type": "integer",
17458 "format": "int32",
17459 "title": "Nullable<Int32>"
17460 }
17461 ],
17462 "responses": {
17463 "200": {
17464 "description": "OK",
17465 "schema": {
17466 "type": "array",
17467 "items": {
17468 "$ref": "#/definitions/PaymentHistoryReportExportModel"
17469 },
17470 "xml": {
17471 "name": "PaymentHistoryReportExportModel",
17472 "wrapped": true
17473 },
17474 "title": "IEnumerable<PaymentHistoryReportExportModel>"
17475 }
17476 }
17477 }
17478 }
17479 },
17480 "/api/v2/business/{businessId}/report/birthday": {
17481 "get": {
17482 "tags": [
17483 "Reporting"
17484 ],
17485 "summary": "Birthday Report",
17486 "description": "Generates a birthday report.",
17487 "operationId": "ReportsBirthday_Get",
17488 "consumes": [],
17489 "produces": [
17490 "application/json",
17491 "text/json",
17492 "application/xml",
17493 "text/xml"
17494 ],
17495 "parameters": [
17496 {
17497 "name": "fromDate",
17498 "in": "query",
17499 "required": true,
17500 "type": "string",
17501 "format": "date-time",
17502 "title": "DateTime"
17503 },
17504 {
17505 "name": "toDate",
17506 "in": "query",
17507 "required": true,
17508 "type": "string",
17509 "format": "date-time",
17510 "title": "DateTime"
17511 },
17512 {
17513 "name": "locationId",
17514 "in": "query",
17515 "required": false,
17516 "type": "integer",
17517 "format": "int32",
17518 "default": 0,
17519 "title": "Int32"
17520 },
17521 {
17522 "name": "businessId",
17523 "in": "path",
17524 "required": true,
17525 "type": "string"
17526 }
17527 ],
17528 "responses": {
17529 "200": {
17530 "description": "OK",
17531 "schema": {
17532 "type": "array",
17533 "items": {
17534 "$ref": "#/definitions/BirthdayReportExportModel"
17535 },
17536 "xml": {
17537 "name": "BirthdayReportExportModel",
17538 "wrapped": true
17539 },
17540 "title": "IEnumerable<BirthdayReportExportModel>"
17541 }
17542 }
17543 }
17544 }
17545 },
17546 "/api/v2/business/{businessId}/report/grosstonet": {
17547 "get": {
17548 "tags": [
17549 "Reporting"
17550 ],
17551 "summary": "Gross To Net Report",
17552 "description": "Generates a Gross To Net Report.",
17553 "operationId": "ReportsGrossToNet_Get",
17554 "consumes": [],
17555 "produces": [
17556 "application/json",
17557 "text/json",
17558 "application/xml",
17559 "text/xml"
17560 ],
17561 "parameters": [
17562 {
17563 "name": "businessId",
17564 "in": "path",
17565 "required": true,
17566 "type": "string"
17567 },
17568 {
17569 "name": "request.employeeId",
17570 "in": "query",
17571 "required": false,
17572 "type": "integer",
17573 "format": "int32",
17574 "title": "Int32"
17575 },
17576 {
17577 "name": "request.payCategoryIds",
17578 "in": "query",
17579 "required": false,
17580 "type": "array",
17581 "items": {
17582 "type": "integer",
17583 "format": "int32",
17584 "title": "Int32"
17585 },
17586 "collectionFormat": "multi",
17587 "title": "List<Int32>"
17588 },
17589 {
17590 "name": "request.payScheduleId",
17591 "in": "query",
17592 "required": false,
17593 "type": "integer",
17594 "format": "int32",
17595 "title": "Int32"
17596 },
17597 {
17598 "name": "request.fromDate",
17599 "in": "query",
17600 "required": false,
17601 "type": "string",
17602 "format": "date-time",
17603 "title": "DateTime"
17604 },
17605 {
17606 "name": "request.toDate",
17607 "in": "query",
17608 "required": false,
17609 "type": "string",
17610 "format": "date-time",
17611 "title": "DateTime"
17612 },
17613 {
17614 "name": "request.locationId",
17615 "in": "query",
17616 "required": false,
17617 "type": "integer",
17618 "format": "int32",
17619 "title": "Int32"
17620 },
17621 {
17622 "name": "request.employingEntityId",
17623 "in": "query",
17624 "required": false,
17625 "type": "integer",
17626 "format": "int32",
17627 "title": "Nullable<Int32>"
17628 }
17629 ],
17630 "responses": {
17631 "200": {
17632 "description": "OK",
17633 "schema": {
17634 "type": "array",
17635 "items": {
17636 "$ref": "#/definitions/GrossToNetReportLineItem"
17637 },
17638 "xml": {
17639 "name": "GrossToNetReportLineItem",
17640 "wrapped": true
17641 },
17642 "title": "IEnumerable<GrossToNetReportLineItem>"
17643 }
17644 }
17645 }
17646 }
17647 },
17648 "/api/v2/business/{businessId}/report/leaveliability": {
17649 "get": {
17650 "tags": [
17651 "Reporting"
17652 ],
17653 "summary": "Leave Liability Report",
17654 "description": "Generates a leave liability report.",
17655 "operationId": "ReportsLeaveLiability_Get",
17656 "consumes": [],
17657 "produces": [
17658 "application/json",
17659 "text/json",
17660 "application/xml",
17661 "text/xml"
17662 ],
17663 "parameters": [
17664 {
17665 "name": "businessId",
17666 "in": "path",
17667 "required": true,
17668 "type": "string"
17669 },
17670 {
17671 "name": "model.locationId",
17672 "in": "query",
17673 "required": false,
17674 "type": "integer",
17675 "format": "int32",
17676 "title": "Int32"
17677 },
17678 {
17679 "name": "model.leaveTypeId",
17680 "in": "query",
17681 "required": false,
17682 "type": "integer",
17683 "format": "int32",
17684 "title": "Int32"
17685 },
17686 {
17687 "name": "model.includeApprovedLeave",
17688 "in": "query",
17689 "required": false,
17690 "type": "boolean",
17691 "title": "Boolean"
17692 },
17693 {
17694 "name": "model.asAtDate",
17695 "in": "query",
17696 "required": false,
17697 "type": "string",
17698 "format": "date-time",
17699 "title": "Nullable<DateTime>"
17700 },
17701 {
17702 "name": "model.employingEntityId",
17703 "in": "query",
17704 "required": false,
17705 "type": "integer",
17706 "format": "int32",
17707 "title": "Nullable<Int32>"
17708 }
17709 ],
17710 "responses": {
17711 "200": {
17712 "description": "OK",
17713 "schema": {
17714 "type": "array",
17715 "items": {
17716 "$ref": "#/definitions/LeaveLiabilityReportExportModel"
17717 },
17718 "xml": {
17719 "name": "LeaveLiabilityReportExportModel",
17720 "wrapped": true
17721 },
17722 "title": "IEnumerable<LeaveLiabilityReportExportModel>"
17723 }
17724 }
17725 }
17726 }
17727 },
17728 "/api/v2/business/{businessId}/rostershift": {
17729 "get": {
17730 "tags": [
17731 "RosterShift"
17732 ],
17733 "summary": "Get Roster Shifts",
17734 "description": "Gets roster shifts, optionally filtered by a number of parameters.",
17735 "operationId": "RosterShift_Get",
17736 "consumes": [],
17737 "produces": [
17738 "application/json",
17739 "text/json",
17740 "application/xml",
17741 "text/xml"
17742 ],
17743 "parameters": [
17744 {
17745 "name": "businessId",
17746 "in": "path",
17747 "required": true,
17748 "type": "string"
17749 },
17750 {
17751 "name": "filter.fromDate",
17752 "in": "query",
17753 "required": false,
17754 "type": "string",
17755 "format": "date-time",
17756 "title": "DateTime"
17757 },
17758 {
17759 "name": "filter.toDate",
17760 "in": "query",
17761 "required": false,
17762 "type": "string",
17763 "format": "date-time",
17764 "title": "DateTime"
17765 },
17766 {
17767 "name": "filter.resourceView",
17768 "in": "query",
17769 "required": false,
17770 "type": "string",
17771 "enum": [
17772 "Employee",
17773 "Location"
17774 ],
17775 "title": "ResourceViewEnum"
17776 },
17777 {
17778 "name": "filter.shiftStatus",
17779 "in": "query",
17780 "required": false,
17781 "type": "string",
17782 "enum": [
17783 "All",
17784 "Published",
17785 "Unpublished",
17786 "Accepted"
17787 ],
17788 "title": "RosterShiftStatus"
17789 },
17790 {
17791 "name": "filter.shiftStatuses",
17792 "in": "query",
17793 "required": false,
17794 "type": "array",
17795 "items": {
17796 "type": "string",
17797 "enum": [
17798 "All",
17799 "Published",
17800 "Unpublished",
17801 "Accepted"
17802 ],
17803 "title": "RosterShiftStatus"
17804 },
17805 "collectionFormat": "multi",
17806 "title": "IList<RosterShiftStatus>"
17807 },
17808 {
17809 "name": "filter.selectedLocations",
17810 "in": "query",
17811 "required": false,
17812 "type": "array",
17813 "items": {
17814 "type": "string",
17815 "title": "String"
17816 },
17817 "collectionFormat": "multi",
17818 "title": "IList<String>"
17819 },
17820 {
17821 "name": "filter.selectedEmployees",
17822 "in": "query",
17823 "required": false,
17824 "type": "array",
17825 "items": {
17826 "type": "string",
17827 "title": "String"
17828 },
17829 "collectionFormat": "multi",
17830 "title": "IList<String>"
17831 },
17832 {
17833 "name": "filter.selectedRoles",
17834 "in": "query",
17835 "required": false,
17836 "type": "array",
17837 "items": {
17838 "type": "string",
17839 "title": "String"
17840 },
17841 "collectionFormat": "multi",
17842 "title": "IList<String>"
17843 },
17844 {
17845 "name": "filter.includeSublocations",
17846 "in": "query",
17847 "required": false,
17848 "type": "boolean",
17849 "title": "Boolean"
17850 },
17851 {
17852 "name": "filter.currentView",
17853 "in": "query",
17854 "required": false,
17855 "type": "string",
17856 "enum": [
17857 "resourceDay",
17858 "resourceWeek",
17859 "resourceNextWeeks"
17860 ],
17861 "title": "RosterViewMode"
17862 },
17863 {
17864 "name": "filter.budgetWarningPercent",
17865 "in": "query",
17866 "required": false,
17867 "type": "number",
17868 "format": "double",
17869 "title": "Decimal"
17870 },
17871 {
17872 "name": "filter.employeeId",
17873 "in": "query",
17874 "required": false,
17875 "type": "integer",
17876 "format": "int32",
17877 "title": "Nullable<Int32>"
17878 },
17879 {
17880 "name": "filter.locationId",
17881 "in": "query",
17882 "required": false,
17883 "type": "integer",
17884 "format": "int32",
17885 "title": "Nullable<Int32>"
17886 },
17887 {
17888 "name": "filter.employeeGroupId",
17889 "in": "query",
17890 "required": false,
17891 "type": "integer",
17892 "format": "int32",
17893 "title": "Nullable<Int32>"
17894 },
17895 {
17896 "name": "filter.unassignedShiftsOnly",
17897 "in": "query",
17898 "required": false,
17899 "type": "boolean",
17900 "title": "Boolean"
17901 },
17902 {
17903 "name": "filter.showCosts",
17904 "in": "query",
17905 "required": false,
17906 "type": "boolean",
17907 "title": "Boolean"
17908 },
17909 {
17910 "name": "filter.groupBy",
17911 "in": "query",
17912 "required": false,
17913 "type": "string",
17914 "enum": [
17915 "Business",
17916 "Location"
17917 ],
17918 "title": "RosterGroupByEnum"
17919 },
17920 {
17921 "name": "filter.groupByThen",
17922 "in": "query",
17923 "required": false,
17924 "type": "string",
17925 "enum": [
17926 "Employee",
17927 "Role",
17928 "StartingTime"
17929 ],
17930 "title": "RosterGroupByThenEnum"
17931 },
17932 {
17933 "name": "filter.excludeUnassignedEmployees",
17934 "in": "query",
17935 "required": false,
17936 "type": "boolean",
17937 "title": "Boolean"
17938 },
17939 {
17940 "name": "filter.selectAllRoles",
17941 "in": "query",
17942 "required": false,
17943 "type": "boolean",
17944 "title": "Boolean"
17945 }
17946 ],
17947 "responses": {
17948 "200": {
17949 "description": "OK",
17950 "schema": {
17951 "type": "array",
17952 "items": {
17953 "$ref": "#/definitions/RosterShiftGenerateTimesheetModel"
17954 },
17955 "xml": {
17956 "name": "RosterShiftGenerateTimesheetModel",
17957 "wrapped": true
17958 },
17959 "title": "List<RosterShiftGenerateTimesheetModel>"
17960 }
17961 }
17962 }
17963 }
17964 },
17965 "/api/v2/business/{businessId}/rostershift/{rosterShiftId}/stub": {
17966 "post": {
17967 "tags": [
17968 "RosterShift"
17969 ],
17970 "summary": "Stub Shift Timesheets",
17971 "description": "Generates timesheets for the roster shift with the specified ID.",
17972 "operationId": "RosterShift_StubShiftTimesheets",
17973 "consumes": [
17974 "application/json",
17975 "text/json",
17976 "application/xml",
17977 "text/xml",
17978 "application/x-www-form-urlencoded"
17979 ],
17980 "produces": [],
17981 "parameters": [
17982 {
17983 "name": "rosterShiftId",
17984 "in": "path",
17985 "required": true,
17986 "type": "integer",
17987 "format": "int32",
17988 "title": "Int32"
17989 },
17990 {
17991 "name": "model",
17992 "in": "body",
17993 "required": true,
17994 "schema": {
17995 "$ref": "#/definitions/StubRosterShiftViewModel"
17996 }
17997 },
17998 {
17999 "name": "businessId",
18000 "in": "path",
18001 "required": true,
18002 "type": "string"
18003 }
18004 ],
18005 "responses": {
18006 "204": {
18007 "description": "No Content"
18008 }
18009 }
18010 }
18011 },
18012 "/api/v2/business/{businessId}/rostershift/{employeeId}/nearby": {
18013 "get": {
18014 "tags": [
18015 "RosterShift"
18016 ],
18017 "summary": "Find Nearby Roster Shifts",
18018 "description": "Finds any of the employee's roster shifts that are nearby to the specified local time.",
18019 "operationId": "RosterShift_NearbyRosterShifts",
18020 "consumes": [],
18021 "produces": [
18022 "application/json",
18023 "text/json",
18024 "application/xml",
18025 "text/xml"
18026 ],
18027 "parameters": [
18028 {
18029 "name": "employeeId",
18030 "in": "path",
18031 "required": true,
18032 "type": "integer",
18033 "format": "int32",
18034 "title": "Int32"
18035 },
18036 {
18037 "name": "localTime",
18038 "in": "query",
18039 "required": true,
18040 "type": "string",
18041 "format": "date-time",
18042 "title": "DateTime"
18043 },
18044 {
18045 "name": "businessId",
18046 "in": "path",
18047 "required": true,
18048 "type": "string"
18049 }
18050 ],
18051 "responses": {
18052 "200": {
18053 "description": "OK",
18054 "schema": {
18055 "type": "array",
18056 "items": {
18057 "$ref": "#/definitions/EssRosterShiftModel"
18058 },
18059 "xml": {
18060 "name": "EssRosterShiftModel",
18061 "wrapped": true
18062 },
18063 "title": "IList<EssRosterShiftModel>"
18064 }
18065 }
18066 }
18067 }
18068 },
18069 "/api/v2/business/{businessId}/rostershift/{employeeId}/matchingclockon": {
18070 "get": {
18071 "tags": [
18072 "RosterShift"
18073 ],
18074 "summary": "Find Matching Clock On Roster Shift",
18075 "description": "If a roster shift exists that could match for this employee to clock on at this time \r\ngiven kiosk settings for shift matching, returns that shift.\r\nOtherwise, the Shift result will be null.\r\nNote that if the time matches a shift exactly, the Shift result will also be null.",
18076 "operationId": "RosterShift_MatchingClockOnRosterShift",
18077 "consumes": [],
18078 "produces": [
18079 "application/json",
18080 "text/json",
18081 "application/xml",
18082 "text/xml"
18083 ],
18084 "parameters": [
18085 {
18086 "name": "employeeId",
18087 "in": "path",
18088 "required": true,
18089 "type": "integer",
18090 "format": "int32",
18091 "title": "Int32"
18092 },
18093 {
18094 "name": "kioskId",
18095 "in": "query",
18096 "required": true,
18097 "type": "integer",
18098 "format": "int32",
18099 "title": "Int32"
18100 },
18101 {
18102 "name": "dateUtc",
18103 "in": "query",
18104 "required": true,
18105 "type": "string",
18106 "format": "date-time",
18107 "title": "DateTime"
18108 },
18109 {
18110 "name": "businessId",
18111 "in": "path",
18112 "required": true,
18113 "type": "string"
18114 }
18115 ],
18116 "responses": {
18117 "200": {
18118 "description": "OK",
18119 "schema": {
18120 "$ref": "#/definitions/RosterShiftMatchingResultModel"
18121 }
18122 }
18123 }
18124 }
18125 },
18126 "/api/v2/business/{businessId}/rostershift/{employeeId}/matchingclockoff": {
18127 "get": {
18128 "tags": [
18129 "RosterShift"
18130 ],
18131 "summary": "Find Matching Clock Off Roster Shift",
18132 "description": "If a roster shift exists that could match for this employee to clock off at this time \r\ngiven kiosk settings for shift matching, returns that shift.\r\nOtherwise, the Shift result will be null.\r\nNote that if the time matches a shift exactly, the Shift result will also be null.",
18133 "operationId": "RosterShift_MatchingClockOffRosterShift",
18134 "consumes": [],
18135 "produces": [
18136 "application/json",
18137 "text/json",
18138 "application/xml",
18139 "text/xml"
18140 ],
18141 "parameters": [
18142 {
18143 "name": "employeeId",
18144 "in": "path",
18145 "required": true,
18146 "type": "integer",
18147 "format": "int32",
18148 "title": "Int32"
18149 },
18150 {
18151 "name": "kioskId",
18152 "in": "query",
18153 "required": true,
18154 "type": "integer",
18155 "format": "int32",
18156 "title": "Int32"
18157 },
18158 {
18159 "name": "dateUtc",
18160 "in": "query",
18161 "required": true,
18162 "type": "string",
18163 "format": "date-time",
18164 "title": "DateTime"
18165 },
18166 {
18167 "name": "businessId",
18168 "in": "path",
18169 "required": true,
18170 "type": "string"
18171 }
18172 ],
18173 "responses": {
18174 "200": {
18175 "description": "OK",
18176 "schema": {
18177 "$ref": "#/definitions/RosterShiftMatchingResultModel"
18178 }
18179 }
18180 }
18181 }
18182 },
18183 "/api/v2/business/{businessId}/selfmanagedsuperfund": {
18184 "get": {
18185 "tags": [
18186 "SuperFund"
18187 ],
18188 "summary": "List Self Managed Super Funds",
18189 "description": "Lists all the self managed super funds for the business.\n\nThis operation supports OData queries.",
18190 "operationId": "SelfManagedSuperFund_GetFunds",
18191 "consumes": [],
18192 "produces": [
18193 "application/json",
18194 "text/json",
18195 "application/xml",
18196 "text/xml"
18197 ],
18198 "parameters": [
18199 {
18200 "name": "businessId",
18201 "in": "path",
18202 "required": true,
18203 "type": "string"
18204 }
18205 ],
18206 "responses": {
18207 "200": {
18208 "description": "OK",
18209 "schema": {
18210 "type": "array",
18211 "items": {
18212 "$ref": "#/definitions/SelfManagedSuperFundModel"
18213 },
18214 "xml": {
18215 "name": "SelfManagedSuperFundModel",
18216 "wrapped": true
18217 },
18218 "title": "IEnumerable<SelfManagedSuperFundModel>"
18219 }
18220 }
18221 }
18222 },
18223 "post": {
18224 "tags": [
18225 "SuperFund"
18226 ],
18227 "summary": "Create Self Managed Super Fund",
18228 "description": "Creates a new self managed super fund for the business.",
18229 "operationId": "SelfManagedSuperFund_Post",
18230 "consumes": [
18231 "application/json",
18232 "text/json",
18233 "application/xml",
18234 "text/xml",
18235 "application/x-www-form-urlencoded"
18236 ],
18237 "produces": [
18238 "application/json",
18239 "text/json",
18240 "application/xml",
18241 "text/xml"
18242 ],
18243 "parameters": [
18244 {
18245 "name": "fund",
18246 "in": "body",
18247 "required": true,
18248 "schema": {
18249 "$ref": "#/definitions/SelfManagedSuperFundModel"
18250 }
18251 },
18252 {
18253 "name": "businessId",
18254 "in": "path",
18255 "required": true,
18256 "type": "string"
18257 }
18258 ],
18259 "responses": {
18260 "200": {
18261 "description": "OK"
18262 }
18263 }
18264 }
18265 },
18266 "/api/v2/business/{businessId}/selfmanagedsuperfund/{id}": {
18267 "get": {
18268 "tags": [
18269 "SuperFund"
18270 ],
18271 "summary": "Get Self Managed Super Fund by ID",
18272 "description": "Gets the self managed super fund with the specified ID.",
18273 "operationId": "SelfManagedSuperFund_Get",
18274 "consumes": [],
18275 "produces": [
18276 "application/json",
18277 "text/json",
18278 "application/xml",
18279 "text/xml"
18280 ],
18281 "parameters": [
18282 {
18283 "name": "id",
18284 "in": "path",
18285 "required": true,
18286 "type": "integer",
18287 "format": "int32",
18288 "title": "Int32"
18289 },
18290 {
18291 "name": "businessId",
18292 "in": "path",
18293 "required": true,
18294 "type": "string"
18295 }
18296 ],
18297 "responses": {
18298 "200": {
18299 "description": "OK",
18300 "schema": {
18301 "$ref": "#/definitions/SelfManagedSuperFundModel"
18302 }
18303 }
18304 }
18305 },
18306 "put": {
18307 "tags": [
18308 "SuperFund"
18309 ],
18310 "summary": "Update Self Managed Super Fund",
18311 "description": "Updates .",
18312 "operationId": "SelfManagedSuperFund_Put",
18313 "consumes": [
18314 "application/json",
18315 "text/json",
18316 "application/xml",
18317 "text/xml",
18318 "application/x-www-form-urlencoded"
18319 ],
18320 "produces": [
18321 "application/json",
18322 "text/json",
18323 "application/xml",
18324 "text/xml"
18325 ],
18326 "parameters": [
18327 {
18328 "name": "id",
18329 "in": "path",
18330 "required": true,
18331 "type": "integer",
18332 "format": "int32",
18333 "title": "Int32"
18334 },
18335 {
18336 "name": "fund",
18337 "in": "body",
18338 "required": true,
18339 "schema": {
18340 "$ref": "#/definitions/SelfManagedSuperFundModel"
18341 }
18342 },
18343 {
18344 "name": "businessId",
18345 "in": "path",
18346 "required": true,
18347 "type": "string"
18348 }
18349 ],
18350 "responses": {
18351 "200": {
18352 "description": "OK"
18353 }
18354 }
18355 }
18356 },
18357 "/api/v2/business/{businessId}/superfund/productsearch": {
18358 "get": {
18359 "tags": [
18360 "SuperFund"
18361 ],
18362 "summary": "Search Super Funds",
18363 "description": "Search for super funds based on a string.",
18364 "operationId": "SuperFund_ProductSearch",
18365 "consumes": [],
18366 "produces": [
18367 "application/json",
18368 "text/json",
18369 "application/xml",
18370 "text/xml"
18371 ],
18372 "parameters": [
18373 {
18374 "name": "term",
18375 "in": "query",
18376 "required": true,
18377 "type": "string",
18378 "title": "String"
18379 },
18380 {
18381 "name": "businessId",
18382 "in": "path",
18383 "required": true,
18384 "type": "string"
18385 }
18386 ],
18387 "responses": {
18388 "200": {
18389 "description": "OK",
18390 "schema": {
18391 "type": "array",
18392 "items": {
18393 "$ref": "#/definitions/SuperProductEditModel"
18394 },
18395 "xml": {
18396 "name": "SuperProductEditModel",
18397 "wrapped": true
18398 },
18399 "title": "List<SuperProductEditModel>"
18400 }
18401 }
18402 }
18403 }
18404 },
18405 "/api/v2/business/{businessId}/kiosk/hasaccess/{employeeId}": {
18406 "get": {
18407 "tags": [
18408 "TimeAndAttendance"
18409 ],
18410 "summary": "Employee Has Access",
18411 "description": "Check if an employee has access to a kiosk.",
18412 "operationId": "TimeAndAttendance_GetHasAccess",
18413 "consumes": [],
18414 "produces": [
18415 "application/json",
18416 "text/json",
18417 "application/xml",
18418 "text/xml"
18419 ],
18420 "parameters": [
18421 {
18422 "name": "businessId",
18423 "in": "path",
18424 "required": true,
18425 "type": "string"
18426 },
18427 {
18428 "name": "employeeId",
18429 "in": "path",
18430 "required": true,
18431 "type": "string"
18432 }
18433 ],
18434 "responses": {
18435 "200": {
18436 "description": "OK"
18437 }
18438 }
18439 }
18440 },
18441 "/api/v2/business/{businessId}/kiosk/{kioskId}/staff": {
18442 "get": {
18443 "tags": [
18444 "TimeAndAttendance"
18445 ],
18446 "summary": "List Kiosk Staff",
18447 "description": "Lists all the staff associated with a kiosk.",
18448 "operationId": "TimeAndAttendance_GetStaff",
18449 "consumes": [],
18450 "produces": [
18451 "application/json",
18452 "text/json",
18453 "application/xml",
18454 "text/xml"
18455 ],
18456 "parameters": [
18457 {
18458 "name": "kioskId",
18459 "in": "path",
18460 "required": true,
18461 "type": "integer",
18462 "format": "int32",
18463 "title": "Int32"
18464 },
18465 {
18466 "name": "businessId",
18467 "in": "path",
18468 "required": true,
18469 "type": "string"
18470 }
18471 ],
18472 "responses": {
18473 "200": {
18474 "description": "OK",
18475 "schema": {
18476 "type": "array",
18477 "items": {
18478 "$ref": "#/definitions/BasicKioskEmployeeModel"
18479 },
18480 "xml": {
18481 "name": "BasicKioskEmployeeModel",
18482 "wrapped": true
18483 },
18484 "title": "List<BasicKioskEmployeeModel>"
18485 }
18486 }
18487 }
18488 },
18489 "post": {
18490 "tags": [
18491 "TimeAndAttendance"
18492 ],
18493 "summary": "Add an Employee",
18494 "description": "Quickly add an employee with minimal details and kiosk enabled. If the employee already exists, the kiosk will be enabled for that employee.",
18495 "operationId": "TimeAndAttendance_PostStaff",
18496 "consumes": [
18497 "application/json",
18498 "text/json",
18499 "application/xml",
18500 "text/xml",
18501 "application/x-www-form-urlencoded"
18502 ],
18503 "produces": [
18504 "application/json",
18505 "text/json",
18506 "application/xml",
18507 "text/xml"
18508 ],
18509 "parameters": [
18510 {
18511 "name": "kioskId",
18512 "in": "path",
18513 "required": true,
18514 "type": "integer",
18515 "format": "int32",
18516 "title": "Int32"
18517 },
18518 {
18519 "name": "model",
18520 "in": "body",
18521 "required": true,
18522 "schema": {
18523 "$ref": "#/definitions/KioskCreateEmployeeModel"
18524 }
18525 },
18526 {
18527 "name": "businessId",
18528 "in": "path",
18529 "required": true,
18530 "type": "string"
18531 }
18532 ],
18533 "responses": {
18534 "200": {
18535 "description": "OK"
18536 }
18537 }
18538 }
18539 },
18540 "/api/v2/business/{businessId}/kiosk/{kioskId}/checkid": {
18541 "post": {
18542 "tags": [
18543 "TimeAndAttendance"
18544 ],
18545 "summary": "Check Employee",
18546 "description": "If the specified employee has kiosk access, returns details about the employee and their current shift.",
18547 "operationId": "TimeAndAttendance_CheckId",
18548 "consumes": [
18549 "application/json",
18550 "text/json",
18551 "application/xml",
18552 "text/xml",
18553 "application/x-www-form-urlencoded"
18554 ],
18555 "produces": [
18556 "application/json",
18557 "text/json",
18558 "application/xml",
18559 "text/xml"
18560 ],
18561 "parameters": [
18562 {
18563 "name": "model",
18564 "in": "body",
18565 "required": true,
18566 "schema": {
18567 "$ref": "#/definitions/CheckKioskEmployeeIdModel"
18568 }
18569 },
18570 {
18571 "name": "businessId",
18572 "in": "path",
18573 "required": true,
18574 "type": "string"
18575 },
18576 {
18577 "name": "kioskId",
18578 "in": "path",
18579 "required": true,
18580 "type": "string"
18581 }
18582 ],
18583 "responses": {
18584 "200": {
18585 "description": "OK"
18586 }
18587 }
18588 }
18589 },
18590 "/api/v2/business/{businessId}/kiosk/{kioskId}/checkpin": {
18591 "post": {
18592 "tags": [
18593 "TimeAndAttendance"
18594 ],
18595 "summary": "Verify Kiosk PIN",
18596 "description": "Verifies the employee's kiosk PIN. Returns error code 400 if the PIN is incorrect.",
18597 "operationId": "TimeAndAttendance_CheckPin",
18598 "consumes": [
18599 "application/json",
18600 "text/json",
18601 "application/xml",
18602 "text/xml",
18603 "application/x-www-form-urlencoded"
18604 ],
18605 "produces": [
18606 "application/json",
18607 "text/json",
18608 "application/xml",
18609 "text/xml"
18610 ],
18611 "parameters": [
18612 {
18613 "name": "model",
18614 "in": "body",
18615 "required": true,
18616 "schema": {
18617 "$ref": "#/definitions/CheckKioskPinModel"
18618 }
18619 },
18620 {
18621 "name": "businessId",
18622 "in": "path",
18623 "required": true,
18624 "type": "string"
18625 },
18626 {
18627 "name": "kioskId",
18628 "in": "path",
18629 "required": true,
18630 "type": "string"
18631 }
18632 ],
18633 "responses": {
18634 "200": {
18635 "description": "OK"
18636 }
18637 }
18638 }
18639 },
18640 "/api/v2/business/{businessId}/kiosk/{kioskId}/clockon": {
18641 "post": {
18642 "tags": [
18643 "TimeAndAttendance"
18644 ],
18645 "summary": "Clock In Employee",
18646 "description": "Clocks in an employee for a new shift.",
18647 "operationId": "TimeAndAttendance_ClockOn",
18648 "consumes": [
18649 "application/json",
18650 "text/json",
18651 "application/xml",
18652 "text/xml",
18653 "application/x-www-form-urlencoded"
18654 ],
18655 "produces": [
18656 "application/json",
18657 "text/json",
18658 "application/xml",
18659 "text/xml"
18660 ],
18661 "parameters": [
18662 {
18663 "name": "kioskId",
18664 "in": "path",
18665 "required": true,
18666 "type": "integer",
18667 "format": "int32",
18668 "title": "Int32"
18669 },
18670 {
18671 "name": "request",
18672 "in": "body",
18673 "required": true,
18674 "schema": {
18675 "$ref": "#/definitions/ClockOnModel"
18676 }
18677 },
18678 {
18679 "name": "businessId",
18680 "in": "path",
18681 "required": true,
18682 "type": "string"
18683 }
18684 ],
18685 "responses": {
18686 "200": {
18687 "description": "OK"
18688 }
18689 }
18690 }
18691 },
18692 "/api/v2/business/{businessId}/kiosk/{kioskId}/clockoff": {
18693 "post": {
18694 "tags": [
18695 "TimeAndAttendance"
18696 ],
18697 "summary": "Clock Out Employee",
18698 "description": "Clocks out an employee from their existing shift. \r\nIf they are on a break, it will be ended automatically.",
18699 "operationId": "TimeAndAttendance_ClockOff",
18700 "consumes": [
18701 "application/json",
18702 "text/json",
18703 "application/xml",
18704 "text/xml",
18705 "application/x-www-form-urlencoded"
18706 ],
18707 "produces": [
18708 "application/json",
18709 "text/json",
18710 "application/xml",
18711 "text/xml"
18712 ],
18713 "parameters": [
18714 {
18715 "name": "kioskId",
18716 "in": "path",
18717 "required": true,
18718 "type": "integer",
18719 "format": "int32",
18720 "title": "Int32"
18721 },
18722 {
18723 "name": "request",
18724 "in": "body",
18725 "required": true,
18726 "schema": {
18727 "$ref": "#/definitions/ClockOffModel"
18728 }
18729 },
18730 {
18731 "name": "businessId",
18732 "in": "path",
18733 "required": true,
18734 "type": "string"
18735 }
18736 ],
18737 "responses": {
18738 "200": {
18739 "description": "OK"
18740 }
18741 }
18742 }
18743 },
18744 "/api/v2/business/{businessId}/kiosk/{kioskId}/startbreak": {
18745 "post": {
18746 "tags": [
18747 "TimeAndAttendance"
18748 ],
18749 "summary": "Start Break",
18750 "description": "Starts a break for an employee who is clocked on for a shift.",
18751 "operationId": "TimeAndAttendance_StartBreak",
18752 "consumes": [
18753 "application/json",
18754 "text/json",
18755 "application/xml",
18756 "text/xml",
18757 "application/x-www-form-urlencoded"
18758 ],
18759 "produces": [
18760 "application/json",
18761 "text/json",
18762 "application/xml",
18763 "text/xml"
18764 ],
18765 "parameters": [
18766 {
18767 "name": "kioskId",
18768 "in": "path",
18769 "required": true,
18770 "type": "integer",
18771 "format": "int32",
18772 "title": "Int32"
18773 },
18774 {
18775 "name": "request",
18776 "in": "body",
18777 "required": true,
18778 "schema": {
18779 "$ref": "#/definitions/StartBreakModel"
18780 }
18781 },
18782 {
18783 "name": "businessId",
18784 "in": "path",
18785 "required": true,
18786 "type": "string"
18787 }
18788 ],
18789 "responses": {
18790 "200": {
18791 "description": "OK"
18792 }
18793 }
18794 }
18795 },
18796 "/api/v2/business/{businessId}/kiosk/{kioskId}/endbreak": {
18797 "post": {
18798 "tags": [
18799 "TimeAndAttendance"
18800 ],
18801 "summary": "End Break",
18802 "description": "Ends the employee's current break.",
18803 "operationId": "TimeAndAttendance_EndBreak",
18804 "consumes": [
18805 "application/json",
18806 "text/json",
18807 "application/xml",
18808 "text/xml",
18809 "application/x-www-form-urlencoded"
18810 ],
18811 "produces": [
18812 "application/json",
18813 "text/json",
18814 "application/xml",
18815 "text/xml"
18816 ],
18817 "parameters": [
18818 {
18819 "name": "kioskId",
18820 "in": "path",
18821 "required": true,
18822 "type": "integer",
18823 "format": "int32",
18824 "title": "Int32"
18825 },
18826 {
18827 "name": "request",
18828 "in": "body",
18829 "required": true,
18830 "schema": {
18831 "$ref": "#/definitions/EndBreakModel"
18832 }
18833 },
18834 {
18835 "name": "businessId",
18836 "in": "path",
18837 "required": true,
18838 "type": "string"
18839 }
18840 ],
18841 "responses": {
18842 "200": {
18843 "description": "OK"
18844 }
18845 }
18846 }
18847 },
18848 "/api/v2/business/{businessId}/kiosk/shifts": {
18849 "post": {
18850 "tags": [
18851 "TimeAndAttendance"
18852 ],
18853 "summary": "Shifts",
18854 "description": "Gets shifts based on certain optional criteria.",
18855 "operationId": "TimeAndAttendance_Shifts",
18856 "consumes": [
18857 "application/json",
18858 "text/json",
18859 "application/xml",
18860 "text/xml",
18861 "application/x-www-form-urlencoded"
18862 ],
18863 "produces": [
18864 "application/json",
18865 "text/json",
18866 "application/xml",
18867 "text/xml"
18868 ],
18869 "parameters": [
18870 {
18871 "name": "model",
18872 "in": "body",
18873 "required": true,
18874 "schema": {
18875 "$ref": "#/definitions/GetShiftsModel"
18876 }
18877 },
18878 {
18879 "name": "businessId",
18880 "in": "path",
18881 "required": true,
18882 "type": "string"
18883 }
18884 ],
18885 "responses": {
18886 "200": {
18887 "description": "OK",
18888 "schema": {
18889 "type": "array",
18890 "items": {
18891 "$ref": "#/definitions/TimeAndAttendanceShiftModel"
18892 },
18893 "xml": {
18894 "name": "TimeAndAttendanceShiftModel",
18895 "wrapped": true
18896 },
18897 "title": "IList<TimeAndAttendanceShiftModel>"
18898 }
18899 }
18900 }
18901 }
18902 },
18903 "/api/v2/business/{businessId}/kiosk/{kioskId}/changepin": {
18904 "post": {
18905 "tags": [
18906 "TimeAndAttendance"
18907 ],
18908 "summary": "Change PIN",
18909 "description": "Changes the kiosk PIN for an employee, given their old PIN.",
18910 "operationId": "TimeAndAttendance_ChangePin",
18911 "consumes": [
18912 "application/json",
18913 "text/json",
18914 "application/xml",
18915 "text/xml",
18916 "application/x-www-form-urlencoded"
18917 ],
18918 "produces": [
18919 "application/json",
18920 "text/json",
18921 "application/xml",
18922 "text/xml"
18923 ],
18924 "parameters": [
18925 {
18926 "name": "kioskId",
18927 "in": "path",
18928 "required": true,
18929 "type": "integer",
18930 "format": "int32",
18931 "title": "Int32"
18932 },
18933 {
18934 "name": "model",
18935 "in": "body",
18936 "required": true,
18937 "schema": {
18938 "$ref": "#/definitions/ChangeKioskPinModel"
18939 }
18940 },
18941 {
18942 "name": "businessId",
18943 "in": "path",
18944 "required": true,
18945 "type": "string"
18946 }
18947 ],
18948 "responses": {
18949 "200": {
18950 "description": "OK"
18951 }
18952 }
18953 }
18954 },
18955 "/api/v2/business/{businessId}/kiosk/{kioskId}/emailreset": {
18956 "post": {
18957 "tags": [
18958 "TimeAndAttendance"
18959 ],
18960 "summary": "Send PIN Reset Email",
18961 "description": "Sends kiosk PIN reset instructions to an employee by email.",
18962 "operationId": "TimeAndAttendance_EmailReset",
18963 "consumes": [
18964 "application/json",
18965 "text/json",
18966 "application/xml",
18967 "text/xml",
18968 "application/x-www-form-urlencoded"
18969 ],
18970 "produces": [
18971 "application/json",
18972 "text/json",
18973 "application/xml",
18974 "text/xml"
18975 ],
18976 "parameters": [
18977 {
18978 "name": "model",
18979 "in": "body",
18980 "required": true,
18981 "schema": {
18982 "$ref": "#/definitions/PinResetModel"
18983 }
18984 },
18985 {
18986 "name": "businessId",
18987 "in": "path",
18988 "required": true,
18989 "type": "string"
18990 },
18991 {
18992 "name": "kioskId",
18993 "in": "path",
18994 "required": true,
18995 "type": "string"
18996 }
18997 ],
18998 "responses": {
18999 "200": {
19000 "description": "OK"
19001 }
19002 }
19003 }
19004 },
19005 "/api/v2/business/{businessId}/kiosk/{kioskId}/smsreset": {
19006 "post": {
19007 "tags": [
19008 "TimeAndAttendance"
19009 ],
19010 "summary": "Send PIN Reset SMS",
19011 "description": "Sends kiosk PIN reset instructions to an employee by SMS. Note that the current business must have SMS notifications enabled.",
19012 "operationId": "TimeAndAttendance_SmsReset",
19013 "consumes": [
19014 "application/json",
19015 "text/json",
19016 "application/xml",
19017 "text/xml",
19018 "application/x-www-form-urlencoded"
19019 ],
19020 "produces": [
19021 "application/json",
19022 "text/json",
19023 "application/xml",
19024 "text/xml"
19025 ],
19026 "parameters": [
19027 {
19028 "name": "model",
19029 "in": "body",
19030 "required": true,
19031 "schema": {
19032 "$ref": "#/definitions/PinResetModel"
19033 }
19034 },
19035 {
19036 "name": "businessId",
19037 "in": "path",
19038 "required": true,
19039 "type": "string"
19040 },
19041 {
19042 "name": "kioskId",
19043 "in": "path",
19044 "required": true,
19045 "type": "string"
19046 }
19047 ],
19048 "responses": {
19049 "200": {
19050 "description": "OK"
19051 }
19052 }
19053 }
19054 },
19055 "/api/v2/business/{businessId}/kiosk/{kioskId}/discard": {
19056 "post": {
19057 "tags": [
19058 "TimeAndAttendance"
19059 ],
19060 "summary": "Discard current shift",
19061 "description": "Discards the current shift for an employee. \r\nIf they are on a break, it will be ended automatically.",
19062 "operationId": "TimeAndAttendance_DiscardShift",
19063 "consumes": [
19064 "application/json",
19065 "text/json",
19066 "application/xml",
19067 "text/xml",
19068 "application/x-www-form-urlencoded"
19069 ],
19070 "produces": [
19071 "application/json",
19072 "text/json",
19073 "application/xml",
19074 "text/xml"
19075 ],
19076 "parameters": [
19077 {
19078 "name": "kioskId",
19079 "in": "path",
19080 "required": true,
19081 "type": "integer",
19082 "format": "int32",
19083 "title": "Int32"
19084 },
19085 {
19086 "name": "request",
19087 "in": "body",
19088 "required": true,
19089 "schema": {
19090 "$ref": "#/definitions/ClockOffModel"
19091 }
19092 },
19093 {
19094 "name": "businessId",
19095 "in": "path",
19096 "required": true,
19097 "type": "string"
19098 }
19099 ],
19100 "responses": {
19101 "200": {
19102 "description": "OK"
19103 }
19104 }
19105 }
19106 },
19107 "/api/v2/business/{businessId}/kiosk/{kioskId}/lookupdata/{employeeId}": {
19108 "get": {
19109 "tags": [
19110 "TimeAndAttendance"
19111 ],
19112 "summary": "Get Employee Lookup Data",
19113 "description": "Gets relevant lookup data for an employee in relation to a kiosk.",
19114 "operationId": "TimeAndAttendance_GetLookupData",
19115 "consumes": [],
19116 "produces": [
19117 "application/json",
19118 "text/json",
19119 "application/xml",
19120 "text/xml"
19121 ],
19122 "parameters": [
19123 {
19124 "name": "kioskId",
19125 "in": "path",
19126 "required": true,
19127 "type": "integer",
19128 "format": "int32",
19129 "title": "Int32"
19130 },
19131 {
19132 "name": "employeeId",
19133 "in": "path",
19134 "required": true,
19135 "type": "integer",
19136 "format": "int32",
19137 "title": "Int32"
19138 },
19139 {
19140 "name": "businessId",
19141 "in": "path",
19142 "required": true,
19143 "type": "string"
19144 }
19145 ],
19146 "responses": {
19147 "200": {
19148 "description": "OK",
19149 "schema": {
19150 "$ref": "#/definitions/TimeAndAttendanceLookupDataModel"
19151 }
19152 }
19153 }
19154 }
19155 },
19156 "/api/v2/business/{businessId}/kiosk/{kioskId}/shift/{shiftId}/notes": {
19157 "get": {
19158 "tags": [
19159 "TimeAndAttendance"
19160 ],
19161 "summary": "Get Shift Notes",
19162 "description": "Gets all the notes for a specific shift.",
19163 "operationId": "TimeAndAttendance_GetShiftNotes",
19164 "consumes": [],
19165 "produces": [
19166 "application/json",
19167 "text/json",
19168 "application/xml",
19169 "text/xml"
19170 ],
19171 "parameters": [
19172 {
19173 "name": "kioskId",
19174 "in": "path",
19175 "required": true,
19176 "type": "integer",
19177 "format": "int32",
19178 "title": "Int32"
19179 },
19180 {
19181 "name": "shiftId",
19182 "in": "path",
19183 "required": true,
19184 "type": "integer",
19185 "format": "int32",
19186 "title": "Int32"
19187 },
19188 {
19189 "name": "businessId",
19190 "in": "path",
19191 "required": true,
19192 "type": "string"
19193 },
19194 {
19195 "name": "model.employeeId",
19196 "in": "query",
19197 "required": false,
19198 "type": "integer",
19199 "format": "int32",
19200 "title": "Int32"
19201 },
19202 {
19203 "name": "model.isAdminInitiated",
19204 "in": "query",
19205 "required": false,
19206 "type": "boolean",
19207 "title": "Boolean"
19208 },
19209 {
19210 "name": "model.type",
19211 "in": "query",
19212 "required": false,
19213 "type": "string",
19214 "enum": [
19215 "Shift",
19216 "ClockOn",
19217 "ClockOff"
19218 ],
19219 "title": "Nullable<TimeAttendanceShiftNoteType>"
19220 },
19221 {
19222 "name": "model.visibility",
19223 "in": "query",
19224 "required": false,
19225 "type": "string",
19226 "enum": [
19227 "Hidden",
19228 "Visible"
19229 ],
19230 "title": "Nullable<TimeAttendanceShiftNoteVisibility>"
19231 }
19232 ],
19233 "responses": {
19234 "200": {
19235 "description": "OK"
19236 }
19237 }
19238 },
19239 "post": {
19240 "tags": [
19241 "TimeAndAttendance"
19242 ],
19243 "summary": "Add Note to Shift",
19244 "description": "Adds a note to an existing shift.",
19245 "operationId": "TimeAndAttendance_AddNote",
19246 "consumes": [
19247 "application/json",
19248 "text/json",
19249 "application/xml",
19250 "text/xml",
19251 "application/x-www-form-urlencoded"
19252 ],
19253 "produces": [
19254 "application/json",
19255 "text/json",
19256 "application/xml",
19257 "text/xml"
19258 ],
19259 "parameters": [
19260 {
19261 "name": "kioskId",
19262 "in": "path",
19263 "required": true,
19264 "type": "integer",
19265 "format": "int32",
19266 "title": "Int32"
19267 },
19268 {
19269 "name": "shiftId",
19270 "in": "path",
19271 "required": true,
19272 "type": "integer",
19273 "format": "int32",
19274 "title": "Int32"
19275 },
19276 {
19277 "name": "model",
19278 "in": "body",
19279 "required": true,
19280 "schema": {
19281 "$ref": "#/definitions/AddNoteModel"
19282 }
19283 },
19284 {
19285 "name": "businessId",
19286 "in": "path",
19287 "required": true,
19288 "type": "string"
19289 }
19290 ],
19291 "responses": {
19292 "200": {
19293 "description": "OK"
19294 }
19295 }
19296 }
19297 },
19298 "/api/v2/business/{businessId}/kiosk/{kioskId}/shift/{shiftId}/notes/{noteId}": {
19299 "delete": {
19300 "tags": [
19301 "TimeAndAttendance"
19302 ],
19303 "summary": "Delete Note from Shift",
19304 "description": "Deletes a note from an existing shift.",
19305 "operationId": "TimeAndAttendance_DeleteNote",
19306 "consumes": [],
19307 "produces": [
19308 "application/json",
19309 "text/json",
19310 "application/xml",
19311 "text/xml"
19312 ],
19313 "parameters": [
19314 {
19315 "name": "kioskId",
19316 "in": "path",
19317 "required": true,
19318 "type": "integer",
19319 "format": "int32",
19320 "title": "Int32"
19321 },
19322 {
19323 "name": "shiftId",
19324 "in": "path",
19325 "required": true,
19326 "type": "integer",
19327 "format": "int32",
19328 "title": "Int32"
19329 },
19330 {
19331 "name": "noteId",
19332 "in": "path",
19333 "required": true,
19334 "type": "integer",
19335 "format": "int32",
19336 "title": "Int32"
19337 },
19338 {
19339 "name": "businessId",
19340 "in": "path",
19341 "required": true,
19342 "type": "string"
19343 }
19344 ],
19345 "responses": {
19346 "200": {
19347 "description": "OK"
19348 }
19349 }
19350 }
19351 },
19352 "/api/v2/business/{businessId}/kiosk/{kioskId}/shift/{shiftId}/notes/read-state": {
19353 "post": {
19354 "tags": [
19355 "TimeAndAttendance"
19356 ],
19357 "summary": "Mark Shift Notes Read",
19358 "description": "Marks some shift notes as either read or unread.",
19359 "operationId": "TimeAndAttendance_MarkNotesRead",
19360 "consumes": [
19361 "application/json",
19362 "text/json",
19363 "application/xml",
19364 "text/xml",
19365 "application/x-www-form-urlencoded"
19366 ],
19367 "produces": [
19368 "application/json",
19369 "text/json",
19370 "application/xml",
19371 "text/xml"
19372 ],
19373 "parameters": [
19374 {
19375 "name": "model",
19376 "in": "body",
19377 "required": true,
19378 "schema": {
19379 "$ref": "#/definitions/MarkNotesReadViewModel"
19380 }
19381 },
19382 {
19383 "name": "businessId",
19384 "in": "path",
19385 "required": true,
19386 "type": "string"
19387 },
19388 {
19389 "name": "kioskId",
19390 "in": "path",
19391 "required": true,
19392 "type": "string"
19393 },
19394 {
19395 "name": "shiftId",
19396 "in": "path",
19397 "required": true,
19398 "type": "string"
19399 }
19400 ],
19401 "responses": {
19402 "200": {
19403 "description": "OK"
19404 }
19405 }
19406 }
19407 },
19408 "/api/v2/business/{businessId}/kiosk": {
19409 "get": {
19410 "tags": [
19411 "TimeAndAttendance"
19412 ],
19413 "summary": "List Kiosks",
19414 "description": "Lists all kiosks for the specified business.\n\nThis operation supports OData queries.",
19415 "operationId": "Kiosk_GetAll",
19416 "consumes": [],
19417 "produces": [
19418 "application/json",
19419 "text/json",
19420 "application/xml",
19421 "text/xml"
19422 ],
19423 "parameters": [
19424 {
19425 "name": "businessId",
19426 "in": "path",
19427 "required": true,
19428 "type": "string"
19429 }
19430 ],
19431 "responses": {
19432 "200": {
19433 "description": "OK",
19434 "schema": {
19435 "type": "array",
19436 "items": {
19437 "$ref": "#/definitions/TimeAndAttendanceKioskModel"
19438 },
19439 "xml": {
19440 "name": "TimeAndAttendanceKioskModel",
19441 "wrapped": true
19442 },
19443 "title": "IQueryable<TimeAndAttendanceKioskModel>"
19444 }
19445 }
19446 }
19447 },
19448 "post": {
19449 "tags": [
19450 "TimeAndAttendance"
19451 ],
19452 "summary": "Create Kiosk",
19453 "description": "Creates a new kiosk for the business.",
19454 "operationId": "Kiosk_Post",
19455 "consumes": [
19456 "application/json",
19457 "text/json",
19458 "application/xml",
19459 "text/xml",
19460 "application/x-www-form-urlencoded"
19461 ],
19462 "produces": [
19463 "application/json",
19464 "text/json",
19465 "application/xml",
19466 "text/xml"
19467 ],
19468 "parameters": [
19469 {
19470 "name": "kiosk",
19471 "in": "body",
19472 "required": true,
19473 "schema": {
19474 "$ref": "#/definitions/TimeAndAttendanceKioskModel"
19475 }
19476 },
19477 {
19478 "name": "businessId",
19479 "in": "path",
19480 "required": true,
19481 "type": "string"
19482 }
19483 ],
19484 "responses": {
19485 "200": {
19486 "description": "OK"
19487 }
19488 }
19489 }
19490 },
19491 "/api/v2/business/{businessId}/kiosk/{id}": {
19492 "get": {
19493 "tags": [
19494 "TimeAndAttendance"
19495 ],
19496 "summary": "Get Kiosk by ID",
19497 "description": "Gets the kiosk with the specified ID.",
19498 "operationId": "Kiosk_Get",
19499 "consumes": [],
19500 "produces": [
19501 "application/json",
19502 "text/json",
19503 "application/xml",
19504 "text/xml"
19505 ],
19506 "parameters": [
19507 {
19508 "name": "id",
19509 "in": "path",
19510 "required": true,
19511 "type": "integer",
19512 "format": "int32",
19513 "title": "Int32"
19514 },
19515 {
19516 "name": "businessId",
19517 "in": "path",
19518 "required": true,
19519 "type": "string"
19520 }
19521 ],
19522 "responses": {
19523 "200": {
19524 "description": "OK",
19525 "schema": {
19526 "$ref": "#/definitions/TimeAndAttendanceKioskModel"
19527 }
19528 }
19529 }
19530 },
19531 "put": {
19532 "tags": [
19533 "TimeAndAttendance"
19534 ],
19535 "summary": "Update Kiosk",
19536 "description": "Updates the kiosk with the specified ID.",
19537 "operationId": "Kiosk_Put",
19538 "consumes": [
19539 "application/json",
19540 "text/json",
19541 "application/xml",
19542 "text/xml",
19543 "application/x-www-form-urlencoded"
19544 ],
19545 "produces": [
19546 "application/json",
19547 "text/json",
19548 "application/xml",
19549 "text/xml"
19550 ],
19551 "parameters": [
19552 {
19553 "name": "id",
19554 "in": "path",
19555 "required": true,
19556 "type": "integer",
19557 "format": "int32",
19558 "title": "Int32"
19559 },
19560 {
19561 "name": "kiosk",
19562 "in": "body",
19563 "required": true,
19564 "schema": {
19565 "$ref": "#/definitions/TimeAndAttendanceKioskModel"
19566 }
19567 },
19568 {
19569 "name": "businessId",
19570 "in": "path",
19571 "required": true,
19572 "type": "string"
19573 }
19574 ],
19575 "responses": {
19576 "200": {
19577 "description": "OK"
19578 }
19579 }
19580 },
19581 "delete": {
19582 "tags": [
19583 "TimeAndAttendance"
19584 ],
19585 "summary": "Delete Kiosk",
19586 "description": "Deletes the kiosk with the specified ID.",
19587 "operationId": "Kiosk_Delete",
19588 "consumes": [],
19589 "produces": [
19590 "application/json",
19591 "text/json",
19592 "application/xml",
19593 "text/xml"
19594 ],
19595 "parameters": [
19596 {
19597 "name": "id",
19598 "in": "path",
19599 "required": true,
19600 "type": "integer",
19601 "format": "int32",
19602 "title": "Int32"
19603 },
19604 {
19605 "name": "businessId",
19606 "in": "path",
19607 "required": true,
19608 "type": "string"
19609 }
19610 ],
19611 "responses": {
19612 "200": {
19613 "description": "OK"
19614 }
19615 }
19616 }
19617 },
19618 "/api/v2/business/{businessId}/timesheet": {
19619 "get": {
19620 "tags": [
19621 "Timesheets"
19622 ],
19623 "summary": "Get Business Timesheets",
19624 "description": "Retrieves all timesheets for the specified business.\n\nThis operation supports OData queries.",
19625 "operationId": "Timesheet_Get",
19626 "consumes": [],
19627 "produces": [
19628 "application/json",
19629 "text/json",
19630 "application/xml",
19631 "text/xml"
19632 ],
19633 "parameters": [
19634 {
19635 "name": "businessId",
19636 "in": "path",
19637 "required": true,
19638 "type": "string"
19639 }
19640 ],
19641 "responses": {
19642 "200": {
19643 "description": "OK",
19644 "schema": {
19645 "type": "array",
19646 "items": {
19647 "$ref": "#/definitions/TimesheetLineModel"
19648 },
19649 "xml": {
19650 "name": "TimesheetLineModel",
19651 "wrapped": true
19652 },
19653 "title": "IEnumerable<TimesheetLineModel>"
19654 }
19655 }
19656 }
19657 }
19658 },
19659 "/api/v2/business/{businessId}/timesheet/bulk": {
19660 "put": {
19661 "tags": [
19662 "Timesheets"
19663 ],
19664 "summary": "Update/Replace timesheets",
19665 "description": "Performs the same action as 'Bulk Insert Timesheets', but any existing timesheets \r\nfor the specified employees within the specified time period \r\n(StartTime - EndTime) will be replaced with the timesheets specified.",
19666 "operationId": "Timesheet_Put",
19667 "consumes": [
19668 "application/json",
19669 "text/json",
19670 "application/xml",
19671 "text/xml",
19672 "application/x-www-form-urlencoded"
19673 ],
19674 "produces": [
19675 "application/json",
19676 "text/json",
19677 "application/xml",
19678 "text/xml"
19679 ],
19680 "parameters": [
19681 {
19682 "name": "request",
19683 "in": "body",
19684 "required": true,
19685 "schema": {
19686 "$ref": "#/definitions/SubmitTimesheetsRequest"
19687 }
19688 },
19689 {
19690 "name": "businessId",
19691 "in": "path",
19692 "required": true,
19693 "type": "string"
19694 }
19695 ],
19696 "responses": {
19697 "200": {
19698 "description": "OK"
19699 }
19700 }
19701 },
19702 "post": {
19703 "tags": [
19704 "Timesheets"
19705 ],
19706 "summary": "Bulk Insert Timesheets",
19707 "description": "Adds timesheets for the specified business. This will not replace any existing timesheets.",
19708 "operationId": "Timesheet_Post",
19709 "consumes": [
19710 "application/json",
19711 "text/json",
19712 "application/xml",
19713 "text/xml",
19714 "application/x-www-form-urlencoded"
19715 ],
19716 "produces": [
19717 "application/json",
19718 "text/json",
19719 "application/xml",
19720 "text/xml"
19721 ],
19722 "parameters": [
19723 {
19724 "name": "request",
19725 "in": "body",
19726 "required": true,
19727 "schema": {
19728 "$ref": "#/definitions/SubmitTimesheetsRequest"
19729 }
19730 },
19731 {
19732 "name": "businessId",
19733 "in": "path",
19734 "required": true,
19735 "type": "string"
19736 }
19737 ],
19738 "responses": {
19739 "200": {
19740 "description": "OK"
19741 }
19742 }
19743 }
19744 },
19745 "/api/v2/business/{businessId}/unavailability": {
19746 "get": {
19747 "tags": [
19748 "Unavailability"
19749 ],
19750 "summary": "List Unavailabilities",
19751 "description": "Lists all of the unavailabilities for this business, with optional filters.",
19752 "operationId": "Unavailability_Get",
19753 "consumes": [],
19754 "produces": [
19755 "application/json",
19756 "text/json",
19757 "application/xml",
19758 "text/xml"
19759 ],
19760 "parameters": [
19761 {
19762 "name": "businessId",
19763 "in": "path",
19764 "required": true,
19765 "type": "string"
19766 },
19767 {
19768 "name": "filter.fromDate",
19769 "in": "query",
19770 "required": false,
19771 "type": "string",
19772 "format": "date-time",
19773 "title": "Nullable<DateTime>"
19774 },
19775 {
19776 "name": "filter.toDate",
19777 "in": "query",
19778 "required": false,
19779 "type": "string",
19780 "format": "date-time",
19781 "title": "Nullable<DateTime>"
19782 },
19783 {
19784 "name": "filter.employeeId",
19785 "in": "query",
19786 "required": false,
19787 "type": "integer",
19788 "format": "int32",
19789 "title": "Nullable<Int32>"
19790 },
19791 {
19792 "name": "filter.defaultLocationId",
19793 "in": "query",
19794 "required": false,
19795 "type": "integer",
19796 "format": "int32",
19797 "title": "Nullable<Int32>"
19798 }
19799 ],
19800 "responses": {
19801 "200": {
19802 "description": "OK",
19803 "schema": {
19804 "type": "array",
19805 "items": {
19806 "$ref": "#/definitions/UnavailabilityModel"
19807 },
19808 "xml": {
19809 "name": "UnavailabilityModel",
19810 "wrapped": true
19811 },
19812 "title": "IEnumerable<UnavailabilityModel>"
19813 }
19814 }
19815 }
19816 },
19817 "post": {
19818 "tags": [
19819 "Unavailability"
19820 ],
19821 "summary": "Create Unavailability",
19822 "description": "Creates a new unavailability for the employee.",
19823 "operationId": "Unavailability_Post",
19824 "consumes": [
19825 "application/json",
19826 "text/json",
19827 "application/xml",
19828 "text/xml",
19829 "application/x-www-form-urlencoded"
19830 ],
19831 "produces": [
19832 "application/json",
19833 "text/json",
19834 "application/xml",
19835 "text/xml"
19836 ],
19837 "parameters": [
19838 {
19839 "name": "unavailabilityModel",
19840 "in": "body",
19841 "required": true,
19842 "schema": {
19843 "$ref": "#/definitions/UnavailabilityModel"
19844 }
19845 },
19846 {
19847 "name": "businessId",
19848 "in": "path",
19849 "required": true,
19850 "type": "string"
19851 }
19852 ],
19853 "responses": {
19854 "200": {
19855 "description": "OK",
19856 "schema": {
19857 "$ref": "#/definitions/UnavailabilityModel"
19858 }
19859 }
19860 }
19861 }
19862 },
19863 "/api/v2/business/{businessId}/unavailability/{id}": {
19864 "get": {
19865 "tags": [
19866 "Unavailability"
19867 ],
19868 "summary": "Get unavailability by ID",
19869 "description": "Gets the unavailability with the specified ID.",
19870 "operationId": "Unavailability_GetApiV2BusinessByBusinessIdUnavailabilityById",
19871 "consumes": [],
19872 "produces": [
19873 "application/json",
19874 "text/json",
19875 "application/xml",
19876 "text/xml"
19877 ],
19878 "parameters": [
19879 {
19880 "name": "id",
19881 "in": "path",
19882 "required": true,
19883 "type": "integer",
19884 "format": "int32",
19885 "title": "Int32"
19886 },
19887 {
19888 "name": "businessId",
19889 "in": "path",
19890 "required": true,
19891 "type": "string"
19892 }
19893 ],
19894 "responses": {
19895 "200": {
19896 "description": "OK",
19897 "schema": {
19898 "$ref": "#/definitions/UnavailabilityModel"
19899 }
19900 }
19901 }
19902 },
19903 "put": {
19904 "tags": [
19905 "Unavailability"
19906 ],
19907 "summary": "Update Unavailability",
19908 "description": "Updates the unavailability with the specified ID.",
19909 "operationId": "Unavailability_Put",
19910 "consumes": [
19911 "application/json",
19912 "text/json",
19913 "application/xml",
19914 "text/xml",
19915 "application/x-www-form-urlencoded"
19916 ],
19917 "produces": [
19918 "application/json",
19919 "text/json",
19920 "application/xml",
19921 "text/xml"
19922 ],
19923 "parameters": [
19924 {
19925 "name": "id",
19926 "in": "path",
19927 "required": true,
19928 "type": "integer",
19929 "format": "int32",
19930 "title": "Int32"
19931 },
19932 {
19933 "name": "unavailabilityModel",
19934 "in": "body",
19935 "required": true,
19936 "schema": {
19937 "$ref": "#/definitions/UnavailabilityModel"
19938 }
19939 },
19940 {
19941 "name": "businessId",
19942 "in": "path",
19943 "required": true,
19944 "type": "string"
19945 }
19946 ],
19947 "responses": {
19948 "200": {
19949 "description": "OK"
19950 }
19951 }
19952 },
19953 "delete": {
19954 "tags": [
19955 "Unavailability"
19956 ],
19957 "summary": "Delete Unavailability",
19958 "description": "Deletes the unavailability with the specified ID.",
19959 "operationId": "Unavailability_Delete",
19960 "consumes": [],
19961 "produces": [
19962 "application/json",
19963 "text/json",
19964 "application/xml",
19965 "text/xml"
19966 ],
19967 "parameters": [
19968 {
19969 "name": "id",
19970 "in": "path",
19971 "required": true,
19972 "type": "integer",
19973 "format": "int32",
19974 "title": "Int32"
19975 },
19976 {
19977 "name": "businessId",
19978 "in": "path",
19979 "required": true,
19980 "type": "string"
19981 }
19982 ],
19983 "responses": {
19984 "200": {
19985 "description": "OK"
19986 }
19987 }
19988 }
19989 },
19990 "/api/v2/user": {
19991 "get": {
19992 "tags": [
19993 "User"
19994 ],
19995 "summary": "Get User Details",
19996 "description": "Gets details about the user.",
19997 "operationId": "User_Get",
19998 "consumes": [],
19999 "produces": [
20000 "application/json",
20001 "text/json",
20002 "application/xml",
20003 "text/xml"
20004 ],
20005 "responses": {
20006 "200": {
20007 "description": "OK",
20008 "schema": {
20009 "$ref": "#/definitions/UserModel"
20010 }
20011 }
20012 }
20013 },
20014 "post": {
20015 "tags": [
20016 "User"
20017 ],
20018 "summary": "Create New User",
20019 "description": "Creates a new user.",
20020 "operationId": "User_Post",
20021 "consumes": [
20022 "application/json",
20023 "text/json",
20024 "application/xml",
20025 "text/xml",
20026 "application/x-www-form-urlencoded"
20027 ],
20028 "produces": [
20029 "application/json",
20030 "text/json",
20031 "application/xml",
20032 "text/xml"
20033 ],
20034 "parameters": [
20035 {
20036 "name": "model",
20037 "in": "body",
20038 "required": true,
20039 "schema": {
20040 "$ref": "#/definitions/NewUserModel"
20041 }
20042 }
20043 ],
20044 "responses": {
20045 "200": {
20046 "description": "OK"
20047 }
20048 }
20049 }
20050 },
20051 "/api/v2/business/{businessId}/webhookregistrations": {
20052 "get": {
20053 "tags": [
20054 "Webhook"
20055 ],
20056 "summary": "List Web Hook Registrations",
20057 "description": "Returns a collection containing the registered web hook instances for the user.",
20058 "operationId": "WebHookRegistrations_Get",
20059 "consumes": [],
20060 "produces": [
20061 "application/json",
20062 "text/json",
20063 "application/xml",
20064 "text/xml"
20065 ],
20066 "parameters": [
20067 {
20068 "name": "businessId",
20069 "in": "path",
20070 "required": true,
20071 "type": "string"
20072 }
20073 ],
20074 "responses": {
20075 "200": {
20076 "description": "OK",
20077 "schema": {
20078 "type": "array",
20079 "items": {
20080 "$ref": "#/definitions/WebHook"
20081 },
20082 "xml": {
20083 "name": "WebHook",
20084 "wrapped": true
20085 },
20086 "title": "IEnumerable<WebHook>"
20087 }
20088 }
20089 }
20090 },
20091 "post": {
20092 "tags": [
20093 "Webhook"
20094 ],
20095 "summary": "Register Web Hook",
20096 "description": "Registers a new web hook.",
20097 "operationId": "WebHookRegistrations_Post",
20098 "consumes": [
20099 "application/json",
20100 "text/json",
20101 "application/xml",
20102 "text/xml",
20103 "application/x-www-form-urlencoded"
20104 ],
20105 "produces": [
20106 "application/json",
20107 "text/json",
20108 "application/xml",
20109 "text/xml"
20110 ],
20111 "parameters": [
20112 {
20113 "name": "webHook",
20114 "in": "body",
20115 "required": true,
20116 "schema": {
20117 "$ref": "#/definitions/WebHook"
20118 }
20119 },
20120 {
20121 "name": "businessId",
20122 "in": "path",
20123 "required": true,
20124 "type": "string"
20125 }
20126 ],
20127 "responses": {
20128 "200": {
20129 "description": "OK",
20130 "schema": {
20131 "$ref": "#/definitions/WebHook"
20132 }
20133 }
20134 }
20135 },
20136 "delete": {
20137 "tags": [
20138 "Webhook"
20139 ],
20140 "summary": "Delete all Web Hook Registrations",
20141 "description": "Deletes all the web hook registrations.",
20142 "operationId": "WebHookRegistrations_DeleteAll",
20143 "consumes": [],
20144 "produces": [
20145 "application/json",
20146 "text/json",
20147 "application/xml",
20148 "text/xml"
20149 ],
20150 "parameters": [
20151 {
20152 "name": "businessId",
20153 "in": "path",
20154 "required": true,
20155 "type": "string"
20156 }
20157 ],
20158 "responses": {
20159 "200": {
20160 "description": "OK",
20161 "schema": {
20162 "type": "object",
20163 "title": "IHttpActionResult"
20164 }
20165 }
20166 }
20167 }
20168 },
20169 "/api/v2/business/{businessId}/webhookregistrations/{id}": {
20170 "get": {
20171 "tags": [
20172 "Webhook"
20173 ],
20174 "summary": "Get Web Hook Registration by ID",
20175 "description": "Gets the registered web hook instance with the specified ID.",
20176 "operationId": "WebHookRegistrations_Lookup",
20177 "consumes": [],
20178 "produces": [
20179 "application/json",
20180 "text/json",
20181 "application/xml",
20182 "text/xml"
20183 ],
20184 "parameters": [
20185 {
20186 "name": "id",
20187 "in": "path",
20188 "required": true,
20189 "type": "string",
20190 "title": "String"
20191 },
20192 {
20193 "name": "businessId",
20194 "in": "path",
20195 "required": true,
20196 "type": "string"
20197 }
20198 ],
20199 "responses": {
20200 "200": {
20201 "description": "OK",
20202 "schema": {
20203 "$ref": "#/definitions/WebHook"
20204 }
20205 }
20206 }
20207 },
20208 "put": {
20209 "tags": [
20210 "Webhook"
20211 ],
20212 "summary": "Update Web Hook Registration",
20213 "description": "Updates the web hook registration with the specified ID.",
20214 "operationId": "WebHookRegistrations_Put",
20215 "consumes": [
20216 "application/json",
20217 "text/json",
20218 "application/xml",
20219 "text/xml",
20220 "application/x-www-form-urlencoded"
20221 ],
20222 "produces": [
20223 "application/json",
20224 "text/json",
20225 "application/xml",
20226 "text/xml"
20227 ],
20228 "parameters": [
20229 {
20230 "name": "id",
20231 "in": "path",
20232 "required": true,
20233 "type": "string",
20234 "title": "String"
20235 },
20236 {
20237 "name": "webHook",
20238 "in": "body",
20239 "required": true,
20240 "schema": {
20241 "$ref": "#/definitions/WebHook"
20242 }
20243 },
20244 {
20245 "name": "businessId",
20246 "in": "path",
20247 "required": true,
20248 "type": "string"
20249 }
20250 ],
20251 "responses": {
20252 "200": {
20253 "description": "OK",
20254 "schema": {
20255 "type": "object",
20256 "title": "IHttpActionResult"
20257 }
20258 }
20259 }
20260 },
20261 "delete": {
20262 "tags": [
20263 "Webhook"
20264 ],
20265 "summary": "Delete Web Hook Registration",
20266 "description": "Deletes the web hook registration with the specified ID.",
20267 "operationId": "WebHookRegistrations_Delete",
20268 "consumes": [],
20269 "produces": [
20270 "application/json",
20271 "text/json",
20272 "application/xml",
20273 "text/xml"
20274 ],
20275 "parameters": [
20276 {
20277 "name": "id",
20278 "in": "path",
20279 "required": true,
20280 "type": "string",
20281 "title": "String"
20282 },
20283 {
20284 "name": "businessId",
20285 "in": "path",
20286 "required": true,
20287 "type": "string"
20288 }
20289 ],
20290 "responses": {
20291 "200": {
20292 "description": "OK",
20293 "schema": {
20294 "type": "object",
20295 "title": "IHttpActionResult"
20296 }
20297 }
20298 }
20299 }
20300 },
20301 "/api/v2/business/{businessId}/webhookregistrations/{id}/test": {
20302 "get": {
20303 "tags": [
20304 "Webhook"
20305 ],
20306 "summary": "Test Web Hook",
20307 "description": "Tests a web hook given a registration ID and a filter string.",
20308 "operationId": "WebHookRegistrations_Test",
20309 "consumes": [],
20310 "produces": [
20311 "application/json",
20312 "text/json",
20313 "application/xml",
20314 "text/xml"
20315 ],
20316 "parameters": [
20317 {
20318 "name": "id",
20319 "in": "path",
20320 "required": true,
20321 "type": "string",
20322 "title": "String"
20323 },
20324 {
20325 "name": "filter",
20326 "in": "query",
20327 "required": true,
20328 "type": "string",
20329 "title": "String"
20330 },
20331 {
20332 "name": "businessId",
20333 "in": "path",
20334 "required": true,
20335 "type": "string"
20336 }
20337 ],
20338 "responses": {
20339 "200": {
20340 "description": "OK",
20341 "schema": {
20342 "type": "object",
20343 "title": "IHttpActionResult"
20344 }
20345 }
20346 }
20347 }
20348 },
20349 "/api/v2/whitelabel": {
20350 "get": {
20351 "tags": [
20352 "WhiteLabel"
20353 ],
20354 "summary": "List White Labels",
20355 "description": "Lists all the white labels to which you have access.",
20356 "operationId": "WhiteLabel_GetWhiteLabels",
20357 "consumes": [],
20358 "produces": [
20359 "application/json",
20360 "text/json",
20361 "application/xml",
20362 "text/xml"
20363 ],
20364 "responses": {
20365 "200": {
20366 "description": "OK",
20367 "schema": {
20368 "type": "array",
20369 "items": {
20370 "$ref": "#/definitions/WhiteLabelModel"
20371 },
20372 "xml": {
20373 "name": "WhiteLabelModel",
20374 "wrapped": true
20375 },
20376 "title": "IEnumerable<WhiteLabelModel>"
20377 }
20378 }
20379 }
20380 }
20381 },
20382 "/api/v2/whitelabel/{id}": {
20383 "get": {
20384 "tags": [
20385 "WhiteLabel"
20386 ],
20387 "summary": "Get White Label by ID",
20388 "description": "Gets the white label with the specified ID.",
20389 "operationId": "WhiteLabel_Get",
20390 "consumes": [],
20391 "produces": [
20392 "application/json",
20393 "text/json",
20394 "application/xml",
20395 "text/xml"
20396 ],
20397 "parameters": [
20398 {
20399 "name": "id",
20400 "in": "path",
20401 "required": true,
20402 "type": "integer",
20403 "format": "int32",
20404 "title": "Int32"
20405 }
20406 ],
20407 "responses": {
20408 "200": {
20409 "description": "OK",
20410 "schema": {
20411 "$ref": "#/definitions/WhiteLabelModel"
20412 }
20413 }
20414 }
20415 }
20416 },
20417 "/api/v2/whitelabel/{whiteLabelId}/Invoice": {
20418 "get": {
20419 "tags": [
20420 "WhiteLabel"
20421 ],
20422 "summary": "Get Invoices",
20423 "description": "Get invoices for the specified business or white label.",
20424 "operationId": "Invoice_GetInvoices",
20425 "consumes": [],
20426 "produces": [
20427 "application/json",
20428 "text/json",
20429 "application/xml",
20430 "text/xml"
20431 ],
20432 "parameters": [
20433 {
20434 "name": "businessId",
20435 "in": "query",
20436 "required": false,
20437 "type": "integer",
20438 "format": "int32",
20439 "title": "Nullable<Int32>"
20440 },
20441 {
20442 "name": "whiteLabelId",
20443 "in": "path",
20444 "required": true,
20445 "type": "integer",
20446 "format": "int32",
20447 "title": "Nullable<Int32>"
20448 }
20449 ],
20450 "responses": {
20451 "200": {
20452 "description": "OK",
20453 "schema": {
20454 "type": "array",
20455 "items": {
20456 "$ref": "#/definitions/InvoiceModel"
20457 },
20458 "xml": {
20459 "name": "InvoiceModel",
20460 "wrapped": true
20461 },
20462 "title": "IList<InvoiceModel>"
20463 }
20464 }
20465 }
20466 }
20467 },
20468 "/api/v2/business/{businessId}/Invoice": {
20469 "get": {
20470 "tags": [
20471 "WhiteLabel"
20472 ],
20473 "summary": "Get Invoices",
20474 "description": "Get invoices for the specified business or white label.",
20475 "operationId": "Invoice_GetApiV2BusinessByBusinessIdInvoice",
20476 "consumes": [],
20477 "produces": [
20478 "application/json",
20479 "text/json",
20480 "application/xml",
20481 "text/xml"
20482 ],
20483 "parameters": [
20484 {
20485 "name": "businessId",
20486 "in": "path",
20487 "required": true,
20488 "type": "integer",
20489 "format": "int32",
20490 "title": "Nullable<Int32>"
20491 },
20492 {
20493 "name": "whiteLabelId",
20494 "in": "query",
20495 "required": false,
20496 "type": "integer",
20497 "format": "int32",
20498 "title": "Nullable<Int32>"
20499 }
20500 ],
20501 "responses": {
20502 "200": {
20503 "description": "OK",
20504 "schema": {
20505 "type": "array",
20506 "items": {
20507 "$ref": "#/definitions/InvoiceModel"
20508 },
20509 "xml": {
20510 "name": "InvoiceModel",
20511 "wrapped": true
20512 },
20513 "title": "IList<InvoiceModel>"
20514 }
20515 }
20516 }
20517 }
20518 },
20519 "/api/v2/whitelabel/{whiteLabelId}/Invoice/{id}": {
20520 "get": {
20521 "tags": [
20522 "WhiteLabel"
20523 ],
20524 "summary": "Get Invoice By ID",
20525 "description": "Gets the invoice with the specified ID.",
20526 "operationId": "Invoice_Get",
20527 "consumes": [],
20528 "produces": [
20529 "application/json",
20530 "text/json",
20531 "application/xml",
20532 "text/xml"
20533 ],
20534 "parameters": [
20535 {
20536 "name": "id",
20537 "in": "path",
20538 "required": true,
20539 "type": "integer",
20540 "format": "int32",
20541 "title": "Int32"
20542 },
20543 {
20544 "name": "businessId",
20545 "in": "query",
20546 "required": false,
20547 "type": "integer",
20548 "format": "int32",
20549 "title": "Nullable<Int32>"
20550 },
20551 {
20552 "name": "whiteLabelId",
20553 "in": "path",
20554 "required": true,
20555 "type": "integer",
20556 "format": "int32",
20557 "title": "Nullable<Int32>"
20558 }
20559 ],
20560 "responses": {
20561 "200": {
20562 "description": "OK",
20563 "schema": {
20564 "$ref": "#/definitions/InvoiceModel"
20565 }
20566 }
20567 }
20568 }
20569 },
20570 "/api/v2/business/{businessId}/Invoice/{id}": {
20571 "get": {
20572 "tags": [
20573 "WhiteLabel"
20574 ],
20575 "summary": "Get Invoice By ID",
20576 "description": "Gets the invoice with the specified ID.",
20577 "operationId": "Invoice_GetApiV2BusinessByBusinessIdInvoiceById",
20578 "consumes": [],
20579 "produces": [
20580 "application/json",
20581 "text/json",
20582 "application/xml",
20583 "text/xml"
20584 ],
20585 "parameters": [
20586 {
20587 "name": "id",
20588 "in": "path",
20589 "required": true,
20590 "type": "integer",
20591 "format": "int32",
20592 "title": "Int32"
20593 },
20594 {
20595 "name": "businessId",
20596 "in": "path",
20597 "required": true,
20598 "type": "integer",
20599 "format": "int32",
20600 "title": "Nullable<Int32>"
20601 },
20602 {
20603 "name": "whiteLabelId",
20604 "in": "query",
20605 "required": false,
20606 "type": "integer",
20607 "format": "int32",
20608 "title": "Nullable<Int32>"
20609 }
20610 ],
20611 "responses": {
20612 "200": {
20613 "description": "OK",
20614 "schema": {
20615 "$ref": "#/definitions/InvoiceModel"
20616 }
20617 }
20618 }
20619 }
20620 },
20621 "/api/v2/business/{businessId}/worktype": {
20622 "get": {
20623 "tags": [
20624 "WorkType"
20625 ],
20626 "summary": "List Work Types",
20627 "description": "Lists all the work types for the business.\n\nThis operation supports OData queries.",
20628 "operationId": "WorkType_GetWorkTypes",
20629 "consumes": [],
20630 "produces": [
20631 "application/json",
20632 "text/json",
20633 "application/xml",
20634 "text/xml"
20635 ],
20636 "parameters": [
20637 {
20638 "name": "businessId",
20639 "in": "path",
20640 "required": true,
20641 "type": "string"
20642 }
20643 ],
20644 "responses": {
20645 "200": {
20646 "description": "OK",
20647 "schema": {
20648 "type": "array",
20649 "items": {
20650 "$ref": "#/definitions/WorkTypeModel"
20651 },
20652 "xml": {
20653 "name": "WorkTypeModel",
20654 "wrapped": true
20655 },
20656 "title": "IEnumerable<WorkTypeModel>"
20657 }
20658 }
20659 }
20660 },
20661 "post": {
20662 "tags": [
20663 "WorkType"
20664 ],
20665 "summary": "Create Work Type",
20666 "description": "Creates a new work type for the business.",
20667 "operationId": "WorkType_Post",
20668 "consumes": [
20669 "application/json",
20670 "text/json",
20671 "application/xml",
20672 "text/xml",
20673 "application/x-www-form-urlencoded"
20674 ],
20675 "produces": [
20676 "application/json",
20677 "text/json",
20678 "application/xml",
20679 "text/xml"
20680 ],
20681 "parameters": [
20682 {
20683 "name": "workType",
20684 "in": "body",
20685 "required": true,
20686 "schema": {
20687 "$ref": "#/definitions/WorkTypeModel"
20688 }
20689 },
20690 {
20691 "name": "businessId",
20692 "in": "path",
20693 "required": true,
20694 "type": "string"
20695 }
20696 ],
20697 "responses": {
20698 "200": {
20699 "description": "OK"
20700 }
20701 }
20702 }
20703 },
20704 "/api/v2/business/{businessId}/worktype/{id}": {
20705 "get": {
20706 "tags": [
20707 "WorkType"
20708 ],
20709 "summary": "Get Work Type by ID",
20710 "description": "Gets the work type with the specified ID.",
20711 "operationId": "WorkType_Get",
20712 "consumes": [],
20713 "produces": [
20714 "application/json",
20715 "text/json",
20716 "application/xml",
20717 "text/xml"
20718 ],
20719 "parameters": [
20720 {
20721 "name": "id",
20722 "in": "path",
20723 "required": true,
20724 "type": "integer",
20725 "format": "int32",
20726 "title": "Int32"
20727 },
20728 {
20729 "name": "businessId",
20730 "in": "path",
20731 "required": true,
20732 "type": "string"
20733 }
20734 ],
20735 "responses": {
20736 "200": {
20737 "description": "OK",
20738 "schema": {
20739 "$ref": "#/definitions/WorkTypeModel"
20740 }
20741 }
20742 }
20743 },
20744 "put": {
20745 "tags": [
20746 "WorkType"
20747 ],
20748 "summary": "Update Work Type",
20749 "description": "Updates the work type with the specified ID.",
20750 "operationId": "WorkType_Put",
20751 "consumes": [
20752 "application/json",
20753 "text/json",
20754 "application/xml",
20755 "text/xml",
20756 "application/x-www-form-urlencoded"
20757 ],
20758 "produces": [
20759 "application/json",
20760 "text/json",
20761 "application/xml",
20762 "text/xml"
20763 ],
20764 "parameters": [
20765 {
20766 "name": "id",
20767 "in": "path",
20768 "required": true,
20769 "type": "integer",
20770 "format": "int32",
20771 "title": "Int32"
20772 },
20773 {
20774 "name": "workType",
20775 "in": "body",
20776 "required": true,
20777 "schema": {
20778 "$ref": "#/definitions/WorkTypeModel"
20779 }
20780 },
20781 {
20782 "name": "businessId",
20783 "in": "path",
20784 "required": true,
20785 "type": "string"
20786 }
20787 ],
20788 "responses": {
20789 "200": {
20790 "description": "OK"
20791 }
20792 }
20793 },
20794 "delete": {
20795 "tags": [
20796 "WorkType"
20797 ],
20798 "summary": "Delete Work Type",
20799 "description": "Deletes the work type with the specified ID.",
20800 "operationId": "WorkType_Delete",
20801 "consumes": [],
20802 "produces": [
20803 "application/json",
20804 "text/json",
20805 "application/xml",
20806 "text/xml"
20807 ],
20808 "parameters": [
20809 {
20810 "name": "id",
20811 "in": "path",
20812 "required": true,
20813 "type": "integer",
20814 "format": "int32",
20815 "title": "Int32"
20816 },
20817 {
20818 "name": "businessId",
20819 "in": "path",
20820 "required": true,
20821 "type": "string"
20822 }
20823 ],
20824 "responses": {
20825 "200": {
20826 "description": "OK"
20827 }
20828 }
20829 }
20830 }
20831 },
20832 "definitions": {
20833 "ODataQueryOptions[AbaDetails]": {
20834 "type": "object",
20835 "properties": {
20836 "ifMatch": {
20837 "type": "object",
20838 "readOnly": true,
20839 "title": "ETag<AbaDetails>"
20840 },
20841 "ifNoneMatch": {
20842 "type": "object",
20843 "readOnly": true,
20844 "title": "ETag<AbaDetails>"
20845 },
20846 "context": {
20847 "$ref": "#/definitions/ODataQueryContext",
20848 "readOnly": true
20849 },
20850 "request": {
20851 "type": "object",
20852 "readOnly": true,
20853 "title": "HttpRequestMessage"
20854 },
20855 "rawValues": {
20856 "$ref": "#/definitions/ODataRawQueryOptions",
20857 "readOnly": true
20858 },
20859 "selectExpand": {
20860 "$ref": "#/definitions/SelectExpandQueryOption",
20861 "readOnly": true
20862 },
20863 "filter": {
20864 "$ref": "#/definitions/FilterQueryOption",
20865 "readOnly": true
20866 },
20867 "orderBy": {
20868 "$ref": "#/definitions/OrderByQueryOption",
20869 "readOnly": true
20870 },
20871 "skip": {
20872 "$ref": "#/definitions/SkipQueryOption",
20873 "readOnly": true
20874 },
20875 "top": {
20876 "$ref": "#/definitions/TopQueryOption",
20877 "readOnly": true
20878 },
20879 "inlineCount": {
20880 "$ref": "#/definitions/InlineCountQueryOption",
20881 "readOnly": true
20882 },
20883 "validator": {
20884 "$ref": "#/definitions/ODataQueryValidator"
20885 }
20886 },
20887 "xml": {
20888 "name": "ODataQueryOptions`1"
20889 },
20890 "title": "ODataQueryOptions<AbaDetails>"
20891 },
20892 "ODataQueryContext": {
20893 "type": "object",
20894 "properties": {
20895 "model": {
20896 "$ref": "#/definitions/IEdmModel",
20897 "readOnly": true
20898 },
20899 "elementType": {
20900 "$ref": "#/definitions/IEdmType",
20901 "readOnly": true
20902 },
20903 "elementClrType": {
20904 "type": "string",
20905 "readOnly": true,
20906 "title": "Type"
20907 }
20908 },
20909 "xml": {
20910 "name": "ODataQueryContext"
20911 },
20912 "title": "ODataQueryContext"
20913 },
20914 "ODataRawQueryOptions": {
20915 "type": "object",
20916 "properties": {
20917 "filter": {
20918 "type": "string",
20919 "readOnly": true,
20920 "title": "String"
20921 },
20922 "orderBy": {
20923 "type": "string",
20924 "readOnly": true,
20925 "title": "String"
20926 },
20927 "top": {
20928 "type": "string",
20929 "readOnly": true,
20930 "title": "String"
20931 },
20932 "skip": {
20933 "type": "string",
20934 "readOnly": true,
20935 "title": "String"
20936 },
20937 "select": {
20938 "type": "string",
20939 "readOnly": true,
20940 "title": "String"
20941 },
20942 "expand": {
20943 "type": "string",
20944 "readOnly": true,
20945 "title": "String"
20946 },
20947 "inlineCount": {
20948 "type": "string",
20949 "readOnly": true,
20950 "title": "String"
20951 },
20952 "format": {
20953 "type": "string",
20954 "readOnly": true,
20955 "title": "String"
20956 },
20957 "skipToken": {
20958 "type": "string",
20959 "readOnly": true,
20960 "title": "String"
20961 }
20962 },
20963 "xml": {
20964 "name": "ODataRawQueryOptions"
20965 },
20966 "title": "ODataRawQueryOptions"
20967 },
20968 "SelectExpandQueryOption": {
20969 "type": "object",
20970 "properties": {
20971 "context": {
20972 "$ref": "#/definitions/ODataQueryContext",
20973 "readOnly": true
20974 },
20975 "rawSelect": {
20976 "type": "string",
20977 "readOnly": true,
20978 "title": "String"
20979 },
20980 "rawExpand": {
20981 "type": "string",
20982 "readOnly": true,
20983 "title": "String"
20984 },
20985 "validator": {
20986 "$ref": "#/definitions/SelectExpandQueryValidator"
20987 },
20988 "selectExpandClause": {
20989 "$ref": "#/definitions/SelectExpandClause",
20990 "readOnly": true
20991 }
20992 },
20993 "xml": {
20994 "name": "SelectExpandQueryOption"
20995 },
20996 "title": "SelectExpandQueryOption"
20997 },
20998 "FilterQueryOption": {
20999 "type": "object",
21000 "properties": {
21001 "context": {
21002 "$ref": "#/definitions/ODataQueryContext",
21003 "readOnly": true
21004 },
21005 "validator": {
21006 "$ref": "#/definitions/FilterQueryValidator"
21007 },
21008 "filterClause": {
21009 "$ref": "#/definitions/FilterClause",
21010 "readOnly": true
21011 },
21012 "rawValue": {
21013 "type": "string",
21014 "readOnly": true,
21015 "title": "String"
21016 }
21017 },
21018 "xml": {
21019 "name": "FilterQueryOption"
21020 },
21021 "title": "FilterQueryOption"
21022 },
21023 "OrderByQueryOption": {
21024 "type": "object",
21025 "properties": {
21026 "context": {
21027 "$ref": "#/definitions/ODataQueryContext",
21028 "readOnly": true
21029 },
21030 "orderByNodes": {
21031 "type": "array",
21032 "items": {
21033 "$ref": "#/definitions/OrderByNode"
21034 },
21035 "readOnly": true,
21036 "xml": {
21037 "name": "OrderByNode",
21038 "wrapped": true
21039 },
21040 "title": "IList<OrderByNode>"
21041 },
21042 "rawValue": {
21043 "type": "string",
21044 "readOnly": true,
21045 "title": "String"
21046 },
21047 "validator": {
21048 "$ref": "#/definitions/OrderByQueryValidator"
21049 },
21050 "orderByClause": {
21051 "$ref": "#/definitions/OrderByClause",
21052 "readOnly": true
21053 }
21054 },
21055 "xml": {
21056 "name": "OrderByQueryOption"
21057 },
21058 "title": "OrderByQueryOption"
21059 },
21060 "SkipQueryOption": {
21061 "type": "object",
21062 "properties": {
21063 "context": {
21064 "$ref": "#/definitions/ODataQueryContext",
21065 "readOnly": true
21066 },
21067 "rawValue": {
21068 "type": "string",
21069 "readOnly": true,
21070 "title": "String"
21071 },
21072 "value": {
21073 "format": "int32",
21074 "type": "integer",
21075 "readOnly": true,
21076 "title": "Int32"
21077 },
21078 "validator": {
21079 "$ref": "#/definitions/SkipQueryValidator"
21080 }
21081 },
21082 "xml": {
21083 "name": "SkipQueryOption"
21084 },
21085 "title": "SkipQueryOption"
21086 },
21087 "TopQueryOption": {
21088 "type": "object",
21089 "properties": {
21090 "context": {
21091 "$ref": "#/definitions/ODataQueryContext",
21092 "readOnly": true
21093 },
21094 "rawValue": {
21095 "type": "string",
21096 "readOnly": true,
21097 "title": "String"
21098 },
21099 "value": {
21100 "format": "int32",
21101 "type": "integer",
21102 "readOnly": true,
21103 "title": "Int32"
21104 },
21105 "validator": {
21106 "$ref": "#/definitions/TopQueryValidator"
21107 }
21108 },
21109 "xml": {
21110 "name": "TopQueryOption"
21111 },
21112 "title": "TopQueryOption"
21113 },
21114 "InlineCountQueryOption": {
21115 "type": "object",
21116 "properties": {
21117 "context": {
21118 "$ref": "#/definitions/ODataQueryContext",
21119 "readOnly": true
21120 },
21121 "rawValue": {
21122 "type": "string",
21123 "readOnly": true,
21124 "title": "String"
21125 },
21126 "value": {
21127 "enum": [
21128 "None",
21129 "AllPages"
21130 ],
21131 "type": "string",
21132 "readOnly": true,
21133 "title": "InlineCountValue"
21134 }
21135 },
21136 "xml": {
21137 "name": "InlineCountQueryOption"
21138 },
21139 "title": "InlineCountQueryOption"
21140 },
21141 "ODataQueryValidator": {
21142 "type": "object",
21143 "properties": {},
21144 "xml": {
21145 "name": "ODataQueryValidator"
21146 },
21147 "title": "ODataQueryValidator"
21148 },
21149 "IEdmModel": {
21150 "type": "object",
21151 "properties": {
21152 "schemaElements": {
21153 "type": "array",
21154 "items": {
21155 "$ref": "#/definitions/IEdmSchemaElement"
21156 },
21157 "readOnly": true,
21158 "xml": {
21159 "name": "IEdmSchemaElement",
21160 "wrapped": true
21161 },
21162 "title": "IEnumerable<IEdmSchemaElement>"
21163 },
21164 "vocabularyAnnotations": {
21165 "type": "array",
21166 "items": {
21167 "$ref": "#/definitions/IEdmVocabularyAnnotation"
21168 },
21169 "readOnly": true,
21170 "xml": {
21171 "name": "IEdmVocabularyAnnotation",
21172 "wrapped": true
21173 },
21174 "title": "IEnumerable<IEdmVocabularyAnnotation>"
21175 },
21176 "referencedModels": {
21177 "type": "array",
21178 "items": {
21179 "$ref": "#/definitions/IEdmModel"
21180 },
21181 "readOnly": true,
21182 "xml": {
21183 "name": "IEdmModel",
21184 "wrapped": true
21185 },
21186 "title": "IEnumerable<IEdmModel>"
21187 },
21188 "directValueAnnotationsManager": {
21189 "$ref": "#/definitions/IEdmDirectValueAnnotationsManager",
21190 "readOnly": true
21191 }
21192 },
21193 "xml": {
21194 "name": "IEdmModel"
21195 },
21196 "title": "IEdmModel"
21197 },
21198 "IEdmType": {
21199 "type": "object",
21200 "properties": {
21201 "typeKind": {
21202 "enum": [
21203 "None",
21204 "Primitive",
21205 "Entity",
21206 "Complex",
21207 "Row",
21208 "Collection",
21209 "EntityReference",
21210 "Enum"
21211 ],
21212 "type": "string",
21213 "readOnly": true,
21214 "title": "EdmTypeKind"
21215 }
21216 },
21217 "xml": {
21218 "name": "IEdmType"
21219 },
21220 "title": "IEdmType"
21221 },
21222 "SelectExpandQueryValidator": {
21223 "type": "object",
21224 "properties": {},
21225 "xml": {
21226 "name": "SelectExpandQueryValidator"
21227 },
21228 "title": "SelectExpandQueryValidator"
21229 },
21230 "SelectExpandClause": {
21231 "type": "object",
21232 "properties": {
21233 "selectedItems": {
21234 "type": "array",
21235 "items": {
21236 "$ref": "#/definitions/SelectItem"
21237 },
21238 "readOnly": true,
21239 "xml": {
21240 "name": "SelectItem",
21241 "wrapped": true
21242 },
21243 "title": "IEnumerable<SelectItem>"
21244 },
21245 "allSelected": {
21246 "type": "boolean",
21247 "readOnly": true,
21248 "title": "Boolean"
21249 }
21250 },
21251 "xml": {
21252 "name": "SelectExpandClause"
21253 },
21254 "title": "SelectExpandClause"
21255 },
21256 "FilterQueryValidator": {
21257 "type": "object",
21258 "properties": {},
21259 "xml": {
21260 "name": "FilterQueryValidator"
21261 },
21262 "title": "FilterQueryValidator"
21263 },
21264 "FilterClause": {
21265 "type": "object",
21266 "properties": {
21267 "expression": {
21268 "$ref": "#/definitions/SingleValueNode",
21269 "readOnly": true
21270 },
21271 "rangeVariable": {
21272 "$ref": "#/definitions/RangeVariable",
21273 "readOnly": true
21274 },
21275 "itemType": {
21276 "$ref": "#/definitions/IEdmTypeReference",
21277 "readOnly": true
21278 }
21279 },
21280 "xml": {
21281 "name": "FilterClause"
21282 },
21283 "title": "FilterClause"
21284 },
21285 "OrderByNode": {
21286 "type": "object",
21287 "properties": {
21288 "direction": {
21289 "enum": [
21290 "Ascending",
21291 "Descending"
21292 ],
21293 "type": "string",
21294 "readOnly": true,
21295 "title": "OrderByDirection"
21296 }
21297 },
21298 "xml": {
21299 "name": "OrderByNode"
21300 },
21301 "title": "OrderByNode"
21302 },
21303 "OrderByQueryValidator": {
21304 "type": "object",
21305 "properties": {},
21306 "xml": {
21307 "name": "OrderByQueryValidator"
21308 },
21309 "title": "OrderByQueryValidator"
21310 },
21311 "OrderByClause": {
21312 "type": "object",
21313 "properties": {
21314 "thenBy": {
21315 "$ref": "#/definitions/OrderByClause",
21316 "readOnly": true
21317 },
21318 "expression": {
21319 "$ref": "#/definitions/SingleValueNode",
21320 "readOnly": true
21321 },
21322 "direction": {
21323 "enum": [
21324 "Ascending",
21325 "Descending"
21326 ],
21327 "type": "string",
21328 "readOnly": true,
21329 "title": "OrderByDirection"
21330 },
21331 "rangeVariable": {
21332 "$ref": "#/definitions/RangeVariable",
21333 "readOnly": true
21334 },
21335 "itemType": {
21336 "$ref": "#/definitions/IEdmTypeReference",
21337 "readOnly": true
21338 }
21339 },
21340 "xml": {
21341 "name": "OrderByClause"
21342 },
21343 "title": "OrderByClause"
21344 },
21345 "SkipQueryValidator": {
21346 "type": "object",
21347 "properties": {},
21348 "xml": {
21349 "name": "SkipQueryValidator"
21350 },
21351 "title": "SkipQueryValidator"
21352 },
21353 "TopQueryValidator": {
21354 "type": "object",
21355 "properties": {},
21356 "xml": {
21357 "name": "TopQueryValidator"
21358 },
21359 "title": "TopQueryValidator"
21360 },
21361 "IEdmSchemaElement": {
21362 "type": "object",
21363 "properties": {
21364 "schemaElementKind": {
21365 "enum": [
21366 "None",
21367 "TypeDefinition",
21368 "Function",
21369 "ValueTerm",
21370 "EntityContainer"
21371 ],
21372 "type": "string",
21373 "readOnly": true,
21374 "title": "EdmSchemaElementKind"
21375 },
21376 "namespace": {
21377 "type": "string",
21378 "readOnly": true,
21379 "title": "String"
21380 },
21381 "name": {
21382 "type": "string",
21383 "readOnly": true,
21384 "title": "String"
21385 }
21386 },
21387 "xml": {
21388 "name": "IEdmSchemaElement"
21389 },
21390 "title": "IEdmSchemaElement"
21391 },
21392 "IEdmVocabularyAnnotation": {
21393 "type": "object",
21394 "properties": {
21395 "qualifier": {
21396 "type": "string",
21397 "readOnly": true,
21398 "title": "String"
21399 },
21400 "term": {
21401 "$ref": "#/definitions/IEdmTerm",
21402 "readOnly": true
21403 },
21404 "target": {
21405 "$ref": "#/definitions/IEdmVocabularyAnnotatable",
21406 "readOnly": true
21407 }
21408 },
21409 "xml": {
21410 "name": "IEdmVocabularyAnnotation"
21411 },
21412 "title": "IEdmVocabularyAnnotation"
21413 },
21414 "IEdmDirectValueAnnotationsManager": {
21415 "type": "object",
21416 "properties": {},
21417 "xml": {
21418 "name": "IEdmDirectValueAnnotationsManager"
21419 },
21420 "title": "IEdmDirectValueAnnotationsManager"
21421 },
21422 "SelectItem": {
21423 "type": "object",
21424 "properties": {},
21425 "xml": {
21426 "name": "SelectItem"
21427 },
21428 "title": "SelectItem"
21429 },
21430 "SingleValueNode": {
21431 "type": "object",
21432 "properties": {
21433 "typeReference": {
21434 "$ref": "#/definitions/IEdmTypeReference",
21435 "readOnly": true
21436 },
21437 "kind": {
21438 "enum": [
21439 "None",
21440 "Constant",
21441 "Convert",
21442 "NonentityRangeVariableReference",
21443 "BinaryOperator",
21444 "UnaryOperator",
21445 "SingleValuePropertyAccess",
21446 "CollectionPropertyAccess",
21447 "SingleValueFunctionCall",
21448 "Any",
21449 "CollectionNavigationNode",
21450 "SingleNavigationNode",
21451 "SingleValueOpenPropertyAccess",
21452 "SingleEntityCast",
21453 "All",
21454 "EntityCollectionCast",
21455 "EntityRangeVariableReference",
21456 "SingleEntityFunctionCall",
21457 "CollectionFunctionCall",
21458 "EntityCollectionFunctionCall",
21459 "NamedFunctionParameter"
21460 ],
21461 "type": "string",
21462 "readOnly": true,
21463 "title": "QueryNodeKind"
21464 }
21465 },
21466 "xml": {
21467 "name": "SingleValueNode"
21468 },
21469 "title": "SingleValueNode"
21470 },
21471 "RangeVariable": {
21472 "type": "object",
21473 "properties": {
21474 "name": {
21475 "type": "string",
21476 "readOnly": true,
21477 "title": "String"
21478 },
21479 "typeReference": {
21480 "$ref": "#/definitions/IEdmTypeReference",
21481 "readOnly": true
21482 },
21483 "kind": {
21484 "format": "int32",
21485 "type": "integer",
21486 "readOnly": true,
21487 "title": "Int32"
21488 }
21489 },
21490 "xml": {
21491 "name": "RangeVariable"
21492 },
21493 "title": "RangeVariable"
21494 },
21495 "IEdmTypeReference": {
21496 "type": "object",
21497 "properties": {
21498 "isNullable": {
21499 "type": "boolean",
21500 "readOnly": true,
21501 "title": "Boolean"
21502 },
21503 "definition": {
21504 "$ref": "#/definitions/IEdmType",
21505 "readOnly": true
21506 }
21507 },
21508 "xml": {
21509 "name": "IEdmTypeReference"
21510 },
21511 "title": "IEdmTypeReference"
21512 },
21513 "IEdmTerm": {
21514 "type": "object",
21515 "properties": {
21516 "termKind": {
21517 "enum": [
21518 "None",
21519 "Type",
21520 "Value"
21521 ],
21522 "type": "string",
21523 "readOnly": true,
21524 "title": "EdmTermKind"
21525 },
21526 "schemaElementKind": {
21527 "enum": [
21528 "None",
21529 "TypeDefinition",
21530 "Function",
21531 "ValueTerm",
21532 "EntityContainer"
21533 ],
21534 "type": "string",
21535 "readOnly": true,
21536 "title": "EdmSchemaElementKind"
21537 },
21538 "namespace": {
21539 "type": "string",
21540 "readOnly": true,
21541 "title": "String"
21542 },
21543 "name": {
21544 "type": "string",
21545 "readOnly": true,
21546 "title": "String"
21547 }
21548 },
21549 "xml": {
21550 "name": "IEdmTerm"
21551 },
21552 "title": "IEdmTerm"
21553 },
21554 "IEdmVocabularyAnnotatable": {
21555 "type": "object",
21556 "properties": {},
21557 "xml": {
21558 "name": "IEdmVocabularyAnnotatable"
21559 },
21560 "title": "IEdmVocabularyAnnotatable"
21561 },
21562 "BusinessAbaModel": {
21563 "type": "object",
21564 "properties": {
21565 "id": {
21566 "format": "int32",
21567 "type": "integer",
21568 "title": "Int32"
21569 },
21570 "bsb": {
21571 "type": "string",
21572 "title": "String"
21573 },
21574 "accountNumber": {
21575 "type": "string",
21576 "title": "String"
21577 },
21578 "accountName": {
21579 "type": "string",
21580 "title": "String"
21581 },
21582 "financialInstitutionCode": {
21583 "type": "string",
21584 "title": "String"
21585 },
21586 "lodgementReference": {
21587 "type": "string",
21588 "title": "String"
21589 },
21590 "userName": {
21591 "type": "string",
21592 "title": "String"
21593 },
21594 "userId": {
21595 "type": "string",
21596 "title": "String"
21597 },
21598 "includeSelfBalancingTransaction": {
21599 "type": "boolean",
21600 "title": "Boolean"
21601 },
21602 "mergeMultipleAccountPayments": {
21603 "type": "boolean",
21604 "title": "Boolean"
21605 },
21606 "balanceLodgementReference": {
21607 "type": "string",
21608 "title": "String"
21609 },
21610 "paymentAdditionalContent": {
21611 "enum": [
21612 "None",
21613 "PeriodEndingDate",
21614 "PaymentDate",
21615 "EmployeeId"
21616 ],
21617 "type": "string",
21618 "title": "Nullable<AbaPaymentAdditionalContent>"
21619 },
21620 "balanceAdditionalContent": {
21621 "enum": [
21622 "None",
21623 "PeriodEndingDate",
21624 "PaymentDate",
21625 "PayRunId"
21626 ],
21627 "type": "string",
21628 "title": "Nullable<AbaBalanceAdditionalContent>"
21629 }
21630 },
21631 "xml": {
21632 "name": "BusinessAbaModel"
21633 },
21634 "title": "BusinessAbaModel"
21635 },
21636 "SingleSignOnRequestModel": {
21637 "type": "object",
21638 "properties": {
21639 "businessId": {
21640 "format": "int32",
21641 "type": "integer",
21642 "title": "Nullable<Int32>"
21643 },
21644 "userName": {
21645 "type": "string",
21646 "title": "String"
21647 },
21648 "url": {
21649 "type": "string",
21650 "title": "String"
21651 },
21652 "navigation": {
21653 "enum": [
21654 "Full",
21655 "Primary",
21656 "Secondary",
21657 "None"
21658 ],
21659 "type": "string",
21660 "title": "NavigationDisplayEnum"
21661 },
21662 "hostName": {
21663 "type": "string",
21664 "title": "String"
21665 }
21666 },
21667 "xml": {
21668 "name": "SingleSignOnRequestModel"
21669 },
21670 "title": "SingleSignOnRequestModel"
21671 },
21672 "SingleSignOnResponseModel": {
21673 "type": "object",
21674 "properties": {
21675 "url": {
21676 "type": "string",
21677 "title": "String"
21678 }
21679 },
21680 "xml": {
21681 "name": "SingleSignOnResponseModel"
21682 },
21683 "title": "SingleSignOnResponseModel"
21684 },
21685 "TimesheetRoundingRulesModel": {
21686 "type": "object",
21687 "properties": {
21688 "id": {
21689 "format": "int32",
21690 "type": "integer",
21691 "title": "Int32"
21692 },
21693 "shiftStartRoundingDirection": {
21694 "enum": [
21695 "None",
21696 "Up",
21697 "Down",
21698 "ToTheNearest"
21699 ],
21700 "type": "string",
21701 "title": "RoundingDirectionEnum"
21702 },
21703 "shiftStartRoundingInterval": {
21704 "format": "int32",
21705 "type": "integer",
21706 "title": "Int32"
21707 },
21708 "shiftEndRoundingDirection": {
21709 "enum": [
21710 "None",
21711 "Up",
21712 "Down",
21713 "ToTheNearest"
21714 ],
21715 "type": "string",
21716 "title": "RoundingDirectionEnum"
21717 },
21718 "shiftEndRoundingInterval": {
21719 "format": "int32",
21720 "type": "integer",
21721 "title": "Int32"
21722 },
21723 "breakStartRoundingDirection": {
21724 "enum": [
21725 "None",
21726 "Up",
21727 "Down",
21728 "ToTheNearest"
21729 ],
21730 "type": "string",
21731 "title": "RoundingDirectionEnum"
21732 },
21733 "breakStartRoundingInterval": {
21734 "format": "int32",
21735 "type": "integer",
21736 "title": "Int32"
21737 },
21738 "breakEndRoundingDirection": {
21739 "enum": [
21740 "None",
21741 "Up",
21742 "Down",
21743 "ToTheNearest"
21744 ],
21745 "type": "string",
21746 "title": "RoundingDirectionEnum"
21747 },
21748 "breakEndRoundingInterval": {
21749 "format": "int32",
21750 "type": "integer",
21751 "title": "Int32"
21752 },
21753 "roundUpToShiftStartTimeRoundingInterval": {
21754 "format": "int32",
21755 "type": "integer",
21756 "title": "Nullable<Int32>"
21757 },
21758 "roundDownToShiftStartTimeRoundingInterval": {
21759 "format": "int32",
21760 "type": "integer",
21761 "title": "Nullable<Int32>"
21762 },
21763 "roundUpToShiftEndTimeRoundingInterval": {
21764 "format": "int32",
21765 "type": "integer",
21766 "title": "Nullable<Int32>"
21767 },
21768 "roundDownToShiftEndTimeRoundingInterval": {
21769 "format": "int32",
21770 "type": "integer",
21771 "title": "Nullable<Int32>"
21772 }
21773 },
21774 "xml": {
21775 "name": "TimesheetRoundingRulesModel"
21776 },
21777 "title": "TimesheetRoundingRulesModel"
21778 },
21779 "BusinessAtoSupplierModel": {
21780 "type": "object",
21781 "properties": {
21782 "id": {
21783 "format": "int32",
21784 "type": "integer",
21785 "title": "Int32"
21786 },
21787 "abn": {
21788 "type": "string",
21789 "title": "String"
21790 },
21791 "name": {
21792 "type": "string",
21793 "title": "String"
21794 },
21795 "addressLine1": {
21796 "type": "string",
21797 "title": "String"
21798 },
21799 "addressLine2": {
21800 "type": "string",
21801 "title": "String"
21802 },
21803 "suburb": {
21804 "type": "string",
21805 "title": "String"
21806 },
21807 "state": {
21808 "type": "string",
21809 "title": "String"
21810 },
21811 "postCode": {
21812 "type": "string",
21813 "title": "String"
21814 },
21815 "contactName": {
21816 "type": "string",
21817 "title": "String"
21818 },
21819 "signatoryName": {
21820 "type": "string",
21821 "title": "String"
21822 },
21823 "phoneNumber": {
21824 "type": "string",
21825 "title": "String"
21826 },
21827 "faxNumber": {
21828 "type": "string",
21829 "title": "String"
21830 },
21831 "country": {
21832 "type": "string",
21833 "title": "String"
21834 },
21835 "branch": {
21836 "type": "string",
21837 "title": "String"
21838 }
21839 },
21840 "xml": {
21841 "name": "BusinessAtoSupplierModel"
21842 },
21843 "title": "BusinessAtoSupplierModel"
21844 },
21845 "EntitlementsModel": {
21846 "type": "object",
21847 "properties": {
21848 "planName": {
21849 "type": "string",
21850 "title": "String"
21851 },
21852 "trialExpiryDate": {
21853 "format": "date-time",
21854 "type": "string",
21855 "title": "DateTime"
21856 },
21857 "features": {
21858 "type": "array",
21859 "items": {
21860 "$ref": "#/definitions/EntitlementFeatureModel"
21861 },
21862 "xml": {
21863 "name": "EntitlementFeatureModel",
21864 "wrapped": true
21865 },
21866 "title": "IList<EntitlementFeatureModel>"
21867 }
21868 },
21869 "xml": {
21870 "name": "EntitlementsModel"
21871 },
21872 "title": "EntitlementsModel"
21873 },
21874 "EntitlementFeatureModel": {
21875 "type": "object",
21876 "properties": {
21877 "name": {
21878 "type": "string",
21879 "title": "String"
21880 }
21881 },
21882 "xml": {
21883 "name": "EntitlementFeatureModel"
21884 },
21885 "title": "EntitlementFeatureModel"
21886 },
21887 "DocumentModel": {
21888 "type": "object",
21889 "properties": {
21890 "id": {
21891 "format": "int32",
21892 "type": "integer",
21893 "title": "Int32"
21894 },
21895 "friendlyName": {
21896 "type": "string",
21897 "title": "String"
21898 },
21899 "dateCreated": {
21900 "format": "date-time",
21901 "type": "string",
21902 "title": "DateTime"
21903 },
21904 "visibleToAllEmployees": {
21905 "type": "boolean",
21906 "title": "Boolean"
21907 },
21908 "selectedGroups": {
21909 "type": "array",
21910 "items": {
21911 "$ref": "#/definitions/EmployeeGroupItemModel"
21912 },
21913 "xml": {
21914 "name": "EmployeeGroupItemModel",
21915 "wrapped": true
21916 },
21917 "title": "List<EmployeeGroupItemModel>"
21918 }
21919 },
21920 "xml": {
21921 "name": "DocumentModel"
21922 },
21923 "title": "DocumentModel"
21924 },
21925 "EmployeeGroupItemModel": {
21926 "type": "object",
21927 "properties": {
21928 "id": {
21929 "format": "int32",
21930 "type": "integer",
21931 "title": "Int32"
21932 },
21933 "name": {
21934 "type": "string",
21935 "title": "String"
21936 }
21937 },
21938 "xml": {
21939 "name": "EmployeeGroupItemModel"
21940 },
21941 "title": "EmployeeGroupItemModel"
21942 },
21943 "UpdateDocumentPermissionsModel": {
21944 "type": "object",
21945 "properties": {
21946 "id": {
21947 "format": "int32",
21948 "type": "integer",
21949 "title": "Int32"
21950 },
21951 "visibleToAll": {
21952 "type": "boolean",
21953 "title": "Boolean"
21954 },
21955 "employeeGroups": {
21956 "type": "array",
21957 "items": {
21958 "format": "int32",
21959 "type": "integer",
21960 "title": "Int32"
21961 },
21962 "title": "List<Int32>"
21963 }
21964 },
21965 "xml": {
21966 "name": "UpdateDocumentPermissionsModel"
21967 },
21968 "title": "UpdateDocumentPermissionsModel"
21969 },
21970 "DocumentFile": {
21971 "type": "object",
21972 "properties": {
21973 "contentLength": {
21974 "format": "int64",
21975 "type": "integer",
21976 "title": "Int64"
21977 },
21978 "contentType": {
21979 "type": "string",
21980 "title": "String"
21981 },
21982 "bytes": {
21983 "format": "byte",
21984 "type": "string",
21985 "title": "Byte[]"
21986 },
21987 "filename": {
21988 "type": "string",
21989 "title": "String"
21990 }
21991 },
21992 "xml": {
21993 "name": "DocumentFile"
21994 },
21995 "title": "DocumentFile"
21996 },
21997 "ODataQueryOptions[Business]": {
21998 "type": "object",
21999 "properties": {
22000 "ifMatch": {
22001 "type": "object",
22002 "readOnly": true,
22003 "title": "ETag<Business>"
22004 },
22005 "ifNoneMatch": {
22006 "type": "object",
22007 "readOnly": true,
22008 "title": "ETag<Business>"
22009 },
22010 "context": {
22011 "$ref": "#/definitions/ODataQueryContext",
22012 "readOnly": true
22013 },
22014 "request": {
22015 "type": "object",
22016 "readOnly": true,
22017 "title": "HttpRequestMessage"
22018 },
22019 "rawValues": {
22020 "$ref": "#/definitions/ODataRawQueryOptions",
22021 "readOnly": true
22022 },
22023 "selectExpand": {
22024 "$ref": "#/definitions/SelectExpandQueryOption",
22025 "readOnly": true
22026 },
22027 "filter": {
22028 "$ref": "#/definitions/FilterQueryOption",
22029 "readOnly": true
22030 },
22031 "orderBy": {
22032 "$ref": "#/definitions/OrderByQueryOption",
22033 "readOnly": true
22034 },
22035 "skip": {
22036 "$ref": "#/definitions/SkipQueryOption",
22037 "readOnly": true
22038 },
22039 "top": {
22040 "$ref": "#/definitions/TopQueryOption",
22041 "readOnly": true
22042 },
22043 "inlineCount": {
22044 "$ref": "#/definitions/InlineCountQueryOption",
22045 "readOnly": true
22046 },
22047 "validator": {
22048 "$ref": "#/definitions/ODataQueryValidator"
22049 }
22050 },
22051 "xml": {
22052 "name": "ODataQueryOptions`1"
22053 },
22054 "title": "ODataQueryOptions<Business>"
22055 },
22056 "BusinessModel": {
22057 "type": "object",
22058 "properties": {
22059 "id": {
22060 "format": "int32",
22061 "type": "integer",
22062 "title": "Int32"
22063 },
22064 "name": {
22065 "type": "string",
22066 "title": "String"
22067 },
22068 "abn": {
22069 "type": "string",
22070 "title": "String"
22071 },
22072 "registrationNumber": {
22073 "type": "string",
22074 "title": "String"
22075 },
22076 "legalName": {
22077 "type": "string",
22078 "title": "String"
22079 },
22080 "contactName": {
22081 "type": "string",
22082 "title": "String"
22083 },
22084 "contactEmailAddress": {
22085 "type": "string",
22086 "title": "String"
22087 },
22088 "contactPhoneNumber": {
22089 "type": "string",
22090 "title": "String"
22091 },
22092 "contactFaxNumber": {
22093 "type": "string",
22094 "title": "String"
22095 },
22096 "externalId": {
22097 "type": "string",
22098 "title": "String"
22099 },
22100 "standardHoursPerDay": {
22101 "format": "double",
22102 "type": "number",
22103 "title": "Decimal"
22104 },
22105 "integratedTimesheetsEnabled": {
22106 "type": "boolean",
22107 "title": "Boolean"
22108 },
22109 "journalService": {
22110 "type": "string",
22111 "title": "String"
22112 },
22113 "endOfWeek": {
22114 "enum": [
22115 "Sunday",
22116 "Monday",
22117 "Tuesday",
22118 "Wednesday",
22119 "Thursday",
22120 "Friday",
22121 "Saturday"
22122 ],
22123 "type": "string",
22124 "title": "DayOfWeek"
22125 },
22126 "initialFinancialYearStart": {
22127 "format": "int32",
22128 "type": "integer",
22129 "title": "Nullable<Int32>"
22130 },
22131 "managersCanEditRosterBudgets": {
22132 "type": "boolean",
22133 "title": "Nullable<Boolean>"
22134 },
22135 "budgetWarningPercent": {
22136 "format": "double",
22137 "type": "number",
22138 "title": "Nullable<Decimal>"
22139 },
22140 "budgetEntryMethod": {
22141 "enum": [
22142 "PercentageOfSales",
22143 "Direct"
22144 ],
22145 "type": "string",
22146 "title": "BudgetEntryMethodEnum"
22147 },
22148 "addressLine1": {
22149 "type": "string",
22150 "title": "String"
22151 },
22152 "addressLine2": {
22153 "type": "string",
22154 "title": "String"
22155 },
22156 "suburb": {
22157 "type": "string",
22158 "title": "String"
22159 },
22160 "postCode": {
22161 "type": "string",
22162 "title": "String"
22163 },
22164 "state": {
22165 "type": "string",
22166 "title": "String"
22167 },
22168 "whiteLabelName": {
22169 "type": "string",
22170 "title": "String"
22171 },
22172 "dateCreated": {
22173 "format": "date-time",
22174 "type": "string",
22175 "title": "DateTime"
22176 },
22177 "city": {
22178 "type": "string",
22179 "title": "String"
22180 },
22181 "county": {
22182 "type": "string",
22183 "title": "String"
22184 }
22185 },
22186 "xml": {
22187 "name": "BusinessModel"
22188 },
22189 "title": "BusinessModel"
22190 },
22191 "BusinessAccessModel": {
22192 "type": "object",
22193 "properties": {
22194 "accessType": {
22195 "enum": [
22196 "Unrestricted",
22197 "Restricted"
22198 ],
22199 "type": "string",
22200 "title": "RelatedUserType"
22201 },
22202 "employeeGroups": {
22203 "type": "array",
22204 "items": {
22205 "$ref": "#/definitions/EmployeeGroupAccessModel"
22206 },
22207 "xml": {
22208 "name": "EmployeeGroupAccessModel",
22209 "wrapped": true
22210 },
22211 "title": "IList<EmployeeGroupAccessModel>"
22212 },
22213 "locationAccess": {
22214 "type": "array",
22215 "items": {
22216 "$ref": "#/definitions/LocationAccessModel"
22217 },
22218 "xml": {
22219 "name": "LocationAccessModel",
22220 "wrapped": true
22221 },
22222 "title": "IList<LocationAccessModel>"
22223 },
22224 "reports": {
22225 "$ref": "#/definitions/ReportAccessModel"
22226 },
22227 "name": {
22228 "type": "string",
22229 "title": "String"
22230 },
22231 "email": {
22232 "type": "string",
22233 "title": "String"
22234 }
22235 },
22236 "xml": {
22237 "name": "BusinessAccessModel"
22238 },
22239 "title": "BusinessAccessModel"
22240 },
22241 "EmployeeGroupAccessModel": {
22242 "type": "object",
22243 "properties": {
22244 "employeeGroupId": {
22245 "format": "int32",
22246 "type": "integer",
22247 "title": "Int32"
22248 },
22249 "permissions": {
22250 "enum": [
22251 "ApproveTimesheets",
22252 "ApproveLeaveRequests",
22253 "CreateTimesheets",
22254 "CreateLeaveRequests",
22255 "ViewLeaveRequests",
22256 "ManageRosters",
22257 "ViewRosters",
22258 "ViewShiftCosts",
22259 "ViewExpenses",
22260 "CreateExpenses",
22261 "ApproveExpenses",
22262 "CreateTasks"
22263 ],
22264 "type": "string",
22265 "title": "UserPermission"
22266 }
22267 },
22268 "xml": {
22269 "name": "EmployeeGroupAccessModel"
22270 },
22271 "title": "EmployeeGroupAccessModel"
22272 },
22273 "LocationAccessModel": {
22274 "type": "object",
22275 "properties": {
22276 "filterType": {
22277 "enum": [
22278 "Location",
22279 "LocationOrParents"
22280 ],
22281 "type": "string",
22282 "title": "LocationRestrictionFilterTypeEnum"
22283 },
22284 "locationIds": {
22285 "type": "array",
22286 "items": {
22287 "format": "int32",
22288 "type": "integer",
22289 "title": "Int32"
22290 },
22291 "title": "List<Int32>"
22292 },
22293 "permissions": {
22294 "enum": [
22295 "ApproveTimesheets",
22296 "ApproveLeaveRequests",
22297 "CreateTimesheets",
22298 "CreateLeaveRequests",
22299 "ViewLeaveRequests",
22300 "ManageRosters",
22301 "ViewRosters",
22302 "ViewShiftCosts",
22303 "ViewExpenses",
22304 "CreateExpenses",
22305 "ApproveExpenses",
22306 "CreateTasks"
22307 ],
22308 "type": "string",
22309 "title": "UserPermission"
22310 }
22311 },
22312 "xml": {
22313 "name": "LocationAccessModel"
22314 },
22315 "title": "LocationAccessModel"
22316 },
22317 "ReportAccessModel": {
22318 "type": "object",
22319 "properties": {
22320 "accessType": {
22321 "enum": [
22322 "None",
22323 "AllReports",
22324 "SpecificReports"
22325 ],
22326 "type": "string",
22327 "title": "ReportAccessType"
22328 },
22329 "specificReports": {
22330 "enum": [
22331 "DetailedActivityReport",
22332 "PayRunComparisonReport",
22333 "SuperContributionsReport",
22334 "OrdinaryTimeEarningsReport",
22335 "DeductionsReport",
22336 "PayrollTaxReport",
22337 "PaygReport",
22338 "PayCategoriesReport",
22339 "PayRunAuditReport",
22340 "CostingReport",
22341 "TimesheetReport",
22342 "ExpensesReport",
22343 "PaymentHistoryReport",
22344 "LeaveBalancesReport",
22345 "LeaveLiabilityReport",
22346 "LeaveHistoryReport",
22347 "BirthdayReport",
22348 "EmployeeDetailsReport",
22349 "UnpaidEmployeesReport",
22350 "QualificationsReport",
22351 "EmployeeSatisfactionReport",
22352 "AttendanceReport",
22353 "EmergencyContactsReport",
22354 "EmployerLiabilitiesReport",
22355 "PayRunVarianceReport",
22356 "EmployeeDetailsAuditReport",
22357 "GrossToNetReport",
22358 "LiveView",
22359 "TasksReport",
22360 "ShiftSwappingReport"
22361 ],
22362 "type": "string",
22363 "title": "ReportEnum"
22364 }
22365 },
22366 "xml": {
22367 "name": "ReportAccessModel"
22368 },
22369 "title": "ReportAccessModel"
22370 },
22371 "CreateBusinessAccessModel": {
22372 "type": "object",
22373 "properties": {
22374 "suppressNotificationEmails": {
22375 "type": "boolean",
22376 "title": "Boolean"
22377 },
22378 "accessType": {
22379 "enum": [
22380 "Unrestricted",
22381 "Restricted"
22382 ],
22383 "type": "string",
22384 "title": "RelatedUserType"
22385 },
22386 "employeeGroups": {
22387 "type": "array",
22388 "items": {
22389 "$ref": "#/definitions/EmployeeGroupAccessModel"
22390 },
22391 "xml": {
22392 "name": "EmployeeGroupAccessModel",
22393 "wrapped": true
22394 },
22395 "title": "IList<EmployeeGroupAccessModel>"
22396 },
22397 "locationAccess": {
22398 "type": "array",
22399 "items": {
22400 "$ref": "#/definitions/LocationAccessModel"
22401 },
22402 "xml": {
22403 "name": "LocationAccessModel",
22404 "wrapped": true
22405 },
22406 "title": "IList<LocationAccessModel>"
22407 },
22408 "reports": {
22409 "$ref": "#/definitions/ReportAccessModel"
22410 },
22411 "name": {
22412 "type": "string",
22413 "title": "String"
22414 },
22415 "email": {
22416 "type": "string",
22417 "title": "String"
22418 }
22419 },
22420 "xml": {
22421 "name": "CreateBusinessAccessModel"
22422 },
22423 "title": "CreateBusinessAccessModel"
22424 },
22425 "AccessModel": {
22426 "type": "object",
22427 "properties": {
22428 "name": {
22429 "type": "string",
22430 "title": "String"
22431 },
22432 "email": {
22433 "type": "string",
22434 "title": "String"
22435 }
22436 },
22437 "xml": {
22438 "name": "AccessModel"
22439 },
22440 "title": "AccessModel"
22441 },
22442 "ODataQueryOptions[DeductionCategory]": {
22443 "type": "object",
22444 "properties": {
22445 "ifMatch": {
22446 "type": "object",
22447 "readOnly": true,
22448 "title": "ETag<DeductionCategory>"
22449 },
22450 "ifNoneMatch": {
22451 "type": "object",
22452 "readOnly": true,
22453 "title": "ETag<DeductionCategory>"
22454 },
22455 "context": {
22456 "$ref": "#/definitions/ODataQueryContext",
22457 "readOnly": true
22458 },
22459 "request": {
22460 "type": "object",
22461 "readOnly": true,
22462 "title": "HttpRequestMessage"
22463 },
22464 "rawValues": {
22465 "$ref": "#/definitions/ODataRawQueryOptions",
22466 "readOnly": true
22467 },
22468 "selectExpand": {
22469 "$ref": "#/definitions/SelectExpandQueryOption",
22470 "readOnly": true
22471 },
22472 "filter": {
22473 "$ref": "#/definitions/FilterQueryOption",
22474 "readOnly": true
22475 },
22476 "orderBy": {
22477 "$ref": "#/definitions/OrderByQueryOption",
22478 "readOnly": true
22479 },
22480 "skip": {
22481 "$ref": "#/definitions/SkipQueryOption",
22482 "readOnly": true
22483 },
22484 "top": {
22485 "$ref": "#/definitions/TopQueryOption",
22486 "readOnly": true
22487 },
22488 "inlineCount": {
22489 "$ref": "#/definitions/InlineCountQueryOption",
22490 "readOnly": true
22491 },
22492 "validator": {
22493 "$ref": "#/definitions/ODataQueryValidator"
22494 }
22495 },
22496 "xml": {
22497 "name": "ODataQueryOptions`1"
22498 },
22499 "title": "ODataQueryOptions<DeductionCategory>"
22500 },
22501 "DeductionCategoryModel": {
22502 "type": "object",
22503 "properties": {
22504 "id": {
22505 "format": "int32",
22506 "type": "integer",
22507 "title": "Int32"
22508 },
22509 "name": {
22510 "type": "string",
22511 "title": "String"
22512 },
22513 "taxExempt": {
22514 "type": "boolean",
22515 "title": "Boolean"
22516 },
22517 "source": {
22518 "type": "string",
22519 "title": "String"
22520 },
22521 "externalId": {
22522 "type": "string",
22523 "title": "String"
22524 },
22525 "sgcCalculationImpact": {
22526 "enum": [
22527 "None",
22528 "ReducesOTE",
22529 "ReducesOTEAndSGC"
22530 ],
22531 "type": "string",
22532 "title": "SGCCalculationImpactEnum"
22533 },
22534 "paymentSummaryClassification": {
22535 "enum": [
22536 "Default",
22537 "UnionOrProfessionalAssociationFees",
22538 "WorkplaceGiving"
22539 ],
22540 "type": "string",
22541 "title": "DeductionCategoryPaymentSummaryClassification"
22542 },
22543 "expenseGeneralLedgerMappingCode": {
22544 "type": "string",
22545 "title": "String"
22546 },
22547 "liabilityGeneralLedgerMappingCode": {
22548 "type": "string",
22549 "title": "String"
22550 }
22551 },
22552 "xml": {
22553 "name": "DeductionCategoryModel"
22554 },
22555 "title": "DeductionCategoryModel"
22556 },
22557 "WorkTypeModel": {
22558 "type": "object",
22559 "properties": {
22560 "id": {
22561 "format": "int32",
22562 "type": "integer",
22563 "title": "Int32"
22564 },
22565 "name": {
22566 "type": "string",
22567 "title": "String"
22568 },
22569 "payCategoryId": {
22570 "format": "int32",
22571 "type": "integer",
22572 "title": "Nullable<Int32>"
22573 },
22574 "leaveCategoryId": {
22575 "format": "int32",
22576 "type": "integer",
22577 "title": "Nullable<Int32>"
22578 },
22579 "externalId": {
22580 "type": "string",
22581 "title": "String"
22582 },
22583 "source": {
22584 "type": "string",
22585 "title": "String"
22586 },
22587 "accruesLeave": {
22588 "type": "boolean",
22589 "title": "Boolean"
22590 },
22591 "employmentTypes": {
22592 "type": "array",
22593 "items": {
22594 "enum": [
22595 "Unknown",
22596 "FullTime",
22597 "PartTime",
22598 "LabourHire",
22599 "SuperannuationIncomeStream",
22600 "Casual"
22601 ],
22602 "type": "string",
22603 "title": "EmploymentTypeEnum"
22604 },
22605 "xml": {
22606 "name": "EmploymentTypeEnum",
22607 "wrapped": true
22608 },
22609 "title": "IList<EmploymentTypeEnum>"
22610 },
22611 "mappingType": {
22612 "enum": [
22613 "PayCategory",
22614 "LeaveCategory",
22615 "PrimaryPayCategory",
22616 "ShiftCondition"
22617 ],
22618 "type": "string",
22619 "title": "Nullable<WorkTypeMappingType>"
22620 },
22621 "shortCode": {
22622 "type": "string",
22623 "title": "String"
22624 }
22625 },
22626 "xml": {
22627 "name": "WorkTypeModel"
22628 },
22629 "title": "WorkTypeModel"
22630 },
22631 "ProfileImageMetadata": {
22632 "type": "object",
22633 "properties": {
22634 "contentType": {
22635 "type": "string",
22636 "title": "String"
22637 },
22638 "extension": {
22639 "type": "string",
22640 "title": "String"
22641 },
22642 "width": {
22643 "format": "int32",
22644 "type": "integer",
22645 "title": "Nullable<Int32>"
22646 },
22647 "height": {
22648 "format": "int32",
22649 "type": "integer",
22650 "title": "Nullable<Int32>"
22651 }
22652 },
22653 "xml": {
22654 "name": "ProfileImageMetadata"
22655 },
22656 "title": "ProfileImageMetadata"
22657 },
22658 "ODataQueryOptions[Employee]": {
22659 "type": "object",
22660 "properties": {
22661 "ifMatch": {
22662 "type": "object",
22663 "readOnly": true,
22664 "title": "ETag<Employee>"
22665 },
22666 "ifNoneMatch": {
22667 "type": "object",
22668 "readOnly": true,
22669 "title": "ETag<Employee>"
22670 },
22671 "context": {
22672 "$ref": "#/definitions/ODataQueryContext",
22673 "readOnly": true
22674 },
22675 "request": {
22676 "type": "object",
22677 "readOnly": true,
22678 "title": "HttpRequestMessage"
22679 },
22680 "rawValues": {
22681 "$ref": "#/definitions/ODataRawQueryOptions",
22682 "readOnly": true
22683 },
22684 "selectExpand": {
22685 "$ref": "#/definitions/SelectExpandQueryOption",
22686 "readOnly": true
22687 },
22688 "filter": {
22689 "$ref": "#/definitions/FilterQueryOption",
22690 "readOnly": true
22691 },
22692 "orderBy": {
22693 "$ref": "#/definitions/OrderByQueryOption",
22694 "readOnly": true
22695 },
22696 "skip": {
22697 "$ref": "#/definitions/SkipQueryOption",
22698 "readOnly": true
22699 },
22700 "top": {
22701 "$ref": "#/definitions/TopQueryOption",
22702 "readOnly": true
22703 },
22704 "inlineCount": {
22705 "$ref": "#/definitions/InlineCountQueryOption",
22706 "readOnly": true
22707 },
22708 "validator": {
22709 "$ref": "#/definitions/ODataQueryValidator"
22710 }
22711 },
22712 "xml": {
22713 "name": "ODataQueryOptions`1"
22714 },
22715 "title": "ODataQueryOptions<Employee>"
22716 },
22717 "EmployeeDetailsModel": {
22718 "type": "object",
22719 "properties": {
22720 "id": {
22721 "format": "int32",
22722 "type": "integer",
22723 "title": "Int32"
22724 },
22725 "title": {
22726 "type": "string",
22727 "title": "String"
22728 },
22729 "firstName": {
22730 "type": "string",
22731 "title": "String"
22732 },
22733 "preferredName": {
22734 "type": "string",
22735 "title": "String"
22736 },
22737 "middleName": {
22738 "type": "string",
22739 "title": "String"
22740 },
22741 "surname": {
22742 "type": "string",
22743 "title": "String"
22744 },
22745 "gender": {
22746 "type": "string",
22747 "title": "String"
22748 },
22749 "dateOfBirth": {
22750 "format": "date-time",
22751 "type": "string",
22752 "title": "Nullable<DateTime>"
22753 },
22754 "anniversaryDate": {
22755 "format": "date-time",
22756 "type": "string",
22757 "title": "Nullable<DateTime>"
22758 },
22759 "externalId": {
22760 "type": "string",
22761 "title": "String"
22762 },
22763 "residentialStreetAddress": {
22764 "type": "string",
22765 "title": "String"
22766 },
22767 "residentialAddressLine2": {
22768 "type": "string",
22769 "title": "String"
22770 },
22771 "residentialSuburb": {
22772 "type": "string",
22773 "title": "String"
22774 },
22775 "residentialState": {
22776 "type": "string",
22777 "title": "String"
22778 },
22779 "residentialPostCode": {
22780 "type": "string",
22781 "title": "String"
22782 },
22783 "postalStreetAddress": {
22784 "type": "string",
22785 "title": "String"
22786 },
22787 "postalAddressLine2": {
22788 "type": "string",
22789 "title": "String"
22790 },
22791 "postalSuburb": {
22792 "type": "string",
22793 "title": "String"
22794 },
22795 "postalState": {
22796 "type": "string",
22797 "title": "String"
22798 },
22799 "postalPostCode": {
22800 "type": "string",
22801 "title": "String"
22802 },
22803 "emailAddress": {
22804 "type": "string",
22805 "title": "String"
22806 },
22807 "homePhone": {
22808 "type": "string",
22809 "title": "String"
22810 },
22811 "workPhone": {
22812 "type": "string",
22813 "title": "String"
22814 },
22815 "mobilePhone": {
22816 "type": "string",
22817 "title": "String"
22818 },
22819 "startDate": {
22820 "format": "date-time",
22821 "type": "string",
22822 "title": "Nullable<DateTime>"
22823 },
22824 "endDate": {
22825 "format": "date-time",
22826 "type": "string",
22827 "title": "Nullable<DateTime>"
22828 },
22829 "residentialCity": {
22830 "type": "string",
22831 "title": "String"
22832 },
22833 "residentialCounty": {
22834 "type": "string",
22835 "title": "String"
22836 },
22837 "postalCity": {
22838 "type": "string",
22839 "title": "String"
22840 },
22841 "postalCounty": {
22842 "type": "string",
22843 "title": "String"
22844 }
22845 },
22846 "xml": {
22847 "name": "EmployeeDetailsModel"
22848 },
22849 "title": "EmployeeDetailsModel"
22850 },
22851 "EmployeesFilter": {
22852 "type": "object",
22853 "properties": {
22854 "payScheduleId": {
22855 "format": "int32",
22856 "type": "integer",
22857 "title": "Nullable<Int32>"
22858 },
22859 "locationId": {
22860 "format": "int32",
22861 "type": "integer",
22862 "title": "Nullable<Int32>"
22863 }
22864 },
22865 "xml": {
22866 "name": "EmployeesFilter"
22867 },
22868 "title": "EmployeesFilter"
22869 },
22870 "ODataQueryOptions[UnstructuredEmployeeModel]": {
22871 "type": "object",
22872 "properties": {
22873 "ifMatch": {
22874 "type": "object",
22875 "readOnly": true,
22876 "title": "ETag<UnstructuredEmployeeModel>"
22877 },
22878 "ifNoneMatch": {
22879 "type": "object",
22880 "readOnly": true,
22881 "title": "ETag<UnstructuredEmployeeModel>"
22882 },
22883 "context": {
22884 "$ref": "#/definitions/ODataQueryContext",
22885 "readOnly": true
22886 },
22887 "request": {
22888 "type": "object",
22889 "readOnly": true,
22890 "title": "HttpRequestMessage"
22891 },
22892 "rawValues": {
22893 "$ref": "#/definitions/ODataRawQueryOptions",
22894 "readOnly": true
22895 },
22896 "selectExpand": {
22897 "$ref": "#/definitions/SelectExpandQueryOption",
22898 "readOnly": true
22899 },
22900 "filter": {
22901 "$ref": "#/definitions/FilterQueryOption",
22902 "readOnly": true
22903 },
22904 "orderBy": {
22905 "$ref": "#/definitions/OrderByQueryOption",
22906 "readOnly": true
22907 },
22908 "skip": {
22909 "$ref": "#/definitions/SkipQueryOption",
22910 "readOnly": true
22911 },
22912 "top": {
22913 "$ref": "#/definitions/TopQueryOption",
22914 "readOnly": true
22915 },
22916 "inlineCount": {
22917 "$ref": "#/definitions/InlineCountQueryOption",
22918 "readOnly": true
22919 },
22920 "validator": {
22921 "$ref": "#/definitions/ODataQueryValidator"
22922 }
22923 },
22924 "xml": {
22925 "name": "ODataQueryOptions`1"
22926 },
22927 "title": "ODataQueryOptions<UnstructuredEmployeeModel>"
22928 },
22929 "UnstructuredEmployeeModel": {
22930 "type": "object",
22931 "properties": {
22932 "status": {
22933 "enum": [
22934 "Active",
22935 "Terminated",
22936 "Incomplete"
22937 ],
22938 "type": "string",
22939 "title": "EmployeeStatusEnum"
22940 },
22941 "dateCreated": {
22942 "format": "date-time",
22943 "type": "string",
22944 "title": "DateTime"
22945 },
22946 "residentialCity": {
22947 "type": "string",
22948 "title": "String"
22949 },
22950 "residentialCounty": {
22951 "type": "string",
22952 "title": "String"
22953 },
22954 "postalCity": {
22955 "type": "string",
22956 "title": "String"
22957 },
22958 "postalCounty": {
22959 "type": "string",
22960 "title": "String"
22961 },
22962 "id": {
22963 "format": "int32",
22964 "type": "integer",
22965 "title": "Int32"
22966 },
22967 "taxFileNumber": {
22968 "type": "string",
22969 "title": "String"
22970 },
22971 "title": {
22972 "type": "string",
22973 "title": "String"
22974 },
22975 "preferredName": {
22976 "type": "string",
22977 "title": "String"
22978 },
22979 "firstName": {
22980 "type": "string",
22981 "title": "String"
22982 },
22983 "middleName": {
22984 "type": "string",
22985 "title": "String"
22986 },
22987 "surname": {
22988 "type": "string",
22989 "title": "String"
22990 },
22991 "dateOfBirth": {
22992 "format": "date-time",
22993 "type": "string",
22994 "title": "Nullable<DateTime>"
22995 },
22996 "gender": {
22997 "type": "string",
22998 "title": "String"
22999 },
23000 "externalId": {
23001 "type": "string",
23002 "title": "String"
23003 },
23004 "residentialStreetAddress": {
23005 "type": "string",
23006 "title": "String"
23007 },
23008 "residentialAddressLine2": {
23009 "type": "string",
23010 "title": "String"
23011 },
23012 "residentialSuburb": {
23013 "type": "string",
23014 "title": "String"
23015 },
23016 "residentialState": {
23017 "type": "string",
23018 "title": "String"
23019 },
23020 "residentialPostCode": {
23021 "type": "string",
23022 "title": "String"
23023 },
23024 "postalStreetAddress": {
23025 "type": "string",
23026 "title": "String"
23027 },
23028 "postalAddressLine2": {
23029 "type": "string",
23030 "title": "String"
23031 },
23032 "postalSuburb": {
23033 "type": "string",
23034 "title": "String"
23035 },
23036 "postalState": {
23037 "type": "string",
23038 "title": "String"
23039 },
23040 "postalPostCode": {
23041 "type": "string",
23042 "title": "String"
23043 },
23044 "emailAddress": {
23045 "type": "string",
23046 "title": "String"
23047 },
23048 "homePhone": {
23049 "type": "string",
23050 "title": "String"
23051 },
23052 "workPhone": {
23053 "type": "string",
23054 "title": "String"
23055 },
23056 "mobilePhone": {
23057 "type": "string",
23058 "title": "String"
23059 },
23060 "startDate": {
23061 "format": "date-time",
23062 "type": "string",
23063 "title": "Nullable<DateTime>"
23064 },
23065 "endDate": {
23066 "format": "date-time",
23067 "type": "string",
23068 "title": "Nullable<DateTime>"
23069 },
23070 "anniversaryDate": {
23071 "format": "date-time",
23072 "type": "string",
23073 "title": "Nullable<DateTime>"
23074 },
23075 "tags": {
23076 "type": "string",
23077 "title": "String"
23078 },
23079 "employingEntityABN": {
23080 "type": "string",
23081 "title": "String"
23082 },
23083 "employmentType": {
23084 "type": "string",
23085 "title": "String"
23086 },
23087 "previousSurname": {
23088 "type": "string",
23089 "title": "String"
23090 },
23091 "australianResident": {
23092 "type": "string",
23093 "title": "String"
23094 },
23095 "claimTaxFreeThreshold": {
23096 "type": "string",
23097 "title": "String"
23098 },
23099 "seniorsTaxOffset": {
23100 "type": "string",
23101 "title": "String"
23102 },
23103 "otherTaxOffset": {
23104 "type": "string",
23105 "title": "String"
23106 },
23107 "helpDebt": {
23108 "type": "string",
23109 "title": "String"
23110 },
23111 "afsDebt": {
23112 "type": "string",
23113 "title": "String"
23114 },
23115 "isExemptFromFloodLevy": {
23116 "type": "string",
23117 "title": "String"
23118 },
23119 "hasApprovedWorkingHolidayVisa": {
23120 "type": "string",
23121 "title": "String"
23122 },
23123 "hasWithholdingVariation": {
23124 "type": "string",
23125 "title": "String"
23126 },
23127 "taxVariation": {
23128 "type": "string",
23129 "title": "String"
23130 },
23131 "dateTaxFileDeclarationSigned": {
23132 "format": "date-time",
23133 "type": "string",
23134 "title": "Nullable<DateTime>"
23135 },
23136 "dateTaxFileDeclarationReported": {
23137 "format": "date-time",
23138 "type": "string",
23139 "title": "Nullable<DateTime>"
23140 },
23141 "jobTitle": {
23142 "type": "string",
23143 "title": "String"
23144 },
23145 "paySchedule": {
23146 "type": "string",
23147 "title": "String"
23148 },
23149 "primaryPayCategory": {
23150 "type": "string",
23151 "title": "String"
23152 },
23153 "primaryLocation": {
23154 "type": "string",
23155 "title": "String"
23156 },
23157 "paySlipNotificationType": {
23158 "type": "string",
23159 "title": "String"
23160 },
23161 "rate": {
23162 "format": "double",
23163 "type": "number",
23164 "title": "Nullable<Decimal>"
23165 },
23166 "overrideTemplateRate": {
23167 "type": "string",
23168 "title": "String"
23169 },
23170 "rateUnit": {
23171 "type": "string",
23172 "title": "String"
23173 },
23174 "hoursPerWeek": {
23175 "format": "double",
23176 "type": "number",
23177 "title": "Nullable<Decimal>"
23178 },
23179 "automaticallyPayEmployee": {
23180 "type": "string",
23181 "title": "String"
23182 },
23183 "leaveTemplate": {
23184 "type": "string",
23185 "title": "String"
23186 },
23187 "payRateTemplate": {
23188 "type": "string",
23189 "title": "String"
23190 },
23191 "payConditionRuleSet": {
23192 "type": "string",
23193 "title": "String"
23194 },
23195 "employmentAgreement": {
23196 "type": "string",
23197 "title": "String"
23198 },
23199 "isEnabledForTimesheets": {
23200 "type": "string",
23201 "title": "String"
23202 },
23203 "isExemptFromPayrollTax": {
23204 "type": "string",
23205 "title": "String"
23206 },
23207 "locations": {
23208 "type": "string",
23209 "title": "String"
23210 },
23211 "workTypes": {
23212 "type": "string",
23213 "title": "String"
23214 },
23215 "emergencyContact1_Name": {
23216 "type": "string",
23217 "title": "String"
23218 },
23219 "emergencyContact1_Relationship": {
23220 "type": "string",
23221 "title": "String"
23222 },
23223 "emergencyContact1_Address": {
23224 "type": "string",
23225 "title": "String"
23226 },
23227 "emergencyContact1_ContactNumber": {
23228 "type": "string",
23229 "title": "String"
23230 },
23231 "emergencyContact1_AlternateContactNumber": {
23232 "type": "string",
23233 "title": "String"
23234 },
23235 "emergencyContact2_Name": {
23236 "type": "string",
23237 "title": "String"
23238 },
23239 "emergencyContact2_Relationship": {
23240 "type": "string",
23241 "title": "String"
23242 },
23243 "emergencyContact2_Address": {
23244 "type": "string",
23245 "title": "String"
23246 },
23247 "emergencyContact2_ContactNumber": {
23248 "type": "string",
23249 "title": "String"
23250 },
23251 "emergencyContact2_AlternateContactNumber": {
23252 "type": "string",
23253 "title": "String"
23254 },
23255 "bankAccount1_BSB": {
23256 "type": "string",
23257 "title": "String"
23258 },
23259 "bankAccount1_AccountNumber": {
23260 "type": "string",
23261 "title": "String"
23262 },
23263 "bankAccount1_AccountName": {
23264 "type": "string",
23265 "title": "String"
23266 },
23267 "bankAccount1_AllocatedPercentage": {
23268 "format": "double",
23269 "type": "number",
23270 "title": "Nullable<Decimal>"
23271 },
23272 "bankAccount1_FixedAmount": {
23273 "format": "double",
23274 "type": "number",
23275 "title": "Nullable<Decimal>"
23276 },
23277 "bankAccount2_BSB": {
23278 "type": "string",
23279 "title": "String"
23280 },
23281 "bankAccount2_AccountNumber": {
23282 "type": "string",
23283 "title": "String"
23284 },
23285 "bankAccount2_AccountName": {
23286 "type": "string",
23287 "title": "String"
23288 },
23289 "bankAccount2_AllocatedPercentage": {
23290 "format": "double",
23291 "type": "number",
23292 "title": "Nullable<Decimal>"
23293 },
23294 "bankAccount2_FixedAmount": {
23295 "format": "double",
23296 "type": "number",
23297 "title": "Nullable<Decimal>"
23298 },
23299 "bankAccount3_BSB": {
23300 "type": "string",
23301 "title": "String"
23302 },
23303 "bankAccount3_AccountNumber": {
23304 "type": "string",
23305 "title": "String"
23306 },
23307 "bankAccount3_AccountName": {
23308 "type": "string",
23309 "title": "String"
23310 },
23311 "bankAccount3_AllocatedPercentage": {
23312 "format": "double",
23313 "type": "number",
23314 "title": "Nullable<Decimal>"
23315 },
23316 "bankAccount3_FixedAmount": {
23317 "format": "double",
23318 "type": "number",
23319 "title": "Nullable<Decimal>"
23320 },
23321 "superFund1_ProductCode": {
23322 "type": "string",
23323 "title": "String"
23324 },
23325 "superFund1_FundName": {
23326 "type": "string",
23327 "title": "String"
23328 },
23329 "superFund1_MemberNumber": {
23330 "type": "string",
23331 "title": "String"
23332 },
23333 "superFund1_AllocatedPercentage": {
23334 "format": "double",
23335 "type": "number",
23336 "title": "Nullable<Decimal>"
23337 },
23338 "superFund1_FixedAmount": {
23339 "format": "double",
23340 "type": "number",
23341 "title": "Nullable<Decimal>"
23342 },
23343 "superFund2_ProductCode": {
23344 "type": "string",
23345 "title": "String"
23346 },
23347 "superFund2_FundName": {
23348 "type": "string",
23349 "title": "String"
23350 },
23351 "superFund2_MemberNumber": {
23352 "type": "string",
23353 "title": "String"
23354 },
23355 "superFund2_AllocatedPercentage": {
23356 "format": "double",
23357 "type": "number",
23358 "title": "Nullable<Decimal>"
23359 },
23360 "superFund2_FixedAmount": {
23361 "format": "double",
23362 "type": "number",
23363 "title": "Nullable<Decimal>"
23364 },
23365 "superFund3_ProductCode": {
23366 "type": "string",
23367 "title": "String"
23368 },
23369 "superFund3_FundName": {
23370 "type": "string",
23371 "title": "String"
23372 },
23373 "superFund3_MemberNumber": {
23374 "type": "string",
23375 "title": "String"
23376 },
23377 "superFund3_AllocatedPercentage": {
23378 "format": "double",
23379 "type": "number",
23380 "title": "Nullable<Decimal>"
23381 },
23382 "superFund3_FixedAmount": {
23383 "format": "double",
23384 "type": "number",
23385 "title": "Nullable<Decimal>"
23386 },
23387 "superThresholdAmount": {
23388 "format": "double",
23389 "type": "number",
23390 "title": "Nullable<Decimal>"
23391 },
23392 "maximumQuarterlySuperContributionsBase": {
23393 "format": "double",
23394 "type": "number",
23395 "title": "Nullable<Decimal>"
23396 },
23397 "rosteringNotificationChoices": {
23398 "type": "string",
23399 "title": "String"
23400 },
23401 "medicareLevyExemption": {
23402 "type": "string",
23403 "title": "String"
23404 }
23405 },
23406 "xml": {
23407 "name": "UnstructuredEmployeeModel"
23408 },
23409 "title": "UnstructuredEmployeeModel"
23410 },
23411 "LeaveBalanceModel": {
23412 "type": "object",
23413 "properties": {
23414 "leaveCategoryId": {
23415 "format": "int32",
23416 "type": "integer",
23417 "title": "Int32"
23418 },
23419 "leaveCategoryName": {
23420 "type": "string",
23421 "title": "String"
23422 },
23423 "accruedAmount": {
23424 "format": "double",
23425 "type": "number",
23426 "title": "Decimal"
23427 }
23428 },
23429 "xml": {
23430 "name": "LeaveBalanceModel"
23431 },
23432 "title": "LeaveBalanceModel"
23433 },
23434 "EmployeeNoteModel": {
23435 "type": "object",
23436 "properties": {
23437 "id": {
23438 "format": "int32",
23439 "type": "integer",
23440 "title": "Int32"
23441 },
23442 "user": {
23443 "type": "string",
23444 "title": "String"
23445 },
23446 "dateTime": {
23447 "format": "date-time",
23448 "type": "string",
23449 "title": "DateTime"
23450 },
23451 "note": {
23452 "type": "string",
23453 "title": "String"
23454 }
23455 },
23456 "xml": {
23457 "name": "EmployeeNoteModel"
23458 },
23459 "title": "EmployeeNoteModel"
23460 },
23461 "CreateEmployeeNoteModel": {
23462 "type": "object",
23463 "properties": {
23464 "note": {
23465 "type": "string",
23466 "title": "String"
23467 }
23468 },
23469 "xml": {
23470 "name": "CreateEmployeeNoteModel"
23471 },
23472 "title": "CreateEmployeeNoteModel"
23473 },
23474 "EmployeePayRateModel": {
23475 "type": "object",
23476 "properties": {
23477 "payCategoryId": {
23478 "format": "int32",
23479 "type": "integer",
23480 "title": "Int32"
23481 },
23482 "payCategoryName": {
23483 "type": "string",
23484 "title": "String"
23485 },
23486 "isPrimaryPayCategory": {
23487 "type": "boolean",
23488 "title": "Boolean"
23489 },
23490 "accruesLeave": {
23491 "type": "boolean",
23492 "title": "Boolean"
23493 },
23494 "rateUnit": {
23495 "type": "string",
23496 "title": "String"
23497 },
23498 "rate": {
23499 "format": "double",
23500 "type": "number",
23501 "title": "Decimal"
23502 },
23503 "calculatedRate": {
23504 "format": "double",
23505 "type": "number",
23506 "title": "Decimal"
23507 },
23508 "hasSuperRateOverride": {
23509 "type": "boolean",
23510 "title": "Boolean"
23511 },
23512 "superRate": {
23513 "format": "double",
23514 "type": "number",
23515 "title": "Nullable<Decimal>"
23516 }
23517 },
23518 "xml": {
23519 "name": "EmployeePayRateModel"
23520 },
23521 "title": "EmployeePayRateModel"
23522 },
23523 "OpeningBalancesEditModel": {
23524 "type": "object",
23525 "properties": {
23526 "employeeId": {
23527 "format": "int32",
23528 "type": "integer",
23529 "title": "Nullable<Int32>"
23530 },
23531 "totalHours": {
23532 "format": "double",
23533 "type": "number",
23534 "title": "Nullable<Decimal>"
23535 },
23536 "grossEarnings": {
23537 "format": "double",
23538 "type": "number",
23539 "title": "Nullable<Decimal>"
23540 },
23541 "paygWithholdingAmount": {
23542 "format": "double",
23543 "type": "number",
23544 "title": "Nullable<Decimal>"
23545 },
23546 "sfssAmount": {
23547 "format": "double",
23548 "type": "number",
23549 "title": "Nullable<Decimal>"
23550 },
23551 "helpAmount": {
23552 "format": "double",
23553 "type": "number",
23554 "title": "Nullable<Decimal>"
23555 },
23556 "superContribution": {
23557 "format": "double",
23558 "type": "number",
23559 "title": "Nullable<Decimal>"
23560 },
23561 "employerContribution": {
23562 "format": "double",
23563 "type": "number",
23564 "title": "Nullable<Decimal>"
23565 },
23566 "leaveBalances": {
23567 "type": "array",
23568 "items": {
23569 "$ref": "#/definitions/InitialLeaveBalanceModel"
23570 },
23571 "xml": {
23572 "name": "InitialLeaveBalanceModel",
23573 "wrapped": true
23574 },
23575 "title": "IList<InitialLeaveBalanceModel>"
23576 },
23577 "earningsLines": {
23578 "type": "array",
23579 "items": {
23580 "$ref": "#/definitions/InitialEarningsModel"
23581 },
23582 "xml": {
23583 "name": "InitialEarningsModel",
23584 "wrapped": true
23585 },
23586 "title": "IList<InitialEarningsModel>"
23587 },
23588 "deductions": {
23589 "type": "array",
23590 "items": {
23591 "$ref": "#/definitions/InitialDeductionModel"
23592 },
23593 "xml": {
23594 "name": "InitialDeductionModel",
23595 "wrapped": true
23596 },
23597 "title": "List<InitialDeductionModel>"
23598 },
23599 "employerLiabilities": {
23600 "type": "array",
23601 "items": {
23602 "$ref": "#/definitions/InitialEmployerLiabilityModel"
23603 },
23604 "xml": {
23605 "name": "InitialEmployerLiabilityModel",
23606 "wrapped": true
23607 },
23608 "title": "List<InitialEmployerLiabilityModel>"
23609 },
23610 "etpTypeR": {
23611 "$ref": "#/definitions/OpeningBalancesEtpModel"
23612 },
23613 "etpTypeO": {
23614 "$ref": "#/definitions/OpeningBalancesEtpModel"
23615 },
23616 "financialYearStartingYear": {
23617 "format": "int32",
23618 "type": "integer",
23619 "title": "Nullable<Int32>"
23620 },
23621 "locationName": {
23622 "type": "string",
23623 "title": "String"
23624 }
23625 },
23626 "xml": {
23627 "name": "OpeningBalancesEditModel"
23628 },
23629 "title": "OpeningBalancesEditModel"
23630 },
23631 "InitialLeaveBalanceModel": {
23632 "type": "object",
23633 "properties": {
23634 "leaveCategoryId": {
23635 "format": "int32",
23636 "type": "integer",
23637 "title": "Int32"
23638 },
23639 "name": {
23640 "type": "string",
23641 "title": "String"
23642 },
23643 "amount": {
23644 "format": "double",
23645 "type": "number",
23646 "title": "Decimal"
23647 }
23648 },
23649 "xml": {
23650 "name": "InitialLeaveBalanceModel"
23651 },
23652 "title": "InitialLeaveBalanceModel"
23653 },
23654 "InitialEarningsModel": {
23655 "type": "object",
23656 "properties": {
23657 "payCategoryId": {
23658 "format": "int32",
23659 "type": "integer",
23660 "title": "Int32"
23661 },
23662 "isStandardPayCategory": {
23663 "type": "boolean",
23664 "title": "Boolean"
23665 },
23666 "payCategoryType": {
23667 "enum": [
23668 "Standard",
23669 "LeaveLoading",
23670 "GenuineRedundancyLeavePayment",
23671 "OpeningBalanceAllowances",
23672 "EtpTypeRTaxable",
23673 "EtpTypeRTaxFree",
23674 "EtpTypeOTaxable",
23675 "EtpTypeOTaxFree",
23676 "EtpLumpSumD"
23677 ],
23678 "type": "string",
23679 "title": "PayCategoryType"
23680 },
23681 "name": {
23682 "type": "string",
23683 "title": "String"
23684 },
23685 "amount": {
23686 "format": "double",
23687 "type": "number",
23688 "title": "Decimal"
23689 }
23690 },
23691 "xml": {
23692 "name": "InitialEarningsModel"
23693 },
23694 "title": "InitialEarningsModel"
23695 },
23696 "InitialDeductionModel": {
23697 "type": "object",
23698 "properties": {
23699 "deductionCategoryId": {
23700 "format": "int32",
23701 "type": "integer",
23702 "title": "Int32"
23703 },
23704 "name": {
23705 "type": "string",
23706 "title": "String"
23707 },
23708 "amount": {
23709 "format": "double",
23710 "type": "number",
23711 "title": "Decimal"
23712 },
23713 "isRESC": {
23714 "type": "boolean",
23715 "title": "Boolean"
23716 },
23717 "taxExempt": {
23718 "type": "boolean",
23719 "title": "Boolean"
23720 },
23721 "isMemberVoluntary": {
23722 "type": "boolean",
23723 "title": "Boolean"
23724 }
23725 },
23726 "xml": {
23727 "name": "InitialDeductionModel"
23728 },
23729 "title": "InitialDeductionModel"
23730 },
23731 "InitialEmployerLiabilityModel": {
23732 "type": "object",
23733 "properties": {
23734 "employerLiabilityCategoryId": {
23735 "format": "int32",
23736 "type": "integer",
23737 "title": "Int32"
23738 },
23739 "name": {
23740 "type": "string",
23741 "title": "String"
23742 },
23743 "amount": {
23744 "format": "double",
23745 "type": "number",
23746 "title": "Decimal"
23747 }
23748 },
23749 "xml": {
23750 "name": "InitialEmployerLiabilityModel"
23751 },
23752 "title": "InitialEmployerLiabilityModel"
23753 },
23754 "OpeningBalancesEtpModel": {
23755 "type": "object",
23756 "properties": {
23757 "taxFreeComponent": {
23758 "format": "double",
23759 "type": "number",
23760 "title": "Nullable<Decimal>"
23761 },
23762 "taxableComponent": {
23763 "format": "double",
23764 "type": "number",
23765 "title": "Nullable<Decimal>"
23766 },
23767 "taxWithheld": {
23768 "format": "double",
23769 "type": "number",
23770 "title": "Nullable<Decimal>"
23771 },
23772 "lumpSumD": {
23773 "format": "double",
23774 "type": "number",
23775 "title": "Nullable<Decimal>"
23776 },
23777 "isAmended": {
23778 "type": "boolean",
23779 "title": "Boolean"
23780 },
23781 "paymentDate": {
23782 "format": "date-time",
23783 "type": "string",
23784 "title": "Nullable<DateTime>"
23785 },
23786 "generatePaymentSummary": {
23787 "type": "boolean",
23788 "title": "Boolean"
23789 }
23790 },
23791 "xml": {
23792 "name": "OpeningBalancesEtpModel"
23793 },
23794 "title": "OpeningBalancesEtpModel"
23795 },
23796 "EmployeeAccessModel": {
23797 "type": "object",
23798 "properties": {
23799 "name": {
23800 "type": "string",
23801 "title": "String"
23802 },
23803 "email": {
23804 "type": "string",
23805 "title": "String"
23806 }
23807 },
23808 "xml": {
23809 "name": "EmployeeAccessModel"
23810 },
23811 "title": "EmployeeAccessModel"
23812 },
23813 "CreateEmployeeAccessModel": {
23814 "type": "object",
23815 "properties": {
23816 "suppressNotificationEmails": {
23817 "type": "boolean",
23818 "title": "Boolean"
23819 },
23820 "name": {
23821 "type": "string",
23822 "title": "String"
23823 },
23824 "email": {
23825 "type": "string",
23826 "title": "String"
23827 }
23828 },
23829 "xml": {
23830 "name": "CreateEmployeeAccessModel"
23831 },
23832 "title": "CreateEmployeeAccessModel"
23833 },
23834 "BankAccountModel": {
23835 "type": "object",
23836 "properties": {
23837 "id": {
23838 "format": "int32",
23839 "type": "integer",
23840 "title": "Int32"
23841 },
23842 "employeeId": {
23843 "format": "int32",
23844 "type": "integer",
23845 "title": "Int32"
23846 },
23847 "bsb": {
23848 "type": "string",
23849 "title": "String"
23850 },
23851 "accountName": {
23852 "type": "string",
23853 "title": "String"
23854 },
23855 "accountNumber": {
23856 "type": "string",
23857 "title": "String"
23858 },
23859 "allocatedPercentage": {
23860 "format": "double",
23861 "type": "number",
23862 "title": "Nullable<Decimal>"
23863 },
23864 "fixedAmount": {
23865 "format": "double",
23866 "type": "number",
23867 "title": "Nullable<Decimal>"
23868 },
23869 "allocateBalance": {
23870 "type": "boolean",
23871 "title": "Boolean"
23872 },
23873 "isEmployeeEditable": {
23874 "type": "boolean",
23875 "title": "Boolean"
23876 },
23877 "canBeDeleted": {
23878 "type": "boolean",
23879 "title": "Boolean"
23880 },
23881 "accountType": {
23882 "enum": [
23883 "Electronic",
23884 "ManualDeposit",
23885 "CashOrCheque",
23886 "Bpay"
23887 ],
23888 "type": "string",
23889 "title": "BankAccountTypeEnum"
23890 },
23891 "externalReferenceId": {
23892 "type": "string",
23893 "title": "String"
23894 }
23895 },
23896 "xml": {
23897 "name": "BankAccountModel"
23898 },
23899 "title": "BankAccountModel"
23900 },
23901 "SaveBankAccountResponseModel": {
23902 "type": "object",
23903 "properties": {
23904 "validationWarning": {
23905 "type": "string",
23906 "title": "String"
23907 },
23908 "result": {
23909 "$ref": "#/definitions/BankAccountModel"
23910 }
23911 },
23912 "xml": {
23913 "name": "SaveBankAccountResponseModel"
23914 },
23915 "title": "SaveBankAccountResponseModel"
23916 },
23917 "EmployeeDocumentModel": {
23918 "type": "object",
23919 "properties": {
23920 "id": {
23921 "format": "int32",
23922 "type": "integer",
23923 "title": "Int32"
23924 },
23925 "friendlyName": {
23926 "type": "string",
23927 "title": "String"
23928 },
23929 "dateCreated": {
23930 "format": "date-time",
23931 "type": "string",
23932 "title": "DateTime"
23933 },
23934 "visible": {
23935 "type": "boolean",
23936 "title": "Boolean"
23937 },
23938 "leaveRequestId": {
23939 "format": "int32",
23940 "type": "integer",
23941 "title": "Nullable<Int32>"
23942 },
23943 "timesheetLineId": {
23944 "format": "int32",
23945 "type": "integer",
23946 "title": "Nullable<Int32>"
23947 }
23948 },
23949 "xml": {
23950 "name": "EmployeeDocumentModel"
23951 },
23952 "title": "EmployeeDocumentModel"
23953 },
23954 "UpdateEmployeeDocumentPermissionsModel": {
23955 "type": "object",
23956 "properties": {
23957 "id": {
23958 "format": "int32",
23959 "type": "integer",
23960 "title": "Int32"
23961 },
23962 "visible": {
23963 "type": "boolean",
23964 "title": "Boolean"
23965 }
23966 },
23967 "xml": {
23968 "name": "UpdateEmployeeDocumentPermissionsModel"
23969 },
23970 "title": "UpdateEmployeeDocumentPermissionsModel"
23971 },
23972 "ODataQueryOptions[EmployeeExpenseCategory]": {
23973 "type": "object",
23974 "properties": {
23975 "ifMatch": {
23976 "type": "object",
23977 "readOnly": true,
23978 "title": "ETag<EmployeeExpenseCategory>"
23979 },
23980 "ifNoneMatch": {
23981 "type": "object",
23982 "readOnly": true,
23983 "title": "ETag<EmployeeExpenseCategory>"
23984 },
23985 "context": {
23986 "$ref": "#/definitions/ODataQueryContext",
23987 "readOnly": true
23988 },
23989 "request": {
23990 "type": "object",
23991 "readOnly": true,
23992 "title": "HttpRequestMessage"
23993 },
23994 "rawValues": {
23995 "$ref": "#/definitions/ODataRawQueryOptions",
23996 "readOnly": true
23997 },
23998 "selectExpand": {
23999 "$ref": "#/definitions/SelectExpandQueryOption",
24000 "readOnly": true
24001 },
24002 "filter": {
24003 "$ref": "#/definitions/FilterQueryOption",
24004 "readOnly": true
24005 },
24006 "orderBy": {
24007 "$ref": "#/definitions/OrderByQueryOption",
24008 "readOnly": true
24009 },
24010 "skip": {
24011 "$ref": "#/definitions/SkipQueryOption",
24012 "readOnly": true
24013 },
24014 "top": {
24015 "$ref": "#/definitions/TopQueryOption",
24016 "readOnly": true
24017 },
24018 "inlineCount": {
24019 "$ref": "#/definitions/InlineCountQueryOption",
24020 "readOnly": true
24021 },
24022 "validator": {
24023 "$ref": "#/definitions/ODataQueryValidator"
24024 }
24025 },
24026 "xml": {
24027 "name": "ODataQueryOptions`1"
24028 },
24029 "title": "ODataQueryOptions<EmployeeExpenseCategory>"
24030 },
24031 "EmployeeExpenseCategoryModel": {
24032 "type": "object",
24033 "properties": {
24034 "id": {
24035 "format": "int32",
24036 "type": "integer",
24037 "title": "Int32"
24038 },
24039 "name": {
24040 "type": "string",
24041 "title": "String"
24042 },
24043 "externalId": {
24044 "type": "string",
24045 "title": "String"
24046 },
24047 "generalLedgerMappingCode": {
24048 "type": "string",
24049 "title": "String"
24050 },
24051 "description": {
24052 "type": "string",
24053 "title": "String"
24054 },
24055 "externalReferenceId": {
24056 "type": "string",
24057 "title": "String"
24058 },
24059 "externalTaxCodeId": {
24060 "type": "string",
24061 "title": "String"
24062 },
24063 "taxCode": {
24064 "type": "string",
24065 "title": "String"
24066 },
24067 "taxRate": {
24068 "format": "double",
24069 "type": "number",
24070 "title": "Nullable<Decimal>"
24071 }
24072 },
24073 "xml": {
24074 "name": "EmployeeExpenseCategoryModel"
24075 },
24076 "title": "EmployeeExpenseCategoryModel"
24077 },
24078 "JournalServiceTaxCode": {
24079 "type": "object",
24080 "properties": {
24081 "id": {
24082 "type": "string",
24083 "title": "String"
24084 },
24085 "name": {
24086 "type": "string",
24087 "title": "String"
24088 },
24089 "taxRate": {
24090 "format": "double",
24091 "type": "number",
24092 "title": "Decimal"
24093 }
24094 },
24095 "xml": {
24096 "name": "JournalServiceTaxCode"
24097 },
24098 "title": "JournalServiceTaxCode"
24099 },
24100 "ODataQueryOptions[EmployeeExpenseRequest]": {
24101 "type": "object",
24102 "properties": {
24103 "ifMatch": {
24104 "type": "object",
24105 "readOnly": true,
24106 "title": "ETag<EmployeeExpenseRequest>"
24107 },
24108 "ifNoneMatch": {
24109 "type": "object",
24110 "readOnly": true,
24111 "title": "ETag<EmployeeExpenseRequest>"
24112 },
24113 "context": {
24114 "$ref": "#/definitions/ODataQueryContext",
24115 "readOnly": true
24116 },
24117 "request": {
24118 "type": "object",
24119 "readOnly": true,
24120 "title": "HttpRequestMessage"
24121 },
24122 "rawValues": {
24123 "$ref": "#/definitions/ODataRawQueryOptions",
24124 "readOnly": true
24125 },
24126 "selectExpand": {
24127 "$ref": "#/definitions/SelectExpandQueryOption",
24128 "readOnly": true
24129 },
24130 "filter": {
24131 "$ref": "#/definitions/FilterQueryOption",
24132 "readOnly": true
24133 },
24134 "orderBy": {
24135 "$ref": "#/definitions/OrderByQueryOption",
24136 "readOnly": true
24137 },
24138 "skip": {
24139 "$ref": "#/definitions/SkipQueryOption",
24140 "readOnly": true
24141 },
24142 "top": {
24143 "$ref": "#/definitions/TopQueryOption",
24144 "readOnly": true
24145 },
24146 "inlineCount": {
24147 "$ref": "#/definitions/InlineCountQueryOption",
24148 "readOnly": true
24149 },
24150 "validator": {
24151 "$ref": "#/definitions/ODataQueryValidator"
24152 }
24153 },
24154 "xml": {
24155 "name": "ODataQueryOptions`1"
24156 },
24157 "title": "ODataQueryOptions<EmployeeExpenseRequest>"
24158 },
24159 "ExpenseRequestResponseModel": {
24160 "type": "object",
24161 "properties": {
24162 "id": {
24163 "format": "int32",
24164 "type": "integer",
24165 "title": "Int32"
24166 },
24167 "employeeId": {
24168 "format": "int32",
24169 "type": "integer",
24170 "title": "Int32"
24171 },
24172 "employeeName": {
24173 "type": "string",
24174 "title": "String"
24175 },
24176 "status": {
24177 "type": "string",
24178 "title": "String"
24179 },
24180 "description": {
24181 "type": "string",
24182 "title": "String"
24183 },
24184 "lineItems": {
24185 "type": "array",
24186 "items": {
24187 "$ref": "#/definitions/ExpenseRequestLineItemModel"
24188 },
24189 "xml": {
24190 "name": "ExpenseRequestLineItemModel",
24191 "wrapped": true
24192 },
24193 "title": "List<ExpenseRequestLineItemModel>"
24194 },
24195 "attachments": {
24196 "type": "array",
24197 "items": {
24198 "$ref": "#/definitions/AttachmentModel"
24199 },
24200 "xml": {
24201 "name": "AttachmentModel",
24202 "wrapped": true
24203 },
24204 "title": "List<AttachmentModel>"
24205 },
24206 "statusUpdatedByUser": {
24207 "type": "string",
24208 "title": "String"
24209 },
24210 "statusUpdateNotes": {
24211 "type": "string",
24212 "title": "String"
24213 },
24214 "dateStatusUpdated": {
24215 "format": "date-time",
24216 "type": "string",
24217 "title": "DateTime"
24218 }
24219 },
24220 "xml": {
24221 "name": "ExpenseRequestResponseModel"
24222 },
24223 "title": "ExpenseRequestResponseModel"
24224 },
24225 "ExpenseRequestLineItemModel": {
24226 "type": "object",
24227 "properties": {
24228 "expenseCategoryName": {
24229 "type": "string",
24230 "title": "String"
24231 },
24232 "locationName": {
24233 "type": "string",
24234 "title": "String"
24235 },
24236 "id": {
24237 "format": "int32",
24238 "type": "integer",
24239 "title": "Nullable<Int32>"
24240 },
24241 "expenseCategoryId": {
24242 "format": "int32",
24243 "type": "integer",
24244 "title": "Int32"
24245 },
24246 "locationId": {
24247 "format": "int32",
24248 "type": "integer",
24249 "title": "Nullable<Int32>"
24250 },
24251 "notes": {
24252 "type": "string",
24253 "title": "String"
24254 },
24255 "taxCode": {
24256 "type": "string",
24257 "title": "String"
24258 },
24259 "taxCodeDisplayName": {
24260 "type": "string",
24261 "title": "String"
24262 },
24263 "taxRate": {
24264 "format": "double",
24265 "type": "number",
24266 "title": "Nullable<Decimal>"
24267 },
24268 "amount": {
24269 "format": "double",
24270 "type": "number",
24271 "title": "Decimal"
24272 },
24273 "dateIncurred": {
24274 "format": "date-time",
24275 "type": "string",
24276 "title": "DateTime"
24277 }
24278 },
24279 "xml": {
24280 "name": "ExpenseRequestLineItemModel"
24281 },
24282 "title": "ExpenseRequestLineItemModel"
24283 },
24284 "AttachmentModel": {
24285 "type": "object",
24286 "properties": {
24287 "id": {
24288 "format": "int32",
24289 "type": "integer",
24290 "title": "Nullable<Int32>"
24291 },
24292 "friendlyName": {
24293 "type": "string",
24294 "title": "String"
24295 },
24296 "dateCreated": {
24297 "format": "date-time",
24298 "type": "string",
24299 "title": "Nullable<DateTime>"
24300 },
24301 "url": {
24302 "type": "string",
24303 "title": "String"
24304 }
24305 },
24306 "xml": {
24307 "name": "AttachmentModel"
24308 },
24309 "title": "AttachmentModel"
24310 },
24311 "ExpenseRequestEditModel": {
24312 "required": [
24313 "employeeId"
24314 ],
24315 "type": "object",
24316 "properties": {
24317 "attachments": {
24318 "type": "array",
24319 "items": {
24320 "$ref": "#/definitions/AttachmentModel"
24321 },
24322 "xml": {
24323 "name": "AttachmentModel",
24324 "wrapped": true
24325 },
24326 "title": "List<AttachmentModel>"
24327 },
24328 "id": {
24329 "format": "int32",
24330 "type": "integer",
24331 "title": "Int32"
24332 },
24333 "employeeId": {
24334 "format": "int32",
24335 "type": "integer",
24336 "title": "Int32"
24337 },
24338 "description": {
24339 "maxLength": 255,
24340 "type": "string",
24341 "title": "String"
24342 },
24343 "lineItems": {
24344 "type": "array",
24345 "items": {
24346 "$ref": "#/definitions/ExpenseRequestEditLineItemModel"
24347 },
24348 "xml": {
24349 "name": "ExpenseRequestEditLineItemModel",
24350 "wrapped": true
24351 },
24352 "title": "List<ExpenseRequestEditLineItemModel>"
24353 }
24354 },
24355 "xml": {
24356 "name": "ExpenseRequestEditModel"
24357 },
24358 "title": "ExpenseRequestEditModel"
24359 },
24360 "ExpenseRequestEditLineItemModel": {
24361 "type": "object",
24362 "properties": {
24363 "id": {
24364 "format": "int32",
24365 "type": "integer",
24366 "title": "Nullable<Int32>"
24367 },
24368 "expenseCategoryId": {
24369 "format": "int32",
24370 "type": "integer",
24371 "title": "Int32"
24372 },
24373 "locationId": {
24374 "format": "int32",
24375 "type": "integer",
24376 "title": "Nullable<Int32>"
24377 },
24378 "notes": {
24379 "type": "string",
24380 "title": "String"
24381 },
24382 "taxCode": {
24383 "type": "string",
24384 "title": "String"
24385 },
24386 "taxCodeDisplayName": {
24387 "type": "string",
24388 "title": "String"
24389 },
24390 "taxRate": {
24391 "format": "double",
24392 "type": "number",
24393 "title": "Nullable<Decimal>"
24394 },
24395 "amount": {
24396 "format": "double",
24397 "type": "number",
24398 "title": "Decimal"
24399 },
24400 "dateIncurred": {
24401 "format": "date-time",
24402 "type": "string",
24403 "title": "DateTime"
24404 }
24405 },
24406 "xml": {
24407 "name": "ExpenseRequestEditLineItemModel"
24408 },
24409 "title": "ExpenseRequestEditLineItemModel"
24410 },
24411 "EmployeeGroupModel": {
24412 "type": "object",
24413 "properties": {
24414 "id": {
24415 "format": "int32",
24416 "type": "integer",
24417 "title": "Int32"
24418 },
24419 "name": {
24420 "type": "string",
24421 "title": "String"
24422 },
24423 "filterCombinationStrategy": {
24424 "enum": [
24425 "Or",
24426 "And"
24427 ],
24428 "type": "string",
24429 "title": "FilterCombinationStrategyEnum"
24430 },
24431 "filters": {
24432 "type": "array",
24433 "items": {
24434 "$ref": "#/definitions/EmployeeFilterModel"
24435 },
24436 "xml": {
24437 "name": "EmployeeFilterModel",
24438 "wrapped": true
24439 },
24440 "title": "IList<EmployeeFilterModel>"
24441 }
24442 },
24443 "xml": {
24444 "name": "EmployeeGroupModel"
24445 },
24446 "title": "EmployeeGroupModel"
24447 },
24448 "EmployeeFilterModel": {
24449 "type": "object",
24450 "properties": {
24451 "filterType": {
24452 "enum": [
24453 "Location",
24454 "LocationOrParents",
24455 "Employee",
24456 "PaySchedule",
24457 "EmploymentType",
24458 "EmployingEntity",
24459 "Tag"
24460 ],
24461 "type": "string",
24462 "title": "FilterTypeEnum"
24463 },
24464 "operator": {
24465 "enum": [
24466 "In",
24467 "NotIn"
24468 ],
24469 "type": "string",
24470 "title": "FilterOperatorEnum"
24471 },
24472 "value": {
24473 "type": "string",
24474 "title": "String"
24475 }
24476 },
24477 "xml": {
24478 "name": "EmployeeFilterModel"
24479 },
24480 "title": "EmployeeFilterModel"
24481 },
24482 "DetailedEmployeeGroupModel": {
24483 "type": "object",
24484 "properties": {
24485 "matchingEmployees": {
24486 "type": "array",
24487 "items": {
24488 "$ref": "#/definitions/MatchingEmployeeModel"
24489 },
24490 "xml": {
24491 "name": "MatchingEmployeeModel",
24492 "wrapped": true
24493 },
24494 "title": "IList<MatchingEmployeeModel>"
24495 },
24496 "id": {
24497 "format": "int32",
24498 "type": "integer",
24499 "title": "Int32"
24500 },
24501 "name": {
24502 "type": "string",
24503 "title": "String"
24504 },
24505 "filterCombinationStrategy": {
24506 "enum": [
24507 "Or",
24508 "And"
24509 ],
24510 "type": "string",
24511 "title": "FilterCombinationStrategyEnum"
24512 },
24513 "filters": {
24514 "type": "array",
24515 "items": {
24516 "$ref": "#/definitions/EmployeeFilterModel"
24517 },
24518 "xml": {
24519 "name": "EmployeeFilterModel",
24520 "wrapped": true
24521 },
24522 "title": "IList<EmployeeFilterModel>"
24523 }
24524 },
24525 "xml": {
24526 "name": "DetailedEmployeeGroupModel"
24527 },
24528 "title": "DetailedEmployeeGroupModel"
24529 },
24530 "MatchingEmployeeModel": {
24531 "type": "object",
24532 "properties": {
24533 "id": {
24534 "format": "int32",
24535 "type": "integer",
24536 "title": "Int32"
24537 },
24538 "externalId": {
24539 "type": "string",
24540 "title": "String"
24541 },
24542 "name": {
24543 "type": "string",
24544 "title": "String"
24545 }
24546 },
24547 "xml": {
24548 "name": "MatchingEmployeeModel"
24549 },
24550 "title": "MatchingEmployeeModel"
24551 },
24552 "EmployeeQualificationDocumentModel": {
24553 "type": "object",
24554 "properties": {
24555 "id": {
24556 "format": "int32",
24557 "type": "integer",
24558 "title": "Int32"
24559 },
24560 "name": {
24561 "type": "string",
24562 "title": "String"
24563 },
24564 "dateCreated": {
24565 "format": "date-time",
24566 "type": "string",
24567 "title": "DateTime"
24568 },
24569 "visible": {
24570 "type": "boolean",
24571 "title": "Boolean"
24572 }
24573 },
24574 "xml": {
24575 "name": "EmployeeQualificationDocumentModel"
24576 },
24577 "title": "EmployeeQualificationDocumentModel"
24578 },
24579 "EmployeeQualificationModel": {
24580 "type": "object",
24581 "properties": {
24582 "qualificationId": {
24583 "format": "int32",
24584 "type": "integer",
24585 "title": "Int32"
24586 },
24587 "name": {
24588 "type": "string",
24589 "title": "String"
24590 },
24591 "expiryDate": {
24592 "format": "date-time",
24593 "type": "string",
24594 "title": "Nullable<DateTime>"
24595 },
24596 "documents": {
24597 "type": "array",
24598 "items": {
24599 "$ref": "#/definitions/EmployeeQualificationDocumentModel"
24600 },
24601 "xml": {
24602 "name": "EmployeeQualificationDocumentModel",
24603 "wrapped": true
24604 },
24605 "title": "IList<EmployeeQualificationDocumentModel>"
24606 },
24607 "referenceNumber": {
24608 "type": "string",
24609 "title": "String"
24610 }
24611 },
24612 "xml": {
24613 "name": "EmployeeQualificationModel"
24614 },
24615 "title": "EmployeeQualificationModel"
24616 },
24617 "EmployeeRecurringTaxAdjustmentModel": {
24618 "type": "object",
24619 "properties": {
24620 "adjustmentType": {
24621 "enum": [
24622 "Fixed",
24623 "PercentageGross",
24624 "PercentageTaxableEarnings"
24625 ],
24626 "type": "string",
24627 "title": "TaxAdjustmentTypeEnum"
24628 },
24629 "id": {
24630 "format": "int32",
24631 "type": "integer",
24632 "title": "Nullable<Int32>"
24633 },
24634 "employeeId": {
24635 "format": "int32",
24636 "type": "integer",
24637 "title": "Int32"
24638 },
24639 "amount": {
24640 "format": "double",
24641 "type": "number",
24642 "title": "Decimal"
24643 },
24644 "expiryDate": {
24645 "format": "date-time",
24646 "type": "string",
24647 "title": "Nullable<DateTime>"
24648 },
24649 "fromDate": {
24650 "format": "date-time",
24651 "type": "string",
24652 "title": "DateTime"
24653 },
24654 "maximumAmountPaid": {
24655 "format": "double",
24656 "type": "number",
24657 "title": "Nullable<Decimal>"
24658 },
24659 "totalAmountPaid": {
24660 "format": "double",
24661 "type": "number",
24662 "title": "Decimal"
24663 },
24664 "isActive": {
24665 "type": "boolean",
24666 "title": "Boolean"
24667 },
24668 "notes": {
24669 "type": "string",
24670 "title": "String"
24671 }
24672 },
24673 "xml": {
24674 "name": "EmployeeRecurringTaxAdjustmentModel"
24675 },
24676 "title": "EmployeeRecurringTaxAdjustmentModel"
24677 },
24678 "EmployeeRecurringSuperAdjustmentModel": {
24679 "type": "object",
24680 "properties": {
24681 "contributionType": {
24682 "enum": [
24683 "SuperGuarantee",
24684 "SalarySacrifice",
24685 "MemberVoluntary",
24686 "EmployerContribution"
24687 ],
24688 "type": "string",
24689 "title": "SuperContributionType"
24690 },
24691 "adjustmentType": {
24692 "enum": [
24693 "Fixed",
24694 "PercentageGross",
24695 "PercentageOTE",
24696 "PercentageTaxableEarnings"
24697 ],
24698 "type": "string",
24699 "title": "SuperAdjustmentTypeEnum"
24700 },
24701 "id": {
24702 "format": "int32",
24703 "type": "integer",
24704 "title": "Nullable<Int32>"
24705 },
24706 "employeeId": {
24707 "format": "int32",
24708 "type": "integer",
24709 "title": "Int32"
24710 },
24711 "amount": {
24712 "format": "double",
24713 "type": "number",
24714 "title": "Decimal"
24715 },
24716 "expiryDate": {
24717 "format": "date-time",
24718 "type": "string",
24719 "title": "Nullable<DateTime>"
24720 },
24721 "fromDate": {
24722 "format": "date-time",
24723 "type": "string",
24724 "title": "DateTime"
24725 },
24726 "maximumAmountPaid": {
24727 "format": "double",
24728 "type": "number",
24729 "title": "Nullable<Decimal>"
24730 },
24731 "totalAmountPaid": {
24732 "format": "double",
24733 "type": "number",
24734 "title": "Decimal"
24735 },
24736 "isActive": {
24737 "type": "boolean",
24738 "title": "Boolean"
24739 },
24740 "notes": {
24741 "type": "string",
24742 "title": "String"
24743 }
24744 },
24745 "xml": {
24746 "name": "EmployeeRecurringSuperAdjustmentModel"
24747 },
24748 "title": "EmployeeRecurringSuperAdjustmentModel"
24749 },
24750 "EmployerRecurringLiabilityModel": {
24751 "type": "object",
24752 "properties": {
24753 "employerLiabilityCategoryName": {
24754 "type": "string",
24755 "title": "String"
24756 },
24757 "employerLiabilityCategoryId": {
24758 "format": "int32",
24759 "type": "integer",
24760 "title": "Int32"
24761 },
24762 "liabilityType": {
24763 "enum": [
24764 "Fixed",
24765 "PercentageGross",
24766 "PercentageOTE"
24767 ],
24768 "type": "string",
24769 "title": "EmployerRecurringLiabilityTypeEnum"
24770 },
24771 "externalReferenceId": {
24772 "type": "string",
24773 "title": "String"
24774 },
24775 "source": {
24776 "enum": [
24777 "None",
24778 "Saasu",
24779 "Xero",
24780 "MYOB",
24781 "Deputy",
24782 "EmployeeTimePunch",
24783 "ClickSuper",
24784 "IntegratedTimesheets",
24785 "FileImport",
24786 "FileExport",
24787 "QuickBooks",
24788 "Harmony",
24789 "AwardStore",
24790 "Attache",
24791 "IntegratedRostering",
24792 "ReckonAccounts",
24793 "API",
24794 "MicroPower",
24795 "RosterLive",
24796 "NetSuite",
24797 "Kounta",
24798 "TimeAndAttendanceKiosk",
24799 "DetailedFileExport",
24800 "JonasPremier",
24801 "WageEasy",
24802 "Maestrano",
24803 "WorkZone",
24804 "EmployeePortal",
24805 "RosterTemplate",
24806 "Onboarding",
24807 "Admin",
24808 "WorkZoneClockOnOff"
24809 ],
24810 "type": "string",
24811 "title": "ExternalService"
24812 },
24813 "id": {
24814 "format": "int32",
24815 "type": "integer",
24816 "title": "Nullable<Int32>"
24817 },
24818 "employeeId": {
24819 "format": "int32",
24820 "type": "integer",
24821 "title": "Int32"
24822 },
24823 "amount": {
24824 "format": "double",
24825 "type": "number",
24826 "title": "Decimal"
24827 },
24828 "expiryDate": {
24829 "format": "date-time",
24830 "type": "string",
24831 "title": "Nullable<DateTime>"
24832 },
24833 "fromDate": {
24834 "format": "date-time",
24835 "type": "string",
24836 "title": "DateTime"
24837 },
24838 "maximumAmountPaid": {
24839 "format": "double",
24840 "type": "number",
24841 "title": "Nullable<Decimal>"
24842 },
24843 "totalAmountPaid": {
24844 "format": "double",
24845 "type": "number",
24846 "title": "Decimal"
24847 },
24848 "isActive": {
24849 "type": "boolean",
24850 "title": "Boolean"
24851 },
24852 "notes": {
24853 "type": "string",
24854 "title": "String"
24855 }
24856 },
24857 "xml": {
24858 "name": "EmployerRecurringLiabilityModel"
24859 },
24860 "title": "EmployerRecurringLiabilityModel"
24861 },
24862 "EmployeeRecurringDeductionModel": {
24863 "type": "object",
24864 "properties": {
24865 "name": {
24866 "type": "string",
24867 "title": "String"
24868 },
24869 "deductionCategoryId": {
24870 "format": "int32",
24871 "type": "integer",
24872 "title": "Int32"
24873 },
24874 "paidTo": {
24875 "enum": [
24876 "Manual",
24877 "BankAccount",
24878 "SuperFund",
24879 "Bpay"
24880 ],
24881 "type": "string",
24882 "title": "EmployeeRecurringDeductionPaidToEnum"
24883 },
24884 "paidToAccountId": {
24885 "format": "int32",
24886 "type": "integer",
24887 "title": "Int32"
24888 },
24889 "externalReferenceId": {
24890 "type": "string",
24891 "title": "String"
24892 },
24893 "preservedEarningsAmountNotReachedAction": {
24894 "enum": [
24895 "DoNotPay",
24896 "PayToLimit"
24897 ],
24898 "type": "string",
24899 "title": "DeductionAmountNotReachedEnum"
24900 },
24901 "carryForwardUnpaidDeductions": {
24902 "type": "boolean",
24903 "title": "Boolean"
24904 },
24905 "carryForwardAmount": {
24906 "format": "double",
24907 "type": "number",
24908 "title": "Decimal"
24909 },
24910 "paymentReference": {
24911 "type": "string",
24912 "title": "String"
24913 },
24914 "deductionType": {
24915 "enum": [
24916 "NotSet",
24917 "Fixed",
24918 "PercentageGross",
24919 "PercentageOTE"
24920 ],
24921 "type": "string",
24922 "title": "DeductionTypeEnum"
24923 },
24924 "preservedEarnings": {
24925 "type": "boolean",
24926 "title": "Boolean"
24927 },
24928 "preservedEarningsAmount": {
24929 "format": "double",
24930 "type": "number",
24931 "title": "Decimal"
24932 },
24933 "id": {
24934 "format": "int32",
24935 "type": "integer",
24936 "title": "Nullable<Int32>"
24937 },
24938 "employeeId": {
24939 "format": "int32",
24940 "type": "integer",
24941 "title": "Int32"
24942 },
24943 "amount": {
24944 "format": "double",
24945 "type": "number",
24946 "title": "Decimal"
24947 },
24948 "expiryDate": {
24949 "format": "date-time",
24950 "type": "string",
24951 "title": "Nullable<DateTime>"
24952 },
24953 "fromDate": {
24954 "format": "date-time",
24955 "type": "string",
24956 "title": "DateTime"
24957 },
24958 "maximumAmountPaid": {
24959 "format": "double",
24960 "type": "number",
24961 "title": "Nullable<Decimal>"
24962 },
24963 "totalAmountPaid": {
24964 "format": "double",
24965 "type": "number",
24966 "title": "Decimal"
24967 },
24968 "isActive": {
24969 "type": "boolean",
24970 "title": "Boolean"
24971 },
24972 "notes": {
24973 "type": "string",
24974 "title": "String"
24975 }
24976 },
24977 "xml": {
24978 "name": "EmployeeRecurringDeductionModel"
24979 },
24980 "title": "EmployeeRecurringDeductionModel"
24981 },
24982 "EmployeeRecurringExpenseModel": {
24983 "type": "object",
24984 "properties": {
24985 "name": {
24986 "type": "string",
24987 "title": "String"
24988 },
24989 "expenseCategoryId": {
24990 "format": "int32",
24991 "type": "integer",
24992 "title": "Int32"
24993 },
24994 "locationId": {
24995 "format": "int32",
24996 "type": "integer",
24997 "title": "Int32"
24998 },
24999 "taxCode": {
25000 "type": "string",
25001 "title": "String"
25002 },
25003 "taxCodeDisplayName": {
25004 "type": "string",
25005 "title": "String"
25006 },
25007 "taxRate": {
25008 "format": "double",
25009 "type": "number",
25010 "title": "Nullable<Decimal>"
25011 },
25012 "id": {
25013 "format": "int32",
25014 "type": "integer",
25015 "title": "Nullable<Int32>"
25016 },
25017 "employeeId": {
25018 "format": "int32",
25019 "type": "integer",
25020 "title": "Int32"
25021 },
25022 "amount": {
25023 "format": "double",
25024 "type": "number",
25025 "title": "Decimal"
25026 },
25027 "expiryDate": {
25028 "format": "date-time",
25029 "type": "string",
25030 "title": "Nullable<DateTime>"
25031 },
25032 "fromDate": {
25033 "format": "date-time",
25034 "type": "string",
25035 "title": "DateTime"
25036 },
25037 "maximumAmountPaid": {
25038 "format": "double",
25039 "type": "number",
25040 "title": "Nullable<Decimal>"
25041 },
25042 "totalAmountPaid": {
25043 "format": "double",
25044 "type": "number",
25045 "title": "Decimal"
25046 },
25047 "isActive": {
25048 "type": "boolean",
25049 "title": "Boolean"
25050 },
25051 "notes": {
25052 "type": "string",
25053 "title": "String"
25054 }
25055 },
25056 "xml": {
25057 "name": "EmployeeRecurringExpenseModel"
25058 },
25059 "title": "EmployeeRecurringExpenseModel"
25060 },
25061 "SuperFundModel": {
25062 "type": "object",
25063 "properties": {
25064 "id": {
25065 "format": "int32",
25066 "type": "integer",
25067 "title": "Int32"
25068 },
25069 "employeeId": {
25070 "format": "int32",
25071 "type": "integer",
25072 "title": "Int32"
25073 },
25074 "name": {
25075 "type": "string",
25076 "title": "String"
25077 },
25078 "memberNumber": {
25079 "type": "string",
25080 "title": "String"
25081 },
25082 "allocatedPercentage": {
25083 "format": "double",
25084 "type": "number",
25085 "title": "Nullable<Decimal>"
25086 },
25087 "fixedAmount": {
25088 "format": "double",
25089 "type": "number",
25090 "title": "Nullable<Decimal>"
25091 },
25092 "superProduct": {
25093 "$ref": "#/definitions/SuperProductModel"
25094 },
25095 "allocateBalance": {
25096 "type": "boolean",
25097 "title": "Boolean"
25098 },
25099 "canBeDeleted": {
25100 "type": "boolean",
25101 "title": "Boolean"
25102 }
25103 },
25104 "xml": {
25105 "name": "SuperFundModel"
25106 },
25107 "title": "SuperFundModel"
25108 },
25109 "SuperProductModel": {
25110 "type": "object",
25111 "properties": {
25112 "id": {
25113 "format": "int32",
25114 "type": "integer",
25115 "title": "Int32"
25116 },
25117 "abn": {
25118 "type": "string",
25119 "title": "String"
25120 },
25121 "productCode": {
25122 "type": "string",
25123 "title": "String"
25124 },
25125 "productType": {
25126 "type": "string",
25127 "title": "String"
25128 },
25129 "businessName": {
25130 "type": "string",
25131 "title": "String"
25132 },
25133 "displayName": {
25134 "type": "string",
25135 "title": "String"
25136 },
25137 "productName": {
25138 "type": "string",
25139 "title": "String"
25140 },
25141 "accountNumber": {
25142 "type": "string",
25143 "title": "String"
25144 },
25145 "bsb": {
25146 "type": "string",
25147 "title": "String"
25148 },
25149 "accountName": {
25150 "type": "string",
25151 "title": "String"
25152 },
25153 "source": {
25154 "enum": [
25155 "None",
25156 "Saasu",
25157 "Xero",
25158 "MYOB",
25159 "Deputy",
25160 "EmployeeTimePunch",
25161 "ClickSuper",
25162 "IntegratedTimesheets",
25163 "FileImport",
25164 "FileExport",
25165 "QuickBooks",
25166 "Harmony",
25167 "AwardStore",
25168 "Attache",
25169 "IntegratedRostering",
25170 "ReckonAccounts",
25171 "API",
25172 "MicroPower",
25173 "RosterLive",
25174 "NetSuite",
25175 "Kounta",
25176 "TimeAndAttendanceKiosk",
25177 "DetailedFileExport",
25178 "JonasPremier",
25179 "WageEasy",
25180 "Maestrano",
25181 "WorkZone",
25182 "EmployeePortal",
25183 "RosterTemplate",
25184 "Onboarding",
25185 "Admin",
25186 "WorkZoneClockOnOff"
25187 ],
25188 "type": "string",
25189 "title": "ExternalService"
25190 },
25191 "electronicServiceAddress": {
25192 "type": "string",
25193 "title": "String"
25194 },
25195 "email": {
25196 "type": "string",
25197 "title": "String"
25198 },
25199 "externalReferenceId": {
25200 "type": "string",
25201 "title": "String"
25202 }
25203 },
25204 "xml": {
25205 "name": "SuperProductModel"
25206 },
25207 "title": "SuperProductModel"
25208 },
25209 "SaveSuperFundModel": {
25210 "type": "object",
25211 "properties": {
25212 "memberNumber": {
25213 "type": "string",
25214 "title": "String"
25215 },
25216 "allocatedPercentage": {
25217 "format": "double",
25218 "type": "number",
25219 "title": "Nullable<Decimal>"
25220 },
25221 "fixedAmount": {
25222 "format": "double",
25223 "type": "number",
25224 "title": "Nullable<Decimal>"
25225 },
25226 "productCode": {
25227 "type": "string",
25228 "title": "String"
25229 },
25230 "fundName": {
25231 "type": "string",
25232 "title": "String"
25233 },
25234 "allocateBalance": {
25235 "type": "boolean",
25236 "title": "Boolean"
25237 }
25238 },
25239 "xml": {
25240 "name": "SaveSuperFundModel"
25241 },
25242 "title": "SaveSuperFundModel"
25243 },
25244 "SaveSuperFundResponseModel": {
25245 "type": "object",
25246 "properties": {
25247 "validationWarning": {
25248 "type": "string",
25249 "title": "String"
25250 },
25251 "result": {
25252 "$ref": "#/definitions/SuperFundModel"
25253 }
25254 },
25255 "xml": {
25256 "name": "SaveSuperFundResponseModel"
25257 },
25258 "title": "SaveSuperFundResponseModel"
25259 },
25260 "ODataQueryOptions[EmployerLiabilityCategory]": {
25261 "type": "object",
25262 "properties": {
25263 "ifMatch": {
25264 "type": "object",
25265 "readOnly": true,
25266 "title": "ETag<EmployerLiabilityCategory>"
25267 },
25268 "ifNoneMatch": {
25269 "type": "object",
25270 "readOnly": true,
25271 "title": "ETag<EmployerLiabilityCategory>"
25272 },
25273 "context": {
25274 "$ref": "#/definitions/ODataQueryContext",
25275 "readOnly": true
25276 },
25277 "request": {
25278 "type": "object",
25279 "readOnly": true,
25280 "title": "HttpRequestMessage"
25281 },
25282 "rawValues": {
25283 "$ref": "#/definitions/ODataRawQueryOptions",
25284 "readOnly": true
25285 },
25286 "selectExpand": {
25287 "$ref": "#/definitions/SelectExpandQueryOption",
25288 "readOnly": true
25289 },
25290 "filter": {
25291 "$ref": "#/definitions/FilterQueryOption",
25292 "readOnly": true
25293 },
25294 "orderBy": {
25295 "$ref": "#/definitions/OrderByQueryOption",
25296 "readOnly": true
25297 },
25298 "skip": {
25299 "$ref": "#/definitions/SkipQueryOption",
25300 "readOnly": true
25301 },
25302 "top": {
25303 "$ref": "#/definitions/TopQueryOption",
25304 "readOnly": true
25305 },
25306 "inlineCount": {
25307 "$ref": "#/definitions/InlineCountQueryOption",
25308 "readOnly": true
25309 },
25310 "validator": {
25311 "$ref": "#/definitions/ODataQueryValidator"
25312 }
25313 },
25314 "xml": {
25315 "name": "ODataQueryOptions`1"
25316 },
25317 "title": "ODataQueryOptions<EmployerLiabilityCategory>"
25318 },
25319 "EmployerLiabilityCategoryModel": {
25320 "type": "object",
25321 "properties": {
25322 "id": {
25323 "format": "int32",
25324 "type": "integer",
25325 "title": "Int32"
25326 },
25327 "name": {
25328 "type": "string",
25329 "title": "String"
25330 },
25331 "externalReferenceId": {
25332 "type": "string",
25333 "title": "String"
25334 },
25335 "canBeDeleted": {
25336 "type": "boolean",
25337 "title": "Boolean"
25338 },
25339 "hideFromPaySlips": {
25340 "type": "boolean",
25341 "title": "Boolean"
25342 },
25343 "showTotalPayments": {
25344 "type": "boolean",
25345 "title": "Boolean"
25346 },
25347 "includeInShiftCosts": {
25348 "type": "boolean",
25349 "title": "Boolean"
25350 }
25351 },
25352 "xml": {
25353 "name": "EmployerLiabilityCategoryModel"
25354 },
25355 "title": "EmployerLiabilityCategoryModel"
25356 },
25357 "ODataQueryOptions[EmployingEntity]": {
25358 "type": "object",
25359 "properties": {
25360 "ifMatch": {
25361 "type": "object",
25362 "readOnly": true,
25363 "title": "ETag<EmployingEntity>"
25364 },
25365 "ifNoneMatch": {
25366 "type": "object",
25367 "readOnly": true,
25368 "title": "ETag<EmployingEntity>"
25369 },
25370 "context": {
25371 "$ref": "#/definitions/ODataQueryContext",
25372 "readOnly": true
25373 },
25374 "request": {
25375 "type": "object",
25376 "readOnly": true,
25377 "title": "HttpRequestMessage"
25378 },
25379 "rawValues": {
25380 "$ref": "#/definitions/ODataRawQueryOptions",
25381 "readOnly": true
25382 },
25383 "selectExpand": {
25384 "$ref": "#/definitions/SelectExpandQueryOption",
25385 "readOnly": true
25386 },
25387 "filter": {
25388 "$ref": "#/definitions/FilterQueryOption",
25389 "readOnly": true
25390 },
25391 "orderBy": {
25392 "$ref": "#/definitions/OrderByQueryOption",
25393 "readOnly": true
25394 },
25395 "skip": {
25396 "$ref": "#/definitions/SkipQueryOption",
25397 "readOnly": true
25398 },
25399 "top": {
25400 "$ref": "#/definitions/TopQueryOption",
25401 "readOnly": true
25402 },
25403 "inlineCount": {
25404 "$ref": "#/definitions/InlineCountQueryOption",
25405 "readOnly": true
25406 },
25407 "validator": {
25408 "$ref": "#/definitions/ODataQueryValidator"
25409 }
25410 },
25411 "xml": {
25412 "name": "ODataQueryOptions`1"
25413 },
25414 "title": "ODataQueryOptions<EmployingEntity>"
25415 },
25416 "EmployingEntityModel": {
25417 "type": "object",
25418 "properties": {
25419 "id": {
25420 "format": "int32",
25421 "type": "integer",
25422 "title": "Int32"
25423 },
25424 "name": {
25425 "type": "string",
25426 "title": "String"
25427 },
25428 "abn": {
25429 "type": "string",
25430 "title": "String"
25431 },
25432 "contactName": {
25433 "type": "string",
25434 "title": "String"
25435 },
25436 "signatoryName": {
25437 "type": "string",
25438 "title": "String"
25439 },
25440 "contactEmailAddress": {
25441 "type": "string",
25442 "title": "String"
25443 },
25444 "contactPhoneNumber": {
25445 "type": "string",
25446 "title": "String"
25447 },
25448 "contactFaxNumber": {
25449 "type": "string",
25450 "title": "String"
25451 },
25452 "addressLine1": {
25453 "type": "string",
25454 "title": "String"
25455 },
25456 "addressLine2": {
25457 "type": "string",
25458 "title": "String"
25459 },
25460 "suburb": {
25461 "type": "string",
25462 "title": "String"
25463 },
25464 "state": {
25465 "type": "string",
25466 "title": "String"
25467 },
25468 "postcode": {
25469 "type": "string",
25470 "title": "String"
25471 },
25472 "externalReferenceId": {
25473 "type": "string",
25474 "title": "String"
25475 },
25476 "isExemptFromFringeBenefitsTax": {
25477 "type": "boolean",
25478 "title": "Boolean"
25479 }
25480 },
25481 "xml": {
25482 "name": "EmployingEntityModel"
25483 },
25484 "title": "EmployingEntityModel"
25485 },
25486 "ODataQueryOptions[EmploymentAgreement]": {
25487 "type": "object",
25488 "properties": {
25489 "ifMatch": {
25490 "type": "object",
25491 "readOnly": true,
25492 "title": "ETag<EmploymentAgreement>"
25493 },
25494 "ifNoneMatch": {
25495 "type": "object",
25496 "readOnly": true,
25497 "title": "ETag<EmploymentAgreement>"
25498 },
25499 "context": {
25500 "$ref": "#/definitions/ODataQueryContext",
25501 "readOnly": true
25502 },
25503 "request": {
25504 "type": "object",
25505 "readOnly": true,
25506 "title": "HttpRequestMessage"
25507 },
25508 "rawValues": {
25509 "$ref": "#/definitions/ODataRawQueryOptions",
25510 "readOnly": true
25511 },
25512 "selectExpand": {
25513 "$ref": "#/definitions/SelectExpandQueryOption",
25514 "readOnly": true
25515 },
25516 "filter": {
25517 "$ref": "#/definitions/FilterQueryOption",
25518 "readOnly": true
25519 },
25520 "orderBy": {
25521 "$ref": "#/definitions/OrderByQueryOption",
25522 "readOnly": true
25523 },
25524 "skip": {
25525 "$ref": "#/definitions/SkipQueryOption",
25526 "readOnly": true
25527 },
25528 "top": {
25529 "$ref": "#/definitions/TopQueryOption",
25530 "readOnly": true
25531 },
25532 "inlineCount": {
25533 "$ref": "#/definitions/InlineCountQueryOption",
25534 "readOnly": true
25535 },
25536 "validator": {
25537 "$ref": "#/definitions/ODataQueryValidator"
25538 }
25539 },
25540 "xml": {
25541 "name": "ODataQueryOptions`1"
25542 },
25543 "title": "ODataQueryOptions<EmploymentAgreement>"
25544 },
25545 "BasicEmploymentAgreementModel": {
25546 "type": "object",
25547 "properties": {
25548 "id": {
25549 "format": "int32",
25550 "type": "integer",
25551 "title": "Int32"
25552 },
25553 "classification": {
25554 "type": "string",
25555 "title": "String"
25556 },
25557 "employmentType": {
25558 "enum": [
25559 "Unknown",
25560 "FullTime",
25561 "PartTime",
25562 "LabourHire",
25563 "SuperannuationIncomeStream",
25564 "Casual"
25565 ],
25566 "type": "string",
25567 "title": "EmploymentTypeEnum"
25568 },
25569 "name": {
25570 "type": "string",
25571 "title": "String"
25572 },
25573 "awardName": {
25574 "type": "string",
25575 "title": "String"
25576 },
25577 "rank": {
25578 "format": "int32",
25579 "type": "integer",
25580 "title": "Int32"
25581 }
25582 },
25583 "xml": {
25584 "name": "BasicEmploymentAgreementModel"
25585 },
25586 "title": "BasicEmploymentAgreementModel"
25587 },
25588 "EmploymentAgreementModel": {
25589 "type": "object",
25590 "properties": {
25591 "id": {
25592 "format": "int32",
25593 "type": "integer",
25594 "title": "Int32"
25595 },
25596 "classification": {
25597 "type": "string",
25598 "title": "String"
25599 },
25600 "employmentType": {
25601 "enum": [
25602 "Unknown",
25603 "FullTime",
25604 "PartTime",
25605 "LabourHire",
25606 "SuperannuationIncomeStream",
25607 "Casual"
25608 ],
25609 "type": "string",
25610 "title": "EmploymentTypeEnum"
25611 },
25612 "payRateTemplateType": {
25613 "enum": [
25614 "DateOfBirth",
25615 "Anniversary",
25616 "AnniversaryInMonths",
25617 "DateOfBirthAndAnniversaryInMonths"
25618 ],
25619 "type": "string",
25620 "title": "PayRateTemplateTypeEnum"
25621 },
25622 "payConditionRuleSetId": {
25623 "format": "int32",
25624 "description": "in older serialised versions, the whole ruleset was included. in newer versions, only the ID is included",
25625 "type": "integer",
25626 "title": "Nullable<Int32>"
25627 },
25628 "payConditionRuleSet": {
25629 "$ref": "#/definitions/PayConditionRuleSetModel"
25630 },
25631 "leaveAllowanceTemplates": {
25632 "type": "array",
25633 "items": {
25634 "$ref": "#/definitions/LeaveAllowanceTemplateModel"
25635 },
25636 "xml": {
25637 "name": "LeaveAllowanceTemplateModel",
25638 "wrapped": true
25639 },
25640 "title": "IList<LeaveAllowanceTemplateModel>"
25641 },
25642 "leaveAllowanceTemplateIds": {
25643 "type": "array",
25644 "items": {
25645 "format": "int32",
25646 "type": "integer",
25647 "title": "Int32"
25648 },
25649 "title": "IList<Int32>"
25650 },
25651 "agePayRateTemplates": {
25652 "type": "array",
25653 "items": {
25654 "$ref": "#/definitions/EmploymentAgreementPayRateTemplateModel"
25655 },
25656 "xml": {
25657 "name": "EmploymentAgreementPayRateTemplateModel",
25658 "wrapped": true
25659 },
25660 "title": "IList<EmploymentAgreementPayRateTemplateModel>"
25661 },
25662 "externalId": {
25663 "type": "string",
25664 "title": "String"
25665 },
25666 "source": {
25667 "enum": [
25668 "None",
25669 "Saasu",
25670 "Xero",
25671 "MYOB",
25672 "Deputy",
25673 "EmployeeTimePunch",
25674 "ClickSuper",
25675 "IntegratedTimesheets",
25676 "FileImport",
25677 "FileExport",
25678 "QuickBooks",
25679 "Harmony",
25680 "AwardStore",
25681 "Attache",
25682 "IntegratedRostering",
25683 "ReckonAccounts",
25684 "API",
25685 "MicroPower",
25686 "RosterLive",
25687 "NetSuite",
25688 "Kounta",
25689 "TimeAndAttendanceKiosk",
25690 "DetailedFileExport",
25691 "JonasPremier",
25692 "WageEasy",
25693 "Maestrano",
25694 "WorkZone",
25695 "EmployeePortal",
25696 "RosterTemplate",
25697 "Onboarding",
25698 "Admin",
25699 "WorkZoneClockOnOff"
25700 ],
25701 "type": "string",
25702 "title": "ExternalService"
25703 },
25704 "rank": {
25705 "format": "int32",
25706 "type": "integer",
25707 "title": "Int32"
25708 }
25709 },
25710 "xml": {
25711 "name": "EmploymentAgreementModel"
25712 },
25713 "title": "EmploymentAgreementModel"
25714 },
25715 "PayConditionRuleSetModel": {
25716 "type": "object",
25717 "properties": {
25718 "id": {
25719 "format": "int32",
25720 "type": "integer",
25721 "title": "Int32"
25722 },
25723 "name": {
25724 "type": "string",
25725 "title": "String"
25726 },
25727 "description": {
25728 "type": "string",
25729 "title": "String"
25730 },
25731 "periodType": {
25732 "enum": [
25733 "Weekly",
25734 "Fortnightly",
25735 "Monthly",
25736 "CalendarMonth",
25737 "FourWeekly",
25738 "SixWeekly",
25739 "ThreeWeekly"
25740 ],
25741 "type": "string",
25742 "title": "RuleSetPeriodType"
25743 },
25744 "dayOfWeekEnding": {
25745 "format": "int32",
25746 "type": "integer",
25747 "title": "Nullable<Int32>"
25748 },
25749 "dayOfMonthEnding": {
25750 "format": "int32",
25751 "type": "integer",
25752 "title": "Nullable<Int32>"
25753 },
25754 "periodEnding": {
25755 "format": "date-time",
25756 "type": "string",
25757 "title": "Nullable<DateTime>"
25758 },
25759 "shiftConsolidationOption": {
25760 "enum": [
25761 "None",
25762 "Duration",
25763 "SameDay"
25764 ],
25765 "type": "string",
25766 "title": "Nullable<ShiftConsolidationOption>"
25767 },
25768 "shiftConsolidationThreshold": {
25769 "type": "string",
25770 "title": "Nullable<TimeSpan>"
25771 },
25772 "rulesJson": {
25773 "type": "string",
25774 "title": "String"
25775 }
25776 },
25777 "xml": {
25778 "name": "PayConditionRuleSetModel"
25779 },
25780 "title": "PayConditionRuleSetModel"
25781 },
25782 "LeaveAllowanceTemplateModel": {
25783 "type": "object",
25784 "properties": {
25785 "id": {
25786 "format": "int32",
25787 "type": "integer",
25788 "title": "Int32"
25789 },
25790 "name": {
25791 "type": "string",
25792 "title": "String"
25793 },
25794 "leaveCategories": {
25795 "type": "array",
25796 "items": {
25797 "$ref": "#/definitions/LeaveAllowanceTemplateLeaveCategoryModel"
25798 },
25799 "xml": {
25800 "name": "LeaveAllowanceTemplateLeaveCategoryModel",
25801 "wrapped": true
25802 },
25803 "title": "IList<LeaveAllowanceTemplateLeaveCategoryModel>"
25804 },
25805 "externalId": {
25806 "type": "string",
25807 "title": "String"
25808 },
25809 "source": {
25810 "enum": [
25811 "None",
25812 "Saasu",
25813 "Xero",
25814 "MYOB",
25815 "Deputy",
25816 "EmployeeTimePunch",
25817 "ClickSuper",
25818 "IntegratedTimesheets",
25819 "FileImport",
25820 "FileExport",
25821 "QuickBooks",
25822 "Harmony",
25823 "AwardStore",
25824 "Attache",
25825 "IntegratedRostering",
25826 "ReckonAccounts",
25827 "API",
25828 "MicroPower",
25829 "RosterLive",
25830 "NetSuite",
25831 "Kounta",
25832 "TimeAndAttendanceKiosk",
25833 "DetailedFileExport",
25834 "JonasPremier",
25835 "WageEasy",
25836 "Maestrano",
25837 "WorkZone",
25838 "EmployeePortal",
25839 "RosterTemplate",
25840 "Onboarding",
25841 "Admin",
25842 "WorkZoneClockOnOff"
25843 ],
25844 "type": "string",
25845 "title": "ExternalService"
25846 }
25847 },
25848 "xml": {
25849 "name": "LeaveAllowanceTemplateModel"
25850 },
25851 "title": "LeaveAllowanceTemplateModel"
25852 },
25853 "EmploymentAgreementPayRateTemplateModel": {
25854 "type": "object",
25855 "properties": {
25856 "payRateTemplateId": {
25857 "format": "int32",
25858 "type": "integer",
25859 "title": "Nullable<Int32>"
25860 },
25861 "payRateTemplate": {
25862 "$ref": "#/definitions/PayRateTemplateModel"
25863 },
25864 "minAge": {
25865 "format": "int32",
25866 "type": "integer",
25867 "title": "Nullable<Int32>"
25868 },
25869 "maxAge": {
25870 "format": "int32",
25871 "type": "integer",
25872 "title": "Nullable<Int32>"
25873 },
25874 "minAnniversaryMonths": {
25875 "format": "int32",
25876 "type": "integer",
25877 "title": "Nullable<Int32>"
25878 },
25879 "maxAnniversaryMonths": {
25880 "format": "int32",
25881 "type": "integer",
25882 "title": "Nullable<Int32>"
25883 }
25884 },
25885 "xml": {
25886 "name": "EmploymentAgreementPayRateTemplateModel"
25887 },
25888 "title": "EmploymentAgreementPayRateTemplateModel"
25889 },
25890 "LeaveAllowanceTemplateLeaveCategoryModel": {
25891 "type": "object",
25892 "properties": {
25893 "leaveCategoryId": {
25894 "format": "int32",
25895 "type": "integer",
25896 "title": "Int32"
25897 },
25898 "units": {
25899 "format": "double",
25900 "type": "number",
25901 "title": "Nullable<Decimal>"
25902 },
25903 "unitType": {
25904 "enum": [
25905 "Days",
25906 "Weeks",
25907 "HoursPerHourWorked",
25908 "HoursPerPayRun"
25909 ],
25910 "type": "string",
25911 "title": "Nullable<LeaveAllowanceUnitEnum>"
25912 },
25913 "leaveLoading": {
25914 "format": "double",
25915 "type": "number",
25916 "title": "Nullable<Decimal>"
25917 },
25918 "canApplyForLeave": {
25919 "type": "boolean",
25920 "title": "Boolean"
25921 },
25922 "contingentPeriod": {
25923 "format": "double",
25924 "type": "number",
25925 "title": "Nullable<Decimal>"
25926 },
25927 "entitlementPeriod": {
25928 "format": "double",
25929 "type": "number",
25930 "title": "Nullable<Decimal>"
25931 }
25932 },
25933 "xml": {
25934 "name": "LeaveAllowanceTemplateLeaveCategoryModel"
25935 },
25936 "title": "LeaveAllowanceTemplateLeaveCategoryModel"
25937 },
25938 "PayRateTemplateModel": {
25939 "type": "object",
25940 "properties": {
25941 "id": {
25942 "format": "int32",
25943 "type": "integer",
25944 "title": "Int32"
25945 },
25946 "name": {
25947 "type": "string",
25948 "title": "String"
25949 },
25950 "primaryPayCategoryId": {
25951 "format": "int32",
25952 "type": "integer",
25953 "title": "Int32"
25954 },
25955 "superThresholdAmount": {
25956 "format": "double",
25957 "type": "number",
25958 "title": "Nullable<Decimal>"
25959 },
25960 "payCategories": {
25961 "type": "array",
25962 "items": {
25963 "$ref": "#/definitions/PayRateTemplatePayCategoryModel"
25964 },
25965 "xml": {
25966 "name": "PayRateTemplatePayCategoryModel",
25967 "wrapped": true
25968 },
25969 "title": "List<PayRateTemplatePayCategoryModel>"
25970 },
25971 "externalId": {
25972 "type": "string",
25973 "title": "String"
25974 },
25975 "source": {
25976 "type": "string",
25977 "title": "String"
25978 },
25979 "maximumQuarterlySuperContributionsBase": {
25980 "format": "double",
25981 "type": "number",
25982 "title": "Nullable<Decimal>"
25983 }
25984 },
25985 "xml": {
25986 "name": "PayRateTemplateModel"
25987 },
25988 "title": "PayRateTemplateModel"
25989 },
25990 "PayRateTemplatePayCategoryModel": {
25991 "description": "TODO: Can we get away with not having UserSuppliedRate and CalculatedRate? can we just have 'Rate' and work \r\n(which is interpreted as UserSuppliedRate) and determine calculated rate from there?",
25992 "type": "object",
25993 "properties": {
25994 "payCategoryId": {
25995 "format": "int32",
25996 "type": "integer",
25997 "title": "Int32"
25998 },
25999 "userSuppliedRate": {
26000 "format": "double",
26001 "type": "number",
26002 "title": "Decimal"
26003 },
26004 "calculatedRate": {
26005 "format": "double",
26006 "type": "number",
26007 "title": "Decimal"
26008 },
26009 "standardWeeklyHours": {
26010 "format": "double",
26011 "type": "number",
26012 "title": "Decimal"
26013 },
26014 "superRate": {
26015 "format": "double",
26016 "type": "number",
26017 "title": "Nullable<Decimal>"
26018 }
26019 },
26020 "xml": {
26021 "name": "PayRateTemplatePayCategoryModel"
26022 },
26023 "title": "PayRateTemplatePayCategoryModel"
26024 },
26025 "GetShiftPeriodsModel": {
26026 "type": "object",
26027 "properties": {
26028 "firstShiftStartTime": {
26029 "format": "date-time",
26030 "type": "string",
26031 "title": "Nullable<DateTime>"
26032 },
26033 "lastShiftStartTime": {
26034 "format": "date-time",
26035 "type": "string",
26036 "title": "Nullable<DateTime>"
26037 }
26038 },
26039 "xml": {
26040 "name": "GetShiftPeriodsModel"
26041 },
26042 "title": "GetShiftPeriodsModel"
26043 },
26044 "ShiftPeriodModel": {
26045 "type": "object",
26046 "properties": {
26047 "fromDate": {
26048 "format": "date-time",
26049 "type": "string",
26050 "title": "DateTime"
26051 },
26052 "toDate": {
26053 "format": "date-time",
26054 "type": "string",
26055 "title": "DateTime"
26056 }
26057 },
26058 "xml": {
26059 "name": "ShiftPeriodModel"
26060 },
26061 "title": "ShiftPeriodModel"
26062 },
26063 "ShiftCostingsRequestModel": {
26064 "type": "object",
26065 "properties": {
26066 "transactionExternalId": {
26067 "type": "string",
26068 "title": "String"
26069 },
26070 "locationIdType": {
26071 "enum": [
26072 "Standard",
26073 "External"
26074 ],
26075 "type": "string",
26076 "title": "IdType"
26077 },
26078 "workTypeIdType": {
26079 "enum": [
26080 "Standard",
26081 "External"
26082 ],
26083 "type": "string",
26084 "title": "IdType"
26085 },
26086 "includeEvaluationResults": {
26087 "type": "boolean",
26088 "title": "Boolean"
26089 },
26090 "employee": {
26091 "$ref": "#/definitions/ShiftCostingsEmployeeModel"
26092 },
26093 "shifts": {
26094 "type": "array",
26095 "items": {
26096 "$ref": "#/definitions/ShiftCostingsRequestShiftModel"
26097 },
26098 "xml": {
26099 "name": "ShiftCostingsRequestShiftModel",
26100 "wrapped": true
26101 },
26102 "title": "IList<ShiftCostingsRequestShiftModel>"
26103 }
26104 },
26105 "xml": {
26106 "name": "ShiftCostingsRequestModel"
26107 },
26108 "title": "ShiftCostingsRequestModel"
26109 },
26110 "ShiftCostingsEmployeeModel": {
26111 "type": "object",
26112 "properties": {
26113 "dateOfBirth": {
26114 "format": "date-time",
26115 "type": "string",
26116 "title": "Nullable<DateTime>"
26117 },
26118 "anniversaryDate": {
26119 "format": "date-time",
26120 "type": "string",
26121 "title": "Nullable<DateTime>"
26122 },
26123 "standardHoursPerWeek": {
26124 "format": "double",
26125 "type": "number",
26126 "title": "Nullable<Decimal>"
26127 },
26128 "tags": {
26129 "type": "array",
26130 "items": {
26131 "type": "string",
26132 "title": "String"
26133 },
26134 "title": "IList<String>"
26135 }
26136 },
26137 "xml": {
26138 "name": "ShiftCostingsEmployeeModel"
26139 },
26140 "title": "ShiftCostingsEmployeeModel"
26141 },
26142 "ShiftCostingsRequestShiftModel": {
26143 "type": "object",
26144 "properties": {
26145 "state": {
26146 "type": "string",
26147 "title": "String"
26148 },
26149 "id": {
26150 "format": "int32",
26151 "type": "integer",
26152 "title": "Int32"
26153 },
26154 "employeeId": {
26155 "format": "int32",
26156 "type": "integer",
26157 "title": "Int32"
26158 },
26159 "startTime": {
26160 "format": "date-time",
26161 "type": "string",
26162 "title": "Nullable<DateTime>"
26163 },
26164 "endTime": {
26165 "format": "date-time",
26166 "type": "string",
26167 "title": "Nullable<DateTime>"
26168 },
26169 "units": {
26170 "format": "double",
26171 "type": "number",
26172 "title": "Nullable<Decimal>"
26173 },
26174 "workTypeId": {
26175 "type": "string",
26176 "title": "String"
26177 },
26178 "locationId": {
26179 "type": "string",
26180 "title": "String"
26181 },
26182 "comments": {
26183 "type": "string",
26184 "title": "String"
26185 },
26186 "breaks": {
26187 "type": "array",
26188 "items": {
26189 "$ref": "#/definitions/TimesheetBreakModel"
26190 },
26191 "xml": {
26192 "name": "TimesheetBreakModel",
26193 "wrapped": true
26194 },
26195 "title": "IList<TimesheetBreakModel>"
26196 },
26197 "status": {
26198 "type": "string",
26199 "title": "String"
26200 },
26201 "rate": {
26202 "format": "double",
26203 "type": "number",
26204 "title": "Nullable<Decimal>"
26205 },
26206 "leaveCategoryId": {
26207 "type": "string",
26208 "title": "String"
26209 },
26210 "payCategoryId": {
26211 "type": "string",
26212 "title": "String"
26213 },
26214 "classificationId": {
26215 "type": "string",
26216 "title": "String"
26217 },
26218 "externalId": {
26219 "type": "string",
26220 "title": "String"
26221 },
26222 "source": {
26223 "enum": [
26224 "None",
26225 "Saasu",
26226 "Xero",
26227 "MYOB",
26228 "Deputy",
26229 "EmployeeTimePunch",
26230 "ClickSuper",
26231 "IntegratedTimesheets",
26232 "FileImport",
26233 "FileExport",
26234 "QuickBooks",
26235 "Harmony",
26236 "AwardStore",
26237 "Attache",
26238 "IntegratedRostering",
26239 "ReckonAccounts",
26240 "API",
26241 "MicroPower",
26242 "RosterLive",
26243 "NetSuite",
26244 "Kounta",
26245 "TimeAndAttendanceKiosk",
26246 "DetailedFileExport",
26247 "JonasPremier",
26248 "WageEasy",
26249 "Maestrano",
26250 "WorkZone",
26251 "EmployeePortal",
26252 "RosterTemplate",
26253 "Onboarding",
26254 "Admin",
26255 "WorkZoneClockOnOff"
26256 ],
26257 "type": "string",
26258 "title": "ExternalService"
26259 },
26260 "attachmentId": {
26261 "format": "int32",
26262 "type": "integer",
26263 "title": "Nullable<Int32>"
26264 },
26265 "shiftConditionIds": {
26266 "type": "array",
26267 "items": {
26268 "type": "string",
26269 "title": "String"
26270 },
26271 "title": "IList<String>"
26272 }
26273 },
26274 "xml": {
26275 "name": "ShiftCostingsRequestShiftModel"
26276 },
26277 "title": "ShiftCostingsRequestShiftModel"
26278 },
26279 "TimesheetBreakModel": {
26280 "type": "object",
26281 "properties": {
26282 "startTime": {
26283 "format": "date-time",
26284 "type": "string",
26285 "title": "Nullable<DateTime>"
26286 },
26287 "endTime": {
26288 "format": "date-time",
26289 "type": "string",
26290 "title": "Nullable<DateTime>"
26291 }
26292 },
26293 "xml": {
26294 "name": "TimesheetBreakModel"
26295 },
26296 "title": "TimesheetBreakModel"
26297 },
26298 "ShiftCostingsResponseModel": {
26299 "type": "object",
26300 "properties": {
26301 "transactionId": {
26302 "format": "uuid",
26303 "type": "string",
26304 "example": "00000000-0000-0000-0000-000000000000",
26305 "title": "Guid"
26306 },
26307 "transactionExternalId": {
26308 "type": "string",
26309 "title": "String"
26310 },
26311 "employmentAgreementId": {
26312 "format": "int32",
26313 "type": "integer",
26314 "title": "Int32"
26315 },
26316 "employmentAgreementName": {
26317 "type": "string",
26318 "title": "String"
26319 },
26320 "payConditionRuleSetId": {
26321 "format": "int32",
26322 "type": "integer",
26323 "title": "Int32"
26324 },
26325 "payConditionRuleSetName": {
26326 "type": "string",
26327 "title": "String"
26328 },
26329 "shifts": {
26330 "type": "array",
26331 "items": {
26332 "$ref": "#/definitions/ShiftCostingsResponseShiftModel"
26333 },
26334 "xml": {
26335 "name": "ShiftCostingsResponseShiftModel",
26336 "wrapped": true
26337 },
26338 "title": "List<ShiftCostingsResponseShiftModel>"
26339 }
26340 },
26341 "xml": {
26342 "name": "ShiftCostingsResponseModel"
26343 },
26344 "title": "ShiftCostingsResponseModel"
26345 },
26346 "ShiftCostingsResponseShiftModel": {
26347 "type": "object",
26348 "properties": {
26349 "externalId": {
26350 "type": "string",
26351 "title": "String"
26352 },
26353 "startTime": {
26354 "format": "date-time",
26355 "type": "string",
26356 "title": "DateTime"
26357 },
26358 "endTime": {
26359 "format": "date-time",
26360 "type": "string",
26361 "title": "DateTime"
26362 },
26363 "cost": {
26364 "format": "double",
26365 "type": "number",
26366 "readOnly": true,
26367 "title": "Decimal"
26368 },
26369 "evaluationResults": {
26370 "type": "array",
26371 "items": {
26372 "$ref": "#/definitions/RuleEvaluationResult"
26373 },
26374 "xml": {
26375 "name": "RuleEvaluationResult",
26376 "wrapped": true
26377 },
26378 "title": "IList<RuleEvaluationResult>"
26379 },
26380 "consolidatedShifts": {
26381 "type": "array",
26382 "items": {
26383 "type": "string",
26384 "title": "String"
26385 },
26386 "title": "List<String>"
26387 },
26388 "costBreakdown": {
26389 "type": "array",
26390 "items": {
26391 "$ref": "#/definitions/ShiftCostingBreakdownModel"
26392 },
26393 "xml": {
26394 "name": "ShiftCostingBreakdownModel",
26395 "wrapped": true
26396 },
26397 "title": "List<ShiftCostingBreakdownModel>"
26398 }
26399 },
26400 "xml": {
26401 "name": "ShiftCostingsResponseShiftModel"
26402 },
26403 "title": "ShiftCostingsResponseShiftModel"
26404 },
26405 "RuleEvaluationResult": {
26406 "type": "object",
26407 "properties": {
26408 "ruleName": {
26409 "type": "string",
26410 "title": "String"
26411 },
26412 "matchResult": {
26413 "enum": [
26414 "NoMatch",
26415 "Match",
26416 "DisabledForRuleSet",
26417 "DisabledForEmployee"
26418 ],
26419 "type": "string",
26420 "title": "RuleMatchResult"
26421 }
26422 },
26423 "xml": {
26424 "name": "RuleEvaluationResult"
26425 },
26426 "title": "RuleEvaluationResult"
26427 },
26428 "ShiftCostingBreakdownModel": {
26429 "type": "object",
26430 "properties": {
26431 "startTime": {
26432 "format": "date-time",
26433 "type": "string",
26434 "title": "Nullable<DateTime>"
26435 },
26436 "endTime": {
26437 "format": "date-time",
26438 "type": "string",
26439 "title": "Nullable<DateTime>"
26440 },
26441 "payCategoryId": {
26442 "format": "int32",
26443 "type": "integer",
26444 "title": "Nullable<Int32>"
26445 },
26446 "payCategoryName": {
26447 "type": "string",
26448 "title": "String"
26449 },
26450 "units": {
26451 "format": "double",
26452 "type": "number",
26453 "title": "Decimal"
26454 },
26455 "rate": {
26456 "format": "double",
26457 "type": "number",
26458 "title": "Decimal"
26459 },
26460 "cost": {
26461 "format": "double",
26462 "type": "number",
26463 "title": "Decimal"
26464 },
26465 "type": {
26466 "type": "string",
26467 "title": "String"
26468 },
26469 "liabilityCategoryId": {
26470 "format": "int32",
26471 "type": "integer",
26472 "title": "Nullable<Int32>"
26473 },
26474 "liabilityCategoryName": {
26475 "type": "string",
26476 "title": "String"
26477 }
26478 },
26479 "xml": {
26480 "name": "ShiftCostingBreakdownModel"
26481 },
26482 "title": "ShiftCostingBreakdownModel"
26483 },
26484 "EmployeeLeaveRequestFilter": {
26485 "type": "object",
26486 "properties": {
26487 "showOtherEmployees": {
26488 "type": "boolean",
26489 "title": "Boolean"
26490 },
26491 "fromDate": {
26492 "format": "date-time",
26493 "type": "string",
26494 "title": "Nullable<DateTime>"
26495 },
26496 "toDate": {
26497 "format": "date-time",
26498 "type": "string",
26499 "title": "Nullable<DateTime>"
26500 }
26501 },
26502 "xml": {
26503 "name": "EmployeeLeaveRequestFilter"
26504 },
26505 "title": "EmployeeLeaveRequestFilter"
26506 },
26507 "EssLeaveRequestModel": {
26508 "type": "object",
26509 "properties": {
26510 "leaveCategoryId": {
26511 "format": "int32",
26512 "type": "integer",
26513 "title": "Int32"
26514 },
26515 "isApproved": {
26516 "type": "boolean",
26517 "title": "Boolean"
26518 },
26519 "isDeclined": {
26520 "type": "boolean",
26521 "title": "Boolean"
26522 },
26523 "isCancelled": {
26524 "type": "boolean",
26525 "title": "Boolean"
26526 },
26527 "isPending": {
26528 "type": "boolean",
26529 "title": "Boolean"
26530 },
26531 "id": {
26532 "format": "int32",
26533 "type": "integer",
26534 "title": "Int32"
26535 },
26536 "fromDate": {
26537 "format": "date-time",
26538 "type": "string",
26539 "title": "DateTime"
26540 },
26541 "toDate": {
26542 "format": "date-time",
26543 "type": "string",
26544 "title": "DateTime"
26545 },
26546 "requestedDate": {
26547 "format": "date-time",
26548 "type": "string",
26549 "title": "DateTime"
26550 },
26551 "leaveCategoryName": {
26552 "type": "string",
26553 "title": "String"
26554 },
26555 "hoursPerDay": {
26556 "format": "double",
26557 "type": "number",
26558 "title": "Decimal"
26559 },
26560 "totalHours": {
26561 "format": "double",
26562 "type": "number",
26563 "title": "Decimal"
26564 },
26565 "notes": {
26566 "type": "string",
26567 "title": "String"
26568 },
26569 "totalDays": {
26570 "format": "double",
26571 "type": "number",
26572 "readOnly": true,
26573 "title": "Decimal"
26574 },
26575 "amount": {
26576 "type": "string",
26577 "readOnly": true,
26578 "title": "String"
26579 },
26580 "status": {
26581 "type": "string",
26582 "title": "String"
26583 },
26584 "statusUpdateNotes": {
26585 "type": "string",
26586 "title": "String"
26587 },
26588 "canCancel": {
26589 "type": "boolean",
26590 "title": "Boolean"
26591 },
26592 "canModify": {
26593 "type": "boolean",
26594 "title": "Boolean"
26595 },
26596 "requireNotesForLeaveRequests": {
26597 "type": "boolean",
26598 "title": "Boolean"
26599 },
26600 "attachment": {
26601 "$ref": "#/definitions/AttachmentModel"
26602 }
26603 },
26604 "xml": {
26605 "name": "EssLeaveRequestModel"
26606 },
26607 "title": "EssLeaveRequestModel"
26608 },
26609 "EssLeaveApplicationModel": {
26610 "required": [
26611 "fromDate",
26612 "toDate",
26613 "hours",
26614 "leaveCategoryId"
26615 ],
26616 "type": "object",
26617 "properties": {
26618 "attachment": {
26619 "format": "byte",
26620 "type": "string",
26621 "title": "Byte[]"
26622 },
26623 "attachmentId": {
26624 "format": "int32",
26625 "type": "integer",
26626 "title": "Nullable<Int32>"
26627 },
26628 "id": {
26629 "format": "int32",
26630 "type": "integer",
26631 "title": "Int32"
26632 },
26633 "fromDate": {
26634 "format": "date-time",
26635 "type": "string",
26636 "title": "DateTime"
26637 },
26638 "toDate": {
26639 "format": "date-time",
26640 "type": "string",
26641 "title": "DateTime"
26642 },
26643 "hours": {
26644 "format": "double",
26645 "maximum": 2000,
26646 "type": "number",
26647 "title": "Decimal"
26648 },
26649 "leaveCategoryId": {
26650 "format": "int32",
26651 "type": "integer",
26652 "title": "Nullable<Int32>"
26653 },
26654 "notes": {
26655 "maxLength": 255,
26656 "type": "string",
26657 "title": "String"
26658 }
26659 },
26660 "xml": {
26661 "name": "EssLeaveApplicationModel"
26662 },
26663 "title": "EssLeaveApplicationModel"
26664 },
26665 "EssLeaveCategoryModel": {
26666 "type": "object",
26667 "properties": {
26668 "id": {
26669 "format": "int32",
26670 "type": "integer",
26671 "title": "Int32"
26672 },
26673 "name": {
26674 "type": "string",
26675 "title": "String"
26676 }
26677 },
26678 "xml": {
26679 "name": "EssLeaveCategoryModel"
26680 },
26681 "title": "EssLeaveCategoryModel"
26682 },
26683 "LeaveHoursEstimateFilter": {
26684 "required": [
26685 "fromDate",
26686 "toDate"
26687 ],
26688 "type": "object",
26689 "properties": {
26690 "leaveCategoryId": {
26691 "format": "int32",
26692 "type": "integer",
26693 "title": "Int32"
26694 },
26695 "fromDate": {
26696 "format": "date-time",
26697 "type": "string",
26698 "title": "DateTime"
26699 },
26700 "toDate": {
26701 "format": "date-time",
26702 "type": "string",
26703 "title": "DateTime"
26704 }
26705 },
26706 "xml": {
26707 "name": "LeaveHoursEstimateFilter"
26708 },
26709 "title": "LeaveHoursEstimateFilter"
26710 },
26711 "EssLeaveEstimate": {
26712 "type": "object",
26713 "properties": {
26714 "leaveBalance": {
26715 "format": "double",
26716 "type": "number",
26717 "title": "Nullable<Decimal>"
26718 },
26719 "approvedLeave": {
26720 "format": "double",
26721 "type": "number",
26722 "title": "Nullable<Decimal>"
26723 },
26724 "availableBalance": {
26725 "format": "double",
26726 "type": "number",
26727 "title": "Nullable<Decimal>"
26728 },
26729 "leaveRequired": {
26730 "$ref": "#/definitions/LeaveEstimate"
26731 }
26732 },
26733 "xml": {
26734 "name": "EssLeaveEstimate"
26735 },
26736 "title": "EssLeaveEstimate"
26737 },
26738 "LeaveEstimate": {
26739 "type": "object",
26740 "properties": {
26741 "employeeId": {
26742 "format": "int32",
26743 "type": "integer",
26744 "title": "Int32"
26745 },
26746 "hours": {
26747 "format": "double",
26748 "type": "number",
26749 "title": "Nullable<Decimal>"
26750 },
26751 "details": {
26752 "type": "array",
26753 "items": {
26754 "type": "string",
26755 "title": "String"
26756 },
26757 "title": "IList<String>"
26758 }
26759 },
26760 "xml": {
26761 "name": "LeaveEstimate"
26762 },
26763 "title": "LeaveEstimate"
26764 },
26765 "EssEmployeeDetailsModel": {
26766 "description": "this exists to give it a separate name from the API EmployeeeDetailsModel. As an aside, we should have had an api specific model for this",
26767 "type": "object",
26768 "properties": {
26769 "id": {
26770 "format": "int32",
26771 "type": "integer",
26772 "title": "Int32"
26773 },
26774 "titleId": {
26775 "format": "int32",
26776 "type": "integer",
26777 "title": "Int32"
26778 },
26779 "firstName": {
26780 "type": "string",
26781 "title": "String"
26782 },
26783 "otherName": {
26784 "type": "string",
26785 "title": "String"
26786 },
26787 "middleName": {
26788 "type": "string",
26789 "title": "String"
26790 },
26791 "surname": {
26792 "type": "string",
26793 "title": "String"
26794 },
26795 "gender": {
26796 "type": "string",
26797 "title": "String"
26798 },
26799 "dateOfBirth": {
26800 "format": "date-time",
26801 "type": "string",
26802 "title": "Nullable<DateTime>"
26803 },
26804 "anniversaryDate": {
26805 "format": "date-time",
26806 "type": "string",
26807 "title": "Nullable<DateTime>"
26808 },
26809 "externalId": {
26810 "type": "string",
26811 "title": "String"
26812 },
26813 "residentialStreetAddress": {
26814 "type": "string",
26815 "title": "String"
26816 },
26817 "residentialAddressLine2": {
26818 "type": "string",
26819 "title": "String"
26820 },
26821 "residentialSuburbId": {
26822 "format": "int32",
26823 "type": "integer",
26824 "title": "Nullable<Int32>"
26825 },
26826 "residentialSuburb": {
26827 "type": "string",
26828 "title": "String"
26829 },
26830 "residentialState": {
26831 "type": "string",
26832 "title": "String"
26833 },
26834 "residentialPostcode": {
26835 "type": "string",
26836 "title": "String"
26837 },
26838 "residentialCountry": {
26839 "type": "string",
26840 "title": "String"
26841 },
26842 "postalStreetAddress": {
26843 "type": "string",
26844 "title": "String"
26845 },
26846 "postalAddressLine2": {
26847 "type": "string",
26848 "title": "String"
26849 },
26850 "postalSuburbId": {
26851 "format": "int32",
26852 "type": "integer",
26853 "title": "Nullable<Int32>"
26854 },
26855 "postalSuburb": {
26856 "type": "string",
26857 "title": "String"
26858 },
26859 "postalState": {
26860 "type": "string",
26861 "title": "String"
26862 },
26863 "postalPostcode": {
26864 "type": "string",
26865 "title": "String"
26866 },
26867 "postalCountry": {
26868 "type": "string",
26869 "title": "String"
26870 },
26871 "email": {
26872 "type": "string",
26873 "title": "String"
26874 },
26875 "homePhone": {
26876 "type": "string",
26877 "title": "String"
26878 },
26879 "workPhone": {
26880 "type": "string",
26881 "title": "String"
26882 },
26883 "mobilePhone": {
26884 "type": "string",
26885 "title": "String"
26886 },
26887 "startDate": {
26888 "format": "date-time",
26889 "type": "string",
26890 "title": "Nullable<DateTime>"
26891 },
26892 "endDate": {
26893 "format": "date-time",
26894 "type": "string",
26895 "title": "Nullable<DateTime>"
26896 },
26897 "isTerminated": {
26898 "type": "boolean",
26899 "title": "Boolean"
26900 },
26901 "externalReferenceId": {
26902 "type": "string",
26903 "title": "String"
26904 },
26905 "source": {
26906 "format": "int32",
26907 "type": "integer",
26908 "title": "Int32"
26909 },
26910 "isPostalAddressSameAsResidential": {
26911 "type": "boolean",
26912 "title": "Boolean"
26913 },
26914 "titles": {
26915 "type": "array",
26916 "items": {
26917 "$ref": "#/definitions/TitleViewModel"
26918 },
26919 "xml": {
26920 "name": "TitleViewModel",
26921 "wrapped": true
26922 },
26923 "title": "IList<TitleViewModel>"
26924 },
26925 "editMode": {
26926 "enum": [
26927 "EmployeePortal",
26928 "EmployeePortalReadOnly",
26929 "BusinessPortal"
26930 ],
26931 "type": "string",
26932 "title": "EmployeeDetailsEditMode"
26933 },
26934 "canEdit": {
26935 "type": "boolean",
26936 "readOnly": true,
26937 "title": "Boolean"
26938 },
26939 "tagsString": {
26940 "type": "string",
26941 "title": "String"
26942 },
26943 "allTags": {
26944 "type": "array",
26945 "items": {
26946 "type": "string",
26947 "title": "String"
26948 },
26949 "title": "IList<String>"
26950 },
26951 "timesheetSetting": {
26952 "enum": [
26953 "Disabled",
26954 "Enabled",
26955 "EnabledForExceptions"
26956 ],
26957 "type": "string",
26958 "title": "EmployeeTimesheetSetting"
26959 },
26960 "canDelete": {
26961 "type": "boolean",
26962 "title": "Boolean"
26963 },
26964 "hasProfileImage": {
26965 "type": "boolean",
26966 "title": "Boolean"
26967 },
26968 "canEditProfileImage": {
26969 "type": "boolean",
26970 "title": "Boolean"
26971 },
26972 "bouncedEmail": {
26973 "type": "boolean",
26974 "title": "Boolean"
26975 }
26976 },
26977 "xml": {
26978 "name": "EssEmployeeDetailsModel"
26979 },
26980 "title": "EssEmployeeDetailsModel"
26981 },
26982 "TitleViewModel": {
26983 "type": "object",
26984 "properties": {
26985 "id": {
26986 "format": "int32",
26987 "type": "integer",
26988 "title": "Int32"
26989 },
26990 "description": {
26991 "type": "string",
26992 "title": "String"
26993 }
26994 },
26995 "xml": {
26996 "name": "TitleViewModel"
26997 },
26998 "title": "TitleViewModel"
26999 },
27000 "EmployeePartialEditModel": {
27001 "required": [
27002 "firstName",
27003 "surname",
27004 "startDate"
27005 ],
27006 "type": "object",
27007 "properties": {
27008 "titleId": {
27009 "format": "int32",
27010 "type": "integer",
27011 "title": "Nullable<Int32>"
27012 },
27013 "firstName": {
27014 "maxLength": 50,
27015 "minLength": 0,
27016 "type": "string",
27017 "title": "String"
27018 },
27019 "otherName": {
27020 "maxLength": 50,
27021 "minLength": 0,
27022 "type": "string",
27023 "title": "String"
27024 },
27025 "middleName": {
27026 "maxLength": 50,
27027 "minLength": 0,
27028 "type": "string",
27029 "title": "String"
27030 },
27031 "surname": {
27032 "maxLength": 50,
27033 "minLength": 0,
27034 "type": "string",
27035 "title": "String"
27036 },
27037 "dateOfBirth": {
27038 "format": "date-time",
27039 "type": "string",
27040 "title": "Nullable<DateTime>"
27041 },
27042 "anniversaryDate": {
27043 "format": "date-time",
27044 "type": "string",
27045 "title": "Nullable<DateTime>"
27046 },
27047 "gender": {
27048 "type": "string",
27049 "title": "String"
27050 },
27051 "externalId": {
27052 "type": "string",
27053 "title": "String"
27054 },
27055 "residentialStreetAddress": {
27056 "maxLength": 100,
27057 "minLength": 0,
27058 "type": "string",
27059 "title": "String"
27060 },
27061 "residentialAddressLine2": {
27062 "type": "string",
27063 "title": "String"
27064 },
27065 "residentialSuburbId": {
27066 "format": "int32",
27067 "type": "integer",
27068 "title": "Nullable<Int32>"
27069 },
27070 "residentialSuburb": {
27071 "type": "string",
27072 "title": "String"
27073 },
27074 "residentialState": {
27075 "type": "string",
27076 "title": "String"
27077 },
27078 "residentialPostcode": {
27079 "type": "string",
27080 "title": "String"
27081 },
27082 "residentialCountry": {
27083 "type": "string",
27084 "title": "String"
27085 },
27086 "postalStreetAddress": {
27087 "maxLength": 100,
27088 "minLength": 0,
27089 "type": "string",
27090 "title": "String"
27091 },
27092 "postalAddressLine2": {
27093 "type": "string",
27094 "title": "String"
27095 },
27096 "postalSuburb": {
27097 "type": "string",
27098 "title": "String"
27099 },
27100 "postalState": {
27101 "type": "string",
27102 "title": "String"
27103 },
27104 "postalPostcode": {
27105 "type": "string",
27106 "title": "String"
27107 },
27108 "postalCountry": {
27109 "type": "string",
27110 "title": "String"
27111 },
27112 "postalSuburbId": {
27113 "format": "int32",
27114 "type": "integer",
27115 "title": "Nullable<Int32>"
27116 },
27117 "email": {
27118 "maxLength": 100,
27119 "minLength": 0,
27120 "type": "string",
27121 "title": "String"
27122 },
27123 "homePhone": {
27124 "maxLength": 50,
27125 "minLength": 0,
27126 "type": "string",
27127 "title": "String"
27128 },
27129 "workPhone": {
27130 "maxLength": 50,
27131 "minLength": 0,
27132 "type": "string",
27133 "title": "String"
27134 },
27135 "mobilePhone": {
27136 "maxLength": 50,
27137 "minLength": 0,
27138 "type": "string",
27139 "title": "String"
27140 },
27141 "startDate": {
27142 "format": "date-time",
27143 "type": "string",
27144 "title": "Nullable<DateTime>"
27145 },
27146 "endDate": {
27147 "format": "date-time",
27148 "type": "string",
27149 "title": "Nullable<DateTime>"
27150 },
27151 "businessId": {
27152 "format": "int32",
27153 "type": "integer",
27154 "title": "Int32"
27155 },
27156 "taxFileNumber": {
27157 "type": "string",
27158 "title": "String"
27159 },
27160 "taxFileNumberMasked": {
27161 "type": "string",
27162 "title": "String"
27163 },
27164 "isPostalAddressSameAsResidential": {
27165 "type": "boolean",
27166 "title": "Boolean"
27167 },
27168 "bankAccounts": {
27169 "type": "array",
27170 "items": {
27171 "$ref": "#/definitions/BankAccountEditModel"
27172 },
27173 "xml": {
27174 "name": "BankAccountEditModel",
27175 "wrapped": true
27176 },
27177 "title": "IList<BankAccountEditModel>"
27178 },
27179 "externalReferenceId": {
27180 "type": "string",
27181 "title": "String"
27182 },
27183 "source": {
27184 "enum": [
27185 "None",
27186 "Saasu",
27187 "Xero",
27188 "MYOB",
27189 "Deputy",
27190 "EmployeeTimePunch",
27191 "ClickSuper",
27192 "IntegratedTimesheets",
27193 "FileImport",
27194 "FileExport",
27195 "QuickBooks",
27196 "Harmony",
27197 "AwardStore",
27198 "Attache",
27199 "IntegratedRostering",
27200 "ReckonAccounts",
27201 "API",
27202 "MicroPower",
27203 "RosterLive",
27204 "NetSuite",
27205 "Kounta",
27206 "TimeAndAttendanceKiosk",
27207 "DetailedFileExport",
27208 "JonasPremier",
27209 "WageEasy",
27210 "Maestrano",
27211 "WorkZone",
27212 "EmployeePortal",
27213 "RosterTemplate",
27214 "Onboarding",
27215 "Admin",
27216 "WorkZoneClockOnOff"
27217 ],
27218 "type": "string",
27219 "title": "ExternalService"
27220 },
27221 "tagsString": {
27222 "type": "string",
27223 "title": "String"
27224 },
27225 "timesheetSetting": {
27226 "enum": [
27227 "Disabled",
27228 "Enabled",
27229 "EnabledForExceptions"
27230 ],
27231 "type": "string",
27232 "title": "EmployeeTimesheetSetting"
27233 }
27234 },
27235 "xml": {
27236 "name": "EmployeePartialEditModel"
27237 },
27238 "title": "EmployeePartialEditModel"
27239 },
27240 "BankAccountEditModel": {
27241 "type": "object",
27242 "properties": {
27243 "id": {
27244 "format": "int32",
27245 "type": "integer",
27246 "title": "Int32"
27247 },
27248 "bsb": {
27249 "type": "string",
27250 "title": "String"
27251 },
27252 "accountName": {
27253 "type": "string",
27254 "title": "String"
27255 },
27256 "accountNumber": {
27257 "type": "string",
27258 "title": "String"
27259 },
27260 "allocatedPercentage": {
27261 "format": "double",
27262 "type": "number",
27263 "title": "Nullable<Decimal>"
27264 },
27265 "fixedAmount": {
27266 "format": "double",
27267 "type": "number",
27268 "title": "Nullable<Decimal>"
27269 },
27270 "externalReferenceId": {
27271 "type": "string",
27272 "title": "String"
27273 },
27274 "source": {
27275 "enum": [
27276 "None",
27277 "Saasu",
27278 "Xero",
27279 "MYOB",
27280 "Deputy",
27281 "EmployeeTimePunch",
27282 "ClickSuper",
27283 "IntegratedTimesheets",
27284 "FileImport",
27285 "FileExport",
27286 "QuickBooks",
27287 "Harmony",
27288 "AwardStore",
27289 "Attache",
27290 "IntegratedRostering",
27291 "ReckonAccounts",
27292 "API",
27293 "MicroPower",
27294 "RosterLive",
27295 "NetSuite",
27296 "Kounta",
27297 "TimeAndAttendanceKiosk",
27298 "DetailedFileExport",
27299 "JonasPremier",
27300 "WageEasy",
27301 "Maestrano",
27302 "WorkZone",
27303 "EmployeePortal",
27304 "RosterTemplate",
27305 "Onboarding",
27306 "Admin",
27307 "WorkZoneClockOnOff"
27308 ],
27309 "type": "string",
27310 "title": "ExternalService"
27311 },
27312 "allocateBalance": {
27313 "type": "boolean",
27314 "title": "Boolean"
27315 },
27316 "isEmployeeEditable": {
27317 "type": "boolean",
27318 "title": "Boolean"
27319 },
27320 "canBeDeleted": {
27321 "type": "boolean",
27322 "title": "Boolean"
27323 },
27324 "accountType": {
27325 "enum": [
27326 "Electronic",
27327 "ManualDeposit",
27328 "CashOrCheque",
27329 "Bpay"
27330 ],
27331 "type": "string",
27332 "title": "BankAccountTypeEnum"
27333 }
27334 },
27335 "xml": {
27336 "name": "BankAccountEditModel"
27337 },
27338 "title": "BankAccountEditModel"
27339 },
27340 "EmployeeEmergencyContactsEditModel": {
27341 "type": "object",
27342 "properties": {
27343 "primaryEmergencyContact": {
27344 "$ref": "#/definitions/EmergencyContactEditModel"
27345 },
27346 "secondaryEmergencyContact": {
27347 "$ref": "#/definitions/EmergencyContactEditModel"
27348 },
27349 "canEdit": {
27350 "type": "boolean",
27351 "title": "Boolean"
27352 }
27353 },
27354 "xml": {
27355 "name": "EmployeeEmergencyContactsEditModel"
27356 },
27357 "title": "EmployeeEmergencyContactsEditModel"
27358 },
27359 "EmergencyContactEditModel": {
27360 "type": "object",
27361 "properties": {
27362 "id": {
27363 "format": "int32",
27364 "type": "integer",
27365 "title": "Int32"
27366 },
27367 "name": {
27368 "type": "string",
27369 "title": "String"
27370 },
27371 "relationship": {
27372 "type": "string",
27373 "title": "String"
27374 },
27375 "address": {
27376 "type": "string",
27377 "title": "String"
27378 },
27379 "contactNumber": {
27380 "type": "string",
27381 "title": "String"
27382 },
27383 "alternateContactNumber": {
27384 "type": "string",
27385 "title": "String"
27386 }
27387 },
27388 "xml": {
27389 "name": "EmergencyContactEditModel"
27390 },
27391 "title": "EmergencyContactEditModel"
27392 },
27393 "FeaturesModel": {
27394 "type": "object",
27395 "properties": {
27396 "allowEmployeeLeaveSelfService": {
27397 "type": "boolean",
27398 "title": "Boolean"
27399 },
27400 "allowEmployeeSelfEditing": {
27401 "type": "boolean",
27402 "title": "Boolean"
27403 },
27404 "allowEmployeeTimesheetsSelfService": {
27405 "type": "boolean",
27406 "title": "Boolean"
27407 },
27408 "allowEmployeeToSetUnavailability": {
27409 "type": "boolean",
27410 "title": "Boolean"
27411 },
27412 "allowEmployeeToDeclineShifts": {
27413 "type": "boolean",
27414 "title": "Boolean"
27415 },
27416 "allowEmployeeSuperFundSelfService": {
27417 "type": "boolean",
27418 "title": "Boolean"
27419 },
27420 "allowEmployeeBankAccountSelfService": {
27421 "type": "boolean",
27422 "title": "Boolean"
27423 },
27424 "allowEmployeeSatisfactionSurvey": {
27425 "type": "boolean",
27426 "title": "Boolean"
27427 },
27428 "allowEmployeesToViewAllApprovedLeave": {
27429 "type": "boolean",
27430 "title": "Boolean"
27431 },
27432 "unavailabilityCutOff": {
27433 "format": "int32",
27434 "type": "integer",
27435 "title": "Int32"
27436 },
27437 "allowEmployeesToUploadProfilePicture": {
27438 "type": "boolean",
27439 "title": "Boolean"
27440 },
27441 "allowEmployeeRosteringSelfService": {
27442 "type": "boolean",
27443 "title": "Boolean"
27444 },
27445 "allowEmployeeExpensesSelfService": {
27446 "type": "boolean",
27447 "title": "Boolean"
27448 },
27449 "allowEmployeeOverrideTaxCodes": {
27450 "type": "boolean",
27451 "title": "Boolean"
27452 },
27453 "allowEmployeesToEditKioskTimesheets": {
27454 "type": "boolean",
27455 "title": "Boolean"
27456 },
27457 "essTimesheetSetting": {
27458 "enum": [
27459 "Disabled",
27460 "ReadOnly",
27461 "ReadWrite",
27462 "EditKiosk",
27463 "EditWorkZoneClockOnOff"
27464 ],
27465 "type": "string",
27466 "title": "ESSTimesheetSetting"
27467 },
27468 "employeeMustAcceptShifts": {
27469 "type": "boolean",
27470 "title": "Boolean"
27471 },
27472 "allowEmployeeTimesheetsWithoutStartStopTimes": {
27473 "type": "boolean",
27474 "title": "Boolean"
27475 },
27476 "allowEmployeeToSwapShifts": {
27477 "type": "boolean",
27478 "title": "Boolean"
27479 },
27480 "clockOnCanSpecifyHigherClassification": {
27481 "type": "boolean",
27482 "title": "Boolean"
27483 },
27484 "clockOnRequirePhoto": {
27485 "type": "boolean",
27486 "title": "Boolean"
27487 },
27488 "clockOnAllowEmployeeShiftSelection": {
27489 "type": "boolean",
27490 "title": "Boolean"
27491 },
27492 "clockOnWindowMinutes": {
27493 "format": "int32",
27494 "type": "integer",
27495 "title": "Nullable<Int32>"
27496 },
27497 "clockOffWindowMinutes": {
27498 "format": "int32",
27499 "type": "integer",
27500 "title": "Nullable<Int32>"
27501 },
27502 "timesheetsRequireLocation": {
27503 "type": "boolean",
27504 "title": "Boolean"
27505 },
27506 "timesheetsRequireWorkType": {
27507 "type": "boolean",
27508 "title": "Boolean"
27509 },
27510 "enableWorkZoneClockOn": {
27511 "type": "boolean",
27512 "title": "Boolean"
27513 }
27514 },
27515 "xml": {
27516 "name": "FeaturesModel"
27517 },
27518 "title": "FeaturesModel"
27519 },
27520 "DashboardModel": {
27521 "type": "object",
27522 "properties": {
27523 "latestPayslip": {
27524 "$ref": "#/definitions/EssPayslipModel"
27525 },
27526 "nextShift": {
27527 "$ref": "#/definitions/EssRosterShiftModel"
27528 },
27529 "leaveBalances": {
27530 "type": "array",
27531 "items": {
27532 "$ref": "#/definitions/LeaveBalanceModel"
27533 },
27534 "xml": {
27535 "name": "LeaveBalanceModel",
27536 "wrapped": true
27537 },
27538 "title": "IList<LeaveBalanceModel>"
27539 },
27540 "features": {
27541 "$ref": "#/definitions/FeaturesModel"
27542 },
27543 "titles": {
27544 "type": "array",
27545 "items": {
27546 "$ref": "#/definitions/TitleViewModel"
27547 },
27548 "xml": {
27549 "name": "TitleViewModel",
27550 "wrapped": true
27551 },
27552 "title": "List<TitleViewModel>"
27553 },
27554 "workTypes": {
27555 "type": "array",
27556 "items": {
27557 "$ref": "#/definitions/EssWorkTypeModel"
27558 },
27559 "xml": {
27560 "name": "EssWorkTypeModel",
27561 "wrapped": true
27562 },
27563 "title": "List<EssWorkTypeModel>"
27564 },
27565 "shiftConditions": {
27566 "type": "array",
27567 "items": {
27568 "$ref": "#/definitions/EssWorkTypeModel"
27569 },
27570 "xml": {
27571 "name": "EssWorkTypeModel",
27572 "wrapped": true
27573 },
27574 "title": "List<EssWorkTypeModel>"
27575 },
27576 "locations": {
27577 "type": "array",
27578 "items": {
27579 "$ref": "#/definitions/LocationModel"
27580 },
27581 "xml": {
27582 "name": "LocationModel",
27583 "wrapped": true
27584 },
27585 "title": "List<LocationModel>"
27586 },
27587 "classifications": {
27588 "type": "array",
27589 "items": {
27590 "$ref": "#/definitions/ClassificationSelectModel"
27591 },
27592 "readOnly": true,
27593 "xml": {
27594 "name": "ClassificationSelectModel",
27595 "wrapped": true
27596 },
27597 "title": "IList<ClassificationSelectModel>"
27598 },
27599 "leaveCategories": {
27600 "type": "array",
27601 "items": {
27602 "$ref": "#/definitions/EssLeaveCategoryModel"
27603 },
27604 "xml": {
27605 "name": "EssLeaveCategoryModel",
27606 "wrapped": true
27607 },
27608 "title": "IList<EssLeaveCategoryModel>"
27609 },
27610 "currentWeekSatisfactionSurvey": {
27611 "$ref": "#/definitions/EssSatisfactionSurvey"
27612 },
27613 "timesheets": {
27614 "$ref": "#/definitions/EssCurrentTimesheetsModel"
27615 },
27616 "timesheetEntryPeriodEnd": {
27617 "format": "date-time",
27618 "type": "string",
27619 "title": "DateTime"
27620 },
27621 "expenseCategories": {
27622 "type": "array",
27623 "items": {
27624 "$ref": "#/definitions/ExpenseCategoryResponseModel"
27625 },
27626 "xml": {
27627 "name": "ExpenseCategoryResponseModel",
27628 "wrapped": true
27629 },
27630 "title": "IList<ExpenseCategoryResponseModel>"
27631 },
27632 "taxCodes": {
27633 "type": "array",
27634 "items": {
27635 "$ref": "#/definitions/JournalServiceTaxCode"
27636 },
27637 "xml": {
27638 "name": "JournalServiceTaxCode",
27639 "wrapped": true
27640 },
27641 "title": "IList<JournalServiceTaxCode>"
27642 },
27643 "expenses": {
27644 "$ref": "#/definitions/EssCurrentExpensesModel"
27645 },
27646 "pendingShiftCount": {
27647 "format": "int32",
27648 "type": "integer",
27649 "title": "Int32"
27650 },
27651 "proposedSwapCount": {
27652 "format": "int32",
27653 "type": "integer",
27654 "title": "Int32"
27655 },
27656 "currentShift": {
27657 "$ref": "#/definitions/EssCurrentShiftModel"
27658 }
27659 },
27660 "xml": {
27661 "name": "DashboardModel"
27662 },
27663 "title": "DashboardModel"
27664 },
27665 "EssPayslipModel": {
27666 "type": "object",
27667 "properties": {
27668 "id": {
27669 "format": "int32",
27670 "type": "integer",
27671 "title": "Int32"
27672 },
27673 "employeeId": {
27674 "format": "int32",
27675 "type": "integer",
27676 "title": "Int32"
27677 },
27678 "paySchedule": {
27679 "type": "string",
27680 "title": "String"
27681 },
27682 "datePaid": {
27683 "format": "date-time",
27684 "type": "string",
27685 "title": "DateTime"
27686 },
27687 "payPeriodStart": {
27688 "format": "date-time",
27689 "type": "string",
27690 "title": "DateTime"
27691 },
27692 "payPeriodEnd": {
27693 "format": "date-time",
27694 "type": "string",
27695 "title": "DateTime"
27696 },
27697 "netPay": {
27698 "format": "double",
27699 "type": "number",
27700 "title": "Decimal"
27701 },
27702 "payerName": {
27703 "type": "string",
27704 "title": "String"
27705 },
27706 "payerAbn": {
27707 "type": "string",
27708 "title": "String"
27709 }
27710 },
27711 "xml": {
27712 "name": "EssPayslipModel"
27713 },
27714 "title": "EssPayslipModel"
27715 },
27716 "EssRosterShiftModel": {
27717 "type": "object",
27718 "properties": {
27719 "id": {
27720 "format": "int32",
27721 "type": "integer",
27722 "title": "Int32"
27723 },
27724 "token": {
27725 "type": "string",
27726 "title": "String"
27727 },
27728 "qualifications": {
27729 "type": "array",
27730 "items": {
27731 "$ref": "#/definitions/EssQualificationModel"
27732 },
27733 "xml": {
27734 "name": "EssQualificationModel",
27735 "wrapped": true
27736 },
27737 "title": "IList<EssQualificationModel>"
27738 },
27739 "breaks": {
27740 "type": "array",
27741 "items": {
27742 "$ref": "#/definitions/EssRosterShiftBreakModel"
27743 },
27744 "xml": {
27745 "name": "EssRosterShiftBreakModel",
27746 "wrapped": true
27747 },
27748 "title": "IList<EssRosterShiftBreakModel>"
27749 },
27750 "employeeId": {
27751 "format": "int32",
27752 "type": "integer",
27753 "title": "Nullable<Int32>"
27754 },
27755 "employeeName": {
27756 "type": "string",
27757 "title": "String"
27758 },
27759 "locationId": {
27760 "format": "int32",
27761 "type": "integer",
27762 "title": "Nullable<Int32>"
27763 },
27764 "locationName": {
27765 "type": "string",
27766 "title": "String"
27767 },
27768 "classificationId": {
27769 "format": "int32",
27770 "type": "integer",
27771 "title": "Nullable<Int32>"
27772 },
27773 "classificationName": {
27774 "type": "string",
27775 "title": "String"
27776 },
27777 "workTypeId": {
27778 "format": "int32",
27779 "type": "integer",
27780 "title": "Nullable<Int32>"
27781 },
27782 "workTypeName": {
27783 "type": "string",
27784 "title": "String"
27785 },
27786 "startTime": {
27787 "format": "date-time",
27788 "type": "string",
27789 "title": "DateTime"
27790 },
27791 "endTime": {
27792 "format": "date-time",
27793 "type": "string",
27794 "title": "DateTime"
27795 },
27796 "notes": {
27797 "type": "string",
27798 "title": "String"
27799 },
27800 "published": {
27801 "type": "boolean",
27802 "title": "Boolean"
27803 },
27804 "accepted": {
27805 "type": "boolean",
27806 "title": "Boolean"
27807 },
27808 "pendingSwap": {
27809 "$ref": "#/definitions/EssRosterShiftSwapModel"
27810 },
27811 "datePublished": {
27812 "format": "date-time",
27813 "type": "string",
27814 "title": "Nullable<DateTime>"
27815 }
27816 },
27817 "xml": {
27818 "name": "EssRosterShiftModel"
27819 },
27820 "title": "EssRosterShiftModel"
27821 },
27822 "EssWorkTypeModel": {
27823 "type": "object",
27824 "properties": {
27825 "isUnitBasedWorkType": {
27826 "type": "boolean",
27827 "title": "Boolean"
27828 },
27829 "unitType": {
27830 "type": "string",
27831 "title": "String"
27832 },
27833 "id": {
27834 "format": "int32",
27835 "type": "integer",
27836 "title": "Int32"
27837 },
27838 "name": {
27839 "type": "string",
27840 "title": "String"
27841 },
27842 "payCategoryId": {
27843 "format": "int32",
27844 "type": "integer",
27845 "title": "Nullable<Int32>"
27846 },
27847 "leaveCategoryId": {
27848 "format": "int32",
27849 "type": "integer",
27850 "title": "Nullable<Int32>"
27851 },
27852 "externalId": {
27853 "type": "string",
27854 "title": "String"
27855 },
27856 "source": {
27857 "type": "string",
27858 "title": "String"
27859 },
27860 "accruesLeave": {
27861 "type": "boolean",
27862 "title": "Boolean"
27863 },
27864 "employmentTypes": {
27865 "type": "array",
27866 "items": {
27867 "enum": [
27868 "Unknown",
27869 "FullTime",
27870 "PartTime",
27871 "LabourHire",
27872 "SuperannuationIncomeStream",
27873 "Casual"
27874 ],
27875 "type": "string",
27876 "title": "EmploymentTypeEnum"
27877 },
27878 "xml": {
27879 "name": "EmploymentTypeEnum",
27880 "wrapped": true
27881 },
27882 "title": "IList<EmploymentTypeEnum>"
27883 },
27884 "mappingType": {
27885 "enum": [
27886 "PayCategory",
27887 "LeaveCategory",
27888 "PrimaryPayCategory",
27889 "ShiftCondition"
27890 ],
27891 "type": "string",
27892 "title": "Nullable<WorkTypeMappingType>"
27893 },
27894 "shortCode": {
27895 "type": "string",
27896 "title": "String"
27897 }
27898 },
27899 "xml": {
27900 "name": "EssWorkTypeModel"
27901 },
27902 "title": "EssWorkTypeModel"
27903 },
27904 "LocationModel": {
27905 "type": "object",
27906 "properties": {
27907 "id": {
27908 "format": "int32",
27909 "type": "integer",
27910 "title": "Int32"
27911 },
27912 "parentId": {
27913 "format": "int32",
27914 "type": "integer",
27915 "title": "Nullable<Int32>"
27916 },
27917 "name": {
27918 "type": "string",
27919 "title": "String"
27920 },
27921 "externalId": {
27922 "type": "string",
27923 "title": "String"
27924 },
27925 "source": {
27926 "type": "string",
27927 "title": "String"
27928 },
27929 "fullyQualifiedName": {
27930 "type": "string",
27931 "title": "String"
27932 },
27933 "state": {
27934 "type": "string",
27935 "title": "String"
27936 },
27937 "isGlobal": {
27938 "type": "boolean",
27939 "title": "Boolean"
27940 },
27941 "isRollupReportingLocation": {
27942 "type": "boolean",
27943 "title": "Boolean"
27944 },
27945 "generalLedgerMappingCode": {
27946 "type": "string",
27947 "title": "String"
27948 },
27949 "defaultShiftConditionIds": {
27950 "type": "array",
27951 "items": {
27952 "format": "int32",
27953 "type": "integer",
27954 "title": "Int32"
27955 },
27956 "title": "IList<Int32>"
27957 }
27958 },
27959 "xml": {
27960 "name": "LocationModel"
27961 },
27962 "title": "LocationModel"
27963 },
27964 "ClassificationSelectModel": {
27965 "type": "object",
27966 "properties": {
27967 "name": {
27968 "type": "string",
27969 "title": "String"
27970 },
27971 "id": {
27972 "format": "int32",
27973 "type": "integer",
27974 "title": "Int32"
27975 }
27976 },
27977 "xml": {
27978 "name": "ClassificationSelectModel"
27979 },
27980 "title": "ClassificationSelectModel"
27981 },
27982 "EssSatisfactionSurvey": {
27983 "type": "object",
27984 "properties": {
27985 "value": {
27986 "enum": [
27987 "NotSet",
27988 "Happy",
27989 "Neutral",
27990 "Sad"
27991 ],
27992 "type": "string",
27993 "title": "EmployeeSatisfactionValue"
27994 },
27995 "weekStartDate": {
27996 "format": "date-time",
27997 "type": "string",
27998 "title": "DateTime"
27999 }
28000 },
28001 "xml": {
28002 "name": "EssSatisfactionSurvey"
28003 },
28004 "title": "EssSatisfactionSurvey"
28005 },
28006 "EssCurrentTimesheetsModel": {
28007 "type": "object",
28008 "properties": {
28009 "periodStarting": {
28010 "format": "date-time",
28011 "type": "string",
28012 "title": "DateTime"
28013 },
28014 "periodEnding": {
28015 "format": "date-time",
28016 "type": "string",
28017 "title": "DateTime"
28018 },
28019 "submittedCount": {
28020 "format": "int32",
28021 "type": "integer",
28022 "title": "Int32"
28023 },
28024 "approvedCount": {
28025 "format": "int32",
28026 "type": "integer",
28027 "title": "Int32"
28028 },
28029 "rejectedCount": {
28030 "format": "int32",
28031 "type": "integer",
28032 "title": "Int32"
28033 },
28034 "processedCount": {
28035 "format": "int32",
28036 "type": "integer",
28037 "title": "Int32"
28038 },
28039 "durationInMinutes": {
28040 "format": "double",
28041 "type": "number",
28042 "title": "Decimal"
28043 }
28044 },
28045 "xml": {
28046 "name": "EssCurrentTimesheetsModel"
28047 },
28048 "title": "EssCurrentTimesheetsModel"
28049 },
28050 "ExpenseCategoryResponseModel": {
28051 "type": "object",
28052 "properties": {
28053 "id": {
28054 "format": "int32",
28055 "type": "integer",
28056 "title": "Int32"
28057 },
28058 "name": {
28059 "type": "string",
28060 "title": "String"
28061 },
28062 "externalTaxCodeId": {
28063 "type": "string",
28064 "title": "String"
28065 },
28066 "taxCode": {
28067 "type": "string",
28068 "title": "String"
28069 },
28070 "taxRate": {
28071 "format": "double",
28072 "type": "number",
28073 "title": "Nullable<Decimal>"
28074 }
28075 },
28076 "xml": {
28077 "name": "ExpenseCategoryResponseModel"
28078 },
28079 "title": "ExpenseCategoryResponseModel"
28080 },
28081 "EssCurrentExpensesModel": {
28082 "type": "object",
28083 "properties": {
28084 "periodStarting": {
28085 "format": "date-time",
28086 "type": "string",
28087 "title": "DateTime"
28088 },
28089 "periodEnding": {
28090 "format": "date-time",
28091 "type": "string",
28092 "title": "DateTime"
28093 },
28094 "submittedCount": {
28095 "format": "int32",
28096 "type": "integer",
28097 "title": "Int32"
28098 },
28099 "approvedCount": {
28100 "format": "int32",
28101 "type": "integer",
28102 "title": "Int32"
28103 },
28104 "rejectedCount": {
28105 "format": "int32",
28106 "type": "integer",
28107 "title": "Int32"
28108 },
28109 "processedCount": {
28110 "format": "int32",
28111 "type": "integer",
28112 "title": "Int32"
28113 }
28114 },
28115 "xml": {
28116 "name": "EssCurrentExpensesModel"
28117 },
28118 "title": "EssCurrentExpensesModel"
28119 },
28120 "EssCurrentShiftModel": {
28121 "type": "object",
28122 "properties": {
28123 "shiftId": {
28124 "format": "int32",
28125 "type": "integer",
28126 "title": "Int32"
28127 },
28128 "clockOnTimeUtc": {
28129 "format": "date-time",
28130 "type": "string",
28131 "title": "Nullable<DateTime>"
28132 },
28133 "breakStartTimeUtc": {
28134 "format": "date-time",
28135 "type": "string",
28136 "title": "Nullable<DateTime>"
28137 },
28138 "status": {
28139 "enum": [
28140 "NotClockedOn",
28141 "ClockedOn",
28142 "OnBreak",
28143 "ClockedOff"
28144 ],
28145 "type": "string",
28146 "title": "TimeAttendanceStatus"
28147 },
28148 "longShift": {
28149 "type": "boolean",
28150 "title": "Boolean"
28151 }
28152 },
28153 "xml": {
28154 "name": "EssCurrentShiftModel"
28155 },
28156 "title": "EssCurrentShiftModel"
28157 },
28158 "EssQualificationModel": {
28159 "type": "object",
28160 "properties": {
28161 "id": {
28162 "format": "int32",
28163 "type": "integer",
28164 "title": "Int32"
28165 },
28166 "name": {
28167 "type": "string",
28168 "title": "String"
28169 }
28170 },
28171 "xml": {
28172 "name": "EssQualificationModel"
28173 },
28174 "title": "EssQualificationModel"
28175 },
28176 "EssRosterShiftBreakModel": {
28177 "type": "object",
28178 "properties": {
28179 "id": {
28180 "format": "int32",
28181 "type": "integer",
28182 "title": "Int32"
28183 },
28184 "startTime": {
28185 "format": "date-time",
28186 "type": "string",
28187 "title": "DateTime"
28188 },
28189 "endTime": {
28190 "format": "date-time",
28191 "type": "string",
28192 "title": "DateTime"
28193 }
28194 },
28195 "xml": {
28196 "name": "EssRosterShiftBreakModel"
28197 },
28198 "title": "EssRosterShiftBreakModel"
28199 },
28200 "EssRosterShiftSwapModel": {
28201 "type": "object",
28202 "properties": {
28203 "id": {
28204 "format": "int32",
28205 "type": "integer",
28206 "title": "Int32"
28207 },
28208 "fromEmployee": {
28209 "type": "string",
28210 "title": "String"
28211 },
28212 "toEmployee": {
28213 "type": "string",
28214 "title": "String"
28215 },
28216 "fromEmployeeId": {
28217 "format": "int32",
28218 "type": "integer",
28219 "title": "Int32"
28220 },
28221 "toEmployeeId": {
28222 "format": "int32",
28223 "type": "integer",
28224 "title": "Int32"
28225 },
28226 "dateCreated": {
28227 "format": "date-time",
28228 "type": "string",
28229 "title": "DateTime"
28230 },
28231 "note": {
28232 "type": "string",
28233 "title": "String"
28234 },
28235 "rejectedReason": {
28236 "type": "string",
28237 "title": "String"
28238 },
28239 "status": {
28240 "format": "int32",
28241 "type": "integer",
28242 "title": "Int32"
28243 },
28244 "statusDescription": {
28245 "type": "string",
28246 "title": "String"
28247 }
28248 },
28249 "xml": {
28250 "name": "EssRosterShiftSwapModel"
28251 },
28252 "title": "EssRosterShiftSwapModel"
28253 },
28254 "EmployeeTimesheetFilter": {
28255 "required": [
28256 "fromDate",
28257 "toDate"
28258 ],
28259 "type": "object",
28260 "properties": {
28261 "fromDate": {
28262 "format": "date-time",
28263 "type": "string",
28264 "title": "DateTime"
28265 },
28266 "toDate": {
28267 "format": "date-time",
28268 "type": "string",
28269 "title": "DateTime"
28270 }
28271 },
28272 "xml": {
28273 "name": "EmployeeTimesheetFilter"
28274 },
28275 "title": "EmployeeTimesheetFilter"
28276 },
28277 "EssTimesheetModel": {
28278 "type": "object",
28279 "properties": {
28280 "canDelete": {
28281 "type": "boolean",
28282 "readOnly": true,
28283 "title": "Boolean"
28284 },
28285 "canEdit": {
28286 "type": "boolean",
28287 "readOnly": true,
28288 "title": "Boolean"
28289 },
28290 "statusId": {
28291 "format": "int32",
28292 "type": "integer",
28293 "title": "Int32"
28294 },
28295 "employeeName": {
28296 "type": "string",
28297 "title": "String"
28298 },
28299 "id": {
28300 "format": "int32",
28301 "type": "integer",
28302 "title": "Int32"
28303 },
28304 "employeeId": {
28305 "format": "int32",
28306 "type": "integer",
28307 "title": "Int32"
28308 },
28309 "locationId": {
28310 "format": "int32",
28311 "type": "integer",
28312 "title": "Nullable<Int32>"
28313 },
28314 "workTypeId": {
28315 "format": "int32",
28316 "type": "integer",
28317 "title": "Nullable<Int32>"
28318 },
28319 "classificationId": {
28320 "format": "int32",
28321 "type": "integer",
28322 "title": "Nullable<Int32>"
28323 },
28324 "classificationName": {
28325 "type": "string",
28326 "title": "String"
28327 },
28328 "workTypeName": {
28329 "type": "string",
28330 "title": "String"
28331 },
28332 "locationName": {
28333 "type": "string",
28334 "title": "String"
28335 },
28336 "unitType": {
28337 "type": "string",
28338 "title": "String"
28339 },
28340 "isUnitBasedWorkType": {
28341 "type": "boolean",
28342 "title": "Boolean"
28343 },
28344 "payRunId": {
28345 "format": "int32",
28346 "type": "integer",
28347 "title": "Nullable<Int32>"
28348 },
28349 "start": {
28350 "format": "date-time",
28351 "type": "string",
28352 "title": "Nullable<DateTime>"
28353 },
28354 "end": {
28355 "format": "date-time",
28356 "type": "string",
28357 "title": "Nullable<DateTime>"
28358 },
28359 "submittedStart": {
28360 "format": "date-time",
28361 "type": "string",
28362 "title": "Nullable<DateTime>"
28363 },
28364 "submittedEnd": {
28365 "format": "date-time",
28366 "type": "string",
28367 "title": "Nullable<DateTime>"
28368 },
28369 "units": {
28370 "format": "double",
28371 "type": "number",
28372 "title": "Nullable<Decimal>"
28373 },
28374 "status": {
28375 "enum": [
28376 "Missing",
28377 "Submitted",
28378 "Approved",
28379 "Rejected",
28380 "Processed"
28381 ],
28382 "type": "string",
28383 "title": "TimesheetLineStatusType"
28384 },
28385 "paySlipUrl": {
28386 "type": "string",
28387 "title": "String"
28388 },
28389 "breaks": {
28390 "type": "array",
28391 "items": {
28392 "$ref": "#/definitions/TimesheetBreakViewModel"
28393 },
28394 "xml": {
28395 "name": "TimesheetBreakViewModel",
28396 "wrapped": true
28397 },
28398 "title": "IList<TimesheetBreakViewModel>"
28399 },
28400 "comments": {
28401 "type": "string",
28402 "title": "String"
28403 },
28404 "rate": {
28405 "format": "double",
28406 "type": "number",
28407 "title": "Nullable<Decimal>"
28408 },
28409 "externalReferenceId": {
28410 "type": "string",
28411 "title": "String"
28412 },
28413 "source": {
28414 "enum": [
28415 "None",
28416 "Saasu",
28417 "Xero",
28418 "MYOB",
28419 "Deputy",
28420 "EmployeeTimePunch",
28421 "ClickSuper",
28422 "IntegratedTimesheets",
28423 "FileImport",
28424 "FileExport",
28425 "QuickBooks",
28426 "Harmony",
28427 "AwardStore",
28428 "Attache",
28429 "IntegratedRostering",
28430 "ReckonAccounts",
28431 "API",
28432 "MicroPower",
28433 "RosterLive",
28434 "NetSuite",
28435 "Kounta",
28436 "TimeAndAttendanceKiosk",
28437 "DetailedFileExport",
28438 "JonasPremier",
28439 "WageEasy",
28440 "Maestrano",
28441 "WorkZone",
28442 "EmployeePortal",
28443 "RosterTemplate",
28444 "Onboarding",
28445 "Admin",
28446 "WorkZoneClockOnOff"
28447 ],
28448 "type": "string",
28449 "title": "ExternalService"
28450 },
28451 "payCategoryId": {
28452 "format": "int32",
28453 "type": "integer",
28454 "title": "Nullable<Int32>"
28455 },
28456 "leaveCategoryId": {
28457 "format": "int32",
28458 "type": "integer",
28459 "title": "Nullable<Int32>"
28460 },
28461 "leaveRequestId": {
28462 "format": "int32",
28463 "type": "integer",
28464 "title": "Nullable<Int32>"
28465 },
28466 "isLocked": {
28467 "type": "boolean",
28468 "title": "Boolean"
28469 },
28470 "cost": {
28471 "format": "double",
28472 "type": "number",
28473 "title": "Nullable<Decimal>"
28474 },
28475 "costingData": {
28476 "$ref": "#/definitions/ShiftCostingData"
28477 },
28478 "discard": {
28479 "type": "boolean",
28480 "title": "Boolean"
28481 },
28482 "attachment": {
28483 "$ref": "#/definitions/AttachmentModel"
28484 },
28485 "shiftConditionIds": {
28486 "type": "array",
28487 "items": {
28488 "format": "int32",
28489 "type": "integer",
28490 "title": "Int32"
28491 },
28492 "title": "IList<Int32>"
28493 },
28494 "isOverlapping": {
28495 "type": "boolean",
28496 "title": "Boolean"
28497 },
28498 "overdrawsLeave": {
28499 "type": "boolean",
28500 "title": "Boolean"
28501 },
28502 "reviewedBy": {
28503 "type": "string",
28504 "title": "String"
28505 },
28506 "durationOverride": {
28507 "type": "string",
28508 "title": "Nullable<TimeSpan>"
28509 },
28510 "workDurationInMinutes": {
28511 "format": "double",
28512 "type": "number",
28513 "readOnly": true,
28514 "title": "Double"
28515 },
28516 "breaksDurationInMinutes": {
28517 "format": "double",
28518 "type": "number",
28519 "readOnly": true,
28520 "title": "Double"
28521 },
28522 "totalDurationInMinutes": {
28523 "format": "double",
28524 "type": "number",
28525 "readOnly": true,
28526 "title": "Double"
28527 }
28528 },
28529 "xml": {
28530 "name": "EssTimesheetModel"
28531 },
28532 "title": "EssTimesheetModel"
28533 },
28534 "TimesheetBreakViewModel": {
28535 "type": "object",
28536 "properties": {
28537 "id": {
28538 "format": "int32",
28539 "type": "integer",
28540 "title": "Int32"
28541 },
28542 "start": {
28543 "format": "date-time",
28544 "type": "string",
28545 "title": "Nullable<DateTime>"
28546 },
28547 "end": {
28548 "format": "date-time",
28549 "type": "string",
28550 "title": "Nullable<DateTime>"
28551 },
28552 "submittedStart": {
28553 "format": "date-time",
28554 "type": "string",
28555 "title": "Nullable<DateTime>"
28556 },
28557 "submittedEnd": {
28558 "format": "date-time",
28559 "type": "string",
28560 "title": "Nullable<DateTime>"
28561 },
28562 "formattedStart": {
28563 "type": "string",
28564 "readOnly": true,
28565 "title": "String"
28566 },
28567 "formattedEnd": {
28568 "type": "string",
28569 "readOnly": true,
28570 "title": "String"
28571 }
28572 },
28573 "xml": {
28574 "name": "TimesheetBreakViewModel"
28575 },
28576 "title": "TimesheetBreakViewModel"
28577 },
28578 "ShiftCostingData": {
28579 "type": "object",
28580 "properties": {
28581 "shiftParts": {
28582 "type": "array",
28583 "items": {
28584 "$ref": "#/definitions/ShiftPartModel"
28585 },
28586 "xml": {
28587 "name": "ShiftPartModel",
28588 "wrapped": true
28589 },
28590 "title": "IList<ShiftPartModel>"
28591 },
28592 "allowances": {
28593 "type": "array",
28594 "items": {
28595 "$ref": "#/definitions/ShiftAllowanceModel"
28596 },
28597 "xml": {
28598 "name": "ShiftAllowanceModel",
28599 "wrapped": true
28600 },
28601 "title": "IList<ShiftAllowanceModel>"
28602 },
28603 "liabilities": {
28604 "type": "array",
28605 "items": {
28606 "$ref": "#/definitions/ShiftLiabilityModel"
28607 },
28608 "xml": {
28609 "name": "ShiftLiabilityModel",
28610 "wrapped": true
28611 },
28612 "title": "IList<ShiftLiabilityModel>"
28613 },
28614 "isConsolidated": {
28615 "type": "boolean",
28616 "title": "Boolean"
28617 }
28618 },
28619 "xml": {
28620 "name": "ShiftCostingData"
28621 },
28622 "title": "ShiftCostingData"
28623 },
28624 "ShiftPartModel": {
28625 "type": "object",
28626 "properties": {
28627 "isBreak": {
28628 "type": "boolean",
28629 "title": "Boolean"
28630 },
28631 "startTime": {
28632 "format": "date-time",
28633 "type": "string",
28634 "title": "DateTime"
28635 },
28636 "endTime": {
28637 "format": "date-time",
28638 "type": "string",
28639 "title": "DateTime"
28640 },
28641 "effectiveDuration": {
28642 "type": "string",
28643 "title": "TimeSpan"
28644 },
28645 "actualDuration": {
28646 "type": "string",
28647 "title": "TimeSpan"
28648 },
28649 "payCategory": {
28650 "type": "string",
28651 "title": "String"
28652 },
28653 "payCategoryId": {
28654 "format": "int32",
28655 "type": "integer",
28656 "title": "Int32"
28657 },
28658 "cost": {
28659 "format": "double",
28660 "type": "number",
28661 "title": "Decimal"
28662 },
28663 "rateMultiplier": {
28664 "format": "double",
28665 "type": "number",
28666 "title": "Nullable<Decimal>"
28667 },
28668 "baseRate": {
28669 "format": "double",
28670 "type": "number",
28671 "title": "Decimal"
28672 },
28673 "calculatedRate": {
28674 "format": "double",
28675 "type": "number",
28676 "title": "Decimal"
28677 },
28678 "displayDuration": {
28679 "type": "string",
28680 "readOnly": true,
28681 "title": "String"
28682 },
28683 "workType": {
28684 "$ref": "#/definitions/NominalWorkType"
28685 },
28686 "classification": {
28687 "$ref": "#/definitions/NominalClassification"
28688 },
28689 "leaveCategory": {
28690 "$ref": "#/definitions/NominalLeaveCategory"
28691 }
28692 },
28693 "xml": {
28694 "name": "ShiftPartModel"
28695 },
28696 "title": "ShiftPartModel"
28697 },
28698 "ShiftAllowanceModel": {
28699 "type": "object",
28700 "properties": {
28701 "payCategory": {
28702 "type": "string",
28703 "title": "String"
28704 },
28705 "payCategoryId": {
28706 "format": "int32",
28707 "type": "integer",
28708 "title": "Int32"
28709 },
28710 "units": {
28711 "format": "double",
28712 "type": "number",
28713 "title": "Decimal"
28714 },
28715 "cost": {
28716 "format": "double",
28717 "type": "number",
28718 "title": "Decimal"
28719 },
28720 "rateMultiplier": {
28721 "format": "double",
28722 "type": "number",
28723 "title": "Decimal"
28724 },
28725 "option": {
28726 "enum": [
28727 "Fixed",
28728 "PerHourWorked",
28729 "PercentageOfShiftCost",
28730 "PerShiftUnit"
28731 ],
28732 "type": "string",
28733 "title": "ShiftAllowanceOption"
28734 },
28735 "type": {
28736 "enum": [
28737 "Standard",
28738 "AllPurpose"
28739 ],
28740 "type": "string",
28741 "title": "ShiftAllowanceType"
28742 }
28743 },
28744 "xml": {
28745 "name": "ShiftAllowanceModel"
28746 },
28747 "title": "ShiftAllowanceModel"
28748 },
28749 "ShiftLiabilityModel": {
28750 "type": "object",
28751 "properties": {
28752 "liabilityCategoryName": {
28753 "type": "string",
28754 "title": "String"
28755 },
28756 "liabilityCategoryId": {
28757 "format": "int32",
28758 "type": "integer",
28759 "title": "Int32"
28760 },
28761 "includeInShiftCost": {
28762 "type": "boolean",
28763 "title": "Boolean"
28764 },
28765 "amount": {
28766 "format": "double",
28767 "type": "number",
28768 "title": "Decimal"
28769 },
28770 "option": {
28771 "enum": [
28772 "Fixed",
28773 "PerHourWorked",
28774 "PercentageOfShiftCost",
28775 "PerShiftUnit"
28776 ],
28777 "type": "string",
28778 "title": "ShiftAllowanceOption"
28779 },
28780 "cost": {
28781 "format": "double",
28782 "type": "number",
28783 "title": "Decimal"
28784 }
28785 },
28786 "xml": {
28787 "name": "ShiftLiabilityModel"
28788 },
28789 "title": "ShiftLiabilityModel"
28790 },
28791 "NominalWorkType": {
28792 "type": "object",
28793 "properties": {
28794 "id": {
28795 "format": "int32",
28796 "type": "integer",
28797 "title": "Int32"
28798 },
28799 "name": {
28800 "type": "string",
28801 "title": "String"
28802 },
28803 "linkType": {
28804 "enum": [
28805 "PayCategory",
28806 "LeaveCategory",
28807 "ShiftCondition"
28808 ],
28809 "type": "string",
28810 "title": "WorkTypeLinkTypeRestriction"
28811 }
28812 },
28813 "xml": {
28814 "name": "NominalWorkType"
28815 },
28816 "title": "NominalWorkType"
28817 },
28818 "NominalClassification": {
28819 "type": "object",
28820 "properties": {
28821 "id": {
28822 "format": "int32",
28823 "type": "integer",
28824 "title": "Int32"
28825 },
28826 "rank": {
28827 "format": "int32",
28828 "type": "integer",
28829 "title": "Int32"
28830 },
28831 "name": {
28832 "type": "string",
28833 "title": "String"
28834 }
28835 },
28836 "xml": {
28837 "name": "NominalClassification"
28838 },
28839 "title": "NominalClassification"
28840 },
28841 "NominalLeaveCategory": {
28842 "type": "object",
28843 "properties": {
28844 "id": {
28845 "format": "int32",
28846 "type": "integer",
28847 "title": "Int32"
28848 },
28849 "name": {
28850 "type": "string",
28851 "title": "String"
28852 }
28853 },
28854 "xml": {
28855 "name": "NominalLeaveCategory"
28856 },
28857 "title": "NominalLeaveCategory"
28858 },
28859 "TimesheetLineViewModel": {
28860 "type": "object",
28861 "properties": {
28862 "employeeName": {
28863 "type": "string",
28864 "title": "String"
28865 },
28866 "id": {
28867 "format": "int32",
28868 "type": "integer",
28869 "title": "Int32"
28870 },
28871 "employeeId": {
28872 "format": "int32",
28873 "type": "integer",
28874 "title": "Int32"
28875 },
28876 "locationId": {
28877 "format": "int32",
28878 "type": "integer",
28879 "title": "Nullable<Int32>"
28880 },
28881 "workTypeId": {
28882 "format": "int32",
28883 "type": "integer",
28884 "title": "Nullable<Int32>"
28885 },
28886 "classificationId": {
28887 "format": "int32",
28888 "type": "integer",
28889 "title": "Nullable<Int32>"
28890 },
28891 "classificationName": {
28892 "type": "string",
28893 "title": "String"
28894 },
28895 "workTypeName": {
28896 "type": "string",
28897 "title": "String"
28898 },
28899 "locationName": {
28900 "type": "string",
28901 "title": "String"
28902 },
28903 "unitType": {
28904 "type": "string",
28905 "title": "String"
28906 },
28907 "isUnitBasedWorkType": {
28908 "type": "boolean",
28909 "title": "Boolean"
28910 },
28911 "payRunId": {
28912 "format": "int32",
28913 "type": "integer",
28914 "title": "Nullable<Int32>"
28915 },
28916 "start": {
28917 "format": "date-time",
28918 "type": "string",
28919 "title": "Nullable<DateTime>"
28920 },
28921 "end": {
28922 "format": "date-time",
28923 "type": "string",
28924 "title": "Nullable<DateTime>"
28925 },
28926 "submittedStart": {
28927 "format": "date-time",
28928 "type": "string",
28929 "title": "Nullable<DateTime>"
28930 },
28931 "submittedEnd": {
28932 "format": "date-time",
28933 "type": "string",
28934 "title": "Nullable<DateTime>"
28935 },
28936 "units": {
28937 "format": "double",
28938 "type": "number",
28939 "title": "Nullable<Decimal>"
28940 },
28941 "status": {
28942 "enum": [
28943 "Missing",
28944 "Submitted",
28945 "Approved",
28946 "Rejected",
28947 "Processed"
28948 ],
28949 "type": "string",
28950 "title": "TimesheetLineStatusType"
28951 },
28952 "paySlipUrl": {
28953 "type": "string",
28954 "title": "String"
28955 },
28956 "breaks": {
28957 "type": "array",
28958 "items": {
28959 "$ref": "#/definitions/TimesheetBreakViewModel"
28960 },
28961 "xml": {
28962 "name": "TimesheetBreakViewModel",
28963 "wrapped": true
28964 },
28965 "title": "IList<TimesheetBreakViewModel>"
28966 },
28967 "comments": {
28968 "type": "string",
28969 "title": "String"
28970 },
28971 "rate": {
28972 "format": "double",
28973 "type": "number",
28974 "title": "Nullable<Decimal>"
28975 },
28976 "externalReferenceId": {
28977 "type": "string",
28978 "title": "String"
28979 },
28980 "source": {
28981 "enum": [
28982 "None",
28983 "Saasu",
28984 "Xero",
28985 "MYOB",
28986 "Deputy",
28987 "EmployeeTimePunch",
28988 "ClickSuper",
28989 "IntegratedTimesheets",
28990 "FileImport",
28991 "FileExport",
28992 "QuickBooks",
28993 "Harmony",
28994 "AwardStore",
28995 "Attache",
28996 "IntegratedRostering",
28997 "ReckonAccounts",
28998 "API",
28999 "MicroPower",
29000 "RosterLive",
29001 "NetSuite",
29002 "Kounta",
29003 "TimeAndAttendanceKiosk",
29004 "DetailedFileExport",
29005 "JonasPremier",
29006 "WageEasy",
29007 "Maestrano",
29008 "WorkZone",
29009 "EmployeePortal",
29010 "RosterTemplate",
29011 "Onboarding",
29012 "Admin",
29013 "WorkZoneClockOnOff"
29014 ],
29015 "type": "string",
29016 "title": "ExternalService"
29017 },
29018 "payCategoryId": {
29019 "format": "int32",
29020 "type": "integer",
29021 "title": "Nullable<Int32>"
29022 },
29023 "leaveCategoryId": {
29024 "format": "int32",
29025 "type": "integer",
29026 "title": "Nullable<Int32>"
29027 },
29028 "leaveRequestId": {
29029 "format": "int32",
29030 "type": "integer",
29031 "title": "Nullable<Int32>"
29032 },
29033 "isLocked": {
29034 "type": "boolean",
29035 "title": "Boolean"
29036 },
29037 "cost": {
29038 "format": "double",
29039 "type": "number",
29040 "title": "Nullable<Decimal>"
29041 },
29042 "costingData": {
29043 "$ref": "#/definitions/ShiftCostingData"
29044 },
29045 "discard": {
29046 "type": "boolean",
29047 "title": "Boolean"
29048 },
29049 "attachment": {
29050 "$ref": "#/definitions/AttachmentModel"
29051 },
29052 "shiftConditionIds": {
29053 "type": "array",
29054 "items": {
29055 "format": "int32",
29056 "type": "integer",
29057 "title": "Int32"
29058 },
29059 "title": "IList<Int32>"
29060 },
29061 "isOverlapping": {
29062 "type": "boolean",
29063 "title": "Boolean"
29064 },
29065 "overdrawsLeave": {
29066 "type": "boolean",
29067 "title": "Boolean"
29068 },
29069 "reviewedBy": {
29070 "type": "string",
29071 "title": "String"
29072 },
29073 "durationOverride": {
29074 "type": "string",
29075 "title": "Nullable<TimeSpan>"
29076 },
29077 "workDurationInMinutes": {
29078 "format": "double",
29079 "type": "number",
29080 "readOnly": true,
29081 "title": "Double"
29082 },
29083 "breaksDurationInMinutes": {
29084 "format": "double",
29085 "type": "number",
29086 "readOnly": true,
29087 "title": "Double"
29088 },
29089 "totalDurationInMinutes": {
29090 "format": "double",
29091 "type": "number",
29092 "readOnly": true,
29093 "title": "Double"
29094 }
29095 },
29096 "xml": {
29097 "name": "TimesheetLineViewModel"
29098 },
29099 "title": "TimesheetLineViewModel"
29100 },
29101 "DeviceTokenModel": {
29102 "type": "object",
29103 "properties": {
29104 "token": {
29105 "type": "string",
29106 "title": "String"
29107 },
29108 "platform": {
29109 "enum": [
29110 "iOS",
29111 "Android"
29112 ],
29113 "type": "string",
29114 "title": "MobilePlatform"
29115 }
29116 },
29117 "xml": {
29118 "name": "DeviceTokenModel"
29119 },
29120 "title": "DeviceTokenModel"
29121 },
29122 "TimeAndAttendanceLookupDataModel": {
29123 "type": "object",
29124 "properties": {
29125 "locations": {
29126 "type": "array",
29127 "items": {
29128 "$ref": "#/definitions/LocationSelectModel"
29129 },
29130 "xml": {
29131 "name": "LocationSelectModel",
29132 "wrapped": true
29133 },
29134 "title": "IList<LocationSelectModel>"
29135 },
29136 "workTypes": {
29137 "type": "array",
29138 "items": {
29139 "$ref": "#/definitions/WorkTypeSelectModel"
29140 },
29141 "xml": {
29142 "name": "WorkTypeSelectModel",
29143 "wrapped": true
29144 },
29145 "title": "IList<WorkTypeSelectModel>"
29146 },
29147 "classifications": {
29148 "type": "array",
29149 "items": {
29150 "$ref": "#/definitions/ClassificationLookupModel"
29151 },
29152 "xml": {
29153 "name": "ClassificationLookupModel",
29154 "wrapped": true
29155 },
29156 "title": "IList<ClassificationLookupModel>"
29157 },
29158 "defaultLocation": {
29159 "$ref": "#/definitions/LocationSelectModel"
29160 },
29161 "shiftConditions": {
29162 "type": "array",
29163 "items": {
29164 "$ref": "#/definitions/ShiftConditionSelectModel"
29165 },
29166 "xml": {
29167 "name": "ShiftConditionSelectModel",
29168 "wrapped": true
29169 },
29170 "title": "IList<ShiftConditionSelectModel>"
29171 },
29172 "locationShiftConditions": {
29173 "type": "array",
29174 "items": {
29175 "$ref": "#/definitions/LocationShiftConditionsModel"
29176 },
29177 "xml": {
29178 "name": "LocationShiftConditionsModel",
29179 "wrapped": true
29180 },
29181 "title": "IList<LocationShiftConditionsModel>"
29182 }
29183 },
29184 "xml": {
29185 "name": "TimeAndAttendanceLookupDataModel"
29186 },
29187 "title": "TimeAndAttendanceLookupDataModel"
29188 },
29189 "LocationSelectModel": {
29190 "type": "object",
29191 "properties": {
29192 "id": {
29193 "format": "int32",
29194 "type": "integer",
29195 "title": "Int32"
29196 },
29197 "description": {
29198 "type": "string",
29199 "title": "String"
29200 }
29201 },
29202 "xml": {
29203 "name": "LocationSelectModel"
29204 },
29205 "title": "LocationSelectModel"
29206 },
29207 "WorkTypeSelectModel": {
29208 "type": "object",
29209 "properties": {
29210 "isUnitBased": {
29211 "type": "boolean",
29212 "title": "Boolean"
29213 },
29214 "isLeaveType": {
29215 "type": "boolean",
29216 "title": "Boolean"
29217 },
29218 "unitType": {
29219 "type": "string",
29220 "title": "String"
29221 },
29222 "id": {
29223 "format": "int32",
29224 "type": "integer",
29225 "title": "Int32"
29226 },
29227 "description": {
29228 "type": "string",
29229 "title": "String"
29230 }
29231 },
29232 "xml": {
29233 "name": "WorkTypeSelectModel"
29234 },
29235 "title": "WorkTypeSelectModel"
29236 },
29237 "ClassificationLookupModel": {
29238 "description": "temporary class until ClassificationSelectModel uses the same base class as the other two",
29239 "type": "object",
29240 "properties": {
29241 "id": {
29242 "format": "int32",
29243 "type": "integer",
29244 "title": "Int32"
29245 },
29246 "description": {
29247 "type": "string",
29248 "title": "String"
29249 }
29250 },
29251 "xml": {
29252 "name": "ClassificationLookupModel"
29253 },
29254 "title": "ClassificationLookupModel"
29255 },
29256 "ShiftConditionSelectModel": {
29257 "type": "object",
29258 "properties": {
29259 "shortCode": {
29260 "type": "string",
29261 "title": "String"
29262 },
29263 "id": {
29264 "format": "int32",
29265 "type": "integer",
29266 "title": "Int32"
29267 },
29268 "description": {
29269 "type": "string",
29270 "title": "String"
29271 }
29272 },
29273 "xml": {
29274 "name": "ShiftConditionSelectModel"
29275 },
29276 "title": "ShiftConditionSelectModel"
29277 },
29278 "LocationShiftConditionsModel": {
29279 "type": "object",
29280 "properties": {
29281 "locationId": {
29282 "format": "int32",
29283 "type": "integer",
29284 "title": "Int32"
29285 },
29286 "shiftConditionIds": {
29287 "type": "array",
29288 "items": {
29289 "format": "int32",
29290 "type": "integer",
29291 "title": "Int32"
29292 },
29293 "title": "IList<Int32>"
29294 }
29295 },
29296 "xml": {
29297 "name": "LocationShiftConditionsModel"
29298 },
29299 "title": "LocationShiftConditionsModel"
29300 },
29301 "ClockOnModel": {
29302 "type": "object",
29303 "properties": {
29304 "locationId": {
29305 "format": "int32",
29306 "type": "integer",
29307 "title": "Nullable<Int32>"
29308 },
29309 "classificationId": {
29310 "format": "int32",
29311 "type": "integer",
29312 "title": "Nullable<Int32>"
29313 },
29314 "workTypeId": {
29315 "format": "int32",
29316 "type": "integer",
29317 "title": "Nullable<Int32>"
29318 },
29319 "shiftConditionIds": {
29320 "type": "array",
29321 "items": {
29322 "format": "int32",
29323 "type": "integer",
29324 "title": "Int32"
29325 },
29326 "title": "IList<Int32>"
29327 },
29328 "note": {
29329 "type": "string",
29330 "title": "String"
29331 },
29332 "employeeId": {
29333 "format": "int32",
29334 "type": "integer",
29335 "title": "Nullable<Int32>"
29336 },
29337 "latitude": {
29338 "format": "double",
29339 "type": "number",
29340 "title": "Nullable<Decimal>"
29341 },
29342 "longitude": {
29343 "format": "double",
29344 "type": "number",
29345 "title": "Nullable<Decimal>"
29346 },
29347 "kioskId": {
29348 "format": "int32",
29349 "type": "integer",
29350 "title": "Nullable<Int32>"
29351 },
29352 "ipAddress": {
29353 "type": "string",
29354 "title": "String"
29355 },
29356 "image": {
29357 "format": "byte",
29358 "type": "string",
29359 "title": "Byte[]"
29360 },
29361 "isAdminInitiated": {
29362 "type": "boolean",
29363 "title": "Boolean"
29364 },
29365 "recordedTimeUtc": {
29366 "format": "date-time",
29367 "type": "string",
29368 "title": "Nullable<DateTime>"
29369 },
29370 "utcOffset": {
29371 "type": "string",
29372 "title": "Nullable<TimeSpan>"
29373 },
29374 "noteVisibility": {
29375 "enum": [
29376 "Hidden",
29377 "Visible"
29378 ],
29379 "type": "string",
29380 "title": "Nullable<TimeAttendanceShiftNoteVisibility>"
29381 }
29382 },
29383 "xml": {
29384 "name": "ClockOnModel"
29385 },
29386 "title": "ClockOnModel"
29387 },
29388 "ClockOffModel": {
29389 "type": "object",
29390 "properties": {
29391 "note": {
29392 "type": "string",
29393 "title": "String"
29394 },
29395 "employeeId": {
29396 "format": "int32",
29397 "type": "integer",
29398 "title": "Nullable<Int32>"
29399 },
29400 "latitude": {
29401 "format": "double",
29402 "type": "number",
29403 "title": "Nullable<Decimal>"
29404 },
29405 "longitude": {
29406 "format": "double",
29407 "type": "number",
29408 "title": "Nullable<Decimal>"
29409 },
29410 "kioskId": {
29411 "format": "int32",
29412 "type": "integer",
29413 "title": "Nullable<Int32>"
29414 },
29415 "ipAddress": {
29416 "type": "string",
29417 "title": "String"
29418 },
29419 "image": {
29420 "format": "byte",
29421 "type": "string",
29422 "title": "Byte[]"
29423 },
29424 "isAdminInitiated": {
29425 "type": "boolean",
29426 "title": "Boolean"
29427 },
29428 "recordedTimeUtc": {
29429 "format": "date-time",
29430 "type": "string",
29431 "title": "Nullable<DateTime>"
29432 },
29433 "utcOffset": {
29434 "type": "string",
29435 "title": "Nullable<TimeSpan>"
29436 },
29437 "noteVisibility": {
29438 "enum": [
29439 "Hidden",
29440 "Visible"
29441 ],
29442 "type": "string",
29443 "title": "Nullable<TimeAttendanceShiftNoteVisibility>"
29444 }
29445 },
29446 "xml": {
29447 "name": "ClockOffModel"
29448 },
29449 "title": "ClockOffModel"
29450 },
29451 "StartBreakModel": {
29452 "type": "object",
29453 "properties": {
29454 "employeeId": {
29455 "format": "int32",
29456 "type": "integer",
29457 "title": "Nullable<Int32>"
29458 },
29459 "latitude": {
29460 "format": "double",
29461 "type": "number",
29462 "title": "Nullable<Decimal>"
29463 },
29464 "longitude": {
29465 "format": "double",
29466 "type": "number",
29467 "title": "Nullable<Decimal>"
29468 },
29469 "kioskId": {
29470 "format": "int32",
29471 "type": "integer",
29472 "title": "Nullable<Int32>"
29473 },
29474 "ipAddress": {
29475 "type": "string",
29476 "title": "String"
29477 },
29478 "image": {
29479 "format": "byte",
29480 "type": "string",
29481 "title": "Byte[]"
29482 },
29483 "isAdminInitiated": {
29484 "type": "boolean",
29485 "title": "Boolean"
29486 },
29487 "recordedTimeUtc": {
29488 "format": "date-time",
29489 "type": "string",
29490 "title": "Nullable<DateTime>"
29491 },
29492 "utcOffset": {
29493 "type": "string",
29494 "title": "Nullable<TimeSpan>"
29495 },
29496 "noteVisibility": {
29497 "enum": [
29498 "Hidden",
29499 "Visible"
29500 ],
29501 "type": "string",
29502 "title": "Nullable<TimeAttendanceShiftNoteVisibility>"
29503 }
29504 },
29505 "xml": {
29506 "name": "StartBreakModel"
29507 },
29508 "title": "StartBreakModel"
29509 },
29510 "EndBreakModel": {
29511 "type": "object",
29512 "properties": {
29513 "employeeId": {
29514 "format": "int32",
29515 "type": "integer",
29516 "title": "Nullable<Int32>"
29517 },
29518 "latitude": {
29519 "format": "double",
29520 "type": "number",
29521 "title": "Nullable<Decimal>"
29522 },
29523 "longitude": {
29524 "format": "double",
29525 "type": "number",
29526 "title": "Nullable<Decimal>"
29527 },
29528 "kioskId": {
29529 "format": "int32",
29530 "type": "integer",
29531 "title": "Nullable<Int32>"
29532 },
29533 "ipAddress": {
29534 "type": "string",
29535 "title": "String"
29536 },
29537 "image": {
29538 "format": "byte",
29539 "type": "string",
29540 "title": "Byte[]"
29541 },
29542 "isAdminInitiated": {
29543 "type": "boolean",
29544 "title": "Boolean"
29545 },
29546 "recordedTimeUtc": {
29547 "format": "date-time",
29548 "type": "string",
29549 "title": "Nullable<DateTime>"
29550 },
29551 "utcOffset": {
29552 "type": "string",
29553 "title": "Nullable<TimeSpan>"
29554 },
29555 "noteVisibility": {
29556 "enum": [
29557 "Hidden",
29558 "Visible"
29559 ],
29560 "type": "string",
29561 "title": "Nullable<TimeAttendanceShiftNoteVisibility>"
29562 }
29563 },
29564 "xml": {
29565 "name": "EndBreakModel"
29566 },
29567 "title": "EndBreakModel"
29568 },
29569 "GetShiftsModel": {
29570 "type": "object",
29571 "properties": {
29572 "kioskId": {
29573 "format": "int32",
29574 "type": "integer",
29575 "title": "Nullable<Int32>"
29576 },
29577 "locationId": {
29578 "format": "int32",
29579 "type": "integer",
29580 "title": "Nullable<Int32>"
29581 },
29582 "employeeId": {
29583 "format": "int32",
29584 "type": "integer",
29585 "title": "Nullable<Int32>"
29586 },
29587 "fromDateUtc": {
29588 "format": "date-time",
29589 "type": "string",
29590 "title": "Nullable<DateTime>"
29591 },
29592 "toDateUtc": {
29593 "format": "date-time",
29594 "type": "string",
29595 "title": "Nullable<DateTime>"
29596 }
29597 },
29598 "xml": {
29599 "name": "GetShiftsModel"
29600 },
29601 "title": "GetShiftsModel"
29602 },
29603 "TimeAndAttendanceShiftModel": {
29604 "type": "object",
29605 "properties": {
29606 "id": {
29607 "format": "int32",
29608 "type": "integer",
29609 "title": "Int32"
29610 },
29611 "startTimeLocal": {
29612 "format": "date-time",
29613 "type": "string",
29614 "title": "DateTime"
29615 },
29616 "startTimeUtc": {
29617 "format": "date-time",
29618 "type": "string",
29619 "title": "DateTime"
29620 },
29621 "endTimeUtc": {
29622 "format": "date-time",
29623 "type": "string",
29624 "title": "Nullable<DateTime>"
29625 },
29626 "endTimeLocal": {
29627 "format": "date-time",
29628 "type": "string",
29629 "title": "Nullable<DateTime>"
29630 },
29631 "classificationId": {
29632 "format": "int32",
29633 "type": "integer",
29634 "title": "Nullable<Int32>"
29635 },
29636 "classificationName": {
29637 "type": "string",
29638 "title": "String"
29639 },
29640 "locationId": {
29641 "format": "int32",
29642 "type": "integer",
29643 "title": "Int32"
29644 },
29645 "locationFullyQualifiedName": {
29646 "type": "string",
29647 "title": "String"
29648 },
29649 "workTypeId": {
29650 "format": "int32",
29651 "type": "integer",
29652 "title": "Nullable<Int32>"
29653 },
29654 "workTypeName": {
29655 "type": "string",
29656 "title": "String"
29657 },
29658 "kioskId": {
29659 "format": "int32",
29660 "type": "integer",
29661 "title": "Int32"
29662 },
29663 "kioskName": {
29664 "type": "string",
29665 "title": "String"
29666 },
29667 "timesheetLineId": {
29668 "format": "int32",
29669 "type": "integer",
29670 "title": "Nullable<Int32>"
29671 },
29672 "employee": {
29673 "$ref": "#/definitions/BasicKioskEmployeeModel"
29674 },
29675 "breaks": {
29676 "type": "array",
29677 "items": {
29678 "$ref": "#/definitions/TimeAndAttendanceBreakModel"
29679 },
29680 "xml": {
29681 "name": "TimeAndAttendanceBreakModel",
29682 "wrapped": true
29683 },
29684 "title": "IList<TimeAndAttendanceBreakModel>"
29685 },
29686 "shiftConditions": {
29687 "type": "array",
29688 "items": {
29689 "$ref": "#/definitions/ShiftConditionModel"
29690 },
29691 "xml": {
29692 "name": "ShiftConditionModel",
29693 "wrapped": true
29694 },
29695 "title": "IList<ShiftConditionModel>"
29696 }
29697 },
29698 "xml": {
29699 "name": "TimeAndAttendanceShiftModel"
29700 },
29701 "title": "TimeAndAttendanceShiftModel"
29702 },
29703 "BasicKioskEmployeeModel": {
29704 "type": "object",
29705 "properties": {
29706 "employeeId": {
29707 "format": "int32",
29708 "type": "integer",
29709 "title": "Int32"
29710 },
29711 "firstName": {
29712 "type": "string",
29713 "title": "String"
29714 },
29715 "surname": {
29716 "type": "string",
29717 "title": "String"
29718 },
29719 "name": {
29720 "type": "string",
29721 "title": "String"
29722 },
29723 "hasEmail": {
29724 "type": "boolean",
29725 "title": "Boolean"
29726 },
29727 "profileImageUrl": {
29728 "type": "string",
29729 "title": "String"
29730 },
29731 "hasProfileImage": {
29732 "type": "boolean",
29733 "title": "Boolean"
29734 },
29735 "mobileNumber": {
29736 "type": "string",
29737 "title": "String"
29738 },
29739 "status": {
29740 "enum": [
29741 "NotClockedOn",
29742 "ClockedOn",
29743 "OnBreak",
29744 "ClockedOff"
29745 ],
29746 "type": "string",
29747 "title": "TimeAttendanceStatus"
29748 },
29749 "longShift": {
29750 "type": "boolean",
29751 "title": "Boolean"
29752 },
29753 "clockOnTimeUtc": {
29754 "format": "date-time",
29755 "type": "string",
29756 "title": "Nullable<DateTime>"
29757 },
29758 "breakStartTimeUtc": {
29759 "format": "date-time",
29760 "type": "string",
29761 "title": "Nullable<DateTime>"
29762 },
29763 "recordedTimeUtc": {
29764 "format": "date-time",
29765 "type": "string",
29766 "title": "Nullable<DateTime>"
29767 },
29768 "currentShiftId": {
29769 "format": "int32",
29770 "type": "integer",
29771 "title": "Nullable<Int32>"
29772 }
29773 },
29774 "xml": {
29775 "name": "BasicKioskEmployeeModel"
29776 },
29777 "title": "BasicKioskEmployeeModel"
29778 },
29779 "TimeAndAttendanceBreakModel": {
29780 "type": "object",
29781 "properties": {
29782 "startTimeUtc": {
29783 "format": "date-time",
29784 "type": "string",
29785 "title": "DateTime"
29786 },
29787 "startTimeLocal": {
29788 "format": "date-time",
29789 "type": "string",
29790 "title": "DateTime"
29791 },
29792 "endTimeUtc": {
29793 "format": "date-time",
29794 "type": "string",
29795 "title": "Nullable<DateTime>"
29796 },
29797 "endTimeLocal": {
29798 "format": "date-time",
29799 "type": "string",
29800 "title": "Nullable<DateTime>"
29801 }
29802 },
29803 "xml": {
29804 "name": "TimeAndAttendanceBreakModel"
29805 },
29806 "title": "TimeAndAttendanceBreakModel"
29807 },
29808 "ShiftConditionModel": {
29809 "type": "object",
29810 "properties": {
29811 "id": {
29812 "format": "int32",
29813 "type": "integer",
29814 "title": "Int32"
29815 },
29816 "name": {
29817 "type": "string",
29818 "title": "String"
29819 }
29820 },
29821 "xml": {
29822 "name": "ShiftConditionModel"
29823 },
29824 "title": "ShiftConditionModel"
29825 },
29826 "AddNoteModel": {
29827 "type": "object",
29828 "properties": {
29829 "employeeId": {
29830 "format": "int32",
29831 "type": "integer",
29832 "title": "Int32"
29833 },
29834 "type": {
29835 "enum": [
29836 "Shift",
29837 "ClockOn",
29838 "ClockOff"
29839 ],
29840 "type": "string",
29841 "title": "TimeAttendanceShiftNoteType"
29842 },
29843 "visibility": {
29844 "enum": [
29845 "Hidden",
29846 "Visible"
29847 ],
29848 "type": "string",
29849 "title": "TimeAttendanceShiftNoteVisibility"
29850 },
29851 "note": {
29852 "type": "string",
29853 "title": "String"
29854 },
29855 "isAdminInitiated": {
29856 "type": "boolean",
29857 "title": "Boolean"
29858 }
29859 },
29860 "xml": {
29861 "name": "AddNoteModel"
29862 },
29863 "title": "AddNoteModel"
29864 },
29865 "GetShiftNotesModel": {
29866 "type": "object",
29867 "properties": {
29868 "employeeId": {
29869 "format": "int32",
29870 "type": "integer",
29871 "title": "Int32"
29872 },
29873 "isAdminInitiated": {
29874 "type": "boolean",
29875 "title": "Boolean"
29876 },
29877 "type": {
29878 "enum": [
29879 "Shift",
29880 "ClockOn",
29881 "ClockOff"
29882 ],
29883 "type": "string",
29884 "title": "Nullable<TimeAttendanceShiftNoteType>"
29885 },
29886 "visibility": {
29887 "enum": [
29888 "Hidden",
29889 "Visible"
29890 ],
29891 "type": "string",
29892 "title": "Nullable<TimeAttendanceShiftNoteVisibility>"
29893 }
29894 },
29895 "xml": {
29896 "name": "GetShiftNotesModel"
29897 },
29898 "title": "GetShiftNotesModel"
29899 },
29900 "MarkNotesReadViewModel": {
29901 "type": "object",
29902 "properties": {
29903 "employeeId": {
29904 "format": "int32",
29905 "type": "integer",
29906 "title": "Int32"
29907 },
29908 "noteIds": {
29909 "type": "array",
29910 "items": {
29911 "format": "int32",
29912 "type": "integer",
29913 "title": "Int32"
29914 },
29915 "title": "Int32[]"
29916 },
29917 "read": {
29918 "type": "boolean",
29919 "title": "Boolean"
29920 }
29921 },
29922 "xml": {
29923 "name": "MarkNotesReadViewModel"
29924 },
29925 "title": "MarkNotesReadViewModel"
29926 },
29927 "EssPaymentSummaryModel": {
29928 "type": "object",
29929 "properties": {
29930 "id": {
29931 "format": "int32",
29932 "type": "integer",
29933 "title": "Int32"
29934 },
29935 "period": {
29936 "type": "string",
29937 "title": "String"
29938 },
29939 "isEtp": {
29940 "type": "boolean",
29941 "title": "Boolean"
29942 },
29943 "etpCode": {
29944 "type": "string",
29945 "title": "String"
29946 }
29947 },
29948 "xml": {
29949 "name": "EssPaymentSummaryModel"
29950 },
29951 "title": "EssPaymentSummaryModel"
29952 },
29953 "EssDocumentModel": {
29954 "type": "object",
29955 "properties": {
29956 "id": {
29957 "type": "string",
29958 "title": "String"
29959 },
29960 "friendlyName": {
29961 "type": "string",
29962 "title": "String"
29963 },
29964 "dateCreated": {
29965 "format": "date-time",
29966 "type": "string",
29967 "title": "DateTime"
29968 }
29969 },
29970 "xml": {
29971 "name": "EssDocumentModel"
29972 },
29973 "title": "EssDocumentModel"
29974 },
29975 "EmployeeUnavailabilityFilter": {
29976 "type": "object",
29977 "properties": {
29978 "fromDate": {
29979 "format": "date-time",
29980 "type": "string",
29981 "title": "Nullable<DateTime>"
29982 },
29983 "toDate": {
29984 "format": "date-time",
29985 "type": "string",
29986 "title": "Nullable<DateTime>"
29987 }
29988 },
29989 "xml": {
29990 "name": "EmployeeUnavailabilityFilter"
29991 },
29992 "title": "EmployeeUnavailabilityFilter"
29993 },
29994 "EssUnavailabilityModel": {
29995 "type": "object",
29996 "properties": {
29997 "id": {
29998 "format": "int32",
29999 "type": "integer",
30000 "title": "Int32"
30001 },
30002 "fromDate": {
30003 "format": "date-time",
30004 "type": "string",
30005 "title": "DateTime"
30006 },
30007 "toDate": {
30008 "format": "date-time",
30009 "type": "string",
30010 "title": "Nullable<DateTime>"
30011 },
30012 "endDate": {
30013 "format": "date-time",
30014 "type": "string",
30015 "title": "Nullable<DateTime>"
30016 },
30017 "reason": {
30018 "type": "string",
30019 "title": "String"
30020 },
30021 "recurring": {
30022 "type": "boolean",
30023 "title": "Boolean"
30024 },
30025 "recurringDay": {
30026 "enum": [
30027 "Sunday",
30028 "Monday",
30029 "Tuesday",
30030 "Wednesday",
30031 "Thursday",
30032 "Friday",
30033 "Saturday"
30034 ],
30035 "type": "string",
30036 "title": "Nullable<DayOfWeek>"
30037 },
30038 "isAllDay": {
30039 "type": "boolean",
30040 "readOnly": true,
30041 "title": "Boolean"
30042 },
30043 "viewOnly": {
30044 "type": "boolean",
30045 "title": "Boolean"
30046 }
30047 },
30048 "xml": {
30049 "name": "EssUnavailabilityModel"
30050 },
30051 "title": "EssUnavailabilityModel"
30052 },
30053 "UnavailabilityEditModel": {
30054 "type": "object",
30055 "properties": {
30056 "id": {
30057 "format": "int32",
30058 "type": "integer",
30059 "title": "Int32"
30060 },
30061 "fromDate": {
30062 "format": "date-time",
30063 "type": "string",
30064 "title": "DateTime"
30065 },
30066 "toDate": {
30067 "format": "date-time",
30068 "type": "string",
30069 "title": "Nullable<DateTime>"
30070 },
30071 "endDate": {
30072 "format": "date-time",
30073 "type": "string",
30074 "title": "Nullable<DateTime>"
30075 },
30076 "reason": {
30077 "type": "string",
30078 "title": "String"
30079 },
30080 "recurring": {
30081 "type": "boolean",
30082 "title": "Boolean"
30083 },
30084 "recurringDay": {
30085 "enum": [
30086 "Sunday",
30087 "Monday",
30088 "Tuesday",
30089 "Wednesday",
30090 "Thursday",
30091 "Friday",
30092 "Saturday"
30093 ],
30094 "type": "string",
30095 "title": "Nullable<DayOfWeek>"
30096 },
30097 "isAllDay": {
30098 "type": "boolean",
30099 "readOnly": true,
30100 "title": "Boolean"
30101 },
30102 "viewOnly": {
30103 "type": "boolean",
30104 "title": "Boolean"
30105 }
30106 },
30107 "xml": {
30108 "name": "UnavailabilityEditModel"
30109 },
30110 "title": "UnavailabilityEditModel"
30111 },
30112 "AvailableEmployeeModel": {
30113 "type": "object",
30114 "properties": {
30115 "id": {
30116 "format": "int32",
30117 "type": "integer",
30118 "title": "Int32"
30119 },
30120 "name": {
30121 "type": "string",
30122 "title": "String"
30123 },
30124 "businessId": {
30125 "format": "int32",
30126 "type": "integer",
30127 "title": "Int32"
30128 },
30129 "businessName": {
30130 "type": "string",
30131 "title": "String"
30132 },
30133 "jobTitle": {
30134 "type": "string",
30135 "title": "String"
30136 },
30137 "hasProfileImage": {
30138 "type": "boolean",
30139 "title": "Boolean"
30140 },
30141 "branding": {
30142 "$ref": "#/definitions/WhiteLabelBrandingModel"
30143 },
30144 "defaultLocationId": {
30145 "format": "int32",
30146 "type": "integer",
30147 "title": "Int32"
30148 },
30149 "profileImageUrl": {
30150 "type": "string",
30151 "title": "String"
30152 }
30153 },
30154 "xml": {
30155 "name": "AvailableEmployeeModel"
30156 },
30157 "title": "AvailableEmployeeModel"
30158 },
30159 "WhiteLabelBrandingModel": {
30160 "type": "object",
30161 "properties": {
30162 "logoUrl": {
30163 "type": "string",
30164 "title": "String"
30165 },
30166 "backgroundImageUrl": {
30167 "type": "string",
30168 "title": "String"
30169 },
30170 "backgroundColour": {
30171 "type": "string",
30172 "title": "String"
30173 },
30174 "textColour": {
30175 "type": "string",
30176 "title": "String"
30177 },
30178 "textHoverColour": {
30179 "type": "string",
30180 "title": "String"
30181 },
30182 "textSecondaryColour": {
30183 "type": "string",
30184 "title": "String"
30185 }
30186 },
30187 "xml": {
30188 "name": "WhiteLabelBrandingModel"
30189 },
30190 "title": "WhiteLabelBrandingModel"
30191 },
30192 "RecoverPasswordModel": {
30193 "required": [
30194 "username"
30195 ],
30196 "type": "object",
30197 "properties": {
30198 "username": {
30199 "type": "string",
30200 "title": "String"
30201 },
30202 "messageType": {
30203 "enum": [
30204 "NewPaySlipAvailable",
30205 "NewUser",
30206 "RecoverPassword",
30207 "EmployeeAccess",
30208 "BusinessAccess",
30209 "CancelAccount",
30210 "Invoice",
30211 "InvoicePaymentSuccessNotification",
30212 "AutomatedPassword",
30213 "LeaveRequestNotification",
30214 "RestrictedAccess",
30215 "ResendPayslip",
30216 "PaymentSummaryAvailable",
30217 "SuperPaymentsUpdateResults",
30218 "InvoicePaymentFailedNotification",
30219 "NewShiftsPublished",
30220 "ShiftsUnpublished",
30221 "ShiftDeclined",
30222 "KioskAccessGranted",
30223 "DailyNotifications",
30224 "BsbDataImported",
30225 "InvoiceeCardDetailsRemoved",
30226 "WhiteLabelManagerAccess",
30227 "ResellerAccess",
30228 "DirectDepositReminder",
30229 "DataIntegrityCheckFailed",
30230 "ExpenseRequestNotification",
30231 "UnavailabilityNotification",
30232 "ReportPackGenerated",
30233 "ReportPackError",
30234 "SystemPublicHolidayImport",
30235 "TimesheetRejected",
30236 "ShiftRepublished",
30237 "PendingShiftsReminder",
30238 "EmployeeShiftActionTimeout",
30239 "InitiateEmployeeOnboarding",
30240 "FollowUpEmployeeOnboarding",
30241 "CompleteEmployeeOnboarding",
30242 "NewShiftsPreAccepted",
30243 "PayRunTaskNotification",
30244 "ShiftSwapCancelled",
30245 "BulkShiftSwapsCancelled",
30246 "ShiftSwapAwaitingApproval",
30247 "ShiftSwapProposed",
30248 "ShiftSwapAccepted",
30249 "ShiftSwapDeclined",
30250 "ShiftSwapRejected",
30251 "ShiftSwapApproved"
30252 ],
30253 "type": "string",
30254 "title": "MessageTypeEnum"
30255 }
30256 },
30257 "xml": {
30258 "name": "RecoverPasswordModel"
30259 },
30260 "title": "RecoverPasswordModel"
30261 },
30262 "EmployeeExpensePaymentSummaryModel": {
30263 "type": "object",
30264 "properties": {
30265 "employeeId": {
30266 "format": "int32",
30267 "type": "integer",
30268 "title": "Int32"
30269 },
30270 "expenseCategoryId": {
30271 "format": "int32",
30272 "type": "integer",
30273 "title": "Int32"
30274 },
30275 "expenseCategoryName": {
30276 "type": "string",
30277 "title": "String"
30278 },
30279 "ytdAmount": {
30280 "format": "double",
30281 "type": "number",
30282 "title": "Decimal"
30283 },
30284 "totalAmount": {
30285 "format": "double",
30286 "type": "number",
30287 "title": "Decimal"
30288 }
30289 },
30290 "xml": {
30291 "name": "EmployeeExpensePaymentSummaryModel"
30292 },
30293 "title": "EmployeeExpensePaymentSummaryModel"
30294 },
30295 "EssExpenseRequestResponseModel": {
30296 "type": "object",
30297 "properties": {
30298 "canCancel": {
30299 "type": "boolean",
30300 "readOnly": true,
30301 "title": "Boolean"
30302 },
30303 "canModify": {
30304 "type": "boolean",
30305 "readOnly": true,
30306 "title": "Boolean"
30307 },
30308 "id": {
30309 "format": "int32",
30310 "type": "integer",
30311 "title": "Int32"
30312 },
30313 "employeeId": {
30314 "format": "int32",
30315 "type": "integer",
30316 "title": "Int32"
30317 },
30318 "employeeName": {
30319 "type": "string",
30320 "title": "String"
30321 },
30322 "status": {
30323 "type": "string",
30324 "title": "String"
30325 },
30326 "description": {
30327 "type": "string",
30328 "title": "String"
30329 },
30330 "lineItems": {
30331 "type": "array",
30332 "items": {
30333 "$ref": "#/definitions/ExpenseRequestLineItemModel"
30334 },
30335 "xml": {
30336 "name": "ExpenseRequestLineItemModel",
30337 "wrapped": true
30338 },
30339 "title": "List<ExpenseRequestLineItemModel>"
30340 },
30341 "attachments": {
30342 "type": "array",
30343 "items": {
30344 "$ref": "#/definitions/AttachmentModel"
30345 },
30346 "xml": {
30347 "name": "AttachmentModel",
30348 "wrapped": true
30349 },
30350 "title": "List<AttachmentModel>"
30351 },
30352 "statusUpdatedByUser": {
30353 "type": "string",
30354 "title": "String"
30355 },
30356 "statusUpdateNotes": {
30357 "type": "string",
30358 "title": "String"
30359 },
30360 "dateStatusUpdated": {
30361 "format": "date-time",
30362 "type": "string",
30363 "title": "DateTime"
30364 }
30365 },
30366 "xml": {
30367 "name": "EssExpenseRequestResponseModel"
30368 },
30369 "title": "EssExpenseRequestResponseModel"
30370 },
30371 "LeaveAllowanceModel": {
30372 "type": "object",
30373 "properties": {
30374 "leaveCategoryId": {
30375 "type": "string",
30376 "title": "String"
30377 },
30378 "leaveCategoryName": {
30379 "type": "string",
30380 "title": "String"
30381 },
30382 "units": {
30383 "format": "double",
30384 "type": "number",
30385 "title": "Nullable<Decimal>"
30386 },
30387 "unitType": {
30388 "type": "string",
30389 "title": "String"
30390 },
30391 "hoursPerYear": {
30392 "format": "double",
30393 "type": "number",
30394 "title": "Decimal"
30395 },
30396 "automaticallyAccrues": {
30397 "type": "boolean",
30398 "title": "Boolean"
30399 },
30400 "leaveLoading": {
30401 "format": "double",
30402 "type": "number",
30403 "title": "Decimal"
30404 }
30405 },
30406 "xml": {
30407 "name": "LeaveAllowanceModel"
30408 },
30409 "title": "LeaveAllowanceModel"
30410 },
30411 "SubmitEmployeeLeaveAllowancesRequest": {
30412 "type": "object",
30413 "properties": {
30414 "employeeIdType": {
30415 "enum": [
30416 "Standard",
30417 "External"
30418 ],
30419 "type": "string",
30420 "title": "IdType"
30421 },
30422 "leaveCategoryIdType": {
30423 "enum": [
30424 "Standard",
30425 "External"
30426 ],
30427 "type": "string",
30428 "title": "IdType"
30429 },
30430 "leaveAllowances": {
30431 "type": "object",
30432 "additionalProperties": {
30433 "type": "array",
30434 "items": {
30435 "$ref": "#/definitions/LeaveAllowanceModel"
30436 },
30437 "xml": {
30438 "name": "LeaveAllowanceModel",
30439 "wrapped": true
30440 },
30441 "title": "List<LeaveAllowanceModel>"
30442 },
30443 "title": "Dictionary<String,List`1>"
30444 }
30445 },
30446 "xml": {
30447 "name": "SubmitEmployeeLeaveAllowancesRequest"
30448 },
30449 "title": "SubmitEmployeeLeaveAllowancesRequest"
30450 },
30451 "ODataQueryOptions[LeaveAllowanceTemplate]": {
30452 "type": "object",
30453 "properties": {
30454 "ifMatch": {
30455 "type": "object",
30456 "readOnly": true,
30457 "title": "ETag<LeaveAllowanceTemplate>"
30458 },
30459 "ifNoneMatch": {
30460 "type": "object",
30461 "readOnly": true,
30462 "title": "ETag<LeaveAllowanceTemplate>"
30463 },
30464 "context": {
30465 "$ref": "#/definitions/ODataQueryContext",
30466 "readOnly": true
30467 },
30468 "request": {
30469 "type": "object",
30470 "readOnly": true,
30471 "title": "HttpRequestMessage"
30472 },
30473 "rawValues": {
30474 "$ref": "#/definitions/ODataRawQueryOptions",
30475 "readOnly": true
30476 },
30477 "selectExpand": {
30478 "$ref": "#/definitions/SelectExpandQueryOption",
30479 "readOnly": true
30480 },
30481 "filter": {
30482 "$ref": "#/definitions/FilterQueryOption",
30483 "readOnly": true
30484 },
30485 "orderBy": {
30486 "$ref": "#/definitions/OrderByQueryOption",
30487 "readOnly": true
30488 },
30489 "skip": {
30490 "$ref": "#/definitions/SkipQueryOption",
30491 "readOnly": true
30492 },
30493 "top": {
30494 "$ref": "#/definitions/TopQueryOption",
30495 "readOnly": true
30496 },
30497 "inlineCount": {
30498 "$ref": "#/definitions/InlineCountQueryOption",
30499 "readOnly": true
30500 },
30501 "validator": {
30502 "$ref": "#/definitions/ODataQueryValidator"
30503 }
30504 },
30505 "xml": {
30506 "name": "ODataQueryOptions`1"
30507 },
30508 "title": "ODataQueryOptions<LeaveAllowanceTemplate>"
30509 },
30510 "ODataQueryOptions[LeaveCategory]": {
30511 "type": "object",
30512 "properties": {
30513 "ifMatch": {
30514 "type": "object",
30515 "readOnly": true,
30516 "title": "ETag<LeaveCategory>"
30517 },
30518 "ifNoneMatch": {
30519 "type": "object",
30520 "readOnly": true,
30521 "title": "ETag<LeaveCategory>"
30522 },
30523 "context": {
30524 "$ref": "#/definitions/ODataQueryContext",
30525 "readOnly": true
30526 },
30527 "request": {
30528 "type": "object",
30529 "readOnly": true,
30530 "title": "HttpRequestMessage"
30531 },
30532 "rawValues": {
30533 "$ref": "#/definitions/ODataRawQueryOptions",
30534 "readOnly": true
30535 },
30536 "selectExpand": {
30537 "$ref": "#/definitions/SelectExpandQueryOption",
30538 "readOnly": true
30539 },
30540 "filter": {
30541 "$ref": "#/definitions/FilterQueryOption",
30542 "readOnly": true
30543 },
30544 "orderBy": {
30545 "$ref": "#/definitions/OrderByQueryOption",
30546 "readOnly": true
30547 },
30548 "skip": {
30549 "$ref": "#/definitions/SkipQueryOption",
30550 "readOnly": true
30551 },
30552 "top": {
30553 "$ref": "#/definitions/TopQueryOption",
30554 "readOnly": true
30555 },
30556 "inlineCount": {
30557 "$ref": "#/definitions/InlineCountQueryOption",
30558 "readOnly": true
30559 },
30560 "validator": {
30561 "$ref": "#/definitions/ODataQueryValidator"
30562 }
30563 },
30564 "xml": {
30565 "name": "ODataQueryOptions`1"
30566 },
30567 "title": "ODataQueryOptions<LeaveCategory>"
30568 },
30569 "LeaveCategoryModel": {
30570 "type": "object",
30571 "properties": {
30572 "id": {
30573 "format": "int32",
30574 "type": "integer",
30575 "title": "Int32"
30576 },
30577 "name": {
30578 "type": "string",
30579 "title": "String"
30580 },
30581 "unitType": {
30582 "enum": [
30583 "Days",
30584 "Weeks",
30585 "HoursPerHourWorked",
30586 "HoursPerPayRun"
30587 ],
30588 "type": "string",
30589 "title": "LeaveAllowanceUnitEnum"
30590 },
30591 "units": {
30592 "format": "double",
30593 "type": "number",
30594 "title": "Decimal"
30595 },
30596 "automaticallyAccrues": {
30597 "type": "boolean",
30598 "title": "Boolean"
30599 },
30600 "isPrivate": {
30601 "type": "boolean",
30602 "title": "Boolean"
30603 },
30604 "excludeFromTerminationPayout": {
30605 "type": "boolean",
30606 "title": "Boolean"
30607 },
30608 "externalId": {
30609 "type": "string",
30610 "title": "String"
30611 },
30612 "source": {
30613 "type": "string",
30614 "title": "String"
30615 },
30616 "leaveLoading": {
30617 "format": "double",
30618 "type": "number",
30619 "title": "Decimal"
30620 },
30621 "contingentPeriod": {
30622 "format": "double",
30623 "type": "number",
30624 "title": "Nullable<Decimal>"
30625 },
30626 "entitlementPeriod": {
30627 "format": "double",
30628 "type": "number",
30629 "title": "Nullable<Decimal>"
30630 },
30631 "isBalanceUntracked": {
30632 "type": "boolean",
30633 "title": "Boolean"
30634 },
30635 "leaveCategoryType": {
30636 "enum": [
30637 "Standard",
30638 "LongServiceLeave"
30639 ],
30640 "type": "string",
30641 "title": "LeaveCategoryTypeEnum"
30642 },
30643 "deductFromPrimaryPayCategory": {
30644 "type": "boolean",
30645 "title": "Boolean"
30646 },
30647 "deductFromPayCategoryId": {
30648 "format": "int32",
30649 "type": "integer",
30650 "title": "Nullable<Int32>"
30651 },
30652 "transferToPayCategoryId": {
30653 "format": "int32",
30654 "type": "integer",
30655 "title": "Nullable<Int32>"
30656 },
30657 "hideAccrualsOnPayslip": {
30658 "type": "boolean",
30659 "title": "Boolean"
30660 },
30661 "useDeductFromPayCategoryRate": {
30662 "type": "boolean",
30663 "title": "Boolean"
30664 }
30665 },
30666 "xml": {
30667 "name": "LeaveCategoryModel"
30668 },
30669 "title": "LeaveCategoryModel"
30670 },
30671 "LeaveRequestFilterModel": {
30672 "type": "object",
30673 "properties": {
30674 "status": {
30675 "enum": [
30676 "Pending",
30677 "Approved",
30678 "Cancelled",
30679 "Rejected"
30680 ],
30681 "type": "string",
30682 "title": "Nullable<LeaveRequestStatus>"
30683 },
30684 "fromDate": {
30685 "format": "date-time",
30686 "type": "string",
30687 "title": "Nullable<DateTime>"
30688 },
30689 "toDate": {
30690 "format": "date-time",
30691 "type": "string",
30692 "title": "Nullable<DateTime>"
30693 },
30694 "leaveCategoryId": {
30695 "format": "int32",
30696 "type": "integer",
30697 "title": "Nullable<Int32>"
30698 },
30699 "locationId": {
30700 "format": "int32",
30701 "type": "integer",
30702 "title": "Nullable<Int32>"
30703 },
30704 "employeeId": {
30705 "format": "int32",
30706 "type": "integer",
30707 "title": "Nullable<Int32>"
30708 },
30709 "groupBy": {
30710 "enum": [
30711 "Employee",
30712 "LeaveType"
30713 ],
30714 "type": "string",
30715 "title": "LeaveRequestGroupBy"
30716 },
30717 "restrictOverlappingLeave": {
30718 "type": "boolean",
30719 "title": "Boolean"
30720 }
30721 },
30722 "xml": {
30723 "name": "LeaveRequestFilterModel"
30724 },
30725 "title": "LeaveRequestFilterModel"
30726 },
30727 "LeaveRequestResponseModel": {
30728 "type": "object",
30729 "properties": {
30730 "id": {
30731 "format": "int32",
30732 "type": "integer",
30733 "title": "Int32"
30734 },
30735 "employeeId": {
30736 "format": "int32",
30737 "type": "integer",
30738 "title": "Int32"
30739 },
30740 "leaveCategoryId": {
30741 "format": "int32",
30742 "type": "integer",
30743 "title": "Int32"
30744 },
30745 "employee": {
30746 "type": "string",
30747 "title": "String"
30748 },
30749 "leaveCategory": {
30750 "type": "string",
30751 "title": "String"
30752 },
30753 "fromDate": {
30754 "format": "date-time",
30755 "type": "string",
30756 "title": "DateTime"
30757 },
30758 "toDate": {
30759 "format": "date-time",
30760 "type": "string",
30761 "title": "DateTime"
30762 },
30763 "totalHours": {
30764 "format": "double",
30765 "type": "number",
30766 "title": "Decimal"
30767 },
30768 "hoursApplied": {
30769 "format": "double",
30770 "type": "number",
30771 "title": "Decimal"
30772 },
30773 "notes": {
30774 "type": "string",
30775 "title": "String"
30776 },
30777 "status": {
30778 "type": "string",
30779 "title": "String"
30780 },
30781 "attachmentId": {
30782 "format": "int32",
30783 "type": "integer",
30784 "title": "Nullable<Int32>"
30785 }
30786 },
30787 "xml": {
30788 "name": "LeaveRequestResponseModel"
30789 },
30790 "title": "LeaveRequestResponseModel"
30791 },
30792 "ODataQueryOptions[LeaveRequest]": {
30793 "type": "object",
30794 "properties": {
30795 "ifMatch": {
30796 "type": "object",
30797 "readOnly": true,
30798 "title": "ETag<LeaveRequest>"
30799 },
30800 "ifNoneMatch": {
30801 "type": "object",
30802 "readOnly": true,
30803 "title": "ETag<LeaveRequest>"
30804 },
30805 "context": {
30806 "$ref": "#/definitions/ODataQueryContext",
30807 "readOnly": true
30808 },
30809 "request": {
30810 "type": "object",
30811 "readOnly": true,
30812 "title": "HttpRequestMessage"
30813 },
30814 "rawValues": {
30815 "$ref": "#/definitions/ODataRawQueryOptions",
30816 "readOnly": true
30817 },
30818 "selectExpand": {
30819 "$ref": "#/definitions/SelectExpandQueryOption",
30820 "readOnly": true
30821 },
30822 "filter": {
30823 "$ref": "#/definitions/FilterQueryOption",
30824 "readOnly": true
30825 },
30826 "orderBy": {
30827 "$ref": "#/definitions/OrderByQueryOption",
30828 "readOnly": true
30829 },
30830 "skip": {
30831 "$ref": "#/definitions/SkipQueryOption",
30832 "readOnly": true
30833 },
30834 "top": {
30835 "$ref": "#/definitions/TopQueryOption",
30836 "readOnly": true
30837 },
30838 "inlineCount": {
30839 "$ref": "#/definitions/InlineCountQueryOption",
30840 "readOnly": true
30841 },
30842 "validator": {
30843 "$ref": "#/definitions/ODataQueryValidator"
30844 }
30845 },
30846 "xml": {
30847 "name": "ODataQueryOptions`1"
30848 },
30849 "title": "ODataQueryOptions<LeaveRequest>"
30850 },
30851 "ApiLeaveApplicationModel": {
30852 "required": [
30853 "fromDate",
30854 "toDate",
30855 "hours",
30856 "leaveCategoryId"
30857 ],
30858 "type": "object",
30859 "properties": {
30860 "automaticallyApprove": {
30861 "type": "boolean",
30862 "title": "Boolean"
30863 },
30864 "employeeId": {
30865 "format": "int32",
30866 "type": "integer",
30867 "title": "Int32"
30868 },
30869 "requireNotesForLeaveRequests": {
30870 "type": "boolean",
30871 "title": "Boolean"
30872 },
30873 "attachment": {
30874 "$ref": "#/definitions/AttachmentModel"
30875 },
30876 "id": {
30877 "format": "int32",
30878 "type": "integer",
30879 "title": "Int32"
30880 },
30881 "fromDate": {
30882 "format": "date-time",
30883 "type": "string",
30884 "title": "DateTime"
30885 },
30886 "toDate": {
30887 "format": "date-time",
30888 "type": "string",
30889 "title": "DateTime"
30890 },
30891 "hours": {
30892 "format": "double",
30893 "maximum": 2000,
30894 "type": "number",
30895 "title": "Decimal"
30896 },
30897 "leaveCategoryId": {
30898 "format": "int32",
30899 "type": "integer",
30900 "title": "Nullable<Int32>"
30901 },
30902 "notes": {
30903 "maxLength": 255,
30904 "type": "string",
30905 "title": "String"
30906 }
30907 },
30908 "xml": {
30909 "name": "ApiLeaveApplicationModel"
30910 },
30911 "title": "ApiLeaveApplicationModel"
30912 },
30913 "DeclineLeaveRequest": {
30914 "type": "object",
30915 "properties": {
30916 "reason": {
30917 "type": "string",
30918 "title": "String"
30919 }
30920 },
30921 "xml": {
30922 "name": "DeclineLeaveRequest"
30923 },
30924 "title": "DeclineLeaveRequest"
30925 },
30926 "ODataQueryOptions[Location]": {
30927 "type": "object",
30928 "properties": {
30929 "ifMatch": {
30930 "type": "object",
30931 "readOnly": true,
30932 "title": "ETag<Location>"
30933 },
30934 "ifNoneMatch": {
30935 "type": "object",
30936 "readOnly": true,
30937 "title": "ETag<Location>"
30938 },
30939 "context": {
30940 "$ref": "#/definitions/ODataQueryContext",
30941 "readOnly": true
30942 },
30943 "request": {
30944 "type": "object",
30945 "readOnly": true,
30946 "title": "HttpRequestMessage"
30947 },
30948 "rawValues": {
30949 "$ref": "#/definitions/ODataRawQueryOptions",
30950 "readOnly": true
30951 },
30952 "selectExpand": {
30953 "$ref": "#/definitions/SelectExpandQueryOption",
30954 "readOnly": true
30955 },
30956 "filter": {
30957 "$ref": "#/definitions/FilterQueryOption",
30958 "readOnly": true
30959 },
30960 "orderBy": {
30961 "$ref": "#/definitions/OrderByQueryOption",
30962 "readOnly": true
30963 },
30964 "skip": {
30965 "$ref": "#/definitions/SkipQueryOption",
30966 "readOnly": true
30967 },
30968 "top": {
30969 "$ref": "#/definitions/TopQueryOption",
30970 "readOnly": true
30971 },
30972 "inlineCount": {
30973 "$ref": "#/definitions/InlineCountQueryOption",
30974 "readOnly": true
30975 },
30976 "validator": {
30977 "$ref": "#/definitions/ODataQueryValidator"
30978 }
30979 },
30980 "xml": {
30981 "name": "ODataQueryOptions`1"
30982 },
30983 "title": "ODataQueryOptions<Location>"
30984 },
30985 "NameIdPair": {
30986 "type": "object",
30987 "properties": {
30988 "id": {
30989 "type": "string",
30990 "title": "String"
30991 },
30992 "name": {
30993 "type": "string",
30994 "title": "String"
30995 }
30996 },
30997 "xml": {
30998 "name": "NameIdPair"
30999 },
31000 "title": "NameIdPair"
31001 },
31002 "EssDeclineRosterShiftModel": {
31003 "required": [
31004 "reason"
31005 ],
31006 "type": "object",
31007 "properties": {
31008 "reason": {
31009 "type": "string",
31010 "title": "String"
31011 }
31012 },
31013 "xml": {
31014 "name": "EssDeclineRosterShiftModel"
31015 },
31016 "title": "EssDeclineRosterShiftModel"
31017 },
31018 "EssBulkAcceptRosterShiftsModel": {
31019 "type": "object",
31020 "properties": {
31021 "shifts": {
31022 "type": "array",
31023 "items": {
31024 "format": "int32",
31025 "type": "integer",
31026 "title": "Int32"
31027 },
31028 "title": "IList<Int32>"
31029 }
31030 },
31031 "xml": {
31032 "name": "EssBulkAcceptRosterShiftsModel"
31033 },
31034 "title": "EssBulkAcceptRosterShiftsModel"
31035 },
31036 "EssBulkDeclineRosterShiftsModel": {
31037 "required": [
31038 "reason"
31039 ],
31040 "type": "object",
31041 "properties": {
31042 "reason": {
31043 "type": "string",
31044 "title": "String"
31045 },
31046 "shifts": {
31047 "type": "array",
31048 "items": {
31049 "format": "int32",
31050 "type": "integer",
31051 "title": "Int32"
31052 },
31053 "title": "IList<Int32>"
31054 }
31055 },
31056 "xml": {
31057 "name": "EssBulkDeclineRosterShiftsModel"
31058 },
31059 "title": "EssBulkDeclineRosterShiftsModel"
31060 },
31061 "RosterShiftMatchingResultModel": {
31062 "type": "object",
31063 "properties": {
31064 "shift": {
31065 "$ref": "#/definitions/EssRosterShiftModel"
31066 }
31067 },
31068 "xml": {
31069 "name": "RosterShiftMatchingResultModel"
31070 },
31071 "title": "RosterShiftMatchingResultModel"
31072 },
31073 "SwapShiftModel": {
31074 "type": "object",
31075 "properties": {
31076 "rosterShiftId": {
31077 "format": "int32",
31078 "type": "integer",
31079 "title": "Int32"
31080 },
31081 "fromEmployeeId": {
31082 "format": "int32",
31083 "type": "integer",
31084 "title": "Int32"
31085 },
31086 "toEmployeeId": {
31087 "format": "int32",
31088 "type": "integer",
31089 "title": "Int32"
31090 },
31091 "note": {
31092 "type": "string",
31093 "title": "String"
31094 },
31095 "dateCreated": {
31096 "format": "date-time",
31097 "type": "string",
31098 "title": "Nullable<DateTime>"
31099 },
31100 "createdByUserId": {
31101 "format": "int32",
31102 "type": "integer",
31103 "title": "Nullable<Int32>"
31104 },
31105 "token": {
31106 "type": "string",
31107 "title": "String"
31108 }
31109 },
31110 "xml": {
31111 "name": "SwapShiftModel"
31112 },
31113 "title": "SwapShiftModel"
31114 },
31115 "EssBulkRosterShiftSwapModel": {
31116 "type": "object",
31117 "properties": {
31118 "shifts": {
31119 "type": "array",
31120 "items": {
31121 "format": "int32",
31122 "type": "integer",
31123 "title": "Int32"
31124 },
31125 "title": "IList<Int32>"
31126 }
31127 },
31128 "xml": {
31129 "name": "EssBulkRosterShiftSwapModel"
31130 },
31131 "title": "EssBulkRosterShiftSwapModel"
31132 },
31133 "TasksReportRequestModel": {
31134 "type": "object",
31135 "properties": {
31136 "employeeId": {
31137 "format": "int32",
31138 "type": "integer",
31139 "title": "Int32"
31140 },
31141 "payRunId": {
31142 "format": "int32",
31143 "type": "integer",
31144 "title": "Int32"
31145 },
31146 "fromDate": {
31147 "format": "date-time",
31148 "type": "string",
31149 "title": "Nullable<DateTime>"
31150 },
31151 "toDate": {
31152 "format": "date-time",
31153 "type": "string",
31154 "title": "Nullable<DateTime>"
31155 },
31156 "payScheduleId": {
31157 "format": "int32",
31158 "type": "integer",
31159 "title": "Int32"
31160 },
31161 "status": {
31162 "enum": [
31163 "All",
31164 "Completed",
31165 "NotCompleted"
31166 ],
31167 "type": "string",
31168 "title": "TasksReportStatusEnum"
31169 }
31170 },
31171 "xml": {
31172 "name": "TasksReportRequestModel"
31173 },
31174 "title": "TasksReportRequestModel"
31175 },
31176 "TasksReportExportModel": {
31177 "type": "object",
31178 "properties": {
31179 "payRunTaskId": {
31180 "format": "int32",
31181 "type": "integer",
31182 "title": "Int32"
31183 },
31184 "employeeName": {
31185 "type": "string",
31186 "title": "String"
31187 },
31188 "employeeId": {
31189 "format": "int32",
31190 "type": "integer",
31191 "title": "Nullable<Int32>"
31192 },
31193 "externalId": {
31194 "type": "string",
31195 "title": "String"
31196 },
31197 "taskDescription": {
31198 "type": "string",
31199 "title": "String"
31200 },
31201 "createdBy": {
31202 "type": "string",
31203 "title": "String"
31204 },
31205 "createdDate": {
31206 "format": "date-time",
31207 "type": "string",
31208 "title": "DateTime"
31209 },
31210 "dueDate": {
31211 "format": "date-time",
31212 "type": "string",
31213 "title": "Nullable<DateTime>"
31214 },
31215 "completed": {
31216 "type": "boolean",
31217 "title": "Boolean"
31218 },
31219 "notes": {
31220 "type": "array",
31221 "items": {
31222 "$ref": "#/definitions/TasksReportNoteModel"
31223 },
31224 "xml": {
31225 "name": "TasksReportNoteModel",
31226 "wrapped": true
31227 },
31228 "title": "List<TasksReportNoteModel>"
31229 },
31230 "completedBy": {
31231 "type": "string",
31232 "title": "String"
31233 },
31234 "completedDate": {
31235 "format": "date-time",
31236 "type": "string",
31237 "title": "Nullable<DateTime>"
31238 }
31239 },
31240 "xml": {
31241 "name": "TasksReportExportModel"
31242 },
31243 "title": "TasksReportExportModel"
31244 },
31245 "TasksReportNoteModel": {
31246 "type": "object",
31247 "properties": {
31248 "username": {
31249 "type": "string",
31250 "title": "String"
31251 },
31252 "dateCreated": {
31253 "format": "date-time",
31254 "type": "string",
31255 "title": "DateTime"
31256 },
31257 "note": {
31258 "type": "string",
31259 "title": "String"
31260 },
31261 "isVisibleToManager": {
31262 "type": "boolean",
31263 "title": "Boolean"
31264 }
31265 },
31266 "xml": {
31267 "name": "TasksReportNoteModel"
31268 },
31269 "title": "TasksReportNoteModel"
31270 },
31271 "ShiftSwappingReportRequestModel": {
31272 "type": "object",
31273 "properties": {
31274 "fromEmployeeId": {
31275 "format": "int32",
31276 "type": "integer",
31277 "title": "Nullable<Int32>"
31278 },
31279 "toEmployeeId": {
31280 "format": "int32",
31281 "type": "integer",
31282 "title": "Nullable<Int32>"
31283 },
31284 "includeCosts": {
31285 "type": "boolean",
31286 "title": "Boolean"
31287 },
31288 "statuses": {
31289 "type": "array",
31290 "items": {
31291 "enum": [
31292 "Created",
31293 "Cancelled",
31294 "Accepted",
31295 "Declined",
31296 "AwaitingManagerApproval",
31297 "ApprovedByManager",
31298 "RejectedByManager"
31299 ],
31300 "type": "string",
31301 "title": "RosterShiftSwapStatusEnum"
31302 },
31303 "xml": {
31304 "name": "RosterShiftSwapStatusEnum",
31305 "wrapped": true
31306 },
31307 "title": "IList<RosterShiftSwapStatusEnum>"
31308 },
31309 "fromDate": {
31310 "format": "date-time",
31311 "type": "string",
31312 "title": "DateTime"
31313 },
31314 "toDate": {
31315 "format": "date-time",
31316 "type": "string",
31317 "title": "DateTime"
31318 },
31319 "locationId": {
31320 "format": "int32",
31321 "type": "integer",
31322 "title": "Int32"
31323 },
31324 "employingEntityId": {
31325 "format": "int32",
31326 "type": "integer",
31327 "title": "Nullable<Int32>"
31328 }
31329 },
31330 "xml": {
31331 "name": "ShiftSwappingReportRequestModel"
31332 },
31333 "title": "ShiftSwappingReportRequestModel"
31334 },
31335 "ShiftSwappingReportExportModel": {
31336 "type": "object",
31337 "properties": {
31338 "fromEmployeeId": {
31339 "format": "int32",
31340 "type": "integer",
31341 "title": "Int32"
31342 },
31343 "fromEmployeeName": {
31344 "type": "string",
31345 "title": "String"
31346 },
31347 "toEmployeeId": {
31348 "format": "int32",
31349 "type": "integer",
31350 "title": "Int32"
31351 },
31352 "toEmployeeName": {
31353 "type": "string",
31354 "title": "String"
31355 },
31356 "start": {
31357 "format": "date-time",
31358 "type": "string",
31359 "title": "DateTime"
31360 },
31361 "startTime": {
31362 "type": "string",
31363 "title": "TimeSpan"
31364 },
31365 "end": {
31366 "format": "date-time",
31367 "type": "string",
31368 "title": "DateTime"
31369 },
31370 "endTime": {
31371 "type": "string",
31372 "title": "TimeSpan"
31373 },
31374 "locationId": {
31375 "type": "string",
31376 "title": "String"
31377 },
31378 "location": {
31379 "type": "string",
31380 "title": "String"
31381 },
31382 "workTypeId": {
31383 "type": "string",
31384 "title": "String"
31385 },
31386 "workType": {
31387 "type": "string",
31388 "title": "String"
31389 },
31390 "status": {
31391 "type": "string",
31392 "title": "String"
31393 },
31394 "oldCost": {
31395 "format": "double",
31396 "type": "number",
31397 "title": "Nullable<Decimal>"
31398 },
31399 "newCost": {
31400 "format": "double",
31401 "type": "number",
31402 "title": "Nullable<Decimal>"
31403 }
31404 },
31405 "xml": {
31406 "name": "ShiftSwappingReportExportModel"
31407 },
31408 "title": "ShiftSwappingReportExportModel"
31409 },
31410 "ODataQueryOptions[PayCategory]": {
31411 "type": "object",
31412 "properties": {
31413 "ifMatch": {
31414 "type": "object",
31415 "readOnly": true,
31416 "title": "ETag<PayCategory>"
31417 },
31418 "ifNoneMatch": {
31419 "type": "object",
31420 "readOnly": true,
31421 "title": "ETag<PayCategory>"
31422 },
31423 "context": {
31424 "$ref": "#/definitions/ODataQueryContext",
31425 "readOnly": true
31426 },
31427 "request": {
31428 "type": "object",
31429 "readOnly": true,
31430 "title": "HttpRequestMessage"
31431 },
31432 "rawValues": {
31433 "$ref": "#/definitions/ODataRawQueryOptions",
31434 "readOnly": true
31435 },
31436 "selectExpand": {
31437 "$ref": "#/definitions/SelectExpandQueryOption",
31438 "readOnly": true
31439 },
31440 "filter": {
31441 "$ref": "#/definitions/FilterQueryOption",
31442 "readOnly": true
31443 },
31444 "orderBy": {
31445 "$ref": "#/definitions/OrderByQueryOption",
31446 "readOnly": true
31447 },
31448 "skip": {
31449 "$ref": "#/definitions/SkipQueryOption",
31450 "readOnly": true
31451 },
31452 "top": {
31453 "$ref": "#/definitions/TopQueryOption",
31454 "readOnly": true
31455 },
31456 "inlineCount": {
31457 "$ref": "#/definitions/InlineCountQueryOption",
31458 "readOnly": true
31459 },
31460 "validator": {
31461 "$ref": "#/definitions/ODataQueryValidator"
31462 }
31463 },
31464 "xml": {
31465 "name": "ODataQueryOptions`1"
31466 },
31467 "title": "ODataQueryOptions<PayCategory>"
31468 },
31469 "PayCategoryModel": {
31470 "type": "object",
31471 "properties": {
31472 "id": {
31473 "format": "int32",
31474 "type": "integer",
31475 "title": "Int32"
31476 },
31477 "parentId": {
31478 "format": "int32",
31479 "type": "integer",
31480 "title": "Nullable<Int32>"
31481 },
31482 "name": {
31483 "type": "string",
31484 "title": "String"
31485 },
31486 "rateUnit": {
31487 "enum": [
31488 "Hourly",
31489 "Annually",
31490 "Fixed",
31491 "Daily"
31492 ],
31493 "type": "string",
31494 "title": "RateUnitEnum"
31495 },
31496 "accruesLeave": {
31497 "type": "boolean",
31498 "title": "Boolean"
31499 },
31500 "defaultSuperRate": {
31501 "format": "double",
31502 "type": "number",
31503 "title": "Decimal"
31504 },
31505 "rateLoadingPercent": {
31506 "format": "double",
31507 "type": "number",
31508 "title": "Decimal"
31509 },
31510 "penaltyLoadingPercent": {
31511 "format": "double",
31512 "type": "number",
31513 "title": "Decimal"
31514 },
31515 "isTaxExempt": {
31516 "type": "boolean",
31517 "title": "Boolean"
31518 },
31519 "isPayrollTaxExempt": {
31520 "type": "boolean",
31521 "title": "Boolean"
31522 },
31523 "externalId": {
31524 "type": "string",
31525 "title": "String"
31526 },
31527 "source": {
31528 "type": "string",
31529 "title": "String"
31530 },
31531 "generalLedgerMappingCode": {
31532 "type": "string",
31533 "title": "String"
31534 },
31535 "superExpenseMappingCode": {
31536 "type": "string",
31537 "title": "String"
31538 },
31539 "superLiabilityMappingCode": {
31540 "type": "string",
31541 "title": "String"
31542 },
31543 "isSystemPayCategory": {
31544 "type": "boolean",
31545 "title": "Boolean"
31546 },
31547 "numberOfDecimalPlaces": {
31548 "format": "int32",
31549 "type": "integer",
31550 "title": "Nullable<Int32>"
31551 },
31552 "paymentSummaryClassification": {
31553 "enum": [
31554 "Default",
31555 "Allowance",
31556 "LumpSumATypeR",
31557 "LumpSumATypeT",
31558 "LumpSumB",
31559 "LumpSumD",
31560 "LumpSumE",
31561 "Exclude",
31562 "Cdep",
31563 "ExemptForeignEmploymentIncome"
31564 ],
31565 "type": "string",
31566 "title": "Nullable<PayCategoryPaymentSummaryClassification>"
31567 }
31568 },
31569 "xml": {
31570 "name": "PayCategoryModel"
31571 },
31572 "title": "PayCategoryModel"
31573 },
31574 "ODataQueryOptions[PaygPaymentSummarySnapshot]": {
31575 "type": "object",
31576 "properties": {
31577 "ifMatch": {
31578 "type": "object",
31579 "readOnly": true,
31580 "title": "ETag<PaygPaymentSummarySnapshot>"
31581 },
31582 "ifNoneMatch": {
31583 "type": "object",
31584 "readOnly": true,
31585 "title": "ETag<PaygPaymentSummarySnapshot>"
31586 },
31587 "context": {
31588 "$ref": "#/definitions/ODataQueryContext",
31589 "readOnly": true
31590 },
31591 "request": {
31592 "type": "object",
31593 "readOnly": true,
31594 "title": "HttpRequestMessage"
31595 },
31596 "rawValues": {
31597 "$ref": "#/definitions/ODataRawQueryOptions",
31598 "readOnly": true
31599 },
31600 "selectExpand": {
31601 "$ref": "#/definitions/SelectExpandQueryOption",
31602 "readOnly": true
31603 },
31604 "filter": {
31605 "$ref": "#/definitions/FilterQueryOption",
31606 "readOnly": true
31607 },
31608 "orderBy": {
31609 "$ref": "#/definitions/OrderByQueryOption",
31610 "readOnly": true
31611 },
31612 "skip": {
31613 "$ref": "#/definitions/SkipQueryOption",
31614 "readOnly": true
31615 },
31616 "top": {
31617 "$ref": "#/definitions/TopQueryOption",
31618 "readOnly": true
31619 },
31620 "inlineCount": {
31621 "$ref": "#/definitions/InlineCountQueryOption",
31622 "readOnly": true
31623 },
31624 "validator": {
31625 "$ref": "#/definitions/ODataQueryValidator"
31626 }
31627 },
31628 "xml": {
31629 "name": "ODataQueryOptions`1"
31630 },
31631 "title": "ODataQueryOptions<PaygPaymentSummarySnapshot>"
31632 },
31633 "PaygPaymentSummaryModel": {
31634 "type": "object",
31635 "properties": {
31636 "employeeId": {
31637 "format": "int32",
31638 "type": "integer",
31639 "title": "Int32"
31640 },
31641 "employingEntityId": {
31642 "format": "int32",
31643 "type": "integer",
31644 "title": "Nullable<Int32>"
31645 },
31646 "dateGenerated": {
31647 "format": "date-time",
31648 "type": "string",
31649 "title": "DateTime"
31650 },
31651 "paymentSummaryType": {
31652 "enum": [
31653 "BusinessAndPersonalServicesIncome",
31654 "EmployeeTerminationPayment",
31655 "ForeignEmployment",
31656 "IndividualNonBusiness",
31657 "SuperannuationIncomeStream",
31658 "SuperannuationLumpSum"
31659 ],
31660 "type": "string",
31661 "title": "PaygPaymentSummaryTypeEnum"
31662 },
31663 "status": {
31664 "enum": [
31665 "Generated",
31666 "Published",
31667 "Unpublished"
31668 ],
31669 "type": "string",
31670 "title": "PaygPaymentSummaryStatus"
31671 },
31672 "etpCode": {
31673 "type": "string",
31674 "title": "String"
31675 },
31676 "isAmended": {
31677 "type": "boolean",
31678 "title": "Boolean"
31679 },
31680 "payeeName": {
31681 "type": "string",
31682 "title": "String"
31683 },
31684 "payeeAddress": {
31685 "type": "string",
31686 "title": "String"
31687 },
31688 "payeeAddressLine2": {
31689 "type": "string",
31690 "title": "String"
31691 },
31692 "payeeSuburb": {
31693 "type": "string",
31694 "title": "String"
31695 },
31696 "payeePostCode": {
31697 "type": "string",
31698 "title": "String"
31699 },
31700 "payeeState": {
31701 "type": "string",
31702 "title": "String"
31703 },
31704 "paymentPeriodStart": {
31705 "format": "date-time",
31706 "type": "string",
31707 "title": "DateTime"
31708 },
31709 "paymentPeriodEnd": {
31710 "format": "date-time",
31711 "type": "string",
31712 "title": "DateTime"
31713 },
31714 "financialYearStart": {
31715 "format": "date-time",
31716 "type": "string",
31717 "title": "DateTime"
31718 },
31719 "financialYearEnd": {
31720 "format": "date-time",
31721 "type": "string",
31722 "title": "DateTime"
31723 },
31724 "payeeTaxFileNumber": {
31725 "type": "string",
31726 "title": "String"
31727 },
31728 "totalTaxWithheld": {
31729 "format": "int32",
31730 "type": "integer",
31731 "title": "Int32"
31732 },
31733 "grossPayments": {
31734 "format": "int32",
31735 "type": "integer",
31736 "title": "Int32"
31737 },
31738 "cdepPayments": {
31739 "format": "int32",
31740 "type": "integer",
31741 "title": "Int32"
31742 },
31743 "fringeBenefits": {
31744 "format": "int32",
31745 "type": "integer",
31746 "title": "Int32"
31747 },
31748 "isExemptFromFringeBenefitsTax": {
31749 "type": "boolean",
31750 "title": "Nullable<Boolean>"
31751 },
31752 "employerSuperContributions": {
31753 "format": "int32",
31754 "type": "integer",
31755 "title": "Int32"
31756 },
31757 "totalAllowances": {
31758 "format": "int32",
31759 "type": "integer",
31760 "title": "Int32"
31761 },
31762 "lumpSumA": {
31763 "format": "int32",
31764 "type": "integer",
31765 "title": "Int32"
31766 },
31767 "lumpSumB": {
31768 "format": "int32",
31769 "type": "integer",
31770 "title": "Int32"
31771 },
31772 "lumpSumD": {
31773 "format": "int32",
31774 "type": "integer",
31775 "title": "Int32"
31776 },
31777 "lumpSumE": {
31778 "format": "int32",
31779 "type": "integer",
31780 "title": "Int32"
31781 },
31782 "lumpSumAType": {
31783 "type": "string",
31784 "title": "String"
31785 },
31786 "notReportedAmount": {
31787 "format": "int32",
31788 "type": "integer",
31789 "title": "Int32"
31790 },
31791 "allowances": {
31792 "type": "object",
31793 "additionalProperties": {
31794 "format": "int32",
31795 "type": "integer",
31796 "title": "Int32"
31797 },
31798 "title": "Dictionary<String,Int32>"
31799 },
31800 "unionFeeDeductions": {
31801 "type": "object",
31802 "additionalProperties": {
31803 "format": "int32",
31804 "type": "integer",
31805 "title": "Int32"
31806 },
31807 "title": "Dictionary<String,Int32>"
31808 },
31809 "workplaceGiving": {
31810 "format": "int32",
31811 "type": "integer",
31812 "title": "Int32"
31813 },
31814 "exemptForeignEmploymentIncome": {
31815 "format": "int32",
31816 "type": "integer",
31817 "title": "Int32"
31818 },
31819 "deductibleAmountOfUndeductedAnnuityPrice": {
31820 "format": "int32",
31821 "type": "integer",
31822 "title": "Int32"
31823 },
31824 "otherAmounts": {
31825 "type": "array",
31826 "items": {
31827 "$ref": "#/definitions/OtherAmounts"
31828 },
31829 "xml": {
31830 "name": "OtherAmounts",
31831 "wrapped": true
31832 },
31833 "title": "IList<OtherAmounts>"
31834 },
31835 "payerABN": {
31836 "type": "string",
31837 "title": "String"
31838 },
31839 "payerName": {
31840 "type": "string",
31841 "title": "String"
31842 },
31843 "payerBranch": {
31844 "type": "string",
31845 "title": "String"
31846 },
31847 "payerSignatory": {
31848 "type": "string",
31849 "title": "String"
31850 },
31851 "paymentDate": {
31852 "format": "date-time",
31853 "type": "string",
31854 "title": "DateTime"
31855 },
31856 "isTransitionalTerminationPayment": {
31857 "type": "boolean",
31858 "title": "Boolean"
31859 },
31860 "isPartOfEarlierPayment": {
31861 "type": "boolean",
31862 "title": "Boolean"
31863 },
31864 "taxableComponent": {
31865 "format": "int32",
31866 "type": "integer",
31867 "title": "Int32"
31868 },
31869 "taxFreeComponent": {
31870 "format": "int32",
31871 "type": "integer",
31872 "title": "Int32"
31873 },
31874 "payeeABN": {
31875 "type": "string",
31876 "title": "String"
31877 },
31878 "paymentType": {
31879 "type": "string",
31880 "title": "String"
31881 },
31882 "grossPaymentType": {
31883 "type": "string",
31884 "title": "String"
31885 },
31886 "foreignTaxPaid": {
31887 "format": "int32",
31888 "type": "integer",
31889 "title": "Int32"
31890 },
31891 "taxableComponentTaxedElement": {
31892 "format": "int32",
31893 "type": "integer",
31894 "title": "Int32"
31895 },
31896 "taxableComponentUntaxedElement": {
31897 "format": "int32",
31898 "type": "integer",
31899 "title": "Int32"
31900 },
31901 "taxableComponentTaxFreeComponent": {
31902 "format": "int32",
31903 "type": "integer",
31904 "title": "Int32"
31905 },
31906 "taxableComponentTaxOffsetAmount": {
31907 "format": "int32",
31908 "type": "integer",
31909 "title": "Int32"
31910 },
31911 "lumpSumInArrearsTaxedElement": {
31912 "format": "int32",
31913 "type": "integer",
31914 "title": "Int32"
31915 },
31916 "lumpSumInArrearsUntaxedElement": {
31917 "format": "int32",
31918 "type": "integer",
31919 "title": "Int32"
31920 },
31921 "lumpSumInArrearsTaxFreeComponent": {
31922 "format": "int32",
31923 "type": "integer",
31924 "title": "Int32"
31925 },
31926 "isDeathBenefit": {
31927 "type": "boolean",
31928 "title": "Boolean"
31929 },
31930 "deathBenefitType": {
31931 "type": "string",
31932 "title": "String"
31933 },
31934 "inputGrossEarnings": {
31935 "format": "double",
31936 "type": "number",
31937 "title": "Nullable<Decimal>"
31938 },
31939 "inputPreTaxDeductionAmount": {
31940 "format": "double",
31941 "type": "number",
31942 "title": "Nullable<Decimal>"
31943 },
31944 "totalDeductions": {
31945 "format": "double",
31946 "type": "number",
31947 "readOnly": true,
31948 "title": "Decimal"
31949 }
31950 },
31951 "xml": {
31952 "name": "PaygPaymentSummaryModel"
31953 },
31954 "title": "PaygPaymentSummaryModel"
31955 },
31956 "OtherAmounts": {
31957 "type": "object",
31958 "properties": {
31959 "workPlaceGiving": {
31960 "format": "double",
31961 "type": "number",
31962 "title": "Decimal"
31963 },
31964 "exemptForeignExemptIncome": {
31965 "format": "double",
31966 "type": "number",
31967 "title": "Decimal"
31968 },
31969 "deductibleAmountOfUndeductedAnnuityPrice": {
31970 "format": "double",
31971 "type": "number",
31972 "title": "Decimal"
31973 }
31974 },
31975 "xml": {
31976 "name": "OtherAmounts"
31977 },
31978 "title": "OtherAmounts"
31979 },
31980 "ODataQueryOptions[PayRateTemplate]": {
31981 "type": "object",
31982 "properties": {
31983 "ifMatch": {
31984 "type": "object",
31985 "readOnly": true,
31986 "title": "ETag<PayRateTemplate>"
31987 },
31988 "ifNoneMatch": {
31989 "type": "object",
31990 "readOnly": true,
31991 "title": "ETag<PayRateTemplate>"
31992 },
31993 "context": {
31994 "$ref": "#/definitions/ODataQueryContext",
31995 "readOnly": true
31996 },
31997 "request": {
31998 "type": "object",
31999 "readOnly": true,
32000 "title": "HttpRequestMessage"
32001 },
32002 "rawValues": {
32003 "$ref": "#/definitions/ODataRawQueryOptions",
32004 "readOnly": true
32005 },
32006 "selectExpand": {
32007 "$ref": "#/definitions/SelectExpandQueryOption",
32008 "readOnly": true
32009 },
32010 "filter": {
32011 "$ref": "#/definitions/FilterQueryOption",
32012 "readOnly": true
32013 },
32014 "orderBy": {
32015 "$ref": "#/definitions/OrderByQueryOption",
32016 "readOnly": true
32017 },
32018 "skip": {
32019 "$ref": "#/definitions/SkipQueryOption",
32020 "readOnly": true
32021 },
32022 "top": {
32023 "$ref": "#/definitions/TopQueryOption",
32024 "readOnly": true
32025 },
32026 "inlineCount": {
32027 "$ref": "#/definitions/InlineCountQueryOption",
32028 "readOnly": true
32029 },
32030 "validator": {
32031 "$ref": "#/definitions/ODataQueryValidator"
32032 }
32033 },
32034 "xml": {
32035 "name": "ODataQueryOptions`1"
32036 },
32037 "title": "ODataQueryOptions<PayRateTemplate>"
32038 },
32039 "PayRunEmployeeExpenseResponse": {
32040 "type": "object",
32041 "properties": {
32042 "employeeExpenses": {
32043 "type": "object",
32044 "additionalProperties": {
32045 "type": "array",
32046 "items": {
32047 "$ref": "#/definitions/EmployeeExpenseModel"
32048 },
32049 "xml": {
32050 "name": "EmployeeExpenseModel",
32051 "wrapped": true
32052 },
32053 "title": "List<EmployeeExpenseModel>"
32054 },
32055 "readOnly": true,
32056 "title": "Dictionary<String,List`1>"
32057 },
32058 "payRunId": {
32059 "format": "int32",
32060 "type": "integer",
32061 "title": "Int32"
32062 }
32063 },
32064 "xml": {
32065 "name": "PayRunEmployeeExpenseResponse"
32066 },
32067 "example": {
32068 "employeeExpenses": {
32069 "12345": [
32070 {
32071 "employeeExpenseCategoryId": "98",
32072 "employeeExpenseCategoryName": "My expense category",
32073 "notes": "Some notes",
32074 "amount": 12.34,
32075 "taxCode": "42rty",
32076 "taxRate": 0.5,
32077 "taxCodeDisplayName": "Tax Code Display",
32078 "id": 0,
32079 "externalId": null,
32080 "locationId": "39",
32081 "locationName": "My Location",
32082 "employeeId": "12345",
32083 "employeeName": "Bob Bobberson",
32084 "employeeExternalId": "EMP01"
32085 }
32086 ]
32087 },
32088 "payRunId": 999
32089 },
32090 "title": "PayRunEmployeeExpenseResponse"
32091 },
32092 "EmployeeExpenseModel": {
32093 "type": "object",
32094 "properties": {
32095 "employeeExpenseCategoryId": {
32096 "type": "string",
32097 "title": "String"
32098 },
32099 "employeeExpenseCategoryName": {
32100 "type": "string",
32101 "title": "String"
32102 },
32103 "notes": {
32104 "type": "string",
32105 "title": "String"
32106 },
32107 "amount": {
32108 "format": "double",
32109 "type": "number",
32110 "title": "Decimal"
32111 },
32112 "taxCode": {
32113 "type": "string",
32114 "title": "String"
32115 },
32116 "taxRate": {
32117 "format": "double",
32118 "type": "number",
32119 "title": "Nullable<Decimal>"
32120 },
32121 "taxCodeDisplayName": {
32122 "type": "string",
32123 "title": "String"
32124 },
32125 "id": {
32126 "format": "int32",
32127 "type": "integer",
32128 "title": "Int32"
32129 },
32130 "externalId": {
32131 "type": "string",
32132 "title": "String"
32133 },
32134 "locationId": {
32135 "type": "string",
32136 "title": "String"
32137 },
32138 "locationName": {
32139 "type": "string",
32140 "title": "String"
32141 },
32142 "employeeId": {
32143 "type": "string",
32144 "title": "String"
32145 },
32146 "employeeName": {
32147 "type": "string",
32148 "title": "String"
32149 },
32150 "employeeExternalId": {
32151 "type": "string",
32152 "title": "String"
32153 }
32154 },
32155 "xml": {
32156 "name": "EmployeeExpenseModel"
32157 },
32158 "title": "EmployeeExpenseModel"
32159 },
32160 "SubmitPayRunEmployeeExpenseRequest": {
32161 "type": "object",
32162 "properties": {
32163 "locationIdType": {
32164 "enum": [
32165 "Standard",
32166 "External"
32167 ],
32168 "type": "string",
32169 "title": "IdType"
32170 },
32171 "employeeExpenseCategoryIdType": {
32172 "enum": [
32173 "Standard",
32174 "External"
32175 ],
32176 "type": "string",
32177 "title": "IdType"
32178 },
32179 "expenses": {
32180 "type": "object",
32181 "additionalProperties": {
32182 "type": "array",
32183 "items": {
32184 "$ref": "#/definitions/EmployeeExpenseModel"
32185 },
32186 "xml": {
32187 "name": "EmployeeExpenseModel",
32188 "wrapped": true
32189 },
32190 "title": "List<EmployeeExpenseModel>"
32191 },
32192 "title": "Dictionary<String,List`1>"
32193 },
32194 "payRunId": {
32195 "format": "int32",
32196 "type": "integer",
32197 "title": "Int32"
32198 },
32199 "employeeIdType": {
32200 "enum": [
32201 "Standard",
32202 "External"
32203 ],
32204 "type": "string",
32205 "title": "IdType"
32206 },
32207 "replaceExisting": {
32208 "type": "boolean",
32209 "title": "Boolean"
32210 },
32211 "suppressCalculations": {
32212 "type": "boolean",
32213 "title": "Boolean"
32214 }
32215 },
32216 "xml": {
32217 "name": "SubmitPayRunEmployeeExpenseRequest"
32218 },
32219 "title": "SubmitPayRunEmployeeExpenseRequest"
32220 },
32221 "PayRunDetailsModel": {
32222 "type": "object",
32223 "properties": {
32224 "payRun": {
32225 "$ref": "#/definitions/PayRunModel"
32226 },
32227 "payRunTotals": {
32228 "type": "array",
32229 "items": {
32230 "$ref": "#/definitions/PayRunTotalGridModel"
32231 },
32232 "xml": {
32233 "name": "PayRunTotalGridModel",
32234 "wrapped": true
32235 },
32236 "title": "IList<PayRunTotalGridModel>"
32237 },
32238 "grandTotal": {
32239 "$ref": "#/definitions/PayRunGrandTotalModel"
32240 }
32241 },
32242 "xml": {
32243 "name": "PayRunDetailsModel"
32244 },
32245 "title": "PayRunDetailsModel"
32246 },
32247 "PayRunModel": {
32248 "type": "object",
32249 "properties": {
32250 "id": {
32251 "format": "int32",
32252 "type": "integer",
32253 "title": "Int32"
32254 },
32255 "dateFinalised": {
32256 "format": "date-time",
32257 "type": "string",
32258 "title": "Nullable<DateTime>"
32259 },
32260 "payScheduleId": {
32261 "format": "int32",
32262 "type": "integer",
32263 "title": "Int32"
32264 },
32265 "payPeriodStarting": {
32266 "format": "date-time",
32267 "type": "string",
32268 "title": "DateTime"
32269 },
32270 "payPeriodEnding": {
32271 "format": "date-time",
32272 "type": "string",
32273 "title": "DateTime"
32274 },
32275 "datePaid": {
32276 "format": "date-time",
32277 "type": "string",
32278 "title": "DateTime"
32279 },
32280 "isFinalised": {
32281 "type": "boolean",
32282 "title": "Boolean"
32283 },
32284 "paySlipsPublished": {
32285 "type": "boolean",
32286 "title": "Boolean"
32287 },
32288 "notation": {
32289 "type": "string",
32290 "title": "String"
32291 },
32292 "externalId": {
32293 "type": "string",
32294 "title": "String"
32295 }
32296 },
32297 "xml": {
32298 "name": "PayRunModel"
32299 },
32300 "title": "PayRunModel"
32301 },
32302 "PayRunTotalGridModel": {
32303 "type": "object",
32304 "properties": {
32305 "id": {
32306 "format": "int32",
32307 "type": "integer",
32308 "title": "Int32"
32309 },
32310 "employeeName": {
32311 "type": "string",
32312 "title": "String"
32313 },
32314 "totalHours": {
32315 "format": "double",
32316 "type": "number",
32317 "title": "Decimal"
32318 },
32319 "grossEarnings": {
32320 "format": "double",
32321 "type": "number",
32322 "title": "Decimal"
32323 },
32324 "netEarnings": {
32325 "format": "double",
32326 "type": "number",
32327 "title": "Decimal"
32328 },
32329 "paygWithholdingAmount": {
32330 "format": "double",
32331 "type": "number",
32332 "title": "Decimal"
32333 },
32334 "paygWithholdingPercent": {
32335 "format": "double",
32336 "type": "number",
32337 "readOnly": true,
32338 "title": "Decimal"
32339 },
32340 "sfssAmount": {
32341 "format": "double",
32342 "type": "number",
32343 "title": "Decimal"
32344 },
32345 "helpAmount": {
32346 "format": "double",
32347 "type": "number",
32348 "title": "Decimal"
32349 },
32350 "superContribution": {
32351 "format": "double",
32352 "type": "number",
32353 "title": "Decimal"
32354 },
32355 "employerContribution": {
32356 "format": "double",
32357 "type": "number",
32358 "title": "Decimal"
32359 },
32360 "superContributionMinusSuperAdjustments": {
32361 "format": "double",
32362 "type": "number",
32363 "readOnly": true,
32364 "title": "Decimal"
32365 },
32366 "allSuperContributionsTotal": {
32367 "format": "double",
32368 "type": "number",
32369 "readOnly": true,
32370 "title": "Decimal"
32371 },
32372 "taxableEarnings": {
32373 "format": "double",
32374 "type": "number",
32375 "title": "Decimal"
32376 },
32377 "postTaxDeductionAmount": {
32378 "format": "double",
32379 "type": "number",
32380 "title": "Decimal"
32381 },
32382 "preTaxDeductionAmount": {
32383 "format": "double",
32384 "type": "number",
32385 "title": "Decimal"
32386 },
32387 "grossPlusSuper": {
32388 "format": "double",
32389 "type": "number",
32390 "readOnly": true,
32391 "title": "Decimal"
32392 },
32393 "payConditionRuleSetName": {
32394 "type": "string",
32395 "title": "String"
32396 },
32397 "employeeId": {
32398 "format": "int32",
32399 "type": "integer",
32400 "title": "Int32"
32401 },
32402 "isTermination": {
32403 "type": "boolean",
32404 "title": "Boolean"
32405 },
32406 "notation": {
32407 "type": "string",
32408 "title": "String"
32409 },
32410 "employeeStartDate": {
32411 "format": "date-time",
32412 "type": "string",
32413 "title": "Nullable<DateTime>"
32414 },
32415 "employeeExternalReferenceId": {
32416 "type": "string",
32417 "title": "String"
32418 },
32419 "isExcluded": {
32420 "type": "boolean",
32421 "title": "Boolean"
32422 },
32423 "employeeExternalId": {
32424 "type": "string",
32425 "title": "String"
32426 },
32427 "superAdjustmentsAmount": {
32428 "format": "double",
32429 "type": "number",
32430 "title": "Decimal"
32431 },
32432 "salarySacrificeSuperAmount": {
32433 "format": "double",
32434 "type": "number",
32435 "title": "Decimal"
32436 },
32437 "memberVoluntarySuperAmount": {
32438 "format": "double",
32439 "type": "number",
32440 "title": "Decimal"
32441 },
32442 "nonSuperDeductionTotal": {
32443 "format": "double",
32444 "type": "number",
32445 "title": "Decimal"
32446 },
32447 "superPaymentsTotal": {
32448 "format": "double",
32449 "type": "number",
32450 "title": "Decimal"
32451 },
32452 "bankPaymentsTotal": {
32453 "format": "double",
32454 "type": "number",
32455 "title": "Decimal"
32456 },
32457 "terminationDate": {
32458 "format": "date-time",
32459 "type": "string",
32460 "title": "Nullable<DateTime>"
32461 },
32462 "earliestTerminationDate": {
32463 "format": "date-time",
32464 "type": "string",
32465 "title": "Nullable<DateTime>"
32466 },
32467 "previousTerminationDate": {
32468 "format": "date-time",
32469 "type": "string",
32470 "title": "Nullable<DateTime>"
32471 },
32472 "employeeExpensesTotal": {
32473 "format": "double",
32474 "type": "number",
32475 "title": "Decimal"
32476 },
32477 "employerLiabilitiesTotal": {
32478 "format": "double",
32479 "type": "number",
32480 "title": "Decimal"
32481 },
32482 "isEmployeeUnder18": {
32483 "type": "boolean",
32484 "title": "Boolean"
32485 },
32486 "employerContributionAdjustmentsAmount": {
32487 "format": "double",
32488 "type": "number",
32489 "title": "Decimal"
32490 },
32491 "paygAdjustmentsAmount": {
32492 "format": "double",
32493 "type": "number",
32494 "title": "Decimal"
32495 },
32496 "superContributionsCapApplied": {
32497 "type": "boolean",
32498 "title": "Boolean"
32499 },
32500 "isComplete": {
32501 "type": "boolean",
32502 "title": "Boolean"
32503 },
32504 "paygPaymentTotal": {
32505 "format": "double",
32506 "type": "number",
32507 "title": "Decimal"
32508 }
32509 },
32510 "xml": {
32511 "name": "PayRunTotalGridModel"
32512 },
32513 "title": "PayRunTotalGridModel"
32514 },
32515 "PayRunGrandTotalModel": {
32516 "type": "object",
32517 "properties": {
32518 "numberOfEmployees": {
32519 "format": "int32",
32520 "type": "integer",
32521 "title": "Int32"
32522 },
32523 "totalHours": {
32524 "format": "double",
32525 "type": "number",
32526 "title": "Decimal"
32527 },
32528 "taxableEarnings": {
32529 "format": "double",
32530 "type": "number",
32531 "title": "Decimal"
32532 },
32533 "grossEarnings": {
32534 "format": "double",
32535 "type": "number",
32536 "title": "Decimal"
32537 },
32538 "netEarnings": {
32539 "format": "double",
32540 "type": "number",
32541 "title": "Decimal"
32542 },
32543 "paygWithholdingAmount": {
32544 "format": "double",
32545 "type": "number",
32546 "title": "Decimal"
32547 },
32548 "sfssAmount": {
32549 "format": "double",
32550 "type": "number",
32551 "title": "Decimal"
32552 },
32553 "helpAmount": {
32554 "format": "double",
32555 "type": "number",
32556 "title": "Decimal"
32557 },
32558 "superContribution": {
32559 "format": "double",
32560 "type": "number",
32561 "title": "Decimal"
32562 },
32563 "preTaxDeductionAmount": {
32564 "format": "double",
32565 "type": "number",
32566 "title": "Decimal"
32567 },
32568 "postTaxDeductionAmount": {
32569 "format": "double",
32570 "type": "number",
32571 "title": "Decimal"
32572 },
32573 "employerContribution": {
32574 "format": "double",
32575 "type": "number",
32576 "title": "Decimal"
32577 },
32578 "employeeExpensesTotal": {
32579 "format": "double",
32580 "type": "number",
32581 "title": "Decimal"
32582 },
32583 "employerLiabilitiesTotal": {
32584 "format": "double",
32585 "type": "number",
32586 "title": "Decimal"
32587 }
32588 },
32589 "xml": {
32590 "name": "PayRunGrandTotalModel"
32591 },
32592 "title": "PayRunGrandTotalModel"
32593 },
32594 "TerminateEmployeeRequest": {
32595 "type": "object",
32596 "properties": {
32597 "employeeId": {
32598 "format": "int32",
32599 "type": "integer",
32600 "title": "Int32"
32601 }
32602 },
32603 "xml": {
32604 "name": "TerminateEmployeeRequest"
32605 },
32606 "title": "TerminateEmployeeRequest"
32607 },
32608 "ApiPaySlipModel": {
32609 "type": "object",
32610 "properties": {
32611 "totalAccruedLeave": {
32612 "type": "array",
32613 "items": {
32614 "$ref": "#/definitions/ApiPaySlipLeaveModel"
32615 },
32616 "xml": {
32617 "name": "ApiPaySlipLeaveModel",
32618 "wrapped": true
32619 },
32620 "title": "IList<ApiPaySlipLeaveModel>"
32621 },
32622 "accruedLeave": {
32623 "type": "array",
32624 "items": {
32625 "$ref": "#/definitions/ApiPaySlipLeaveModel"
32626 },
32627 "xml": {
32628 "name": "ApiPaySlipLeaveModel",
32629 "wrapped": true
32630 },
32631 "title": "IList<ApiPaySlipLeaveModel>"
32632 },
32633 "leaveTaken": {
32634 "type": "array",
32635 "items": {
32636 "$ref": "#/definitions/ApiPaySlipLeaveModel"
32637 },
32638 "xml": {
32639 "name": "ApiPaySlipLeaveModel",
32640 "wrapped": true
32641 },
32642 "title": "IList<ApiPaySlipLeaveModel>"
32643 },
32644 "paygAdjustments": {
32645 "type": "array",
32646 "items": {
32647 "$ref": "#/definitions/ApiPaySlipPaygAdjustmentModel"
32648 },
32649 "xml": {
32650 "name": "ApiPaySlipPaygAdjustmentModel",
32651 "wrapped": true
32652 },
32653 "title": "IList<ApiPaySlipPaygAdjustmentModel>"
32654 },
32655 "superAdjustments": {
32656 "type": "array",
32657 "items": {
32658 "$ref": "#/definitions/ApiPaySlipSuperAdjustmentModel"
32659 },
32660 "xml": {
32661 "name": "ApiPaySlipSuperAdjustmentModel",
32662 "wrapped": true
32663 },
32664 "title": "IList<ApiPaySlipSuperAdjustmentModel>"
32665 },
32666 "earningsLines": {
32667 "type": "array",
32668 "items": {
32669 "$ref": "#/definitions/ApiPaySlipEarningsLineModel"
32670 },
32671 "xml": {
32672 "name": "ApiPaySlipEarningsLineModel",
32673 "wrapped": true
32674 },
32675 "title": "IList<ApiPaySlipEarningsLineModel>"
32676 },
32677 "deductions": {
32678 "type": "array",
32679 "items": {
32680 "$ref": "#/definitions/ApiPaySlipDeductionModel"
32681 },
32682 "xml": {
32683 "name": "ApiPaySlipDeductionModel",
32684 "wrapped": true
32685 },
32686 "title": "IList<ApiPaySlipDeductionModel>"
32687 },
32688 "superPayments": {
32689 "type": "array",
32690 "items": {
32691 "$ref": "#/definitions/ApiPaySlipSuperPaymentModel"
32692 },
32693 "xml": {
32694 "name": "ApiPaySlipSuperPaymentModel",
32695 "wrapped": true
32696 },
32697 "title": "IList<ApiPaySlipSuperPaymentModel>"
32698 },
32699 "bankPayments": {
32700 "type": "array",
32701 "items": {
32702 "$ref": "#/definitions/ApiPaySlipBankPaymentModel"
32703 },
32704 "xml": {
32705 "name": "ApiPaySlipBankPaymentModel",
32706 "wrapped": true
32707 },
32708 "title": "IList<ApiPaySlipBankPaymentModel>"
32709 },
32710 "grossYTDDetails": {
32711 "type": "array",
32712 "items": {
32713 "$ref": "#/definitions/ApiYearToDateEarningsBreakdownModel"
32714 },
32715 "xml": {
32716 "name": "ApiYearToDateEarningsBreakdownModel",
32717 "wrapped": true
32718 },
32719 "title": "IList<ApiYearToDateEarningsBreakdownModel>"
32720 },
32721 "employeeExpenses": {
32722 "type": "array",
32723 "items": {
32724 "$ref": "#/definitions/ApiEmployeeExpenseGridModel"
32725 },
32726 "xml": {
32727 "name": "ApiEmployeeExpenseGridModel",
32728 "wrapped": true
32729 },
32730 "title": "IList<ApiEmployeeExpenseGridModel>"
32731 },
32732 "totalHours": {
32733 "format": "double",
32734 "type": "number",
32735 "title": "Decimal"
32736 },
32737 "grossEarnings": {
32738 "format": "double",
32739 "type": "number",
32740 "title": "Decimal"
32741 },
32742 "netEarnings": {
32743 "format": "double",
32744 "type": "number",
32745 "title": "Decimal"
32746 },
32747 "paygWithholdingAmount": {
32748 "format": "double",
32749 "type": "number",
32750 "title": "Decimal"
32751 },
32752 "sfssAmount": {
32753 "format": "double",
32754 "type": "number",
32755 "title": "Decimal"
32756 },
32757 "helpAmount": {
32758 "format": "double",
32759 "type": "number",
32760 "title": "Decimal"
32761 },
32762 "superContribution": {
32763 "format": "double",
32764 "type": "number",
32765 "title": "Decimal"
32766 },
32767 "taxableEarnings": {
32768 "format": "double",
32769 "type": "number",
32770 "title": "Decimal"
32771 },
32772 "postTaxDeductionAmount": {
32773 "format": "double",
32774 "type": "number",
32775 "title": "Decimal"
32776 },
32777 "preTaxDeductionAmount": {
32778 "format": "double",
32779 "type": "number",
32780 "title": "Decimal"
32781 },
32782 "id": {
32783 "format": "int32",
32784 "type": "integer",
32785 "title": "Int32"
32786 },
32787 "businessName": {
32788 "type": "string",
32789 "title": "String"
32790 },
32791 "businessAddress": {
32792 "type": "string",
32793 "title": "String"
32794 },
32795 "abn": {
32796 "type": "string",
32797 "title": "String"
32798 },
32799 "contactName": {
32800 "type": "string",
32801 "title": "String"
32802 },
32803 "payPeriodStarting": {
32804 "type": "string",
32805 "title": "String"
32806 },
32807 "payPeriodEnding": {
32808 "type": "string",
32809 "title": "String"
32810 },
32811 "message": {
32812 "type": "string",
32813 "title": "String"
32814 },
32815 "employeeId": {
32816 "format": "int32",
32817 "type": "integer",
32818 "title": "Int32"
32819 },
32820 "employeeExternalId": {
32821 "type": "string",
32822 "title": "String"
32823 },
32824 "employeeName": {
32825 "type": "string",
32826 "title": "String"
32827 },
32828 "employeeFirstName": {
32829 "type": "string",
32830 "title": "String"
32831 },
32832 "employeeSurname": {
32833 "type": "string",
32834 "title": "String"
32835 },
32836 "employeePostalStreetAddress": {
32837 "type": "string",
32838 "title": "String"
32839 },
32840 "employeePostalAddressLine2": {
32841 "type": "string",
32842 "title": "String"
32843 },
32844 "employeePostalSuburbName": {
32845 "type": "string",
32846 "title": "String"
32847 },
32848 "employeePostalSuburbPostcode": {
32849 "type": "string",
32850 "title": "String"
32851 },
32852 "employeePostalSuburbState": {
32853 "type": "string",
32854 "title": "String"
32855 },
32856 "notation": {
32857 "type": "string",
32858 "title": "String"
32859 },
32860 "isPublished": {
32861 "type": "boolean",
32862 "title": "Boolean"
32863 },
32864 "grossYTD": {
32865 "format": "double",
32866 "type": "number",
32867 "title": "Decimal"
32868 },
32869 "netYTD": {
32870 "format": "double",
32871 "type": "number",
32872 "title": "Decimal"
32873 },
32874 "paygYTD": {
32875 "format": "double",
32876 "type": "number",
32877 "title": "Decimal"
32878 },
32879 "superYTD": {
32880 "format": "double",
32881 "type": "number",
32882 "title": "Decimal"
32883 },
32884 "taxableEarningsYTD": {
32885 "format": "double",
32886 "type": "number",
32887 "title": "Decimal"
32888 },
32889 "basePayRate": {
32890 "type": "string",
32891 "title": "String"
32892 },
32893 "baseRate": {
32894 "type": "string",
32895 "readOnly": true,
32896 "title": "String"
32897 },
32898 "hourlyRate": {
32899 "format": "double",
32900 "type": "number",
32901 "title": "Decimal"
32902 },
32903 "preTaxDeductionsYTD": {
32904 "format": "double",
32905 "type": "number",
32906 "title": "Decimal"
32907 },
32908 "postTaxDeductionsYTD": {
32909 "format": "double",
32910 "type": "number",
32911 "title": "Decimal"
32912 },
32913 "sfssYTD": {
32914 "format": "double",
32915 "type": "number",
32916 "title": "Decimal"
32917 },
32918 "helpYTD": {
32919 "format": "double",
32920 "type": "number",
32921 "title": "Decimal"
32922 },
32923 "employeeBaseRate": {
32924 "format": "double",
32925 "type": "number",
32926 "title": "Decimal"
32927 },
32928 "employeeBaseRateUnit": {
32929 "enum": [
32930 "Hourly",
32931 "Annually",
32932 "Fixed",
32933 "Daily"
32934 ],
32935 "type": "string",
32936 "title": "RateUnitEnum"
32937 }
32938 },
32939 "xml": {
32940 "name": "ApiPaySlipModel"
32941 },
32942 "title": "ApiPaySlipModel"
32943 },
32944 "ApiPaySlipLeaveModel": {
32945 "type": "object",
32946 "properties": {
32947 "leaveCategory": {
32948 "type": "string",
32949 "title": "String"
32950 },
32951 "amount": {
32952 "format": "double",
32953 "type": "number",
32954 "title": "Decimal"
32955 },
32956 "notes": {
32957 "type": "string",
32958 "title": "String"
32959 }
32960 },
32961 "xml": {
32962 "name": "ApiPaySlipLeaveModel"
32963 },
32964 "title": "ApiPaySlipLeaveModel"
32965 },
32966 "ApiPaySlipPaygAdjustmentModel": {
32967 "type": "object",
32968 "properties": {
32969 "notes": {
32970 "type": "string",
32971 "title": "String"
32972 },
32973 "amount": {
32974 "format": "double",
32975 "type": "number",
32976 "title": "Decimal"
32977 }
32978 },
32979 "xml": {
32980 "name": "ApiPaySlipPaygAdjustmentModel"
32981 },
32982 "title": "ApiPaySlipPaygAdjustmentModel"
32983 },
32984 "ApiPaySlipSuperAdjustmentModel": {
32985 "type": "object",
32986 "properties": {
32987 "notes": {
32988 "type": "string",
32989 "title": "String"
32990 },
32991 "amount": {
32992 "format": "double",
32993 "type": "number",
32994 "title": "Decimal"
32995 }
32996 },
32997 "xml": {
32998 "name": "ApiPaySlipSuperAdjustmentModel"
32999 },
33000 "title": "ApiPaySlipSuperAdjustmentModel"
33001 },
33002 "ApiPaySlipEarningsLineModel": {
33003 "type": "object",
33004 "properties": {
33005 "payCategoryName": {
33006 "type": "string",
33007 "title": "String"
33008 },
33009 "units": {
33010 "format": "double",
33011 "type": "number",
33012 "title": "Decimal"
33013 },
33014 "isFixed": {
33015 "type": "boolean",
33016 "title": "Boolean"
33017 },
33018 "isTaxExempt": {
33019 "type": "boolean",
33020 "title": "Boolean"
33021 },
33022 "rate": {
33023 "format": "double",
33024 "type": "number",
33025 "title": "Decimal"
33026 },
33027 "superContribution": {
33028 "format": "double",
33029 "type": "number",
33030 "title": "Decimal"
33031 },
33032 "notes": {
33033 "type": "string",
33034 "title": "String"
33035 },
33036 "grossEarnings": {
33037 "format": "double",
33038 "type": "number",
33039 "title": "Decimal"
33040 },
33041 "taxableEarnings": {
33042 "format": "double",
33043 "type": "number",
33044 "title": "Decimal"
33045 },
33046 "locationName": {
33047 "type": "string",
33048 "title": "String"
33049 }
33050 },
33051 "xml": {
33052 "name": "ApiPaySlipEarningsLineModel"
33053 },
33054 "title": "ApiPaySlipEarningsLineModel"
33055 },
33056 "ApiPaySlipDeductionModel": {
33057 "type": "object",
33058 "properties": {
33059 "notes": {
33060 "type": "string",
33061 "title": "String"
33062 },
33063 "amount": {
33064 "format": "double",
33065 "type": "number",
33066 "title": "Decimal"
33067 },
33068 "taxStatus": {
33069 "type": "string",
33070 "title": "String"
33071 },
33072 "name": {
33073 "type": "string",
33074 "title": "String"
33075 }
33076 },
33077 "xml": {
33078 "name": "ApiPaySlipDeductionModel"
33079 },
33080 "title": "ApiPaySlipDeductionModel"
33081 },
33082 "ApiPaySlipSuperPaymentModel": {
33083 "type": "object",
33084 "properties": {
33085 "fundName": {
33086 "type": "string",
33087 "title": "String"
33088 },
33089 "memberNumber": {
33090 "type": "string",
33091 "title": "String"
33092 },
33093 "amount": {
33094 "format": "double",
33095 "type": "number",
33096 "title": "Decimal"
33097 }
33098 },
33099 "xml": {
33100 "name": "ApiPaySlipSuperPaymentModel"
33101 },
33102 "title": "ApiPaySlipSuperPaymentModel"
33103 },
33104 "ApiPaySlipBankPaymentModel": {
33105 "type": "object",
33106 "properties": {
33107 "accountName": {
33108 "type": "string",
33109 "title": "String"
33110 },
33111 "accountNumber": {
33112 "type": "string",
33113 "title": "String"
33114 },
33115 "lodgementReference": {
33116 "type": "string",
33117 "title": "String"
33118 },
33119 "bsb": {
33120 "type": "string",
33121 "title": "String"
33122 },
33123 "amount": {
33124 "format": "double",
33125 "type": "number",
33126 "title": "Decimal"
33127 }
33128 },
33129 "xml": {
33130 "name": "ApiPaySlipBankPaymentModel"
33131 },
33132 "title": "ApiPaySlipBankPaymentModel"
33133 },
33134 "ApiYearToDateEarningsBreakdownModel": {
33135 "type": "object",
33136 "properties": {
33137 "payCategoryName": {
33138 "type": "string",
33139 "title": "String"
33140 },
33141 "grossEarnings": {
33142 "format": "double",
33143 "type": "number",
33144 "title": "Decimal"
33145 }
33146 },
33147 "xml": {
33148 "name": "ApiYearToDateEarningsBreakdownModel"
33149 },
33150 "title": "ApiYearToDateEarningsBreakdownModel"
33151 },
33152 "ApiEmployeeExpenseGridModel": {
33153 "type": "object",
33154 "properties": {
33155 "notes": {
33156 "type": "string",
33157 "title": "String"
33158 },
33159 "amount": {
33160 "format": "double",
33161 "type": "number",
33162 "title": "Decimal"
33163 },
33164 "locationName": {
33165 "type": "string",
33166 "title": "String"
33167 },
33168 "employeeExpenseCategoryName": {
33169 "type": "string",
33170 "title": "String"
33171 }
33172 },
33173 "xml": {
33174 "name": "ApiEmployeeExpenseGridModel"
33175 },
33176 "title": "ApiEmployeeExpenseGridModel"
33177 },
33178 "PayRunEarningsLineResponse": {
33179 "type": "object",
33180 "properties": {
33181 "earningsLines": {
33182 "type": "object",
33183 "additionalProperties": {
33184 "type": "array",
33185 "items": {
33186 "$ref": "#/definitions/EarningsLineModel"
33187 },
33188 "xml": {
33189 "name": "EarningsLineModel",
33190 "wrapped": true
33191 },
33192 "title": "List<EarningsLineModel>"
33193 },
33194 "readOnly": true,
33195 "title": "Dictionary<String,List`1>"
33196 },
33197 "payRunId": {
33198 "format": "int32",
33199 "type": "integer",
33200 "title": "Int32"
33201 }
33202 },
33203 "xml": {
33204 "name": "PayRunEarningsLineResponse"
33205 },
33206 "example": {
33207 "earningsLines": {
33208 "12345": [
33209 {
33210 "payCategoryId": "1",
33211 "payCategoryName": "Full Time - Standard",
33212 "units": 40.0,
33213 "notes": "Some notes",
33214 "rate": 31.25,
33215 "earnings": 1250.0,
33216 "super": 0.0,
33217 "sfss": 0.0,
33218 "help": 65.12,
33219 "payg": 263.0,
33220 "lumpSumNumberOfPayPeriods": 0.0,
33221 "timesheetLineId": null,
33222 "id": 0,
33223 "externalId": null,
33224 "locationId": "39",
33225 "locationName": "My Location",
33226 "employeeId": "12345",
33227 "employeeName": "Bob Bobberson",
33228 "employeeExternalId": "EMP01"
33229 },
33230 {
33231 "payCategoryId": "3",
33232 "payCategoryName": "Bonus",
33233 "units": 1.0,
33234 "notes": "Some notes",
33235 "rate": 1000.0,
33236 "earnings": 1000.0,
33237 "super": 106.38,
33238 "sfss": 0.0,
33239 "help": 0.0,
33240 "payg": 229.0,
33241 "lumpSumNumberOfPayPeriods": 1.0,
33242 "timesheetLineId": null,
33243 "id": 0,
33244 "externalId": null,
33245 "locationId": "39",
33246 "locationName": "My Location",
33247 "employeeId": "12345",
33248 "employeeName": "Bob Bobberson",
33249 "employeeExternalId": "EMP01"
33250 }
33251 ]
33252 },
33253 "payRunId": 999
33254 },
33255 "title": "PayRunEarningsLineResponse"
33256 },
33257 "EarningsLineModel": {
33258 "type": "object",
33259 "properties": {
33260 "payCategoryId": {
33261 "type": "string",
33262 "title": "String"
33263 },
33264 "payCategoryName": {
33265 "type": "string",
33266 "title": "String"
33267 },
33268 "units": {
33269 "format": "double",
33270 "type": "number",
33271 "title": "Decimal"
33272 },
33273 "notes": {
33274 "type": "string",
33275 "title": "String"
33276 },
33277 "rate": {
33278 "format": "double",
33279 "type": "number",
33280 "title": "Nullable<Decimal>"
33281 },
33282 "earnings": {
33283 "format": "double",
33284 "type": "number",
33285 "title": "Decimal"
33286 },
33287 "super": {
33288 "format": "double",
33289 "type": "number",
33290 "title": "Decimal"
33291 },
33292 "sfss": {
33293 "format": "double",
33294 "type": "number",
33295 "title": "Decimal"
33296 },
33297 "help": {
33298 "format": "double",
33299 "type": "number",
33300 "title": "Decimal"
33301 },
33302 "payg": {
33303 "format": "double",
33304 "type": "number",
33305 "title": "Decimal"
33306 },
33307 "lumpSumNumberOfPayPeriods": {
33308 "format": "double",
33309 "type": "number",
33310 "title": "Decimal"
33311 },
33312 "timesheetLineId": {
33313 "format": "int32",
33314 "type": "integer",
33315 "title": "Nullable<Int32>"
33316 },
33317 "id": {
33318 "format": "int32",
33319 "type": "integer",
33320 "title": "Int32"
33321 },
33322 "externalId": {
33323 "type": "string",
33324 "title": "String"
33325 },
33326 "locationId": {
33327 "type": "string",
33328 "title": "String"
33329 },
33330 "locationName": {
33331 "type": "string",
33332 "title": "String"
33333 },
33334 "employeeId": {
33335 "type": "string",
33336 "title": "String"
33337 },
33338 "employeeName": {
33339 "type": "string",
33340 "title": "String"
33341 },
33342 "employeeExternalId": {
33343 "type": "string",
33344 "title": "String"
33345 }
33346 },
33347 "xml": {
33348 "name": "EarningsLineModel"
33349 },
33350 "title": "EarningsLineModel"
33351 },
33352 "SubmitPayRunEarningsLineRequest": {
33353 "type": "object",
33354 "properties": {
33355 "locationIdType": {
33356 "enum": [
33357 "Standard",
33358 "External"
33359 ],
33360 "type": "string",
33361 "title": "IdType"
33362 },
33363 "payCategoryIdType": {
33364 "enum": [
33365 "Standard",
33366 "External"
33367 ],
33368 "type": "string",
33369 "title": "IdType"
33370 },
33371 "earningsLines": {
33372 "type": "object",
33373 "additionalProperties": {
33374 "type": "array",
33375 "items": {
33376 "$ref": "#/definitions/EarningsLineModel"
33377 },
33378 "xml": {
33379 "name": "EarningsLineModel",
33380 "wrapped": true
33381 },
33382 "title": "List<EarningsLineModel>"
33383 },
33384 "title": "Dictionary<String,List`1>"
33385 },
33386 "payRunId": {
33387 "format": "int32",
33388 "type": "integer",
33389 "title": "Int32"
33390 },
33391 "employeeIdType": {
33392 "enum": [
33393 "Standard",
33394 "External"
33395 ],
33396 "type": "string",
33397 "title": "IdType"
33398 },
33399 "replaceExisting": {
33400 "type": "boolean",
33401 "title": "Boolean"
33402 },
33403 "suppressCalculations": {
33404 "type": "boolean",
33405 "title": "Boolean"
33406 }
33407 },
33408 "xml": {
33409 "name": "SubmitPayRunEarningsLineRequest"
33410 },
33411 "title": "SubmitPayRunEarningsLineRequest"
33412 },
33413 "PayRunTotalModel": {
33414 "type": "object",
33415 "properties": {
33416 "id": {
33417 "format": "int32",
33418 "type": "integer",
33419 "title": "Int32"
33420 },
33421 "totalHours": {
33422 "format": "double",
33423 "type": "number",
33424 "title": "Decimal"
33425 },
33426 "grossEarnings": {
33427 "format": "double",
33428 "type": "number",
33429 "title": "Decimal"
33430 },
33431 "preTaxDeductions": {
33432 "format": "double",
33433 "type": "number",
33434 "title": "Decimal"
33435 },
33436 "taxableEarnings": {
33437 "format": "double",
33438 "type": "number",
33439 "title": "Decimal"
33440 },
33441 "postTaxDeductions": {
33442 "format": "double",
33443 "type": "number",
33444 "title": "Decimal"
33445 },
33446 "paygWithheld": {
33447 "format": "double",
33448 "type": "number",
33449 "title": "Decimal"
33450 },
33451 "sfssWithheld": {
33452 "format": "double",
33453 "type": "number",
33454 "title": "Decimal"
33455 },
33456 "helpWithheld": {
33457 "format": "double",
33458 "type": "number",
33459 "title": "Decimal"
33460 },
33461 "superContribution": {
33462 "format": "double",
33463 "type": "number",
33464 "title": "Decimal"
33465 },
33466 "employerContribution": {
33467 "format": "double",
33468 "type": "number",
33469 "title": "Decimal"
33470 },
33471 "netEarnings": {
33472 "format": "double",
33473 "type": "number",
33474 "title": "Decimal"
33475 },
33476 "totalEmployeeExpenses": {
33477 "format": "double",
33478 "type": "number",
33479 "title": "Decimal"
33480 },
33481 "totalEmployerLiabilities": {
33482 "format": "double",
33483 "type": "number",
33484 "title": "Decimal"
33485 },
33486 "isPublished": {
33487 "type": "boolean",
33488 "title": "Boolean"
33489 },
33490 "payRunId": {
33491 "format": "int32",
33492 "type": "integer",
33493 "title": "Int32"
33494 },
33495 "notes": {
33496 "type": "string",
33497 "title": "String"
33498 },
33499 "notation": {
33500 "type": "string",
33501 "title": "String"
33502 }
33503 },
33504 "xml": {
33505 "name": "PayRunTotalModel"
33506 },
33507 "title": "PayRunTotalModel"
33508 },
33509 "LeaveAccrualResponse": {
33510 "type": "object",
33511 "properties": {
33512 "payRunId": {
33513 "format": "int32",
33514 "type": "integer",
33515 "title": "Int32"
33516 },
33517 "leave": {
33518 "type": "object",
33519 "additionalProperties": {
33520 "type": "array",
33521 "items": {
33522 "$ref": "#/definitions/LeaveAccrualModel"
33523 },
33524 "xml": {
33525 "name": "LeaveAccrualModel",
33526 "wrapped": true
33527 },
33528 "title": "List<LeaveAccrualModel>"
33529 },
33530 "title": "Dictionary<String,List`1>"
33531 }
33532 },
33533 "xml": {
33534 "name": "LeaveAccrualResponse"
33535 },
33536 "example": {
33537 "payRunId": 999,
33538 "leave": {
33539 "12345": [
33540 {
33541 "id": 1234,
33542 "leaveCategoryName": "Annual Leave",
33543 "leaveCategoryId": "123",
33544 "amount": 3.07654,
33545 "notes": null,
33546 "accrualType": "AutomaticallyAccrued"
33547 },
33548 {
33549 "id": 1235,
33550 "leaveCategoryName": "Sick Leave",
33551 "leaveCategoryId": "124",
33552 "amount": 1.0345,
33553 "notes": "Some notes",
33554 "accrualType": "AutomaticallyAccrued"
33555 }
33556 ]
33557 }
33558 },
33559 "title": "LeaveAccrualResponse"
33560 },
33561 "LeaveAccrualModel": {
33562 "type": "object",
33563 "properties": {
33564 "id": {
33565 "format": "int32",
33566 "type": "integer",
33567 "title": "Int32"
33568 },
33569 "leaveCategoryName": {
33570 "type": "string",
33571 "title": "String"
33572 },
33573 "leaveCategoryId": {
33574 "type": "string",
33575 "title": "String"
33576 },
33577 "amount": {
33578 "format": "double",
33579 "type": "number",
33580 "title": "Decimal"
33581 },
33582 "notes": {
33583 "type": "string",
33584 "title": "String"
33585 },
33586 "accrualType": {
33587 "type": "string",
33588 "title": "String"
33589 }
33590 },
33591 "xml": {
33592 "name": "LeaveAccrualModel"
33593 },
33594 "title": "LeaveAccrualModel"
33595 },
33596 "SubmitLeaveAccrualsModel": {
33597 "type": "object",
33598 "properties": {
33599 "replaceExisting": {
33600 "type": "boolean",
33601 "title": "Boolean"
33602 },
33603 "employeeIdType": {
33604 "enum": [
33605 "Standard",
33606 "External"
33607 ],
33608 "type": "string",
33609 "title": "IdType"
33610 },
33611 "suppressCalculations": {
33612 "type": "boolean",
33613 "title": "Boolean"
33614 },
33615 "leave": {
33616 "type": "object",
33617 "additionalProperties": {
33618 "type": "array",
33619 "items": {
33620 "$ref": "#/definitions/SaveLeaveAccrualModel"
33621 },
33622 "xml": {
33623 "name": "SaveLeaveAccrualModel",
33624 "wrapped": true
33625 },
33626 "title": "List<SaveLeaveAccrualModel>"
33627 },
33628 "title": "Dictionary<String,List`1>"
33629 }
33630 },
33631 "xml": {
33632 "name": "SubmitLeaveAccrualsModel"
33633 },
33634 "title": "SubmitLeaveAccrualsModel"
33635 },
33636 "SaveLeaveAccrualModel": {
33637 "type": "object",
33638 "properties": {
33639 "accrualType": {
33640 "enum": [
33641 "LeaveAccrued",
33642 "LeaveTaken",
33643 "LeaveAdjustment"
33644 ],
33645 "type": "string",
33646 "title": "SaveLeaveAccrualTypeEnum"
33647 },
33648 "notes": {
33649 "type": "string",
33650 "title": "String"
33651 },
33652 "amount": {
33653 "format": "double",
33654 "type": "number",
33655 "title": "Decimal"
33656 },
33657 "leaveCategoryId": {
33658 "format": "int32",
33659 "type": "integer",
33660 "title": "Int32"
33661 },
33662 "applyLeaveLoading": {
33663 "type": "boolean",
33664 "title": "Boolean"
33665 },
33666 "adjustEarnings": {
33667 "type": "boolean",
33668 "title": "Boolean"
33669 },
33670 "externalReferenceId": {
33671 "type": "string",
33672 "title": "String"
33673 }
33674 },
33675 "xml": {
33676 "name": "SaveLeaveAccrualModel"
33677 },
33678 "title": "SaveLeaveAccrualModel"
33679 },
33680 "PayRunPaygAdjustmentResponse": {
33681 "type": "object",
33682 "properties": {
33683 "paygAdjustments": {
33684 "type": "object",
33685 "additionalProperties": {
33686 "type": "array",
33687 "items": {
33688 "$ref": "#/definitions/PaygAdjustmentModel"
33689 },
33690 "xml": {
33691 "name": "PaygAdjustmentModel",
33692 "wrapped": true
33693 },
33694 "title": "List<PaygAdjustmentModel>"
33695 },
33696 "readOnly": true,
33697 "title": "Dictionary<String,List`1>"
33698 },
33699 "payRunId": {
33700 "format": "int32",
33701 "type": "integer",
33702 "title": "Int32"
33703 }
33704 },
33705 "xml": {
33706 "name": "PayRunPaygAdjustmentResponse"
33707 },
33708 "example": {
33709 "paygAdjustments": {
33710 "12345": [
33711 {
33712 "notes": "Some notes",
33713 "amount": 12.34,
33714 "id": 0,
33715 "externalId": "Axb34",
33716 "locationId": "34456",
33717 "locationName": "My Location",
33718 "employeeId": "12345",
33719 "employeeName": "Bob Bobberson",
33720 "employeeExternalId": "EMP01"
33721 }
33722 ]
33723 },
33724 "payRunId": 999
33725 },
33726 "title": "PayRunPaygAdjustmentResponse"
33727 },
33728 "PaygAdjustmentModel": {
33729 "type": "object",
33730 "properties": {
33731 "notes": {
33732 "type": "string",
33733 "title": "String"
33734 },
33735 "amount": {
33736 "format": "double",
33737 "type": "number",
33738 "title": "Decimal"
33739 },
33740 "id": {
33741 "format": "int32",
33742 "type": "integer",
33743 "title": "Int32"
33744 },
33745 "externalId": {
33746 "type": "string",
33747 "title": "String"
33748 },
33749 "locationId": {
33750 "type": "string",
33751 "title": "String"
33752 },
33753 "locationName": {
33754 "type": "string",
33755 "title": "String"
33756 },
33757 "employeeId": {
33758 "type": "string",
33759 "title": "String"
33760 },
33761 "employeeName": {
33762 "type": "string",
33763 "title": "String"
33764 },
33765 "employeeExternalId": {
33766 "type": "string",
33767 "title": "String"
33768 }
33769 },
33770 "xml": {
33771 "name": "PaygAdjustmentModel"
33772 },
33773 "title": "PaygAdjustmentModel"
33774 },
33775 "SubmitPayRunPaygAdjustmentRequest": {
33776 "type": "object",
33777 "properties": {
33778 "paygAdjustments": {
33779 "type": "object",
33780 "additionalProperties": {
33781 "type": "array",
33782 "items": {
33783 "$ref": "#/definitions/PaygAdjustmentModel"
33784 },
33785 "xml": {
33786 "name": "PaygAdjustmentModel",
33787 "wrapped": true
33788 },
33789 "title": "List<PaygAdjustmentModel>"
33790 },
33791 "title": "Dictionary<String,List`1>"
33792 },
33793 "payRunId": {
33794 "format": "int32",
33795 "type": "integer",
33796 "title": "Int32"
33797 },
33798 "employeeIdType": {
33799 "enum": [
33800 "Standard",
33801 "External"
33802 ],
33803 "type": "string",
33804 "title": "IdType"
33805 },
33806 "replaceExisting": {
33807 "type": "boolean",
33808 "title": "Boolean"
33809 },
33810 "suppressCalculations": {
33811 "type": "boolean",
33812 "title": "Boolean"
33813 }
33814 },
33815 "xml": {
33816 "name": "SubmitPayRunPaygAdjustmentRequest"
33817 },
33818 "title": "SubmitPayRunPaygAdjustmentRequest"
33819 },
33820 "PayRunSuperAdjustmentResponse": {
33821 "type": "object",
33822 "properties": {
33823 "superAdjustments": {
33824 "type": "object",
33825 "additionalProperties": {
33826 "type": "array",
33827 "items": {
33828 "$ref": "#/definitions/SuperAdjustmentModel"
33829 },
33830 "xml": {
33831 "name": "SuperAdjustmentModel",
33832 "wrapped": true
33833 },
33834 "title": "List<SuperAdjustmentModel>"
33835 },
33836 "readOnly": true,
33837 "title": "Dictionary<String,List`1>"
33838 },
33839 "payRunId": {
33840 "format": "int32",
33841 "type": "integer",
33842 "title": "Int32"
33843 }
33844 },
33845 "xml": {
33846 "name": "PayRunSuperAdjustmentResponse"
33847 },
33848 "example": {
33849 "superAdjustments": {
33850 "12345": [
33851 {
33852 "notes": "Some notes",
33853 "amount": 12.34,
33854 "contributionType": "Employer Contribution",
33855 "id": 0,
33856 "externalId": "Axb34",
33857 "locationId": "34456",
33858 "locationName": "My Location",
33859 "employeeId": "12345",
33860 "employeeName": "Bob Bobberson",
33861 "employeeExternalId": "EMP01"
33862 }
33863 ]
33864 },
33865 "payRunId": 999
33866 },
33867 "title": "PayRunSuperAdjustmentResponse"
33868 },
33869 "SuperAdjustmentModel": {
33870 "type": "object",
33871 "properties": {
33872 "notes": {
33873 "type": "string",
33874 "title": "String"
33875 },
33876 "amount": {
33877 "format": "double",
33878 "type": "number",
33879 "title": "Decimal"
33880 },
33881 "contributionType": {
33882 "type": "string",
33883 "title": "String"
33884 },
33885 "id": {
33886 "format": "int32",
33887 "type": "integer",
33888 "title": "Int32"
33889 },
33890 "externalId": {
33891 "type": "string",
33892 "title": "String"
33893 },
33894 "locationId": {
33895 "type": "string",
33896 "title": "String"
33897 },
33898 "locationName": {
33899 "type": "string",
33900 "title": "String"
33901 },
33902 "employeeId": {
33903 "type": "string",
33904 "title": "String"
33905 },
33906 "employeeName": {
33907 "type": "string",
33908 "title": "String"
33909 },
33910 "employeeExternalId": {
33911 "type": "string",
33912 "title": "String"
33913 }
33914 },
33915 "xml": {
33916 "name": "SuperAdjustmentModel"
33917 },
33918 "title": "SuperAdjustmentModel"
33919 },
33920 "SubmitPayRunSuperAdjustmentRequest": {
33921 "type": "object",
33922 "properties": {
33923 "superAdjustments": {
33924 "type": "object",
33925 "additionalProperties": {
33926 "type": "array",
33927 "items": {
33928 "$ref": "#/definitions/SuperAdjustmentModel"
33929 },
33930 "xml": {
33931 "name": "SuperAdjustmentModel",
33932 "wrapped": true
33933 },
33934 "title": "List<SuperAdjustmentModel>"
33935 },
33936 "title": "Dictionary<String,List`1>"
33937 },
33938 "payRunId": {
33939 "format": "int32",
33940 "type": "integer",
33941 "title": "Int32"
33942 },
33943 "employeeIdType": {
33944 "enum": [
33945 "Standard",
33946 "External"
33947 ],
33948 "type": "string",
33949 "title": "IdType"
33950 },
33951 "replaceExisting": {
33952 "type": "boolean",
33953 "title": "Boolean"
33954 },
33955 "suppressCalculations": {
33956 "type": "boolean",
33957 "title": "Boolean"
33958 }
33959 },
33960 "xml": {
33961 "name": "SubmitPayRunSuperAdjustmentRequest"
33962 },
33963 "title": "SubmitPayRunSuperAdjustmentRequest"
33964 },
33965 "PayRunUnlockRequest": {
33966 "type": "object",
33967 "properties": {
33968 "comments": {
33969 "type": "string",
33970 "title": "String"
33971 }
33972 },
33973 "xml": {
33974 "name": "PayRunUnlockRequest"
33975 },
33976 "title": "PayRunUnlockRequest"
33977 },
33978 "ODataQueryOptions[PayRun]": {
33979 "type": "object",
33980 "properties": {
33981 "ifMatch": {
33982 "type": "object",
33983 "readOnly": true,
33984 "title": "ETag<PayRun>"
33985 },
33986 "ifNoneMatch": {
33987 "type": "object",
33988 "readOnly": true,
33989 "title": "ETag<PayRun>"
33990 },
33991 "context": {
33992 "$ref": "#/definitions/ODataQueryContext",
33993 "readOnly": true
33994 },
33995 "request": {
33996 "type": "object",
33997 "readOnly": true,
33998 "title": "HttpRequestMessage"
33999 },
34000 "rawValues": {
34001 "$ref": "#/definitions/ODataRawQueryOptions",
34002 "readOnly": true
34003 },
34004 "selectExpand": {
34005 "$ref": "#/definitions/SelectExpandQueryOption",
34006 "readOnly": true
34007 },
34008 "filter": {
34009 "$ref": "#/definitions/FilterQueryOption",
34010 "readOnly": true
34011 },
34012 "orderBy": {
34013 "$ref": "#/definitions/OrderByQueryOption",
34014 "readOnly": true
34015 },
34016 "skip": {
34017 "$ref": "#/definitions/SkipQueryOption",
34018 "readOnly": true
34019 },
34020 "top": {
34021 "$ref": "#/definitions/TopQueryOption",
34022 "readOnly": true
34023 },
34024 "inlineCount": {
34025 "$ref": "#/definitions/InlineCountQueryOption",
34026 "readOnly": true
34027 },
34028 "validator": {
34029 "$ref": "#/definitions/ODataQueryValidator"
34030 }
34031 },
34032 "xml": {
34033 "name": "ODataQueryOptions`1"
34034 },
34035 "title": "ODataQueryOptions<PayRun>"
34036 },
34037 "PayRunCreateRequest": {
34038 "type": "object",
34039 "properties": {
34040 "payScheduleId": {
34041 "format": "int32",
34042 "type": "integer",
34043 "title": "Int32"
34044 },
34045 "payPeriodEnding": {
34046 "format": "date-time",
34047 "type": "string",
34048 "title": "DateTime"
34049 },
34050 "datePaid": {
34051 "format": "date-time",
34052 "type": "string",
34053 "title": "DateTime"
34054 },
34055 "timesheetImportOption": {
34056 "enum": [
34057 "None",
34058 "ThisPayPeriod",
34059 "AllOutstanding"
34060 ],
34061 "type": "string",
34062 "title": "Nullable<TimesheetImportOption>"
34063 },
34064 "externalId": {
34065 "type": "string",
34066 "title": "String"
34067 },
34068 "callbackUrl": {
34069 "type": "string",
34070 "title": "String"
34071 }
34072 },
34073 "xml": {
34074 "name": "PayRunCreateRequest"
34075 },
34076 "title": "PayRunCreateRequest"
34077 },
34078 "PayRunNotationModel": {
34079 "type": "object",
34080 "properties": {
34081 "notation": {
34082 "type": "string",
34083 "title": "String"
34084 }
34085 },
34086 "xml": {
34087 "name": "PayRunNotationModel"
34088 },
34089 "title": "PayRunNotationModel"
34090 },
34091 "PayRunEmployerLiabilityResponse": {
34092 "type": "object",
34093 "properties": {
34094 "employerLiabilities": {
34095 "type": "object",
34096 "additionalProperties": {
34097 "type": "array",
34098 "items": {
34099 "$ref": "#/definitions/EmployerLiabilityModel"
34100 },
34101 "xml": {
34102 "name": "EmployerLiabilityModel",
34103 "wrapped": true
34104 },
34105 "title": "List<EmployerLiabilityModel>"
34106 },
34107 "readOnly": true,
34108 "title": "Dictionary<String,List`1>"
34109 },
34110 "payRunId": {
34111 "format": "int32",
34112 "type": "integer",
34113 "title": "Int32"
34114 }
34115 },
34116 "xml": {
34117 "name": "PayRunEmployerLiabilityResponse"
34118 },
34119 "example": {
34120 "employerLiabilities": {
34121 "12345": [
34122 {
34123 "employerLiabilityCategoryId": "98",
34124 "employerLiabilityCategoryName": "My employer liability category",
34125 "notes": "Some notes",
34126 "amount": 12.34,
34127 "id": 0,
34128 "externalId": "Axb34",
34129 "locationId": "34456",
34130 "locationName": "My Location",
34131 "employeeId": "12345",
34132 "employeeName": "Bob Bobberson",
34133 "employeeExternalId": "EMP01"
34134 }
34135 ]
34136 },
34137 "payRunId": 999
34138 },
34139 "title": "PayRunEmployerLiabilityResponse"
34140 },
34141 "EmployerLiabilityModel": {
34142 "type": "object",
34143 "properties": {
34144 "employerLiabilityCategoryId": {
34145 "type": "string",
34146 "title": "String"
34147 },
34148 "employerLiabilityCategoryName": {
34149 "type": "string",
34150 "title": "String"
34151 },
34152 "notes": {
34153 "type": "string",
34154 "title": "String"
34155 },
34156 "amount": {
34157 "format": "double",
34158 "type": "number",
34159 "title": "Decimal"
34160 },
34161 "id": {
34162 "format": "int32",
34163 "type": "integer",
34164 "title": "Int32"
34165 },
34166 "externalId": {
34167 "type": "string",
34168 "title": "String"
34169 },
34170 "locationId": {
34171 "type": "string",
34172 "title": "String"
34173 },
34174 "locationName": {
34175 "type": "string",
34176 "title": "String"
34177 },
34178 "employeeId": {
34179 "type": "string",
34180 "title": "String"
34181 },
34182 "employeeName": {
34183 "type": "string",
34184 "title": "String"
34185 },
34186 "employeeExternalId": {
34187 "type": "string",
34188 "title": "String"
34189 }
34190 },
34191 "xml": {
34192 "name": "EmployerLiabilityModel"
34193 },
34194 "title": "EmployerLiabilityModel"
34195 },
34196 "SubmitPayRunEmployerLiabilityRequest": {
34197 "type": "object",
34198 "properties": {
34199 "employerLiabilityCategoryIdType": {
34200 "enum": [
34201 "Standard",
34202 "External"
34203 ],
34204 "type": "string",
34205 "title": "IdType"
34206 },
34207 "employerLiabilities": {
34208 "type": "object",
34209 "additionalProperties": {
34210 "type": "array",
34211 "items": {
34212 "$ref": "#/definitions/EmployerLiabilityModel"
34213 },
34214 "xml": {
34215 "name": "EmployerLiabilityModel",
34216 "wrapped": true
34217 },
34218 "title": "List<EmployerLiabilityModel>"
34219 },
34220 "title": "Dictionary<String,List`1>"
34221 },
34222 "payRunId": {
34223 "format": "int32",
34224 "type": "integer",
34225 "title": "Int32"
34226 },
34227 "employeeIdType": {
34228 "enum": [
34229 "Standard",
34230 "External"
34231 ],
34232 "type": "string",
34233 "title": "IdType"
34234 },
34235 "replaceExisting": {
34236 "type": "boolean",
34237 "title": "Boolean"
34238 },
34239 "suppressCalculations": {
34240 "type": "boolean",
34241 "title": "Boolean"
34242 }
34243 },
34244 "xml": {
34245 "name": "SubmitPayRunEmployerLiabilityRequest"
34246 },
34247 "title": "SubmitPayRunEmployerLiabilityRequest"
34248 },
34249 "FinalisePayRunOptions": {
34250 "type": "object",
34251 "properties": {
34252 "payRunId": {
34253 "format": "int32",
34254 "type": "integer",
34255 "title": "Int32"
34256 },
34257 "datePaid": {
34258 "format": "date-time",
34259 "type": "string",
34260 "title": "Nullable<DateTime>"
34261 },
34262 "exportJournals": {
34263 "type": "boolean",
34264 "title": "Boolean"
34265 },
34266 "publishPaySlips": {
34267 "enum": [
34268 "Manual",
34269 "Immediate",
34270 "Scheduled"
34271 ],
34272 "type": "string",
34273 "title": "PublishPaySlipsPreference"
34274 },
34275 "publishPaySlipsDateTime": {
34276 "format": "date-time",
34277 "type": "string",
34278 "title": "Nullable<DateTime>"
34279 },
34280 "suppressNotifications": {
34281 "type": "boolean",
34282 "title": "Boolean"
34283 }
34284 },
34285 "xml": {
34286 "name": "FinalisePayRunOptions"
34287 },
34288 "title": "FinalisePayRunOptions"
34289 },
34290 "PayRunFinaliseResult": {
34291 "type": "object",
34292 "properties": {
34293 "journalExportResult": {
34294 "$ref": "#/definitions/JournalExportResult"
34295 },
34296 "journalExportFailedMessage": {
34297 "type": "string",
34298 "title": "String"
34299 },
34300 "removedEmployees": {
34301 "type": "array",
34302 "items": {
34303 "format": "int32",
34304 "type": "integer",
34305 "title": "Int32"
34306 },
34307 "title": "IList<Int32>"
34308 },
34309 "notifications": {
34310 "$ref": "#/definitions/PaySlipNotificationResponse"
34311 },
34312 "paySlipsPublished": {
34313 "type": "boolean",
34314 "title": "Boolean"
34315 },
34316 "publishPreference": {
34317 "enum": [
34318 "Manual",
34319 "Immediate",
34320 "Scheduled"
34321 ],
34322 "type": "string",
34323 "title": "PublishPaySlipsPreference"
34324 },
34325 "datePaid": {
34326 "format": "date-time",
34327 "type": "string",
34328 "title": "Nullable<DateTime>"
34329 },
34330 "exportJournalsPreference": {
34331 "type": "boolean",
34332 "title": "Boolean"
34333 },
34334 "publishPaySlipsScheduledDateTimeUtc": {
34335 "format": "date-time",
34336 "type": "string",
34337 "title": "Nullable<DateTime>"
34338 },
34339 "publishPreferenceTimeOfDay": {
34340 "type": "string",
34341 "title": "Nullable<TimeSpan>"
34342 }
34343 },
34344 "xml": {
34345 "name": "PayRunFinaliseResult"
34346 },
34347 "title": "PayRunFinaliseResult"
34348 },
34349 "JournalExportResult": {
34350 "type": "object",
34351 "properties": {
34352 "status": {
34353 "enum": [
34354 "NotExported",
34355 "Success",
34356 "FailureUnknownError",
34357 "FailureAccountsNotConfigured",
34358 "FailureInvalidAccounts",
34359 "FailureAccountPeriodClosed",
34360 "FailureNotAuthenticated",
34361 "FailureAlreadyExported",
34362 "FailureFunctionDisabled",
34363 "FailureCannotUseAccountsPayableAccount",
34364 "FailureVendorMessage"
34365 ],
34366 "type": "string",
34367 "title": "JournalExportStatus"
34368 },
34369 "message": {
34370 "type": "string",
34371 "title": "String"
34372 }
34373 },
34374 "xml": {
34375 "name": "JournalExportResult"
34376 },
34377 "title": "JournalExportResult"
34378 },
34379 "PaySlipNotificationResponse": {
34380 "type": "object",
34381 "properties": {
34382 "totalEmailNotificationsSent": {
34383 "format": "int32",
34384 "type": "integer",
34385 "title": "Int32"
34386 },
34387 "totalSmsNotificationsSent": {
34388 "format": "int32",
34389 "type": "integer",
34390 "title": "Int32"
34391 },
34392 "errors": {
34393 "$ref": "#/definitions/PayRunWarningResult"
34394 },
34395 "hasPartiallySentNotifications": {
34396 "type": "boolean",
34397 "title": "Boolean"
34398 }
34399 },
34400 "xml": {
34401 "name": "PaySlipNotificationResponse"
34402 },
34403 "title": "PaySlipNotificationResponse"
34404 },
34405 "PayRunWarningResult": {
34406 "type": "object",
34407 "properties": {
34408 "warningMessage": {
34409 "type": "string",
34410 "title": "String"
34411 },
34412 "warnings": {
34413 "type": "array",
34414 "items": {
34415 "$ref": "#/definitions/PayRunWarning"
34416 },
34417 "xml": {
34418 "name": "PayRunWarning",
34419 "wrapped": true
34420 },
34421 "title": "List<PayRunWarning>"
34422 },
34423 "templateName": {
34424 "type": "string",
34425 "title": "String"
34426 }
34427 },
34428 "xml": {
34429 "name": "PayRunWarningResult"
34430 },
34431 "title": "PayRunWarningResult"
34432 },
34433 "PayRunWarning": {
34434 "type": "object",
34435 "properties": {
34436 "warningType": {
34437 "enum": [
34438 "Aba",
34439 "MoreLeaveThanAccrued",
34440 "UnpaidEarnings",
34441 "Birthday",
34442 "Anniversary",
34443 "NegativeEarnings",
34444 "PreviouslyTerminated",
34445 "TerminatedWithExpenseReimbursements",
34446 "ExpiredQualification",
34447 "DuplicateEarningsLines",
34448 "TaxCodeMissing",
34449 "Bpay"
34450 ],
34451 "type": "string",
34452 "title": "PayRunWarningType"
34453 },
34454 "employeeId": {
34455 "format": "int32",
34456 "type": "integer",
34457 "title": "Int32"
34458 },
34459 "warning": {
34460 "type": "string",
34461 "title": "String"
34462 },
34463 "employeeName": {
34464 "type": "string",
34465 "title": "String"
34466 },
34467 "payRunTotalId": {
34468 "format": "int32",
34469 "type": "integer",
34470 "title": "Int32"
34471 }
34472 },
34473 "xml": {
34474 "name": "PayRunWarning"
34475 },
34476 "title": "PayRunWarning"
34477 },
34478 "JournalItemResponse": {
34479 "type": "object",
34480 "properties": {
34481 "externalAccountReferenceId": {
34482 "type": "string",
34483 "title": "String"
34484 },
34485 "amount": {
34486 "format": "double",
34487 "type": "number",
34488 "title": "Decimal"
34489 },
34490 "amountUnrounded": {
34491 "format": "double",
34492 "type": "number",
34493 "title": "Decimal"
34494 },
34495 "reference": {
34496 "type": "string",
34497 "title": "String"
34498 },
34499 "journalItemType": {
34500 "enum": [
34501 "Asset",
34502 "PaygExpense",
34503 "PaygLiability",
34504 "SuperExpense",
34505 "SuperLiability",
34506 "DefaultExpense",
34507 "WagesExpense",
34508 "DefaultSalarySacrificeExpense",
34509 "DefaultSalarySacrificeLiability",
34510 "DefaultDeductionExpense",
34511 "DefaultDeductionLiability",
34512 "DefaultEmployerLiabilityExpense",
34513 "DefaultEmployerLiabilityLiability",
34514 "DeductionExpense",
34515 "DeductionLiability",
34516 "DeductionAsset",
34517 "DefaultEmployeeExpense",
34518 "EmployeeExpense",
34519 "PreTaxDeductionLiability",
34520 "PostTaxDeductionLiability",
34521 "EmployerLiabilityExpense",
34522 "EmployerLiabilityLiability",
34523 "W1ExemptWagesExpense",
34524 "PreTaxDeductionAsset"
34525 ],
34526 "type": "string",
34527 "title": "JournalItemType"
34528 },
34529 "taxCode": {
34530 "type": "string",
34531 "title": "String"
34532 },
34533 "accountCode": {
34534 "type": "string",
34535 "title": "String"
34536 },
34537 "accountName": {
34538 "type": "string",
34539 "title": "String"
34540 },
34541 "details": {
34542 "type": "string",
34543 "title": "String"
34544 },
34545 "location": {
34546 "type": "string",
34547 "title": "String"
34548 },
34549 "isCredit": {
34550 "type": "boolean",
34551 "title": "Boolean"
34552 },
34553 "isDebit": {
34554 "type": "boolean",
34555 "title": "Boolean"
34556 }
34557 },
34558 "xml": {
34559 "name": "JournalItemResponse"
34560 },
34561 "title": "JournalItemResponse"
34562 },
34563 "SetPayRunUIUnlockStateRequest": {
34564 "type": "object",
34565 "properties": {
34566 "enableUIUnlock": {
34567 "type": "boolean",
34568 "title": "Boolean"
34569 }
34570 },
34571 "xml": {
34572 "name": "SetPayRunUIUnlockStateRequest"
34573 },
34574 "title": "SetPayRunUIUnlockStateRequest"
34575 },
34576 "PayRunTotalResponse": {
34577 "type": "object",
34578 "properties": {
34579 "payRunId": {
34580 "format": "int32",
34581 "type": "integer",
34582 "title": "Int32"
34583 },
34584 "payRunTotals": {
34585 "type": "object",
34586 "additionalProperties": {
34587 "$ref": "#/definitions/PayRunTotalModel"
34588 },
34589 "title": "Dictionary<String,PayRunTotalModel>"
34590 }
34591 },
34592 "xml": {
34593 "name": "PayRunTotalResponse"
34594 },
34595 "title": "PayRunTotalResponse"
34596 },
34597 "PayRunTotalNotationModel": {
34598 "type": "object",
34599 "properties": {
34600 "notation": {
34601 "type": "string",
34602 "title": "String"
34603 }
34604 },
34605 "xml": {
34606 "name": "PayRunTotalNotationModel"
34607 },
34608 "title": "PayRunTotalNotationModel"
34609 },
34610 "PayRunDeductionResponse": {
34611 "type": "object",
34612 "properties": {
34613 "deductions": {
34614 "type": "object",
34615 "additionalProperties": {
34616 "type": "array",
34617 "items": {
34618 "$ref": "#/definitions/DeductionModel"
34619 },
34620 "xml": {
34621 "name": "DeductionModel",
34622 "wrapped": true
34623 },
34624 "title": "List<DeductionModel>"
34625 },
34626 "readOnly": true,
34627 "title": "Dictionary<String,List`1>"
34628 },
34629 "payRunId": {
34630 "format": "int32",
34631 "type": "integer",
34632 "title": "Int32"
34633 }
34634 },
34635 "xml": {
34636 "name": "PayRunDeductionResponse"
34637 },
34638 "example": {
34639 "deductions": {
34640 "12345": [
34641 {
34642 "deductionCategoryId": "98",
34643 "deductionCategoryName": "My deduction category",
34644 "amount": 12.34,
34645 "notes": "Some notes",
34646 "paymentReference": "Payment Reference",
34647 "payToBankAccountBSB": null,
34648 "payToBankAccountNumber": null,
34649 "payToSuperFundName": "My Super Account",
34650 "payToSuperFundMemberNumber": "100000",
34651 "payTo": "SuperFund",
34652 "id": 0,
34653 "externalId": null,
34654 "locationId": "39",
34655 "locationName": "My Location",
34656 "employeeId": "12345",
34657 "employeeName": "Bob Bobberson",
34658 "employeeExternalId": "EMP01"
34659 },
34660 {
34661 "deductionCategoryId": "98",
34662 "deductionCategoryName": "My deduction category",
34663 "amount": 16.12,
34664 "notes": "Some notes",
34665 "paymentReference": "Payment Reference",
34666 "payToBankAccountBSB": "100000",
34667 "payToBankAccountNumber": "987654321",
34668 "payToSuperFundName": null,
34669 "payToSuperFundMemberNumber": null,
34670 "payTo": "BankAccount",
34671 "id": 0,
34672 "externalId": null,
34673 "locationId": "39",
34674 "locationName": "My Location",
34675 "employeeId": "12345",
34676 "employeeName": "Bob Bobberson",
34677 "employeeExternalId": "EMP01"
34678 }
34679 ]
34680 },
34681 "payRunId": 999
34682 },
34683 "title": "PayRunDeductionResponse"
34684 },
34685 "DeductionModel": {
34686 "type": "object",
34687 "properties": {
34688 "deductionCategoryId": {
34689 "type": "string",
34690 "title": "String"
34691 },
34692 "deductionCategoryName": {
34693 "type": "string",
34694 "title": "String"
34695 },
34696 "amount": {
34697 "format": "double",
34698 "type": "number",
34699 "title": "Decimal"
34700 },
34701 "notes": {
34702 "type": "string",
34703 "title": "String"
34704 },
34705 "paymentReference": {
34706 "type": "string",
34707 "title": "String"
34708 },
34709 "note": {
34710 "type": "string",
34711 "title": "String"
34712 },
34713 "payToBankAccountBSB": {
34714 "type": "string",
34715 "title": "String"
34716 },
34717 "payToBankAccountNumber": {
34718 "type": "string",
34719 "title": "String"
34720 },
34721 "payToSuperFundName": {
34722 "type": "string",
34723 "title": "String"
34724 },
34725 "payToSuperFundMemberNumber": {
34726 "type": "string",
34727 "title": "String"
34728 },
34729 "payTo": {
34730 "type": "string",
34731 "title": "String"
34732 },
34733 "id": {
34734 "format": "int32",
34735 "type": "integer",
34736 "title": "Int32"
34737 },
34738 "externalId": {
34739 "type": "string",
34740 "title": "String"
34741 },
34742 "locationId": {
34743 "type": "string",
34744 "title": "String"
34745 },
34746 "locationName": {
34747 "type": "string",
34748 "title": "String"
34749 },
34750 "employeeId": {
34751 "type": "string",
34752 "title": "String"
34753 },
34754 "employeeName": {
34755 "type": "string",
34756 "title": "String"
34757 },
34758 "employeeExternalId": {
34759 "type": "string",
34760 "title": "String"
34761 }
34762 },
34763 "xml": {
34764 "name": "DeductionModel"
34765 },
34766 "title": "DeductionModel"
34767 },
34768 "SubmitPayRunDeductionRequest": {
34769 "type": "object",
34770 "properties": {
34771 "deductionCategoryIdType": {
34772 "enum": [
34773 "Standard",
34774 "External"
34775 ],
34776 "type": "string",
34777 "title": "IdType"
34778 },
34779 "deductions": {
34780 "type": "object",
34781 "additionalProperties": {
34782 "type": "array",
34783 "items": {
34784 "$ref": "#/definitions/DeductionModel"
34785 },
34786 "xml": {
34787 "name": "DeductionModel",
34788 "wrapped": true
34789 },
34790 "title": "List<DeductionModel>"
34791 },
34792 "title": "Dictionary<String,List`1>"
34793 },
34794 "payRunId": {
34795 "format": "int32",
34796 "type": "integer",
34797 "title": "Int32"
34798 },
34799 "employeeIdType": {
34800 "enum": [
34801 "Standard",
34802 "External"
34803 ],
34804 "type": "string",
34805 "title": "IdType"
34806 },
34807 "replaceExisting": {
34808 "type": "boolean",
34809 "title": "Boolean"
34810 },
34811 "suppressCalculations": {
34812 "type": "boolean",
34813 "title": "Boolean"
34814 }
34815 },
34816 "xml": {
34817 "name": "SubmitPayRunDeductionRequest"
34818 },
34819 "title": "SubmitPayRunDeductionRequest"
34820 },
34821 "ODataQueryOptions[PayCycle]": {
34822 "type": "object",
34823 "properties": {
34824 "ifMatch": {
34825 "type": "object",
34826 "readOnly": true,
34827 "title": "ETag<PayCycle>"
34828 },
34829 "ifNoneMatch": {
34830 "type": "object",
34831 "readOnly": true,
34832 "title": "ETag<PayCycle>"
34833 },
34834 "context": {
34835 "$ref": "#/definitions/ODataQueryContext",
34836 "readOnly": true
34837 },
34838 "request": {
34839 "type": "object",
34840 "readOnly": true,
34841 "title": "HttpRequestMessage"
34842 },
34843 "rawValues": {
34844 "$ref": "#/definitions/ODataRawQueryOptions",
34845 "readOnly": true
34846 },
34847 "selectExpand": {
34848 "$ref": "#/definitions/SelectExpandQueryOption",
34849 "readOnly": true
34850 },
34851 "filter": {
34852 "$ref": "#/definitions/FilterQueryOption",
34853 "readOnly": true
34854 },
34855 "orderBy": {
34856 "$ref": "#/definitions/OrderByQueryOption",
34857 "readOnly": true
34858 },
34859 "skip": {
34860 "$ref": "#/definitions/SkipQueryOption",
34861 "readOnly": true
34862 },
34863 "top": {
34864 "$ref": "#/definitions/TopQueryOption",
34865 "readOnly": true
34866 },
34867 "inlineCount": {
34868 "$ref": "#/definitions/InlineCountQueryOption",
34869 "readOnly": true
34870 },
34871 "validator": {
34872 "$ref": "#/definitions/ODataQueryValidator"
34873 }
34874 },
34875 "xml": {
34876 "name": "ODataQueryOptions`1"
34877 },
34878 "title": "ODataQueryOptions<PayCycle>"
34879 },
34880 "PayScheduleModel": {
34881 "type": "object",
34882 "properties": {
34883 "id": {
34884 "format": "int32",
34885 "type": "integer",
34886 "title": "Int32"
34887 },
34888 "name": {
34889 "type": "string",
34890 "title": "String"
34891 },
34892 "frequency": {
34893 "enum": [
34894 "Weekly",
34895 "Fortnightly",
34896 "Monthly",
34897 "AdHoc",
34898 "Initial"
34899 ],
34900 "type": "string",
34901 "title": "PayCycleFrequencyEnum"
34902 },
34903 "employeeSelectionStrategy": {
34904 "enum": [
34905 "None",
34906 "PayRunDefault",
34907 "TimesheetLocations"
34908 ],
34909 "type": "string",
34910 "title": "Nullable<PayRunEmployeeSelectionStrategy>"
34911 },
34912 "lastDatePaid": {
34913 "format": "date-time",
34914 "type": "string",
34915 "title": "Nullable<DateTime>"
34916 },
34917 "lastPayRun": {
34918 "format": "date-time",
34919 "type": "string",
34920 "title": "Nullable<DateTime>"
34921 },
34922 "externalId": {
34923 "type": "string",
34924 "title": "String"
34925 },
34926 "source": {
34927 "type": "string",
34928 "title": "String"
34929 },
34930 "abaDetailsId": {
34931 "format": "int32",
34932 "type": "integer",
34933 "title": "Nullable<Int32>"
34934 },
34935 "locations": {
34936 "type": "array",
34937 "items": {
34938 "format": "int32",
34939 "type": "integer",
34940 "title": "Int32"
34941 },
34942 "title": "List<Int32>"
34943 }
34944 },
34945 "xml": {
34946 "name": "PayScheduleModel"
34947 },
34948 "title": "PayScheduleModel"
34949 },
34950 "PublicHolidayModel": {
34951 "type": "object",
34952 "properties": {
34953 "id": {
34954 "format": "int32",
34955 "type": "integer",
34956 "title": "Nullable<Int32>"
34957 },
34958 "date": {
34959 "format": "date-time",
34960 "type": "string",
34961 "title": "Nullable<DateTime>"
34962 },
34963 "states": {
34964 "type": "array",
34965 "items": {
34966 "type": "string",
34967 "title": "String"
34968 },
34969 "title": "IList<String>"
34970 },
34971 "locationIds": {
34972 "type": "array",
34973 "items": {
34974 "format": "int32",
34975 "type": "integer",
34976 "title": "Int32"
34977 },
34978 "title": "ICollection<Int32>"
34979 },
34980 "description": {
34981 "type": "string",
34982 "title": "String"
34983 },
34984 "note": {
34985 "type": "string",
34986 "title": "String"
34987 },
34988 "isSystem": {
34989 "type": "boolean",
34990 "title": "Boolean"
34991 },
34992 "notAPublicHoliday": {
34993 "type": "boolean",
34994 "title": "Boolean"
34995 }
34996 },
34997 "xml": {
34998 "name": "PublicHolidayModel"
34999 },
35000 "title": "PublicHolidayModel"
35001 },
35002 "ODataQueryOptions[Qualification]": {
35003 "type": "object",
35004 "properties": {
35005 "ifMatch": {
35006 "type": "object",
35007 "readOnly": true,
35008 "title": "ETag<Qualification>"
35009 },
35010 "ifNoneMatch": {
35011 "type": "object",
35012 "readOnly": true,
35013 "title": "ETag<Qualification>"
35014 },
35015 "context": {
35016 "$ref": "#/definitions/ODataQueryContext",
35017 "readOnly": true
35018 },
35019 "request": {
35020 "type": "object",
35021 "readOnly": true,
35022 "title": "HttpRequestMessage"
35023 },
35024 "rawValues": {
35025 "$ref": "#/definitions/ODataRawQueryOptions",
35026 "readOnly": true
35027 },
35028 "selectExpand": {
35029 "$ref": "#/definitions/SelectExpandQueryOption",
35030 "readOnly": true
35031 },
35032 "filter": {
35033 "$ref": "#/definitions/FilterQueryOption",
35034 "readOnly": true
35035 },
35036 "orderBy": {
35037 "$ref": "#/definitions/OrderByQueryOption",
35038 "readOnly": true
35039 },
35040 "skip": {
35041 "$ref": "#/definitions/SkipQueryOption",
35042 "readOnly": true
35043 },
35044 "top": {
35045 "$ref": "#/definitions/TopQueryOption",
35046 "readOnly": true
35047 },
35048 "inlineCount": {
35049 "$ref": "#/definitions/InlineCountQueryOption",
35050 "readOnly": true
35051 },
35052 "validator": {
35053 "$ref": "#/definitions/ODataQueryValidator"
35054 }
35055 },
35056 "xml": {
35057 "name": "ODataQueryOptions`1"
35058 },
35059 "title": "ODataQueryOptions<Qualification>"
35060 },
35061 "QualificationModel": {
35062 "type": "object",
35063 "properties": {
35064 "id": {
35065 "format": "int32",
35066 "type": "integer",
35067 "title": "Int32"
35068 },
35069 "name": {
35070 "type": "string",
35071 "title": "String"
35072 }
35073 },
35074 "xml": {
35075 "name": "QualificationModel"
35076 },
35077 "title": "QualificationModel"
35078 },
35079 "ReportRequestWithPayScheduleModel": {
35080 "type": "object",
35081 "properties": {
35082 "payScheduleId": {
35083 "format": "int32",
35084 "type": "integer",
35085 "title": "Int32"
35086 },
35087 "fromDate": {
35088 "format": "date-time",
35089 "type": "string",
35090 "title": "DateTime"
35091 },
35092 "toDate": {
35093 "format": "date-time",
35094 "type": "string",
35095 "title": "DateTime"
35096 },
35097 "locationId": {
35098 "format": "int32",
35099 "type": "integer",
35100 "title": "Int32"
35101 },
35102 "employingEntityId": {
35103 "format": "int32",
35104 "type": "integer",
35105 "title": "Nullable<Int32>"
35106 }
35107 },
35108 "xml": {
35109 "name": "ReportRequestWithPayScheduleModel"
35110 },
35111 "title": "ReportRequestWithPayScheduleModel"
35112 },
35113 "SuperAccrualExportModel": {
35114 "type": "object",
35115 "properties": {
35116 "locationId": {
35117 "format": "int32",
35118 "type": "integer",
35119 "title": "Int32"
35120 },
35121 "locationName": {
35122 "type": "string",
35123 "title": "String"
35124 },
35125 "employeeId": {
35126 "format": "int32",
35127 "type": "integer",
35128 "title": "Int32"
35129 },
35130 "firstName": {
35131 "type": "string",
35132 "title": "String"
35133 },
35134 "surname": {
35135 "type": "string",
35136 "title": "String"
35137 },
35138 "externalId": {
35139 "type": "string",
35140 "title": "String"
35141 },
35142 "accrualDate": {
35143 "format": "date-time",
35144 "type": "string",
35145 "title": "Nullable<DateTime>"
35146 },
35147 "accrualType": {
35148 "type": "string",
35149 "title": "String"
35150 },
35151 "accrualAmount": {
35152 "format": "double",
35153 "type": "number",
35154 "title": "Decimal"
35155 }
35156 },
35157 "xml": {
35158 "name": "SuperAccrualExportModel"
35159 },
35160 "title": "SuperAccrualExportModel"
35161 },
35162 "SuperContributionsReportExportModel": {
35163 "type": "object",
35164 "properties": {
35165 "locationName": {
35166 "type": "string",
35167 "title": "String"
35168 },
35169 "employeeId": {
35170 "format": "int32",
35171 "type": "integer",
35172 "title": "Int32"
35173 },
35174 "firstName": {
35175 "type": "string",
35176 "title": "String"
35177 },
35178 "surname": {
35179 "type": "string",
35180 "title": "String"
35181 },
35182 "externalId": {
35183 "type": "string",
35184 "title": "String"
35185 },
35186 "superFundName": {
35187 "type": "string",
35188 "title": "String"
35189 },
35190 "superFundNumber": {
35191 "type": "string",
35192 "title": "String"
35193 },
35194 "paymentType": {
35195 "type": "string",
35196 "title": "String"
35197 },
35198 "amount": {
35199 "format": "double",
35200 "type": "number",
35201 "title": "Decimal"
35202 }
35203 },
35204 "xml": {
35205 "name": "SuperContributionsReportExportModel"
35206 },
35207 "title": "SuperContributionsReportExportModel"
35208 },
35209 "LeaveBalancesReportRequestModel": {
35210 "type": "object",
35211 "properties": {
35212 "locationId": {
35213 "format": "int32",
35214 "type": "integer",
35215 "title": "Int32"
35216 },
35217 "leaveTypeId": {
35218 "format": "int32",
35219 "type": "integer",
35220 "title": "Int32"
35221 },
35222 "groupBy": {
35223 "enum": [
35224 "AccrualLocation",
35225 "DefaultLocation"
35226 ],
35227 "type": "string",
35228 "title": "LeaveReportDisplayEnum"
35229 },
35230 "employingEntityId": {
35231 "format": "int32",
35232 "type": "integer",
35233 "title": "Nullable<Int32>"
35234 },
35235 "asAtDate": {
35236 "format": "date-time",
35237 "type": "string",
35238 "title": "Nullable<DateTime>"
35239 }
35240 },
35241 "xml": {
35242 "name": "LeaveBalancesReportRequestModel"
35243 },
35244 "title": "LeaveBalancesReportRequestModel"
35245 },
35246 "LeaveBalancesReportExportModel": {
35247 "type": "object",
35248 "properties": {
35249 "employeeId": {
35250 "format": "int32",
35251 "type": "integer",
35252 "title": "Int32"
35253 },
35254 "externalId": {
35255 "type": "string",
35256 "title": "String"
35257 },
35258 "firstName": {
35259 "type": "string",
35260 "title": "String"
35261 },
35262 "surname": {
35263 "type": "string",
35264 "title": "String"
35265 },
35266 "location": {
35267 "type": "string",
35268 "title": "String"
35269 },
35270 "leaveCategoryName": {
35271 "type": "string",
35272 "title": "String"
35273 },
35274 "accruedAmount": {
35275 "format": "double",
35276 "type": "number",
35277 "title": "Decimal"
35278 },
35279 "accruedAmountInDays": {
35280 "format": "double",
35281 "type": "number",
35282 "title": "Decimal"
35283 },
35284 "leaveValue": {
35285 "format": "double",
35286 "type": "number",
35287 "title": "Decimal"
35288 },
35289 "loadingValue": {
35290 "format": "double",
35291 "type": "number",
35292 "title": "Decimal"
35293 },
35294 "leavePlusLoading": {
35295 "format": "double",
35296 "type": "number",
35297 "readOnly": true,
35298 "title": "Decimal"
35299 }
35300 },
35301 "xml": {
35302 "name": "LeaveBalancesReportExportModel"
35303 },
35304 "title": "LeaveBalancesReportExportModel"
35305 },
35306 "DeductionsReportRequestModel": {
35307 "type": "object",
35308 "properties": {
35309 "employeeId": {
35310 "format": "int32",
35311 "type": "integer",
35312 "title": "Int32"
35313 },
35314 "deductionCategoryId": {
35315 "format": "int32",
35316 "type": "integer",
35317 "title": "Int32"
35318 },
35319 "disableRollupReporting": {
35320 "type": "boolean",
35321 "title": "Boolean"
35322 },
35323 "payScheduleId": {
35324 "format": "int32",
35325 "type": "integer",
35326 "title": "Int32"
35327 },
35328 "fromDate": {
35329 "format": "date-time",
35330 "type": "string",
35331 "title": "DateTime"
35332 },
35333 "toDate": {
35334 "format": "date-time",
35335 "type": "string",
35336 "title": "DateTime"
35337 },
35338 "locationId": {
35339 "format": "int32",
35340 "type": "integer",
35341 "title": "Int32"
35342 },
35343 "employingEntityId": {
35344 "format": "int32",
35345 "type": "integer",
35346 "title": "Nullable<Int32>"
35347 }
35348 },
35349 "xml": {
35350 "name": "DeductionsReportRequestModel"
35351 },
35352 "title": "DeductionsReportRequestModel"
35353 },
35354 "DeductionsReportExportModel": {
35355 "type": "object",
35356 "properties": {
35357 "payRun": {
35358 "type": "string",
35359 "title": "String"
35360 },
35361 "datePaid": {
35362 "format": "date-time",
35363 "type": "string",
35364 "title": "DateTime"
35365 },
35366 "employeeId": {
35367 "format": "int32",
35368 "type": "integer",
35369 "title": "Int32"
35370 },
35371 "firstName": {
35372 "type": "string",
35373 "title": "String"
35374 },
35375 "surname": {
35376 "type": "string",
35377 "title": "String"
35378 },
35379 "externalId": {
35380 "type": "string",
35381 "title": "String"
35382 },
35383 "location": {
35384 "type": "string",
35385 "title": "String"
35386 },
35387 "amounts": {
35388 "type": "array",
35389 "items": {
35390 "$ref": "#/definitions/DeductionsReportDeductionAmountModel"
35391 },
35392 "xml": {
35393 "name": "DeductionsReportDeductionAmountModel",
35394 "wrapped": true
35395 },
35396 "title": "List<DeductionsReportDeductionAmountModel>"
35397 }
35398 },
35399 "xml": {
35400 "name": "DeductionsReportExportModel"
35401 },
35402 "title": "DeductionsReportExportModel"
35403 },
35404 "DeductionsReportDeductionAmountModel": {
35405 "type": "object",
35406 "properties": {
35407 "deductionCategoryId": {
35408 "format": "int32",
35409 "type": "integer",
35410 "title": "Int32"
35411 },
35412 "deductionCategoryName": {
35413 "type": "string",
35414 "title": "String"
35415 },
35416 "amount": {
35417 "format": "double",
35418 "type": "number",
35419 "title": "Decimal"
35420 }
35421 },
35422 "xml": {
35423 "name": "DeductionsReportDeductionAmountModel"
35424 },
35425 "title": "DeductionsReportDeductionAmountModel"
35426 },
35427 "ActivityReportExportModel": {
35428 "type": "object",
35429 "properties": {
35430 "employeeId": {
35431 "format": "int32",
35432 "type": "integer",
35433 "title": "Int32"
35434 },
35435 "locationId": {
35436 "format": "int32",
35437 "type": "integer",
35438 "title": "Int32"
35439 },
35440 "location": {
35441 "type": "string",
35442 "title": "String"
35443 },
35444 "firstName": {
35445 "type": "string",
35446 "title": "String"
35447 },
35448 "surname": {
35449 "type": "string",
35450 "title": "String"
35451 },
35452 "totalHours": {
35453 "format": "double",
35454 "type": "number",
35455 "title": "Decimal"
35456 },
35457 "grossEarnings": {
35458 "format": "double",
35459 "type": "number",
35460 "title": "Decimal"
35461 },
35462 "taxableEarnings": {
35463 "format": "double",
35464 "type": "number",
35465 "title": "Decimal"
35466 },
35467 "paygWithholding": {
35468 "format": "double",
35469 "type": "number",
35470 "title": "Decimal"
35471 },
35472 "superContributions": {
35473 "format": "double",
35474 "type": "number",
35475 "title": "Decimal"
35476 },
35477 "netEarnings": {
35478 "format": "double",
35479 "type": "number",
35480 "title": "Decimal"
35481 }
35482 },
35483 "xml": {
35484 "name": "ActivityReportExportModel"
35485 },
35486 "title": "ActivityReportExportModel"
35487 },
35488 "LeaveHistoryApiReportModel": {
35489 "type": "object",
35490 "properties": {
35491 "fromDate": {
35492 "format": "date-time",
35493 "type": "string",
35494 "title": "DateTime"
35495 },
35496 "toDate": {
35497 "format": "date-time",
35498 "type": "string",
35499 "title": "DateTime"
35500 },
35501 "payScheduleId": {
35502 "format": "int32",
35503 "type": "integer",
35504 "title": "Int32"
35505 },
35506 "locationId": {
35507 "format": "int32",
35508 "type": "integer",
35509 "title": "Int32"
35510 },
35511 "employeeId": {
35512 "type": "array",
35513 "items": {
35514 "type": "string",
35515 "title": "String"
35516 },
35517 "title": "IList<String>"
35518 },
35519 "leaveCategoryId": {
35520 "format": "int32",
35521 "type": "integer",
35522 "title": "Int32"
35523 }
35524 },
35525 "xml": {
35526 "name": "LeaveHistoryApiReportModel"
35527 },
35528 "title": "LeaveHistoryApiReportModel"
35529 },
35530 "LeaveHistoryReportGroupModel": {
35531 "type": "object",
35532 "properties": {
35533 "employeeId": {
35534 "format": "int32",
35535 "type": "integer",
35536 "title": "Int32"
35537 },
35538 "employeeExternalId": {
35539 "type": "string",
35540 "title": "String"
35541 },
35542 "firstName": {
35543 "type": "string",
35544 "title": "String"
35545 },
35546 "surname": {
35547 "type": "string",
35548 "title": "String"
35549 },
35550 "leaveCategoryType": {
35551 "type": "string",
35552 "title": "String"
35553 },
35554 "openingBalance": {
35555 "format": "double",
35556 "type": "number",
35557 "title": "Decimal"
35558 },
35559 "closingBalance": {
35560 "format": "double",
35561 "type": "number",
35562 "title": "Decimal"
35563 },
35564 "leaveHistoryDetails": {
35565 "type": "array",
35566 "items": {
35567 "$ref": "#/definitions/LeaveHistoryReportDetailModel"
35568 },
35569 "xml": {
35570 "name": "LeaveHistoryReportDetailModel",
35571 "wrapped": true
35572 },
35573 "title": "List<LeaveHistoryReportDetailModel>"
35574 }
35575 },
35576 "xml": {
35577 "name": "LeaveHistoryReportGroupModel"
35578 },
35579 "title": "LeaveHistoryReportGroupModel"
35580 },
35581 "LeaveHistoryReportDetailModel": {
35582 "type": "object",
35583 "properties": {
35584 "payPeriod": {
35585 "type": "string",
35586 "title": "String"
35587 },
35588 "notes": {
35589 "type": "string",
35590 "title": "String"
35591 },
35592 "leaveAccrued": {
35593 "format": "double",
35594 "type": "number",
35595 "title": "Decimal"
35596 },
35597 "leaveTaken": {
35598 "format": "double",
35599 "type": "number",
35600 "title": "Decimal"
35601 }
35602 },
35603 "xml": {
35604 "name": "LeaveHistoryReportDetailModel"
35605 },
35606 "title": "LeaveHistoryReportDetailModel"
35607 },
35608 "EmployeeDetailsReportField": {
35609 "type": "object",
35610 "properties": {
35611 "value": {
35612 "type": "string",
35613 "title": "String"
35614 },
35615 "displayText": {
35616 "type": "string",
35617 "title": "String"
35618 }
35619 },
35620 "xml": {
35621 "name": "EmployeeDetailsReportField"
35622 },
35623 "title": "EmployeeDetailsReportField"
35624 },
35625 "PayCategoriesReportRequestModel": {
35626 "type": "object",
35627 "properties": {
35628 "payScheduleId": {
35629 "format": "int32",
35630 "type": "integer",
35631 "title": "Int32"
35632 },
35633 "employeeId": {
35634 "format": "int32",
35635 "type": "integer",
35636 "title": "Int32"
35637 },
35638 "groupByEarningsLocation": {
35639 "type": "boolean",
35640 "title": "Boolean"
35641 },
35642 "fromDate": {
35643 "format": "date-time",
35644 "type": "string",
35645 "title": "DateTime"
35646 },
35647 "toDate": {
35648 "format": "date-time",
35649 "type": "string",
35650 "title": "DateTime"
35651 },
35652 "locationId": {
35653 "format": "int32",
35654 "type": "integer",
35655 "title": "Int32"
35656 },
35657 "employingEntityId": {
35658 "format": "int32",
35659 "type": "integer",
35660 "title": "Nullable<Int32>"
35661 }
35662 },
35663 "xml": {
35664 "name": "PayCategoriesReportRequestModel"
35665 },
35666 "title": "PayCategoriesReportRequestModel"
35667 },
35668 "PayCategoriesReportExportModel": {
35669 "type": "object",
35670 "properties": {
35671 "payCategory": {
35672 "type": "string",
35673 "title": "String"
35674 },
35675 "payRun": {
35676 "type": "string",
35677 "title": "String"
35678 },
35679 "datePaid": {
35680 "format": "date-time",
35681 "type": "string",
35682 "title": "DateTime"
35683 },
35684 "employeeId": {
35685 "format": "int32",
35686 "type": "integer",
35687 "title": "Int32"
35688 },
35689 "firstName": {
35690 "type": "string",
35691 "title": "String"
35692 },
35693 "surname": {
35694 "type": "string",
35695 "title": "String"
35696 },
35697 "externalId": {
35698 "type": "string",
35699 "title": "String"
35700 },
35701 "location": {
35702 "type": "string",
35703 "title": "String"
35704 },
35705 "units": {
35706 "format": "double",
35707 "type": "number",
35708 "title": "Decimal"
35709 },
35710 "rate": {
35711 "format": "double",
35712 "type": "number",
35713 "title": "Decimal"
35714 },
35715 "amount": {
35716 "format": "double",
35717 "type": "number",
35718 "title": "Decimal"
35719 },
35720 "superAmount": {
35721 "format": "double",
35722 "type": "number",
35723 "title": "Decimal"
35724 }
35725 },
35726 "xml": {
35727 "name": "PayCategoriesReportExportModel"
35728 },
35729 "title": "PayCategoriesReportExportModel"
35730 },
35731 "PaygReportRequestModel": {
35732 "type": "object",
35733 "properties": {
35734 "state": {
35735 "type": "string",
35736 "title": "String"
35737 },
35738 "fromDate": {
35739 "format": "date-time",
35740 "type": "string",
35741 "title": "DateTime"
35742 },
35743 "toDate": {
35744 "format": "date-time",
35745 "type": "string",
35746 "title": "DateTime"
35747 },
35748 "locationId": {
35749 "format": "int32",
35750 "type": "integer",
35751 "title": "Int32"
35752 },
35753 "employingEntityId": {
35754 "format": "int32",
35755 "type": "integer",
35756 "title": "Nullable<Int32>"
35757 }
35758 },
35759 "xml": {
35760 "name": "PaygReportRequestModel"
35761 },
35762 "title": "PaygReportRequestModel"
35763 },
35764 "PaygReportExportModel": {
35765 "type": "object",
35766 "properties": {
35767 "location": {
35768 "type": "string",
35769 "title": "String"
35770 },
35771 "month": {
35772 "type": "string",
35773 "title": "String"
35774 },
35775 "grossEarnings": {
35776 "format": "double",
35777 "type": "number",
35778 "title": "Decimal"
35779 },
35780 "preTaxDeductions": {
35781 "format": "double",
35782 "type": "number",
35783 "title": "Decimal"
35784 },
35785 "grossEarningsLessPreTaxDeductions": {
35786 "format": "double",
35787 "type": "number",
35788 "title": "Decimal"
35789 },
35790 "payg": {
35791 "format": "double",
35792 "type": "number",
35793 "title": "Decimal"
35794 }
35795 },
35796 "xml": {
35797 "name": "PaygReportExportModel"
35798 },
35799 "title": "PaygReportExportModel"
35800 },
35801 "DetailedActivityReportExportModel": {
35802 "type": "object",
35803 "properties": {
35804 "location": {
35805 "type": "string",
35806 "title": "String"
35807 },
35808 "employeeId": {
35809 "format": "int32",
35810 "type": "integer",
35811 "title": "Int32"
35812 },
35813 "firstName": {
35814 "type": "string",
35815 "title": "String"
35816 },
35817 "surname": {
35818 "type": "string",
35819 "title": "String"
35820 },
35821 "externalId": {
35822 "type": "string",
35823 "title": "String"
35824 },
35825 "hours": {
35826 "format": "double",
35827 "type": "number",
35828 "title": "Decimal"
35829 },
35830 "grossEarnings": {
35831 "format": "double",
35832 "type": "number",
35833 "title": "Decimal"
35834 },
35835 "preTaxDeductions": {
35836 "format": "double",
35837 "type": "number",
35838 "title": "Decimal"
35839 },
35840 "postTaxDedutions": {
35841 "type": "object",
35842 "title": "Object"
35843 },
35844 "taxExemptEarnings": {
35845 "format": "double",
35846 "type": "number",
35847 "title": "Decimal"
35848 },
35849 "taxableEarnings": {
35850 "format": "double",
35851 "type": "number",
35852 "title": "Decimal"
35853 },
35854 "payg": {
35855 "format": "double",
35856 "type": "number",
35857 "title": "Decimal"
35858 },
35859 "sfss": {
35860 "format": "double",
35861 "type": "number",
35862 "title": "Decimal"
35863 },
35864 "help": {
35865 "format": "double",
35866 "type": "number",
35867 "title": "Decimal"
35868 },
35869 "super": {
35870 "format": "double",
35871 "type": "number",
35872 "title": "Decimal"
35873 },
35874 "netEarnings": {
35875 "format": "double",
35876 "type": "number",
35877 "title": "Decimal"
35878 },
35879 "employerLiabilities": {
35880 "format": "double",
35881 "type": "number",
35882 "title": "Decimal"
35883 },
35884 "grossPlusSuper": {
35885 "format": "double",
35886 "type": "number",
35887 "title": "Decimal"
35888 }
35889 },
35890 "xml": {
35891 "name": "DetailedActivityReportExportModel"
35892 },
35893 "title": "DetailedActivityReportExportModel"
35894 },
35895 "PayrollTaxReportRequestModel": {
35896 "type": "object",
35897 "properties": {
35898 "groupBy": {
35899 "enum": [
35900 "EarningsLocation",
35901 "DefaultLocation"
35902 ],
35903 "type": "string",
35904 "title": "PayrollTaxGroupByEnum"
35905 },
35906 "fromDate": {
35907 "format": "date-time",
35908 "type": "string",
35909 "title": "DateTime"
35910 },
35911 "toDate": {
35912 "format": "date-time",
35913 "type": "string",
35914 "title": "DateTime"
35915 },
35916 "locationId": {
35917 "format": "int32",
35918 "type": "integer",
35919 "title": "Int32"
35920 },
35921 "employingEntityId": {
35922 "format": "int32",
35923 "type": "integer",
35924 "title": "Nullable<Int32>"
35925 }
35926 },
35927 "xml": {
35928 "name": "PayrollTaxReportRequestModel"
35929 },
35930 "title": "PayrollTaxReportRequestModel"
35931 },
35932 "PayrollTaxReportExportModel": {
35933 "type": "object",
35934 "properties": {
35935 "employeeId": {
35936 "format": "int32",
35937 "type": "integer",
35938 "title": "Int32"
35939 },
35940 "firstName": {
35941 "type": "string",
35942 "title": "String"
35943 },
35944 "surname": {
35945 "type": "string",
35946 "title": "String"
35947 },
35948 "externalId": {
35949 "type": "string",
35950 "title": "String"
35951 },
35952 "location": {
35953 "type": "string",
35954 "title": "String"
35955 },
35956 "type": {
35957 "type": "string",
35958 "title": "String"
35959 },
35960 "state": {
35961 "type": "string",
35962 "title": "String"
35963 },
35964 "amount": {
35965 "format": "double",
35966 "type": "number",
35967 "title": "Decimal"
35968 },
35969 "employeePayrollTaxExempt": {
35970 "type": "boolean",
35971 "title": "Boolean"
35972 },
35973 "payCategoryPayrollTaxExempt": {
35974 "type": "boolean",
35975 "title": "Boolean"
35976 },
35977 "terminationPayment": {
35978 "type": "boolean",
35979 "title": "Boolean"
35980 },
35981 "allowance": {
35982 "type": "boolean",
35983 "title": "Boolean"
35984 },
35985 "etp": {
35986 "type": "boolean",
35987 "title": "Boolean"
35988 },
35989 "genuineRedundancy": {
35990 "type": "boolean",
35991 "title": "Boolean"
35992 },
35993 "lumpSumD": {
35994 "type": "boolean",
35995 "title": "Boolean"
35996 }
35997 },
35998 "xml": {
35999 "name": "PayrollTaxReportExportModel"
36000 },
36001 "title": "PayrollTaxReportExportModel"
36002 },
36003 "TimesheetReportRequestModel": {
36004 "type": "object",
36005 "properties": {
36006 "employeeId": {
36007 "format": "int32",
36008 "type": "integer",
36009 "title": "Nullable<Int32>"
36010 },
36011 "includeCosts": {
36012 "type": "boolean",
36013 "title": "Boolean"
36014 },
36015 "statuses": {
36016 "type": "array",
36017 "items": {
36018 "enum": [
36019 "Missing",
36020 "Submitted",
36021 "Approved",
36022 "Rejected",
36023 "Processed"
36024 ],
36025 "type": "string",
36026 "title": "TimesheetLineStatusType"
36027 },
36028 "xml": {
36029 "name": "TimesheetLineStatusType",
36030 "wrapped": true
36031 },
36032 "title": "IList<TimesheetLineStatusType>"
36033 },
36034 "workTypeId": {
36035 "format": "int32",
36036 "type": "integer",
36037 "title": "Nullable<Int32>"
36038 },
36039 "payScheduleId": {
36040 "format": "int32",
36041 "type": "integer",
36042 "title": "Int32"
36043 },
36044 "fromDate": {
36045 "format": "date-time",
36046 "type": "string",
36047 "title": "DateTime"
36048 },
36049 "toDate": {
36050 "format": "date-time",
36051 "type": "string",
36052 "title": "DateTime"
36053 },
36054 "locationId": {
36055 "format": "int32",
36056 "type": "integer",
36057 "title": "Int32"
36058 },
36059 "employingEntityId": {
36060 "format": "int32",
36061 "type": "integer",
36062 "title": "Nullable<Int32>"
36063 }
36064 },
36065 "xml": {
36066 "name": "TimesheetReportRequestModel"
36067 },
36068 "title": "TimesheetReportRequestModel"
36069 },
36070 "TimesheetReportExportModel": {
36071 "type": "object",
36072 "properties": {
36073 "employeeId": {
36074 "format": "int32",
36075 "type": "integer",
36076 "title": "Int32"
36077 },
36078 "firstName": {
36079 "type": "string",
36080 "title": "String"
36081 },
36082 "surname": {
36083 "type": "string",
36084 "title": "String"
36085 },
36086 "employeeExternalId": {
36087 "type": "string",
36088 "title": "String"
36089 },
36090 "id": {
36091 "format": "int32",
36092 "type": "integer",
36093 "title": "Int32"
36094 },
36095 "status": {
36096 "type": "string",
36097 "title": "String"
36098 },
36099 "location": {
36100 "type": "string",
36101 "title": "String"
36102 },
36103 "start": {
36104 "format": "date-time",
36105 "type": "string",
36106 "title": "DateTime"
36107 },
36108 "startTime": {
36109 "type": "string",
36110 "title": "TimeSpan"
36111 },
36112 "end": {
36113 "format": "date-time",
36114 "type": "string",
36115 "title": "DateTime"
36116 },
36117 "endTime": {
36118 "type": "string",
36119 "title": "TimeSpan"
36120 },
36121 "duration": {
36122 "type": "string",
36123 "readOnly": true,
36124 "title": "TimeSpan"
36125 },
36126 "units": {
36127 "format": "double",
36128 "type": "number",
36129 "title": "Decimal"
36130 },
36131 "unitType": {
36132 "type": "string",
36133 "title": "String"
36134 },
36135 "workType": {
36136 "type": "string",
36137 "title": "String"
36138 },
36139 "shiftConditions": {
36140 "type": "string",
36141 "readOnly": true,
36142 "title": "String"
36143 },
36144 "classification": {
36145 "type": "string",
36146 "title": "String"
36147 },
36148 "numberOfBreaks": {
36149 "format": "int32",
36150 "type": "integer",
36151 "title": "Int32"
36152 },
36153 "breakDuration": {
36154 "type": "string",
36155 "title": "TimeSpan"
36156 },
36157 "comments": {
36158 "type": "string",
36159 "title": "String"
36160 },
36161 "consolidatedWithTimesheetLineId": {
36162 "format": "int32",
36163 "type": "integer",
36164 "title": "Nullable<Int32>"
36165 },
36166 "reviewedBy": {
36167 "type": "string",
36168 "title": "String"
36169 },
36170 "gross": {
36171 "format": "double",
36172 "type": "number",
36173 "title": "Nullable<Decimal>"
36174 },
36175 "netEarnings": {
36176 "format": "double",
36177 "type": "number",
36178 "title": "Nullable<Decimal>"
36179 },
36180 "super": {
36181 "format": "double",
36182 "type": "number",
36183 "title": "Nullable<Decimal>"
36184 },
36185 "payg": {
36186 "format": "double",
36187 "type": "number",
36188 "title": "Nullable<Decimal>"
36189 },
36190 "employerLiabilities": {
36191 "format": "double",
36192 "type": "number",
36193 "title": "Nullable<Decimal>"
36194 },
36195 "totalCost": {
36196 "format": "double",
36197 "type": "number",
36198 "title": "Nullable<Decimal>"
36199 },
36200 "dateCreated": {
36201 "format": "date-time",
36202 "type": "string",
36203 "title": "DateTime"
36204 },
36205 "dateReviewed": {
36206 "format": "date-time",
36207 "type": "string",
36208 "title": "Nullable<DateTime>"
36209 },
36210 "shiftConditionShortCodes": {
36211 "type": "array",
36212 "items": {
36213 "type": "string",
36214 "title": "String"
36215 },
36216 "title": "IList<String>"
36217 },
36218 "breaks": {
36219 "type": "array",
36220 "items": {
36221 "$ref": "#/definitions/TimesheetBreakModel"
36222 },
36223 "xml": {
36224 "name": "TimesheetBreakModel",
36225 "wrapped": true
36226 },
36227 "title": "IList<TimesheetBreakModel>"
36228 }
36229 },
36230 "xml": {
36231 "name": "TimesheetReportExportModel"
36232 },
36233 "title": "TimesheetReportExportModel"
36234 },
36235 "PaymentHistoryReportRequestModel": {
36236 "type": "object",
36237 "properties": {
36238 "employeeId": {
36239 "format": "int32",
36240 "type": "integer",
36241 "title": "Nullable<Int32>"
36242 },
36243 "fromDate": {
36244 "format": "date-time",
36245 "type": "string",
36246 "title": "DateTime"
36247 },
36248 "toDate": {
36249 "format": "date-time",
36250 "type": "string",
36251 "title": "DateTime"
36252 },
36253 "locationId": {
36254 "format": "int32",
36255 "type": "integer",
36256 "title": "Int32"
36257 },
36258 "employingEntityId": {
36259 "format": "int32",
36260 "type": "integer",
36261 "title": "Nullable<Int32>"
36262 }
36263 },
36264 "xml": {
36265 "name": "PaymentHistoryReportRequestModel"
36266 },
36267 "title": "PaymentHistoryReportRequestModel"
36268 },
36269 "PaymentHistoryReportExportModel": {
36270 "type": "object",
36271 "properties": {
36272 "employeeId": {
36273 "format": "int32",
36274 "type": "integer",
36275 "title": "Int32"
36276 },
36277 "firstName": {
36278 "type": "string",
36279 "title": "String"
36280 },
36281 "surname": {
36282 "type": "string",
36283 "title": "String"
36284 },
36285 "externalId": {
36286 "type": "string",
36287 "title": "String"
36288 },
36289 "datePaid": {
36290 "format": "date-time",
36291 "type": "string",
36292 "title": "DateTime"
36293 },
36294 "locationName": {
36295 "type": "string",
36296 "title": "String"
36297 },
36298 "accountName": {
36299 "type": "string",
36300 "title": "String"
36301 },
36302 "bsb": {
36303 "type": "string",
36304 "title": "String"
36305 },
36306 "accountNumber": {
36307 "type": "string",
36308 "title": "String"
36309 },
36310 "accountType": {
36311 "type": "string",
36312 "title": "String"
36313 },
36314 "taxableEarnings": {
36315 "format": "double",
36316 "type": "number",
36317 "title": "Decimal"
36318 },
36319 "netEarnings": {
36320 "format": "double",
36321 "type": "number",
36322 "title": "Decimal"
36323 },
36324 "totalAllowances": {
36325 "format": "double",
36326 "type": "number",
36327 "title": "Decimal"
36328 },
36329 "totalDeductions": {
36330 "format": "double",
36331 "type": "number",
36332 "title": "Decimal"
36333 },
36334 "amount": {
36335 "format": "double",
36336 "type": "number",
36337 "title": "Decimal"
36338 }
36339 },
36340 "xml": {
36341 "name": "PaymentHistoryReportExportModel"
36342 },
36343 "title": "PaymentHistoryReportExportModel"
36344 },
36345 "BirthdayReportExportModel": {
36346 "type": "object",
36347 "properties": {
36348 "location": {
36349 "type": "string",
36350 "title": "String"
36351 },
36352 "dateOfBirth": {
36353 "format": "date-time",
36354 "type": "string",
36355 "title": "DateTime"
36356 },
36357 "employeeId": {
36358 "format": "int32",
36359 "type": "integer",
36360 "title": "Int32"
36361 },
36362 "firstName": {
36363 "type": "string",
36364 "title": "String"
36365 },
36366 "surname": {
36367 "type": "string",
36368 "title": "String"
36369 },
36370 "externalId": {
36371 "type": "string",
36372 "title": "String"
36373 },
36374 "employmentStatus": {
36375 "type": "string",
36376 "title": "String"
36377 },
36378 "age": {
36379 "format": "int32",
36380 "type": "integer",
36381 "title": "Int32"
36382 }
36383 },
36384 "xml": {
36385 "name": "BirthdayReportExportModel"
36386 },
36387 "title": "BirthdayReportExportModel"
36388 },
36389 "GrossToNetReportRequest": {
36390 "type": "object",
36391 "properties": {
36392 "employeeId": {
36393 "format": "int32",
36394 "type": "integer",
36395 "title": "Int32"
36396 },
36397 "payCategoryIds": {
36398 "type": "array",
36399 "items": {
36400 "format": "int32",
36401 "type": "integer",
36402 "title": "Int32"
36403 },
36404 "title": "List<Int32>"
36405 },
36406 "payScheduleId": {
36407 "format": "int32",
36408 "type": "integer",
36409 "title": "Int32"
36410 },
36411 "fromDate": {
36412 "format": "date-time",
36413 "type": "string",
36414 "title": "DateTime"
36415 },
36416 "toDate": {
36417 "format": "date-time",
36418 "type": "string",
36419 "title": "DateTime"
36420 },
36421 "locationId": {
36422 "format": "int32",
36423 "type": "integer",
36424 "title": "Int32"
36425 },
36426 "employingEntityId": {
36427 "format": "int32",
36428 "type": "integer",
36429 "title": "Nullable<Int32>"
36430 }
36431 },
36432 "xml": {
36433 "name": "GrossToNetReportRequest"
36434 },
36435 "title": "GrossToNetReportRequest"
36436 },
36437 "GrossToNetReportLineItem": {
36438 "type": "object",
36439 "properties": {
36440 "employeeId": {
36441 "format": "int32",
36442 "type": "integer",
36443 "title": "Int32"
36444 },
36445 "firstName": {
36446 "type": "string",
36447 "title": "String"
36448 },
36449 "surname": {
36450 "type": "string",
36451 "title": "String"
36452 },
36453 "primaryLocationId": {
36454 "format": "int32",
36455 "type": "integer",
36456 "title": "Int32"
36457 },
36458 "primaryLocation": {
36459 "type": "string",
36460 "title": "String"
36461 },
36462 "externalId": {
36463 "type": "string",
36464 "title": "String"
36465 },
36466 "totalHours": {
36467 "format": "double",
36468 "type": "number",
36469 "title": "Decimal"
36470 },
36471 "grossEarnings": {
36472 "type": "object",
36473 "additionalProperties": {
36474 "format": "double",
36475 "type": "number",
36476 "title": "Decimal"
36477 },
36478 "title": "Dictionary<String,Decimal>"
36479 },
36480 "totalGrossEarnings": {
36481 "format": "double",
36482 "type": "number",
36483 "readOnly": true,
36484 "title": "Decimal"
36485 },
36486 "totalTaxExemptEarnings": {
36487 "format": "double",
36488 "type": "number",
36489 "title": "Decimal"
36490 },
36491 "preTaxDeductions": {
36492 "type": "object",
36493 "additionalProperties": {
36494 "format": "double",
36495 "type": "number",
36496 "title": "Decimal"
36497 },
36498 "title": "Dictionary<String,Decimal>"
36499 },
36500 "totalPreTaxDeductions": {
36501 "format": "double",
36502 "type": "number",
36503 "readOnly": true,
36504 "title": "Decimal"
36505 },
36506 "taxableEarnings": {
36507 "format": "double",
36508 "type": "number",
36509 "readOnly": true,
36510 "title": "Decimal"
36511 },
36512 "payg": {
36513 "format": "double",
36514 "type": "number",
36515 "title": "Decimal"
36516 },
36517 "sfss": {
36518 "format": "double",
36519 "type": "number",
36520 "title": "Decimal"
36521 },
36522 "help": {
36523 "format": "double",
36524 "type": "number",
36525 "title": "Decimal"
36526 },
36527 "postTaxDeductions": {
36528 "type": "object",
36529 "additionalProperties": {
36530 "format": "double",
36531 "type": "number",
36532 "title": "Decimal"
36533 },
36534 "title": "Dictionary<String,Decimal>"
36535 },
36536 "totalPostTaxDeductions": {
36537 "format": "double",
36538 "type": "number",
36539 "readOnly": true,
36540 "title": "Decimal"
36541 },
36542 "netEarnings": {
36543 "format": "double",
36544 "type": "number",
36545 "readOnly": true,
36546 "title": "Decimal"
36547 },
36548 "expenses": {
36549 "type": "object",
36550 "additionalProperties": {
36551 "format": "double",
36552 "type": "number",
36553 "title": "Decimal"
36554 },
36555 "title": "Dictionary<String,Decimal>"
36556 },
36557 "totalExpenses": {
36558 "format": "double",
36559 "type": "number",
36560 "readOnly": true,
36561 "title": "Decimal"
36562 },
36563 "bankPayments": {
36564 "format": "double",
36565 "type": "number",
36566 "readOnly": true,
36567 "title": "Decimal"
36568 },
36569 "sgc": {
36570 "format": "double",
36571 "type": "number",
36572 "title": "Decimal"
36573 },
36574 "employerContribution": {
36575 "format": "double",
36576 "type": "number",
36577 "title": "Decimal"
36578 },
36579 "totalGrossPlusSuper": {
36580 "format": "double",
36581 "type": "number",
36582 "readOnly": true,
36583 "title": "Decimal"
36584 }
36585 },
36586 "xml": {
36587 "name": "GrossToNetReportLineItem"
36588 },
36589 "title": "GrossToNetReportLineItem"
36590 },
36591 "ReportLeaveLiabilityRequestModel": {
36592 "type": "object",
36593 "properties": {
36594 "locationId": {
36595 "format": "int32",
36596 "type": "integer",
36597 "title": "Int32"
36598 },
36599 "leaveTypeId": {
36600 "format": "int32",
36601 "type": "integer",
36602 "title": "Int32"
36603 },
36604 "includeApprovedLeave": {
36605 "type": "boolean",
36606 "title": "Boolean"
36607 },
36608 "asAtDate": {
36609 "format": "date-time",
36610 "type": "string",
36611 "title": "Nullable<DateTime>"
36612 },
36613 "employingEntityId": {
36614 "format": "int32",
36615 "type": "integer",
36616 "title": "Nullable<Int32>"
36617 }
36618 },
36619 "xml": {
36620 "name": "ReportLeaveLiabilityRequestModel"
36621 },
36622 "title": "ReportLeaveLiabilityRequestModel"
36623 },
36624 "LeaveLiabilityReportExportModel": {
36625 "type": "object",
36626 "properties": {
36627 "employeeId": {
36628 "format": "int32",
36629 "type": "integer",
36630 "title": "Int32"
36631 },
36632 "firstName": {
36633 "type": "string",
36634 "title": "String"
36635 },
36636 "surname": {
36637 "type": "string",
36638 "title": "String"
36639 },
36640 "externalId": {
36641 "type": "string",
36642 "title": "String"
36643 },
36644 "startDate": {
36645 "format": "date-time",
36646 "type": "string",
36647 "title": "DateTime"
36648 },
36649 "lastPaidDate": {
36650 "format": "date-time",
36651 "type": "string",
36652 "title": "Nullable<DateTime>"
36653 },
36654 "calculatedWeeks": {
36655 "format": "double",
36656 "type": "number",
36657 "title": "Decimal"
36658 },
36659 "location": {
36660 "type": "string",
36661 "title": "String"
36662 },
36663 "leaveCategoryName": {
36664 "type": "string",
36665 "title": "String"
36666 },
36667 "approvedLeaveAmount": {
36668 "format": "double",
36669 "type": "number",
36670 "title": "Nullable<Decimal>"
36671 },
36672 "accruedAmount": {
36673 "format": "double",
36674 "type": "number",
36675 "title": "Decimal"
36676 },
36677 "accruedAmountInDays": {
36678 "format": "double",
36679 "type": "number",
36680 "title": "Decimal"
36681 },
36682 "leaveValue": {
36683 "format": "double",
36684 "type": "number",
36685 "title": "Decimal"
36686 },
36687 "leaveLoadingDollarValue": {
36688 "format": "double",
36689 "type": "number",
36690 "title": "Decimal"
36691 }
36692 },
36693 "xml": {
36694 "name": "LeaveLiabilityReportExportModel"
36695 },
36696 "title": "LeaveLiabilityReportExportModel"
36697 },
36698 "RosterShiftFilterModel": {
36699 "type": "object",
36700 "properties": {
36701 "fromDate": {
36702 "format": "date-time",
36703 "type": "string",
36704 "title": "DateTime"
36705 },
36706 "toDate": {
36707 "format": "date-time",
36708 "type": "string",
36709 "title": "DateTime"
36710 },
36711 "resourceView": {
36712 "enum": [
36713 "Employee",
36714 "Location"
36715 ],
36716 "type": "string",
36717 "title": "ResourceViewEnum"
36718 },
36719 "shiftStatus": {
36720 "enum": [
36721 "All",
36722 "Published",
36723 "Unpublished",
36724 "Accepted"
36725 ],
36726 "type": "string",
36727 "title": "RosterShiftStatus"
36728 },
36729 "shiftStatuses": {
36730 "type": "array",
36731 "items": {
36732 "enum": [
36733 "All",
36734 "Published",
36735 "Unpublished",
36736 "Accepted"
36737 ],
36738 "type": "string",
36739 "title": "RosterShiftStatus"
36740 },
36741 "xml": {
36742 "name": "RosterShiftStatus",
36743 "wrapped": true
36744 },
36745 "title": "IList<RosterShiftStatus>"
36746 },
36747 "selectedLocations": {
36748 "type": "array",
36749 "items": {
36750 "type": "string",
36751 "title": "String"
36752 },
36753 "title": "IList<String>"
36754 },
36755 "selectedEmployees": {
36756 "type": "array",
36757 "items": {
36758 "type": "string",
36759 "title": "String"
36760 },
36761 "title": "IList<String>"
36762 },
36763 "selectedRoles": {
36764 "type": "array",
36765 "items": {
36766 "type": "string",
36767 "title": "String"
36768 },
36769 "title": "IList<String>"
36770 },
36771 "includeSublocations": {
36772 "type": "boolean",
36773 "title": "Boolean"
36774 },
36775 "currentView": {
36776 "enum": [
36777 "resourceDay",
36778 "resourceWeek",
36779 "resourceNextWeeks"
36780 ],
36781 "type": "string",
36782 "title": "RosterViewMode"
36783 },
36784 "budgetWarningPercent": {
36785 "format": "double",
36786 "type": "number",
36787 "title": "Decimal"
36788 },
36789 "employeeId": {
36790 "format": "int32",
36791 "type": "integer",
36792 "title": "Nullable<Int32>"
36793 },
36794 "locationId": {
36795 "format": "int32",
36796 "type": "integer",
36797 "title": "Nullable<Int32>"
36798 },
36799 "employeeGroupId": {
36800 "format": "int32",
36801 "type": "integer",
36802 "title": "Nullable<Int32>"
36803 },
36804 "unassignedShiftsOnly": {
36805 "type": "boolean",
36806 "title": "Boolean"
36807 },
36808 "showCosts": {
36809 "type": "boolean",
36810 "title": "Boolean"
36811 },
36812 "groupBy": {
36813 "enum": [
36814 "Business",
36815 "Location"
36816 ],
36817 "type": "string",
36818 "title": "RosterGroupByEnum"
36819 },
36820 "groupByThen": {
36821 "enum": [
36822 "Employee",
36823 "Role",
36824 "StartingTime"
36825 ],
36826 "type": "string",
36827 "title": "RosterGroupByThenEnum"
36828 },
36829 "excludeUnassignedEmployees": {
36830 "type": "boolean",
36831 "title": "Boolean"
36832 },
36833 "selectAllRoles": {
36834 "type": "boolean",
36835 "title": "Boolean"
36836 }
36837 },
36838 "xml": {
36839 "name": "RosterShiftFilterModel"
36840 },
36841 "title": "RosterShiftFilterModel"
36842 },
36843 "RosterShiftGenerateTimesheetModel": {
36844 "type": "object",
36845 "properties": {
36846 "description": {
36847 "type": "string",
36848 "readOnly": true,
36849 "title": "String"
36850 },
36851 "isDifferent": {
36852 "type": "boolean",
36853 "title": "Boolean"
36854 },
36855 "fullyQualifiedLocationName": {
36856 "type": "string",
36857 "title": "String"
36858 },
36859 "id": {
36860 "format": "int32",
36861 "type": "integer",
36862 "title": "Int32"
36863 },
36864 "employeeId": {
36865 "format": "int32",
36866 "type": "integer",
36867 "title": "Nullable<Int32>"
36868 },
36869 "startTime": {
36870 "format": "date-time",
36871 "type": "string",
36872 "title": "DateTime"
36873 },
36874 "endTime": {
36875 "format": "date-time",
36876 "type": "string",
36877 "title": "DateTime"
36878 },
36879 "noteAuthor": {
36880 "type": "string",
36881 "title": "String"
36882 },
36883 "notes": {
36884 "type": "string",
36885 "title": "String"
36886 },
36887 "locationId": {
36888 "format": "int32",
36889 "type": "integer",
36890 "title": "Int32"
36891 },
36892 "employeeName": {
36893 "type": "string",
36894 "title": "String"
36895 },
36896 "initials": {
36897 "type": "string",
36898 "title": "String"
36899 },
36900 "locationName": {
36901 "type": "string",
36902 "title": "String"
36903 },
36904 "published": {
36905 "type": "boolean",
36906 "title": "Boolean"
36907 },
36908 "isAccepted": {
36909 "type": "boolean",
36910 "title": "Boolean"
36911 },
36912 "selectedQualifications": {
36913 "type": "array",
36914 "items": {
36915 "format": "int32",
36916 "type": "integer",
36917 "title": "Int32"
36918 },
36919 "title": "IList<Int32>"
36920 },
36921 "breaks": {
36922 "type": "array",
36923 "items": {
36924 "$ref": "#/definitions/RosterShiftBreakModel"
36925 },
36926 "xml": {
36927 "name": "RosterShiftBreakModel",
36928 "wrapped": true
36929 },
36930 "title": "IList<RosterShiftBreakModel>"
36931 },
36932 "workTypeId": {
36933 "format": "int32",
36934 "type": "integer",
36935 "title": "Nullable<Int32>"
36936 },
36937 "classificationId": {
36938 "format": "int32",
36939 "type": "integer",
36940 "title": "Nullable<Int32>"
36941 },
36942 "classification": {
36943 "type": "string",
36944 "title": "String"
36945 },
36946 "workType": {
36947 "type": "string",
36948 "title": "String"
36949 },
36950 "shiftConditionIds": {
36951 "type": "array",
36952 "items": {
36953 "format": "int32",
36954 "type": "integer",
36955 "title": "Int32"
36956 },
36957 "title": "IList<Int32>"
36958 },
36959 "roleId": {
36960 "format": "int32",
36961 "type": "integer",
36962 "title": "Nullable<Int32>"
36963 },
36964 "datePublished": {
36965 "format": "date-time",
36966 "type": "string",
36967 "title": "Nullable<DateTime>"
36968 },
36969 "resourceId": {
36970 "format": "int32",
36971 "type": "integer",
36972 "title": "Nullable<Int32>"
36973 }
36974 },
36975 "xml": {
36976 "name": "RosterShiftGenerateTimesheetModel"
36977 },
36978 "title": "RosterShiftGenerateTimesheetModel"
36979 },
36980 "RosterShiftBreakModel": {
36981 "type": "object",
36982 "properties": {
36983 "id": {
36984 "format": "int32",
36985 "type": "integer",
36986 "title": "Int32"
36987 },
36988 "startTime": {
36989 "format": "date-time",
36990 "type": "string",
36991 "readOnly": true,
36992 "title": "DateTime"
36993 },
36994 "endTime": {
36995 "format": "date-time",
36996 "type": "string",
36997 "readOnly": true,
36998 "title": "DateTime"
36999 },
37000 "startDateTime": {
37001 "format": "date-time",
37002 "type": "string",
37003 "title": "DateTime"
37004 },
37005 "endDateTime": {
37006 "format": "date-time",
37007 "type": "string",
37008 "title": "DateTime"
37009 }
37010 },
37011 "xml": {
37012 "name": "RosterShiftBreakModel"
37013 },
37014 "title": "RosterShiftBreakModel"
37015 },
37016 "StubRosterShiftViewModel": {
37017 "type": "object",
37018 "properties": {
37019 "note": {
37020 "type": "string",
37021 "title": "String"
37022 }
37023 },
37024 "xml": {
37025 "name": "StubRosterShiftViewModel"
37026 },
37027 "title": "StubRosterShiftViewModel"
37028 },
37029 "ODataQueryOptions[SuperFundProduct]": {
37030 "type": "object",
37031 "properties": {
37032 "ifMatch": {
37033 "type": "object",
37034 "readOnly": true,
37035 "title": "ETag<SuperFundProduct>"
37036 },
37037 "ifNoneMatch": {
37038 "type": "object",
37039 "readOnly": true,
37040 "title": "ETag<SuperFundProduct>"
37041 },
37042 "context": {
37043 "$ref": "#/definitions/ODataQueryContext",
37044 "readOnly": true
37045 },
37046 "request": {
37047 "type": "object",
37048 "readOnly": true,
37049 "title": "HttpRequestMessage"
37050 },
37051 "rawValues": {
37052 "$ref": "#/definitions/ODataRawQueryOptions",
37053 "readOnly": true
37054 },
37055 "selectExpand": {
37056 "$ref": "#/definitions/SelectExpandQueryOption",
37057 "readOnly": true
37058 },
37059 "filter": {
37060 "$ref": "#/definitions/FilterQueryOption",
37061 "readOnly": true
37062 },
37063 "orderBy": {
37064 "$ref": "#/definitions/OrderByQueryOption",
37065 "readOnly": true
37066 },
37067 "skip": {
37068 "$ref": "#/definitions/SkipQueryOption",
37069 "readOnly": true
37070 },
37071 "top": {
37072 "$ref": "#/definitions/TopQueryOption",
37073 "readOnly": true
37074 },
37075 "inlineCount": {
37076 "$ref": "#/definitions/InlineCountQueryOption",
37077 "readOnly": true
37078 },
37079 "validator": {
37080 "$ref": "#/definitions/ODataQueryValidator"
37081 }
37082 },
37083 "xml": {
37084 "name": "ODataQueryOptions`1"
37085 },
37086 "title": "ODataQueryOptions<SuperFundProduct>"
37087 },
37088 "SelfManagedSuperFundModel": {
37089 "type": "object",
37090 "properties": {
37091 "id": {
37092 "format": "int32",
37093 "type": "integer",
37094 "title": "Int32"
37095 },
37096 "abn": {
37097 "type": "string",
37098 "title": "String"
37099 },
37100 "fundName": {
37101 "type": "string",
37102 "title": "String"
37103 },
37104 "accountName": {
37105 "type": "string",
37106 "title": "String"
37107 },
37108 "accountNumber": {
37109 "type": "string",
37110 "title": "String"
37111 },
37112 "bsb": {
37113 "type": "string",
37114 "title": "String"
37115 },
37116 "electronicServiceAddress": {
37117 "type": "string",
37118 "title": "String"
37119 },
37120 "email": {
37121 "type": "string",
37122 "title": "String"
37123 }
37124 },
37125 "xml": {
37126 "name": "SelfManagedSuperFundModel"
37127 },
37128 "title": "SelfManagedSuperFundModel"
37129 },
37130 "SuperProductEditModel": {
37131 "type": "object",
37132 "properties": {
37133 "id": {
37134 "format": "int32",
37135 "type": "integer",
37136 "title": "Int32"
37137 },
37138 "abn": {
37139 "type": "string",
37140 "title": "String"
37141 },
37142 "productCode": {
37143 "type": "string",
37144 "title": "String"
37145 },
37146 "productType": {
37147 "type": "string",
37148 "title": "String"
37149 },
37150 "businessName": {
37151 "type": "string",
37152 "title": "String"
37153 },
37154 "displayName": {
37155 "type": "string",
37156 "readOnly": true,
37157 "title": "String"
37158 },
37159 "productName": {
37160 "type": "string",
37161 "title": "String"
37162 },
37163 "accountNumber": {
37164 "type": "string",
37165 "title": "String"
37166 },
37167 "bsb": {
37168 "type": "string",
37169 "title": "String"
37170 },
37171 "accountName": {
37172 "type": "string",
37173 "title": "String"
37174 },
37175 "source": {
37176 "enum": [
37177 "None",
37178 "Saasu",
37179 "Xero",
37180 "MYOB",
37181 "Deputy",
37182 "EmployeeTimePunch",
37183 "ClickSuper",
37184 "IntegratedTimesheets",
37185 "FileImport",
37186 "FileExport",
37187 "QuickBooks",
37188 "Harmony",
37189 "AwardStore",
37190 "Attache",
37191 "IntegratedRostering",
37192 "ReckonAccounts",
37193 "API",
37194 "MicroPower",
37195 "RosterLive",
37196 "NetSuite",
37197 "Kounta",
37198 "TimeAndAttendanceKiosk",
37199 "DetailedFileExport",
37200 "JonasPremier",
37201 "WageEasy",
37202 "Maestrano",
37203 "WorkZone",
37204 "EmployeePortal",
37205 "RosterTemplate",
37206 "Onboarding",
37207 "Admin",
37208 "WorkZoneClockOnOff"
37209 ],
37210 "type": "string",
37211 "title": "ExternalService"
37212 },
37213 "electronicServiceAddress": {
37214 "type": "string",
37215 "title": "String"
37216 },
37217 "email": {
37218 "type": "string",
37219 "title": "String"
37220 },
37221 "externalReferenceId": {
37222 "type": "string",
37223 "title": "String"
37224 }
37225 },
37226 "xml": {
37227 "name": "SuperProductEditModel"
37228 },
37229 "title": "SuperProductEditModel"
37230 },
37231 "KioskCreateEmployeeModel": {
37232 "type": "object",
37233 "properties": {
37234 "firstName": {
37235 "type": "string",
37236 "title": "String"
37237 },
37238 "surname": {
37239 "type": "string",
37240 "title": "String"
37241 },
37242 "email": {
37243 "type": "string",
37244 "title": "String"
37245 },
37246 "mobileNumber": {
37247 "type": "string",
37248 "title": "String"
37249 },
37250 "pin": {
37251 "type": "string",
37252 "title": "String"
37253 }
37254 },
37255 "xml": {
37256 "name": "KioskCreateEmployeeModel"
37257 },
37258 "title": "KioskCreateEmployeeModel"
37259 },
37260 "CheckKioskEmployeeIdModel": {
37261 "type": "object",
37262 "properties": {
37263 "employeeId": {
37264 "format": "int32",
37265 "type": "integer",
37266 "title": "Nullable<Int32>"
37267 }
37268 },
37269 "xml": {
37270 "name": "CheckKioskEmployeeIdModel"
37271 },
37272 "title": "CheckKioskEmployeeIdModel"
37273 },
37274 "CheckKioskPinModel": {
37275 "type": "object",
37276 "properties": {
37277 "employeeId": {
37278 "format": "int32",
37279 "type": "integer",
37280 "title": "Nullable<Int32>"
37281 },
37282 "pin": {
37283 "type": "string",
37284 "title": "String"
37285 }
37286 },
37287 "xml": {
37288 "name": "CheckKioskPinModel"
37289 },
37290 "title": "CheckKioskPinModel"
37291 },
37292 "ChangeKioskPinModel": {
37293 "type": "object",
37294 "properties": {
37295 "employeeId": {
37296 "format": "int32",
37297 "type": "integer",
37298 "title": "Nullable<Int32>"
37299 },
37300 "oldPin": {
37301 "type": "string",
37302 "title": "String"
37303 },
37304 "newPin": {
37305 "type": "string",
37306 "title": "String"
37307 }
37308 },
37309 "xml": {
37310 "name": "ChangeKioskPinModel"
37311 },
37312 "title": "ChangeKioskPinModel"
37313 },
37314 "PinResetModel": {
37315 "type": "object",
37316 "properties": {
37317 "employeeId": {
37318 "format": "int32",
37319 "type": "integer",
37320 "title": "Int32"
37321 }
37322 },
37323 "xml": {
37324 "name": "PinResetModel"
37325 },
37326 "title": "PinResetModel"
37327 },
37328 "TimeAndAttendanceKioskModel": {
37329 "type": "object",
37330 "properties": {
37331 "id": {
37332 "format": "int32",
37333 "type": "integer",
37334 "title": "Int32"
37335 },
37336 "externalId": {
37337 "type": "string",
37338 "title": "String"
37339 },
37340 "locationId": {
37341 "format": "int32",
37342 "type": "integer",
37343 "title": "Nullable<Int32>"
37344 },
37345 "name": {
37346 "type": "string",
37347 "title": "String"
37348 },
37349 "timeZone": {
37350 "type": "string",
37351 "title": "String"
37352 },
37353 "allowHigherClassificationSelection": {
37354 "type": "boolean",
37355 "title": "Boolean"
37356 },
37357 "branding": {
37358 "$ref": "#/definitions/WhiteLabelBrandingModel"
37359 },
37360 "isLocationRequired": {
37361 "type": "boolean",
37362 "title": "Boolean"
37363 },
37364 "isWorkTypeRequired": {
37365 "type": "boolean",
37366 "title": "Boolean"
37367 },
37368 "restrictLocationsForEmployees": {
37369 "type": "boolean",
37370 "title": "Boolean"
37371 },
37372 "allowEmployeeShiftSelection": {
37373 "type": "boolean",
37374 "title": "Nullable<Boolean>"
37375 },
37376 "clockOnWindowMinutes": {
37377 "format": "int32",
37378 "type": "integer",
37379 "title": "Nullable<Int32>"
37380 },
37381 "clockOffWindowMinutes": {
37382 "format": "int32",
37383 "type": "integer",
37384 "title": "Nullable<Int32>"
37385 },
37386 "ianaTimeZone": {
37387 "type": "string",
37388 "readOnly": true,
37389 "title": "String"
37390 },
37391 "isPhotoRequired": {
37392 "type": "boolean",
37393 "title": "Nullable<Boolean>"
37394 }
37395 },
37396 "xml": {
37397 "name": "TimeAndAttendanceKioskModel"
37398 },
37399 "title": "TimeAndAttendanceKioskModel"
37400 },
37401 "ODataQueryOptions[TimesheetLine]": {
37402 "type": "object",
37403 "properties": {
37404 "ifMatch": {
37405 "type": "object",
37406 "readOnly": true,
37407 "title": "ETag<TimesheetLine>"
37408 },
37409 "ifNoneMatch": {
37410 "type": "object",
37411 "readOnly": true,
37412 "title": "ETag<TimesheetLine>"
37413 },
37414 "context": {
37415 "$ref": "#/definitions/ODataQueryContext",
37416 "readOnly": true
37417 },
37418 "request": {
37419 "type": "object",
37420 "readOnly": true,
37421 "title": "HttpRequestMessage"
37422 },
37423 "rawValues": {
37424 "$ref": "#/definitions/ODataRawQueryOptions",
37425 "readOnly": true
37426 },
37427 "selectExpand": {
37428 "$ref": "#/definitions/SelectExpandQueryOption",
37429 "readOnly": true
37430 },
37431 "filter": {
37432 "$ref": "#/definitions/FilterQueryOption",
37433 "readOnly": true
37434 },
37435 "orderBy": {
37436 "$ref": "#/definitions/OrderByQueryOption",
37437 "readOnly": true
37438 },
37439 "skip": {
37440 "$ref": "#/definitions/SkipQueryOption",
37441 "readOnly": true
37442 },
37443 "top": {
37444 "$ref": "#/definitions/TopQueryOption",
37445 "readOnly": true
37446 },
37447 "inlineCount": {
37448 "$ref": "#/definitions/InlineCountQueryOption",
37449 "readOnly": true
37450 },
37451 "validator": {
37452 "$ref": "#/definitions/ODataQueryValidator"
37453 }
37454 },
37455 "xml": {
37456 "name": "ODataQueryOptions`1"
37457 },
37458 "title": "ODataQueryOptions<TimesheetLine>"
37459 },
37460 "TimesheetLineModel": {
37461 "type": "object",
37462 "properties": {
37463 "id": {
37464 "format": "int32",
37465 "type": "integer",
37466 "title": "Int32"
37467 },
37468 "employeeId": {
37469 "format": "int32",
37470 "type": "integer",
37471 "title": "Int32"
37472 },
37473 "startTime": {
37474 "format": "date-time",
37475 "type": "string",
37476 "title": "Nullable<DateTime>"
37477 },
37478 "endTime": {
37479 "format": "date-time",
37480 "type": "string",
37481 "title": "Nullable<DateTime>"
37482 },
37483 "units": {
37484 "format": "double",
37485 "type": "number",
37486 "title": "Nullable<Decimal>"
37487 },
37488 "workTypeId": {
37489 "type": "string",
37490 "title": "String"
37491 },
37492 "locationId": {
37493 "type": "string",
37494 "title": "String"
37495 },
37496 "comments": {
37497 "type": "string",
37498 "title": "String"
37499 },
37500 "breaks": {
37501 "type": "array",
37502 "items": {
37503 "$ref": "#/definitions/TimesheetBreakModel"
37504 },
37505 "xml": {
37506 "name": "TimesheetBreakModel",
37507 "wrapped": true
37508 },
37509 "title": "IList<TimesheetBreakModel>"
37510 },
37511 "status": {
37512 "type": "string",
37513 "title": "String"
37514 },
37515 "rate": {
37516 "format": "double",
37517 "type": "number",
37518 "title": "Nullable<Decimal>"
37519 },
37520 "leaveCategoryId": {
37521 "type": "string",
37522 "title": "String"
37523 },
37524 "payCategoryId": {
37525 "type": "string",
37526 "title": "String"
37527 },
37528 "classificationId": {
37529 "type": "string",
37530 "title": "String"
37531 },
37532 "externalId": {
37533 "type": "string",
37534 "title": "String"
37535 },
37536 "source": {
37537 "enum": [
37538 "None",
37539 "Saasu",
37540 "Xero",
37541 "MYOB",
37542 "Deputy",
37543 "EmployeeTimePunch",
37544 "ClickSuper",
37545 "IntegratedTimesheets",
37546 "FileImport",
37547 "FileExport",
37548 "QuickBooks",
37549 "Harmony",
37550 "AwardStore",
37551 "Attache",
37552 "IntegratedRostering",
37553 "ReckonAccounts",
37554 "API",
37555 "MicroPower",
37556 "RosterLive",
37557 "NetSuite",
37558 "Kounta",
37559 "TimeAndAttendanceKiosk",
37560 "DetailedFileExport",
37561 "JonasPremier",
37562 "WageEasy",
37563 "Maestrano",
37564 "WorkZone",
37565 "EmployeePortal",
37566 "RosterTemplate",
37567 "Onboarding",
37568 "Admin",
37569 "WorkZoneClockOnOff"
37570 ],
37571 "type": "string",
37572 "title": "ExternalService"
37573 },
37574 "attachmentId": {
37575 "format": "int32",
37576 "type": "integer",
37577 "title": "Nullable<Int32>"
37578 },
37579 "shiftConditionIds": {
37580 "type": "array",
37581 "items": {
37582 "type": "string",
37583 "title": "String"
37584 },
37585 "title": "IList<String>"
37586 }
37587 },
37588 "xml": {
37589 "name": "TimesheetLineModel"
37590 },
37591 "title": "TimesheetLineModel"
37592 },
37593 "SubmitTimesheetsRequest": {
37594 "type": "object",
37595 "properties": {
37596 "fromDate": {
37597 "format": "date-time",
37598 "type": "string",
37599 "title": "Nullable<DateTime>"
37600 },
37601 "toDate": {
37602 "format": "date-time",
37603 "type": "string",
37604 "title": "Nullable<DateTime>"
37605 },
37606 "replaceExisting": {
37607 "type": "boolean",
37608 "title": "Boolean"
37609 },
37610 "approved": {
37611 "type": "boolean",
37612 "title": "Boolean"
37613 },
37614 "employeeIdType": {
37615 "enum": [
37616 "Standard",
37617 "External"
37618 ],
37619 "type": "string",
37620 "title": "IdType"
37621 },
37622 "locationIdType": {
37623 "enum": [
37624 "Standard",
37625 "External"
37626 ],
37627 "type": "string",
37628 "title": "IdType"
37629 },
37630 "workTypeIdType": {
37631 "enum": [
37632 "Standard",
37633 "External"
37634 ],
37635 "type": "string",
37636 "title": "IdType"
37637 },
37638 "timesheets": {
37639 "type": "object",
37640 "additionalProperties": {
37641 "type": "array",
37642 "items": {
37643 "$ref": "#/definitions/TimesheetLineModel"
37644 },
37645 "xml": {
37646 "name": "TimesheetLineModel",
37647 "wrapped": true
37648 },
37649 "title": "IList<TimesheetLineModel>"
37650 },
37651 "title": "IDictionary<String,IList`1>"
37652 }
37653 },
37654 "xml": {
37655 "name": "SubmitTimesheetsRequest"
37656 },
37657 "example": {
37658 "fromDate": "2017-06-01T00:00:00",
37659 "toDate": "2017-06-30T00:00:00",
37660 "replaceExisting": false,
37661 "approved": true,
37662 "employeeIdType": "External",
37663 "locationIdType": "Standard",
37664 "workTypeIdType": "External",
37665 "timesheets": {
37666 "emP3316": [
37667 {
37668 "id": 0,
37669 "employeeId": 0,
37670 "startTime": "2017-06-11T10:00:00",
37671 "endTime": "2017-06-11T13:00:00",
37672 "units": null,
37673 "workTypeId": null,
37674 "locationId": null,
37675 "comments": null,
37676 "breaks": [],
37677 "status": null,
37678 "rate": null,
37679 "leaveCategoryId": null,
37680 "payCategoryId": null,
37681 "classificationId": null,
37682 "externalId": null,
37683 "source": "None",
37684 "attachmentId": null,
37685 "shiftConditionIds": null
37686 }
37687 ],
37688 "emP3317": [
37689 {
37690 "id": 0,
37691 "employeeId": 0,
37692 "startTime": "2017-06-13T09:00:00",
37693 "endTime": "2017-06-13T17:00:00",
37694 "units": 8.0,
37695 "workTypeId": "WT1485",
37696 "locationId": "123456",
37697 "comments": "Some Comments",
37698 "breaks": [
37699 {
37700 "startTime": "2017-06-13T11:00:00",
37701 "endTime": "2017-06-13T12:00:00"
37702 }
37703 ],
37704 "status": null,
37705 "rate": 20.0,
37706 "leaveCategoryId": null,
37707 "payCategoryId": null,
37708 "classificationId": null,
37709 "externalId": null,
37710 "source": "None",
37711 "attachmentId": null,
37712 "shiftConditionIds": null
37713 },
37714 {
37715 "id": 0,
37716 "employeeId": 0,
37717 "startTime": "2017-06-15T09:00:00",
37718 "endTime": "2017-06-15T17:00:00",
37719 "units": 8.0,
37720 "workTypeId": "WT1485",
37721 "locationId": "123456",
37722 "comments": "Some Comments",
37723 "breaks": [
37724 {
37725 "startTime": "2017-06-15T11:00:00",
37726 "endTime": "2017-06-15T12:00:00"
37727 }
37728 ],
37729 "status": null,
37730 "rate": 20.0,
37731 "leaveCategoryId": null,
37732 "payCategoryId": null,
37733 "classificationId": null,
37734 "externalId": null,
37735 "source": "None",
37736 "attachmentId": null,
37737 "shiftConditionIds": null
37738 }
37739 ]
37740 }
37741 },
37742 "title": "SubmitTimesheetsRequest"
37743 },
37744 "UnavailabilityFilter": {
37745 "type": "object",
37746 "properties": {
37747 "fromDate": {
37748 "format": "date-time",
37749 "type": "string",
37750 "title": "Nullable<DateTime>"
37751 },
37752 "toDate": {
37753 "format": "date-time",
37754 "type": "string",
37755 "title": "Nullable<DateTime>"
37756 },
37757 "employeeId": {
37758 "format": "int32",
37759 "type": "integer",
37760 "title": "Nullable<Int32>"
37761 },
37762 "defaultLocationId": {
37763 "format": "int32",
37764 "type": "integer",
37765 "title": "Nullable<Int32>"
37766 }
37767 },
37768 "xml": {
37769 "name": "UnavailabilityFilter"
37770 },
37771 "title": "UnavailabilityFilter"
37772 },
37773 "UnavailabilityModel": {
37774 "type": "object",
37775 "properties": {
37776 "employeeId": {
37777 "format": "int32",
37778 "type": "integer",
37779 "title": "Int32"
37780 },
37781 "id": {
37782 "format": "int32",
37783 "type": "integer",
37784 "title": "Int32"
37785 },
37786 "fromDate": {
37787 "format": "date-time",
37788 "type": "string",
37789 "title": "DateTime"
37790 },
37791 "toDate": {
37792 "format": "date-time",
37793 "type": "string",
37794 "title": "Nullable<DateTime>"
37795 },
37796 "endDate": {
37797 "format": "date-time",
37798 "type": "string",
37799 "title": "Nullable<DateTime>"
37800 },
37801 "reason": {
37802 "type": "string",
37803 "title": "String"
37804 },
37805 "recurring": {
37806 "type": "boolean",
37807 "title": "Boolean"
37808 },
37809 "recurringDay": {
37810 "enum": [
37811 "Sunday",
37812 "Monday",
37813 "Tuesday",
37814 "Wednesday",
37815 "Thursday",
37816 "Friday",
37817 "Saturday"
37818 ],
37819 "type": "string",
37820 "title": "Nullable<DayOfWeek>"
37821 },
37822 "isAllDay": {
37823 "type": "boolean",
37824 "readOnly": true,
37825 "title": "Boolean"
37826 },
37827 "viewOnly": {
37828 "type": "boolean",
37829 "title": "Boolean"
37830 }
37831 },
37832 "xml": {
37833 "name": "UnavailabilityModel"
37834 },
37835 "title": "UnavailabilityModel"
37836 },
37837 "UserModel": {
37838 "type": "object",
37839 "properties": {
37840 "id": {
37841 "format": "int32",
37842 "type": "integer",
37843 "title": "Int32"
37844 },
37845 "email": {
37846 "type": "string",
37847 "title": "String"
37848 },
37849 "displayName": {
37850 "type": "string",
37851 "title": "String"
37852 },
37853 "timeZone": {
37854 "type": "string",
37855 "title": "String"
37856 }
37857 },
37858 "xml": {
37859 "name": "UserModel"
37860 },
37861 "title": "UserModel"
37862 },
37863 "NewUserModel": {
37864 "type": "object",
37865 "properties": {
37866 "username": {
37867 "type": "string",
37868 "title": "String"
37869 },
37870 "displayName": {
37871 "type": "string",
37872 "title": "String"
37873 },
37874 "timeZone": {
37875 "type": "string",
37876 "title": "String"
37877 },
37878 "apiOnly": {
37879 "type": "boolean",
37880 "title": "Boolean"
37881 }
37882 },
37883 "xml": {
37884 "name": "NewUserModel"
37885 },
37886 "title": "NewUserModel"
37887 },
37888 "WebHook": {
37889 "required": [
37890 "webHookUri"
37891 ],
37892 "type": "object",
37893 "properties": {
37894 "id": {
37895 "type": "string",
37896 "title": "String"
37897 },
37898 "webHookUri": {
37899 "type": "string",
37900 "title": "Uri"
37901 },
37902 "secret": {
37903 "type": "string",
37904 "title": "String"
37905 },
37906 "description": {
37907 "type": "string",
37908 "title": "String"
37909 },
37910 "isPaused": {
37911 "type": "boolean",
37912 "title": "Boolean"
37913 },
37914 "filters": {
37915 "type": "array",
37916 "items": {
37917 "type": "string",
37918 "title": "String"
37919 },
37920 "readOnly": true,
37921 "title": "ISet<String>"
37922 },
37923 "headers": {
37924 "type": "object",
37925 "additionalProperties": {
37926 "type": "string",
37927 "title": "String"
37928 },
37929 "readOnly": true,
37930 "title": "IDictionary<String,String>"
37931 },
37932 "properties": {
37933 "type": "object",
37934 "additionalProperties": {
37935 "type": "object",
37936 "title": "Object"
37937 },
37938 "readOnly": true,
37939 "title": "IDictionary<String,Object>"
37940 }
37941 },
37942 "xml": {
37943 "name": "WebHook"
37944 },
37945 "title": "WebHook"
37946 },
37947 "WhiteLabelModel": {
37948 "type": "object",
37949 "properties": {
37950 "id": {
37951 "format": "int32",
37952 "type": "integer",
37953 "title": "Int32"
37954 },
37955 "name": {
37956 "type": "string",
37957 "title": "String"
37958 }
37959 },
37960 "xml": {
37961 "name": "WhiteLabelModel"
37962 },
37963 "title": "WhiteLabelModel"
37964 },
37965 "InvoiceModel": {
37966 "type": "object",
37967 "properties": {
37968 "id": {
37969 "format": "int32",
37970 "type": "integer",
37971 "title": "Int32"
37972 },
37973 "invoiceNumber": {
37974 "type": "string",
37975 "title": "String"
37976 },
37977 "date": {
37978 "format": "date-time",
37979 "type": "string",
37980 "title": "DateTime"
37981 },
37982 "totalExcludingGst": {
37983 "format": "double",
37984 "type": "number",
37985 "title": "Decimal"
37986 },
37987 "gst": {
37988 "format": "double",
37989 "type": "number",
37990 "title": "Decimal"
37991 },
37992 "totalIncludingGst": {
37993 "format": "double",
37994 "type": "number",
37995 "title": "Decimal"
37996 },
37997 "cultureName": {
37998 "type": "string",
37999 "title": "String"
38000 },
38001 "currency": {
38002 "type": "string",
38003 "title": "String"
38004 },
38005 "lineItems": {
38006 "type": "array",
38007 "items": {
38008 "$ref": "#/definitions/InvoiceLineItemModel"
38009 },
38010 "xml": {
38011 "name": "InvoiceLineItemModel",
38012 "wrapped": true
38013 },
38014 "title": "List<InvoiceLineItemModel>"
38015 }
38016 },
38017 "xml": {
38018 "name": "InvoiceModel"
38019 },
38020 "title": "InvoiceModel"
38021 },
38022 "InvoiceLineItemModel": {
38023 "type": "object",
38024 "properties": {
38025 "abn": {
38026 "type": "string",
38027 "title": "String"
38028 },
38029 "description": {
38030 "type": "string",
38031 "title": "String"
38032 },
38033 "unitPriceIncludingGst": {
38034 "format": "double",
38035 "type": "number",
38036 "title": "Decimal"
38037 },
38038 "quantity": {
38039 "format": "double",
38040 "type": "number",
38041 "title": "Decimal"
38042 },
38043 "totalIncludingGst": {
38044 "format": "double",
38045 "type": "number",
38046 "title": "Decimal"
38047 },
38048 "details": {
38049 "type": "array",
38050 "items": {
38051 "$ref": "#/definitions/InvoiceLineItemDetailModel"
38052 },
38053 "xml": {
38054 "name": "InvoiceLineItemDetailModel",
38055 "wrapped": true
38056 },
38057 "title": "List<InvoiceLineItemDetailModel>"
38058 }
38059 },
38060 "xml": {
38061 "name": "InvoiceLineItemModel"
38062 },
38063 "title": "InvoiceLineItemModel"
38064 },
38065 "InvoiceLineItemDetailModel": {
38066 "type": "object",
38067 "properties": {
38068 "description": {
38069 "type": "string",
38070 "title": "String"
38071 }
38072 },
38073 "xml": {
38074 "name": "InvoiceLineItemDetailModel"
38075 },
38076 "title": "InvoiceLineItemDetailModel"
38077 },
38078 "ODataQueryOptions[WorkType]": {
38079 "type": "object",
38080 "properties": {
38081 "ifMatch": {
38082 "type": "object",
38083 "readOnly": true,
38084 "title": "ETag<WorkType>"
38085 },
38086 "ifNoneMatch": {
38087 "type": "object",
38088 "readOnly": true,
38089 "title": "ETag<WorkType>"
38090 },
38091 "context": {
38092 "$ref": "#/definitions/ODataQueryContext",
38093 "readOnly": true
38094 },
38095 "request": {
38096 "type": "object",
38097 "readOnly": true,
38098 "title": "HttpRequestMessage"
38099 },
38100 "rawValues": {
38101 "$ref": "#/definitions/ODataRawQueryOptions",
38102 "readOnly": true
38103 },
38104 "selectExpand": {
38105 "$ref": "#/definitions/SelectExpandQueryOption",
38106 "readOnly": true
38107 },
38108 "filter": {
38109 "$ref": "#/definitions/FilterQueryOption",
38110 "readOnly": true
38111 },
38112 "orderBy": {
38113 "$ref": "#/definitions/OrderByQueryOption",
38114 "readOnly": true
38115 },
38116 "skip": {
38117 "$ref": "#/definitions/SkipQueryOption",
38118 "readOnly": true
38119 },
38120 "top": {
38121 "$ref": "#/definitions/TopQueryOption",
38122 "readOnly": true
38123 },
38124 "inlineCount": {
38125 "$ref": "#/definitions/InlineCountQueryOption",
38126 "readOnly": true
38127 },
38128 "validator": {
38129 "$ref": "#/definitions/ODataQueryValidator"
38130 }
38131 },
38132 "xml": {
38133 "name": "ODataQueryOptions`1"
38134 },
38135 "title": "ODataQueryOptions<WorkType>"
38136 }
38137 },
38138 "securityDefinitions": {
38139 "basic": {
38140 "type": "basic",
38141 "description": "Your API key should be the username and the password can be left blank"
38142 },
38143 "apiKey": {
38144 "type": "apiKey",
38145 "description": "API Key Authentication",
38146 "name": "apiKey",
38147 "in": "header"
38148 },
38149 "oauth2": {
38150 "type": "oauth2",
38151 "description": "OAuth2 Implicit Grant",
38152 "flow": "implicit",
38153 "authorizationUrl": "https://{yourwhitelabel}.yourpayroll.com.au/oauth/authorise",
38154 "tokenUrl": "https://{yourwhitelabel}.yourpayroll.com.au/oauth/token",
38155 "scopes": {
38156 "read": "Read access to protected resources",
38157 "write": "Write access to protected resources"
38158 }
38159 }
38160 },
38161 "security": [
38162 {
38163 "apiKey": []
38164 }
38165 ],
38166 "tags": [
38167 {
38168 "name": "User",
38169 "description": "User"
38170 },
38171 {
38172 "name": "Authentication",
38173 "description": "Authentication"
38174 },
38175 {
38176 "name": "Business",
38177 "description": "Business"
38178 },
38179 {
38180 "name": "PayRun",
38181 "description": "Pay Run"
38182 },
38183 {
38184 "name": "PublicHoliday",
38185 "description": "Public Holiday"
38186 },
38187 {
38188 "name": "TimeAndAttendance",
38189 "description": "Time and Attendance"
38190 },
38191 {
38192 "name": "EmployeeQualifications",
38193 "description": "Employee Qualifications"
38194 },
38195 {
38196 "name": "LeaveRequests",
38197 "description": "Leave Requests"
38198 },
38199 {
38200 "name": "Timesheets",
38201 "description": "Timesheets"
38202 },
38203 {
38204 "name": "Location",
38205 "description": "Location"
38206 },
38207 {
38208 "name": "DeductionCategories",
38209 "description": "Deduction Categories"
38210 },
38211 {
38212 "name": "EmployeeExpenseCategories",
38213 "description": "Employee Expense Categories"
38214 },
38215 {
38216 "name": "EmployerLiabilityCategories",
38217 "description": "Employer Liability Categories"
38218 },
38219 {
38220 "name": "LeaveAllowance",
38221 "description": "Leave Allowances"
38222 },
38223 {
38224 "name": "Employee",
38225 "description": "Employee"
38226 },
38227 {
38228 "name": "EmployeeDocument",
38229 "description": "Employee Documents"
38230 },
38231 {
38232 "name": "EmployeeGroups",
38233 "description": "Employee Groups"
38234 },
38235 {
38236 "name": "AbaSettings",
38237 "description": "ABA Settings"
38238 },
38239 {
38240 "name": "EmployingEntities",
38241 "description": "Employing Entities"
38242 },
38243 {
38244 "name": "EmploymentAgreement",
38245 "description": "Employment Agreement"
38246 },
38247 {
38248 "name": "LeaveCategories",
38249 "description": "Leave Categories"
38250 },
38251 {
38252 "name": "PayCategory",
38253 "description": "Pay Category"
38254 },
38255 {
38256 "name": "PaymentSummary",
38257 "description": "Payment Summaries"
38258 },
38259 {
38260 "name": "PayRateTemplate",
38261 "description": "Pay Rate Templates"
38262 },
38263 {
38264 "name": "PaySchedule",
38265 "description": "Pay Schedules"
38266 },
38267 {
38268 "name": "Qualifications",
38269 "description": "Qualifications"
38270 },
38271 {
38272 "name": "RosterShift",
38273 "description": "Roster Shifts"
38274 },
38275 {
38276 "name": "SuperFund",
38277 "description": "Super Funds"
38278 },
38279 {
38280 "name": "WorkType",
38281 "description": "Work Types"
38282 },
38283 {
38284 "name": "EmployeeAccess",
38285 "description": "Employee Access"
38286 },
38287 {
38288 "name": "EmployeeExpenseRequest",
38289 "description": "Employee Expense Requests"
38290 },
38291 {
38292 "name": "EmployeeBankAccount",
38293 "description": "Employee Bank Accounts"
38294 },
38295 {
38296 "name": "EmployeeSuperFund",
38297 "description": "Employee Super Funds"
38298 },
38299 {
38300 "name": "EmployeeRecurringTransactions",
38301 "description": "Pay Run Inclusions"
38302 },
38303 {
38304 "name": "Unavailability",
38305 "description": "Unavailability"
38306 },
38307 {
38308 "name": "Reporting",
38309 "description": "Reporting"
38310 },
38311 {
38312 "name": "Ess",
38313 "description": "Employee Self Service"
38314 },
38315 {
38316 "name": "LookupData",
38317 "description": "Lookup Data"
38318 },
38319 {
38320 "name": "Webhook",
38321 "description": "Webhook"
38322 },
38323 {
38324 "name": "WhiteLabel",
38325 "description": "White Label Only"
38326 }
38327 ],
38328 "x-navigateMethodsByName": true
38329}View as plain text