|
1684 | 1684 | }, |
1685 | 1685 | "sickLeaveHoursToAccrueAnnually" : { |
1686 | 1686 | "type" : "number", |
1687 | | - "description" : "Number of hours accrued annually for sick leave. Multiply the number of days they're entitled to by the hours worked per day", |
| 1687 | + "description" : "Deprecated use SickLeaveToAccrueAnnually", |
1688 | 1688 | "format" : "double", |
1689 | 1689 | "example" : 100.5, |
1690 | 1690 | "x-is-money" : true |
1691 | 1691 | }, |
1692 | 1692 | "sickLeaveMaximumHoursToAccrue" : { |
1693 | 1693 | "type" : "number", |
1694 | | - "description" : "Maximum number of hours accrued annually for sick leave. Multiply the maximum days they can accrue by the hours worked per day", |
| 1694 | + "description" : "Deprecated use SickLeaveMaximumToAccrue", |
| 1695 | + "format" : "double", |
| 1696 | + "example" : 200.5, |
| 1697 | + "x-is-money" : true |
| 1698 | + }, |
| 1699 | + "SickLeaveToAccrueAnnually" : { |
| 1700 | + "type" : "number", |
| 1701 | + "description" : "Number of units accrued annually for sick leave. The type of units is determined by the property \"TypeOfUnitsToAccrue\" on the \"Sick Leave\" leave type", |
| 1702 | + "format" : "double", |
| 1703 | + "example" : 100.5, |
| 1704 | + "x-is-money" : true |
| 1705 | + }, |
| 1706 | + "SickLeaveMaximumToAccrue" : { |
| 1707 | + "type" : "number", |
| 1708 | + "description" : "Maximum number of units accrued annually for sick leave. The type of units is determined by the property \"TypeOfUnitsToAccrue\" on the \"Sick Leave\" leave type", |
1695 | 1709 | "format" : "double", |
1696 | 1710 | "example" : 200.5, |
1697 | 1711 | "x-is-money" : true |
|
1710 | 1724 | }, |
1711 | 1725 | "SickLeaveAnniversaryDate" : { |
1712 | 1726 | "type" : "string", |
1713 | | - "description" : "If Sick Leave Schedule of Accrual is \"OnAnniversaryDate\", this is the date when entitled to Sick Leave", |
| 1727 | + "description" : "If Sick Leave Schedule of Accrual is \"OnAnniversaryDate\", this is the date when entitled to Sick Leave. When null the Employee's start date is used as the anniversary date", |
| 1728 | + "format" : "date", |
| 1729 | + "example" : "2020-01-19", |
| 1730 | + "x-is-date" : true |
| 1731 | + }, |
| 1732 | + "AnnualLeaveAnniversaryDate" : { |
| 1733 | + "type" : "string", |
| 1734 | + "description" : "The first date the employee will accrue Annual Leave. When null the Employee's start date is used as the anniversary date", |
1714 | 1735 | "format" : "date", |
1715 | 1736 | "example" : "2020-01-19", |
1716 | 1737 | "x-is-date" : true |
|
1750 | 1771 | }, |
1751 | 1772 | "hoursAccruedAnnually" : { |
1752 | 1773 | "type" : "number", |
1753 | | - "description" : "The number of hours accrued for the leave annually. This is 0 when the scheduleOfAccrual chosen is \"OnHourWorked\"", |
| 1774 | + "description" : "Deprecated use UnitsAccruedAnnually", |
1754 | 1775 | "format" : "double", |
1755 | 1776 | "x-is-money" : true |
1756 | 1777 | }, |
| 1778 | + "UnitsAccruedAnnually" : { |
| 1779 | + "type" : "number", |
| 1780 | + "description" : "The number of units accrued for the leave annually. This is 0 when the ScheduleOfAccrual chosen is \"NoAccruals\"", |
| 1781 | + "format" : "double", |
| 1782 | + "x-is-money" : true |
| 1783 | + }, |
| 1784 | + "typeOfUnitsToAccrue" : { |
| 1785 | + "type" : "string", |
| 1786 | + "description" : "The type of units accrued for the leave annually" |
| 1787 | + }, |
1757 | 1788 | "maximumToAccrue" : { |
1758 | 1789 | "type" : "number", |
1759 | | - "description" : "The maximum number of hours that can be accrued for the leave", |
| 1790 | + "description" : "The maximum number of units that can be accrued for the leave", |
1760 | 1791 | "format" : "double", |
1761 | 1792 | "x-is-money" : true |
1762 | 1793 | }, |
1763 | 1794 | "openingBalance" : { |
1764 | 1795 | "type" : "number", |
1765 | | - "description" : "The initial number of hours assigned when the leave was added to the employee", |
| 1796 | + "description" : "The initial number of units assigned when the leave was added to the employee", |
1766 | 1797 | "format" : "double", |
1767 | 1798 | "x-is-money" : true |
1768 | 1799 | }, |
| 1800 | + "openingBalanceTypeOfUnits" : { |
| 1801 | + "type" : "string", |
| 1802 | + "description" : "The type of units for the opening balance" |
| 1803 | + }, |
1769 | 1804 | "rateAccruedHourly" : { |
1770 | 1805 | "type" : "number", |
1771 | 1806 | "description" : "The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\"", |
|
2609 | 2644 | "format" : "double", |
2610 | 2645 | "x-is-money" : true |
2611 | 2646 | }, |
| 2647 | + "numberOfUnitsTaken" : { |
| 2648 | + "type" : "number", |
| 2649 | + "description" : "The number of units taken for the leave", |
| 2650 | + "format" : "double" |
| 2651 | + }, |
| 2652 | + "typeOfUnits" : { |
| 2653 | + "type" : "string", |
| 2654 | + "description" : "The type of units paid for the leave" |
| 2655 | + }, |
| 2656 | + "typeOfUnitsTaken" : { |
| 2657 | + "type" : "string", |
| 2658 | + "description" : "The type of units taken for the leave" |
| 2659 | + }, |
2612 | 2660 | "periodStatus" : { |
2613 | 2661 | "type" : "string", |
2614 | | - "description" : "Period Status", |
2615 | | - "enum" : [ "Approved", "Completed" ] |
| 2662 | + "description" : "Status of leave", |
| 2663 | + "enum" : [ "Approved", "Completed", "Estimated" ] |
2616 | 2664 | } |
2617 | 2665 | }, |
2618 | 2666 | "description" : "" |
|
2667 | 2715 | "isActive" : { |
2668 | 2716 | "type" : "boolean", |
2669 | 2717 | "description" : "Shows whether the leave type is active or not" |
| 2718 | + }, |
| 2719 | + "typeOfUnits" : { |
| 2720 | + "type" : "string", |
| 2721 | + "description" : "The type of units to be paid for the leave type" |
| 2722 | + }, |
| 2723 | + "typeOfUnitsToAccrue" : { |
| 2724 | + "type" : "string", |
| 2725 | + "description" : "The type of units to be accrued for the leave type" |
2670 | 2726 | } |
2671 | 2727 | }, |
2672 | 2728 | "description" : "" |
|
4032 | 4088 | <nav id="scrollingNav"> |
4033 | 4089 | <ul class="sidenav nav nav-list"> |
4034 | 4090 | <li class="nav-header" data-group="PayrollNz"><strong>SDK: </strong><span id='sdk-name'></span></li> |
4035 | | - <li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>9.3.0</li> |
| 4091 | + <li class="nav-header" data-group="PayrollNz"><strong>VSN: </strong>10.0.0</li> |
4036 | 4092 | <li class="nav-header" data-group="PayrollNz"><a href="#api-PayrollNz">Methods</a></li> |
4037 | 4093 | <li data-group="PayrollNz" data-name="approveTimesheet" class=""> |
4038 | 4094 | <a href="#api-PayrollNz-approveTimesheet">approveTimesheet</a> |
|
0 commit comments