UkPayRunDetailsModel resource

Methods

  • get - Get Pay Run Details

Resource

{
    "grandTotal": {
        "employeeExpensesTotal": "double",
        "employeeNationalInsuranceContribution": "double",
        "employeePensionContributionAmount": "double",
        "employerContribution": "double",
        "employerLiabilitiesTotal": "double",
        "employerNationalInsuranceContribution": "double",
        "employerPensionContributionAmount": "double",
        "grossEarnings": "double",
        "netEarnings": "double",
        "numberOfEmployees": "int32",
        "payeWithholdingAmount": "double",
        "pension": "double",
        "postTaxDeductionAmount": "double",
        "preTaxDeductionAmount": "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": [
        {
            "autoEnrolmentPensionAssessmentStatus": "string",
            "bankPaymentsTotal": "double",
            "earliestTerminationDate": "date-time",
            "employeeExpensesTotal": "double",
            "employeeExternalId": "string",
            "employeeExternalReferenceId": "string",
            "employeeId": "int32",
            "employeeName": "string",
            "employeeNationalInsuranceContribution": "double",
            "employeePensionContributionAmount": "double",
            "employeeStartDate": "date-time",
            "employerLiabilitiesTotal": "double",
            "employerNationalInsuranceContribution": "double",
            "employerPensionContributionAmount": "double",
            "grossEarnings": "double",
            "id": "int32",
            "isComplete": "boolean",
            "isExcluded": "boolean",
            "isTermination": "boolean",
            "lodgementRecordId": "int32",
            "nationalInsuranceEligibleEarnings": "double",
            "netEarnings": "double",
            "notation": "string",
            "overrideNicCalculation": "boolean",
            "payConditionRuleSetName": "string",
            "payeAdjustmentsAmount": "double",
            "payePaymentTotal": "double",
            "payeWithholdingAmount": "double",
            "payeWithholdingPercentage": "double",
            "pensionContributionAmount": "double",
            "postTaxDeductionAmount": "double",
            "preTaxDeductionAmount": "double",
            "previousTerminationDate": "date-time",
            "studentLoanAmount": "double",
            "taxableEarnings": "double",
            "terminationDate": "date-time",
            "totalHours": "double"
        }
    ]
}

Properties

Name Type Description
grandTotal object UkPayRunGrandTotalModel
grandTotal.employeeExpensesTotal double Decimal
grandTotal.employeeNationalInsuranceContribution double Decimal
grandTotal.employeePensionContributionAmount double Decimal
grandTotal.employerContribution double Decimal
grandTotal.employerLiabilitiesTotal double Decimal
grandTotal.employerNationalInsuranceContribution double Decimal
grandTotal.employerPensionContributionAmount double Decimal
grandTotal.grossEarnings double Decimal
grandTotal.netEarnings double Decimal
grandTotal.numberOfEmployees int32 Int32
grandTotal.payeWithholdingAmount double Decimal
grandTotal.pension double Decimal
grandTotal.postTaxDeductionAmount double Decimal
grandTotal.preTaxDeductionAmount 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[].autoEnrolmentPensionAssessmentStatus string Nullable

Possible values are:

  • NotAssessed
  • EligibleJobHolder
  • NonEligibleJobHolder
  • EntitledWorker
  • Postponed
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[].employeeNationalInsuranceContribution double Decimal
payRunTotals[].employeePensionContributionAmount double Decimal
payRunTotals[].employeeStartDate date-time Nullable
payRunTotals[].employerLiabilitiesTotal double Decimal
payRunTotals[].employerNationalInsuranceContribution double Decimal
payRunTotals[].employerPensionContributionAmount double Decimal
payRunTotals[].grossEarnings double Decimal
payRunTotals[].id int32 Int32
payRunTotals[].isComplete boolean Boolean
payRunTotals[].isExcluded boolean Boolean
payRunTotals[].isTermination boolean Boolean
payRunTotals[].lodgementRecordId int32 Nullable
payRunTotals[].nationalInsuranceEligibleEarnings double Decimal
payRunTotals[].netEarnings double Decimal
payRunTotals[].notation string String
payRunTotals[].overrideNicCalculation boolean Boolean
payRunTotals[].payConditionRuleSetName string String
payRunTotals[].payeAdjustmentsAmount double Decimal
payRunTotals[].payePaymentTotal double Decimal
payRunTotals[].payeWithholdingAmount double Decimal
payRunTotals[].payeWithholdingPercentage double Decimal
payRunTotals[].pensionContributionAmount double Decimal
payRunTotals[].postTaxDeductionAmount double Decimal
payRunTotals[].preTaxDeductionAmount double Decimal
payRunTotals[].previousTerminationDate date-time Nullable
payRunTotals[].studentLoanAmount double Decimal
payRunTotals[].taxableEarnings double Decimal
payRunTotals[].terminationDate date-time Nullable
payRunTotals[].totalHours double Decimal