Methods

  • get - Get Pay Run Details

Resource

{
    "grandTotal": {
        "employeeExpensesTotal": "double",
        "employerContribution": "double",
        "employerLiabilitiesTotal": "double",
        "grossEarnings": "double",
        "helpAmount": "double",
        "netEarnings": "double",
        "numberOfEmployees": "int32",
        "paygWithholdingAmount": "double",
        "postTaxDeductionAmount": "double",
        "preTaxDeductionAmount": "double",
        "sfssAmount": "double",
        "superContribution": "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": [
        {
            "allSuperContributionsTotal": "double",
            "bankPaymentsTotal": "double",
            "earliestTerminationDate": "date-time",
            "employeeExpensesTotal": "double",
            "employeeExternalId": "string",
            "employeeExternalReferenceId": "string",
            "employeeId": "int32",
            "employeeName": "string",
            "employeeStartDate": "date-time",
            "employerContribution": "double",
            "employerContributionAdjustmentsAmount": "double",
            "employerLiabilitiesTotal": "double",
            "grossEarnings": "double",
            "grossPlusSuper": "double",
            "helpAmount": "double",
            "id": "int32",
            "isComplete": "boolean",
            "isEmployeeUnder18": "boolean",
            "isExcluded": "boolean",
            "isTermination": "boolean",
            "memberVoluntarySuperAmount": "double",
            "netEarnings": "double",
            "nonSuperDeductionTotal": "double",
            "notation": "string",
            "payConditionRuleSetName": "string",
            "paygAdjustmentsAmount": "double",
            "paygPaymentTotal": "double",
            "paygWithholdingAmount": "double",
            "paygWithholdingPercent": "double",
            "postTaxDeductionAmount": "double",
            "preTaxDeductionAmount": "double",
            "previousTerminationDate": "date-time",
            "salarySacrificeSuperAmount": "double",
            "sfssAmount": "double",
            "superAdjustmentsAmount": "double",
            "superContribution": "double",
            "superContributionMinusSuperAdjustments": "double",
            "superContributionsCapApplied": "boolean",
            "superPaymentsTotal": "double",
            "taxableEarnings": "double",
            "terminationDate": "date-time",
            "totalHours": "double"
        }
    ]
}

Properties

Name Type Description
grandTotal object AuPayRunGrandTotalModel
grandTotal.employeeExpensesTotal double Decimal
grandTotal.employerContribution double Decimal
grandTotal.employerLiabilitiesTotal double Decimal
grandTotal.grossEarnings double Decimal
grandTotal.helpAmount double Decimal
grandTotal.netEarnings double Decimal
grandTotal.numberOfEmployees int32 Int32
grandTotal.paygWithholdingAmount double Decimal
grandTotal.postTaxDeductionAmount double Decimal
grandTotal.preTaxDeductionAmount double Decimal
grandTotal.sfssAmount double Decimal
grandTotal.superContribution 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[].allSuperContributionsTotal double Decimal
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[].employerContribution double Decimal
payRunTotals[].employerContributionAdjustmentsAmount double Decimal
payRunTotals[].employerLiabilitiesTotal double Decimal
payRunTotals[].grossEarnings double Decimal
payRunTotals[].grossPlusSuper double Decimal
payRunTotals[].helpAmount double Decimal
payRunTotals[].id int32 Int32
payRunTotals[].isComplete boolean Boolean
payRunTotals[].isEmployeeUnder18 boolean Boolean
payRunTotals[].isExcluded boolean Boolean
payRunTotals[].isTermination boolean Boolean
payRunTotals[].memberVoluntarySuperAmount double Decimal
payRunTotals[].netEarnings double Decimal
payRunTotals[].nonSuperDeductionTotal double Decimal
payRunTotals[].notation string String
payRunTotals[].payConditionRuleSetName string String
payRunTotals[].paygAdjustmentsAmount double Decimal
payRunTotals[].paygPaymentTotal double Decimal
payRunTotals[].paygWithholdingAmount double Decimal
payRunTotals[].paygWithholdingPercent double Decimal
payRunTotals[].postTaxDeductionAmount double Decimal
payRunTotals[].preTaxDeductionAmount double Decimal
payRunTotals[].previousTerminationDate date-time Nullable
payRunTotals[].salarySacrificeSuperAmount double Decimal
payRunTotals[].sfssAmount double Decimal
payRunTotals[].superAdjustmentsAmount double Decimal
payRunTotals[].superContribution double Decimal
payRunTotals[].superContributionMinusSuperAdjustments double Decimal
payRunTotals[].superContributionsCapApplied boolean Boolean
payRunTotals[].superPaymentsTotal double Decimal
payRunTotals[].taxableEarnings double Decimal
payRunTotals[].terminationDate date-time Nullable
payRunTotals[].totalHours double Decimal