NzPayRunDetailsModel resource

Methods

  • get - Get Pay Run Details

Resource

{
    "grandTotal": {
        "employeeExpensesTotal": "double",
        "employerContribution": "double",
        "employerLiabilitiesTotal": "double",
        "esctContributionAmount": "double",
        "grossEarnings": "double",
        "kiwiSaverEmployeeContributionAmount": "double",
        "kiwiSaverEmployerContributionAmount": "double",
        "netEarnings": "double",
        "numberOfEmployees": "int32",
        "payeWithholdingAmount": "double",
        "postTaxDeductionAmount": "double",
        "preTaxDeductionAmount": "double",
        "studentLoanAdditionalMandatoryAmount": "double",
        "studentLoanAdditionalVoluntaryAmount": "double",
        "studentLoanAmount": "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",
            "earliestTerminationDate": "date-time",
            "employeeExpensesTotal": "double",
            "employeeExternalId": "string",
            "employeeExternalReferenceId": "string",
            "employeeId": "int32",
            "employeeName": "string",
            "employeeStartDate": "date-time",
            "employerLiabilitiesTotal": "double",
            "esctContributionAmount": "double",
            "grossEarnings": "double",
            "id": "int32",
            "isComplete": "boolean",
            "isExcluded": "boolean",
            "isTermination": "boolean",
            "kiwiSaverEmployeeContributionAmount": "double",
            "kiwiSaverEmployerContributionAmount": "double",
            "netEarnings": "double",
            "notation": "string",
            "payConditionRuleSetName": "string",
            "payeAdjustmentsAmount": "double",
            "payePaymentTotal": "double",
            "payeWithholdingAmount": "double",
            "payeWithholdingPercentage": "double",
            "postTaxDeductionAmount": "double",
            "preTaxDeductionAmount": "double",
            "previousTerminationDate": "date-time",
            "studentLoanAdditionalMandatoryAmount": "double",
            "studentLoanAdditionalVoluntaryAmount": "double",
            "studentLoanAmount": "double",
            "taxableEarnings": "double",
            "terminationDate": "date-time",
            "totalHours": "double"
        }
    ]
}

Properties

Name Type Description
grandTotal object NzPayRunGrandTotalModel
grandTotal.employeeExpensesTotal double Decimal
grandTotal.employerContribution double Decimal
grandTotal.employerLiabilitiesTotal double Decimal
grandTotal.esctContributionAmount double Decimal
grandTotal.grossEarnings double Decimal
grandTotal.kiwiSaverEmployeeContributionAmount double Decimal
grandTotal.kiwiSaverEmployerContributionAmount double Decimal
grandTotal.netEarnings double Decimal
grandTotal.numberOfEmployees int32 Int32
grandTotal.payeWithholdingAmount double Decimal
grandTotal.postTaxDeductionAmount double Decimal
grandTotal.preTaxDeductionAmount double Decimal
grandTotal.studentLoanAdditionalMandatoryAmount double Decimal
grandTotal.studentLoanAdditionalVoluntaryAmount double Decimal
grandTotal.studentLoanAmount 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[].earliestTerminationDate date-time Nullable
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[].esctContributionAmount double Decimal
payRunTotals[].grossEarnings double Decimal
payRunTotals[].id int32 Int32
payRunTotals[].isComplete boolean Boolean
payRunTotals[].isExcluded boolean Boolean
payRunTotals[].isTermination boolean Boolean
payRunTotals[].kiwiSaverEmployeeContributionAmount double Decimal
payRunTotals[].kiwiSaverEmployerContributionAmount double Decimal
payRunTotals[].netEarnings double Decimal
payRunTotals[].notation string String
payRunTotals[].payConditionRuleSetName string String
payRunTotals[].payeAdjustmentsAmount double Decimal
payRunTotals[].payePaymentTotal double Decimal
payRunTotals[].payeWithholdingAmount double Decimal
payRunTotals[].payeWithholdingPercentage double Decimal
payRunTotals[].postTaxDeductionAmount double Decimal
payRunTotals[].preTaxDeductionAmount double Decimal
payRunTotals[].previousTerminationDate date-time Nullable
payRunTotals[].studentLoanAdditionalMandatoryAmount double Decimal
payRunTotals[].studentLoanAdditionalVoluntaryAmount double Decimal
payRunTotals[].studentLoanAmount double Decimal
payRunTotals[].taxableEarnings double Decimal
payRunTotals[].terminationDate date-time Nullable
payRunTotals[].totalHours double Decimal