Methods

• get - List employee benefits

Resource

{
    "benefitCategories": [
        {
            "additionalAmountPayrolledToDateInPayRuns": "double",
            "additionalHasFinalisedPayRuns": "boolean",
            "additionalHasLinkedPayRuns": "boolean",
            "amountForegone": "double",
            "amountMadeGood": "double",
            "amountPayrolledToDate": "double",
            "amountPayrolledToDateInPayRuns": "double",
            "amountToBePayrolledPerPeriod": "double",
            "benefitCategoryId": "int32",
            "benefitCategoryName": "string",
            "benefitCategorySubType": "string",
            "benefitCategoryType": "string",
            "calculationLogs": [
                "string"
            ],
            "car": {
                "accessories": "double",
                "amountPaidByEmployeeForPrivateUse": "double",
                "availableFromDate": "date-time",
                "availableToDate": "date-time",
                "capitalContributions": "double",
                "employerProvidesFuelForPrivateUse": "boolean",
                "fuel": {
                    "amountPayrolledToDate": "double",
                    "amountToBePayrolledPerPeriod": "double",
                    "availableFromDate": "date-time",
                    "availableToDate": "date-time",
                    "cashEquivalent": "double",
                    "opraAmountForegone": "double",
                    "proRataInFirstPayRun": "boolean",
                    "reinstated": "boolean",
                    "startFromPeriod": "int32"
                },
                "isShared": "boolean",
                "numberOfDaysUnavailable": "int32",
                "opraAmountForegone": "double",
                "sharedPercentage": "double"
            },
            "carryBenefitForward": "boolean",
            "cashEquivalent": "double",
            "dateCreatedUtc": "date-time",
            "employeeId": "int32",
            "employeeName": "string",
            "hasBeenSubmitted": "boolean",
            "hasFinalisedPayRuns": "boolean",
            "hasLinkedPayRuns": "boolean",
            "id": "int32",
            "loan": {
                "amountForegoneUserEntered": "double",
                "amountOutstandingAtEndOfYearOrLoan": "double",
                "amountOutstandingAtStartOfYearOrLoan": "double",
                "dateLoanWasDischargedIfThisYear": "date-time",
                "dateLoanWasMadeIfThisYear": "date-time",
                "interestDue": "double",
                "interestRate": "double",
                "maximumAmountOutstandingDuringTheYear": "double",
                "numberOfJointBorrowers": "int32"
            },
            "payrollingBenefit": "boolean",
            "proRataCalculation": {
                "endDate": "date-time",
                "fullYearAmount": "double",
                "proRataInFirstPayRun": "boolean",
                "startDate": "date-time",
                "useCalculatedValue": "boolean"
            },
            "startFromPeriod": "int32",
            "van": {
                "amountPaidByEmployeeForPrivateUse": "double",
                "availableFromDate": "date-time",
                "availableToDate": "date-time",
                "employerProvidesFuelForPrivateUse": "boolean",
                "fuel": {
                    "amountForegone": "double",
                    "amountPayrolledToDate": "double",
                    "amountToBePayrolledPerPeriod": "double",
                    "availableToDate": "date-time",
                    "cashEquivalent": "double",
                    "opraAmountForegone": "double",
                    "proRataInFirstPayRun": "boolean",
                    "startFromPeriod": "int32"
                },
                "isShared": "boolean",
                "numberOfDaysUnavailable": "int32",
                "opraAmountForegone": "double",
                "sharedPercentage": "double"
            },
            "year": "int32"
        }
    ]
}

Properties