Methods

  • get - Get Pay Run Details

Resource

{
    "grandTotal": {
        "bikTaxExemptAmount": "double",
        "bikTaxableAmount": "double",
        "cp38Amount": "double",
        "eisEmployeeAmount": "double",
        "eisEmployerAmount": "double",
        "employeeExpensesTotal": "double",
        "employerContribution": "double",
        "employerLiabilitiesTotal": "double",
        "epfEmployeeAmount": "double",
        "epfEmployerAmount": "double",
        "grossEarnings": "double",
        "hrdfAmount": "double",
        "netEarnings": "double",
        "numberOfEmployees": "int32",
        "pcbBorneByEmployerAmount": "double",
        "postTaxDeductionAmount": "double",
        "preTaxDeductionAmount": "double",
        "socsoEmployeeAmount": "double",
        "socsoEmployerAmount": "double",
        "socsoSkbbkEmployeeAmount": "double",
        "taxableEarnings": "double",
        "totalHours": "double"
    },
    "payRun": {
        "dateFinalised": "date-time",
        "datePaid": "date-time",
        "externalId": "string",
        "id": "int32",
        "isFinalised": "boolean",
        "notation": "string",
        "payPeriodEnding": "date-time",
        "payPeriodStarting": "date-time",
        "payScheduleId": "int32",
        "paySlipsPublished": "boolean"
    },
    "payRunTotals": [
        {
            "bankPaymentsTotal": "double",
            "bikTaxExemptAmount": "double",
            "bikTaxableAmount": "double",
            "cp38Amount": "double",
            "earliestTerminationDate": "date-time",
            "eisEmployeeAmount": "double",
            "eisEmployerAmount": "double",
            "employeeExpensesTotal": "double",
            "employeeExternalId": "string",
            "employeeExternalReferenceId": "string",
            "employeeId": "int32",
            "employeeName": "string",
            "employeeStartDate": "date-time",
            "employerLiabilitiesTotal": "double",
            "epfEmployeeAmount": "double",
            "epfEmployerAmount": "double",
            "grossEarnings": "double",
            "hrdfAmount": "double",
            "id": "int32",
            "isComplete": "boolean",
            "isExcluded": "boolean",
            "isTermination": "boolean",
            "netEarnings": "double",
            "notation": "string",
            "payConditionRuleSetName": "string",
            "pcbBorneByEmployerAmount": "double",
            "postTaxDeductionAmount": "double",
            "preTaxDeductionAmount": "double",
            "previousTerminationDate": "date-time",
            "socsoEmployeeAmount": "double",
            "socsoEmployerAmount": "double",
            "socsoSkbbkEmployeeAmount": "double",
            "taxableEarnings": "double",
            "terminationDate": "date-time",
            "totalHours": "double"
        }
    ]
}

Properties

Name Type Description
grandTotal object MyPayRunGrandTotalModel
grandTotal.bikTaxExemptAmount double Decimal
grandTotal.bikTaxableAmount double Decimal
grandTotal.cp38Amount double Decimal
grandTotal.eisEmployeeAmount double Decimal
grandTotal.eisEmployerAmount double Decimal
grandTotal.employeeExpensesTotal double Decimal
grandTotal.employerContribution double Decimal
grandTotal.employerLiabilitiesTotal double Decimal
grandTotal.epfEmployeeAmount double Decimal
grandTotal.epfEmployerAmount double Decimal
grandTotal.grossEarnings double Decimal
grandTotal.hrdfAmount double Decimal
grandTotal.netEarnings double Decimal
grandTotal.numberOfEmployees int32 Int32
grandTotal.pcbBorneByEmployerAmount double Decimal
grandTotal.postTaxDeductionAmount double Decimal
grandTotal.preTaxDeductionAmount double Decimal
grandTotal.socsoEmployeeAmount double Decimal
grandTotal.socsoEmployerAmount double Decimal
grandTotal.socsoSkbbkEmployeeAmount double Decimal
grandTotal.taxableEarnings double Decimal
grandTotal.totalHours double Decimal
payRun object PayRunModel
payRun.dateFinalised date-time Nullable
payRun.datePaid date-time DateTime
payRun.externalId string String
payRun.id int32 Int32
payRun.isFinalised boolean Boolean
payRun.notation string String
payRun.payPeriodEnding date-time DateTime
payRun.payPeriodStarting date-time DateTime
payRun.payScheduleId int32 Int32
payRun.paySlipsPublished boolean Boolean
payRunTotals[] array
payRunTotals[].bankPaymentsTotal double Decimal
payRunTotals[].bikTaxExemptAmount double Decimal
payRunTotals[].bikTaxableAmount double Decimal
payRunTotals[].cp38Amount double Decimal
payRunTotals[].earliestTerminationDate date-time Nullable
payRunTotals[].eisEmployeeAmount double Decimal
payRunTotals[].eisEmployerAmount double Decimal
payRunTotals[].employeeExpensesTotal double Decimal
payRunTotals[].employeeExternalId string String
payRunTotals[].employeeExternalReferenceId string String
payRunTotals[].employeeId int32 Int32
payRunTotals[].employeeName string String
payRunTotals[].employeeStartDate date-time Nullable
payRunTotals[].employerLiabilitiesTotal double Decimal
payRunTotals[].epfEmployeeAmount double Decimal
payRunTotals[].epfEmployerAmount double Decimal
payRunTotals[].grossEarnings double Decimal
payRunTotals[].hrdfAmount double Decimal
payRunTotals[].id int32 Int32
payRunTotals[].isComplete boolean Boolean
payRunTotals[].isExcluded boolean Boolean
payRunTotals[].isTermination boolean Boolean
payRunTotals[].netEarnings double Decimal
payRunTotals[].notation string String
payRunTotals[].payConditionRuleSetName string String
payRunTotals[].pcbBorneByEmployerAmount double Decimal
payRunTotals[].postTaxDeductionAmount double Decimal
payRunTotals[].preTaxDeductionAmount double Decimal
payRunTotals[].previousTerminationDate date-time Nullable
payRunTotals[].socsoEmployeeAmount double Decimal
payRunTotals[].socsoEmployerAmount double Decimal
payRunTotals[].socsoSkbbkEmployeeAmount double Decimal
payRunTotals[].taxableEarnings double Decimal
payRunTotals[].terminationDate date-time Nullable
payRunTotals[].totalHours double Decimal