namestring required
The user friendly name of this type of Accrual. Intended to be displayed in a user interface
personIdnumber required
The identifier of the Person who's Accrual is being summarised
datestring date required
The date that this summary covers
measurementUnitstring required
The way that the balance of an Accrual of this accrual_type should be interpreted eg "hours" or "count"
totalnumber double
The total amount agreed for the Accrual in the Agreement period.
workednumber double
The total amount of units worked to date.
totalNetOrGrossOfPH'net_of_ph' | 'gross_of_ph'
Shows whether the target is net or gross of public holiday allowence
targetnumber double required
The pro-rated target value for the Accrual. Shows how many units of the Accrual type the worker should have worked (or been sheduled to work) by this date in order to remain on track to meet the target by the end of the agreement period
remainingLowPrecisioninteger required
The balance that is remaining at the given date presented as a rounded number
remainingHighPrecisionnumber double required
The balance that is remaining at the given date presented as a floating point number
targetVariancenumber double required
Shows how far in surplus (positive number) or deficit (negative number) the worker is against their target
agreementVariancenumber double required
Shows how far in surplus (positive number) or deficit (negative number) the worker is against their agreement
targetStatus'over_target' | 'under_target' | 'on_target' required
Shows whether the worker is over, under or on target