Methods

  • post - Finalise Pay Run

Resource

{
    "activeEmployees": "int32",
    "areReportPacksProcessed": "boolean",
    "datePaid": "date-time",
    "exportJournals": "string",
    "exportJournalsPreference": "boolean",
    "exportJournalsScheduledDateTimeUtc": "date-time",
    "isFirstFinalisation": "boolean",
    "journalExportFailedMessage": "string",
    "journalExportResult": {
        "journalExternalReferenceId": "string",
        "journalSource": "string",
        "message": "string",
        "status": "string"
    },
    "lodgePayRun": "string",
    "lodgePayRunScheduledDateTimeUtc": "date-time",
    "notifications": {
        "errors": {
            "templateName": "string",
            "warningMessage": "string",
            "warnings": [
                {
                    "employeeExternalId": "string",
                    "employeeId": "int32",
                    "employeeName": "string",
                    "formattedWarningMessage": "string",
                    "metaData": {},
                    "metaDataJson": "string",
                    "payRunTotalId": "int32",
                    "warning": "string",
                    "warningType": "string"
                }
            ]
        },
        "hasPartiallySentNotifications": "boolean",
        "totalEmailNotificationsSent": "int32",
        "totalSmsNotificationsSent": "int32"
    },
    "payRunLodgementJobId": "uuid",
    "paySlipsPublished": "boolean",
    "pensionSyncJobId": "uuid",
    "publishPaySlips": "string",
    "publishPaySlipsScheduledDateTimeUtc": "date-time",
    "publishPreference": "string",
    "publishPreferenceTimeOfDay": "string",
    "removedEmployees": [
        "int32"
    ],
    "runReportPacks": "string",
    "runReportPacksScheduledDateTimeUtc": "date-time",
    "selectedReportPacks": [
        "string"
    ],
    "submitToPensionSync": "string",
    "submitToPensionSyncScheduledDateTimeUtc": "date-time",
    "superPayments": [
        {
            "description": "string",
            "superInterchangeId": "int32"
        }
    ]
}

Properties

Name Type Description
activeEmployees int32 Int32
areReportPacksProcessed boolean Boolean
datePaid date-time Nullable
exportJournals string PayRunFinaliseActionPreference

Possible values are:

  • Manual
  • Immediate
  • Scheduled
exportJournalsPreference boolean Boolean
exportJournalsScheduledDateTimeUtc date-time Nullable
isFirstFinalisation boolean Boolean
journalExportFailedMessage string String
journalExportResult object JournalExportResult
journalExportResult.journalExternalReferenceId string String
journalExportResult.journalSource string ExternalService

Possible values are:

  • None
  • Saasu
  • Xero
  • MYOB
  • Deputy
  • EmployeeTimePunch
  • ClickSuper
  • IntegratedTimesheets
  • FileImport
  • FileExport
  • QuickBooks
  • Harmony
  • AwardStore
  • Attache
  • IntegratedRostering
  • ReckonAccounts
  • API
  • MicroPower
  • RosterLive
  • NetSuite
  • Kounta
  • TimeAndAttendanceKiosk
  • DetailedFileExport
  • JonasPremier
  • WageEasy
  • Maestrano
  • WorkZone
  • EmployeePortal
  • RosterTemplate
  • Onboarding
  • Admin
  • WorkZoneClockOnOff
  • NetSuiteOneWorld
  • Sage50
  • PensionSync
  • FinancialsOffice
  • ProntoXI
  • PayRunDefault
  • StandardWorkDay
  • Beam
  • PayRunAutomation
  • BureauDashboard
  • Wiise
  • QBOMigrationTool
  • AbridgedFileImport
  • QBOForcedMigration
  • HmrcDpsUpdate
  • HmrcDpsStudentLoan
  • HmrcDpsPostGradLoan
  • Sage50FileImporter
  • FPSFileImporter
  • OAuth
  • FreshBooks
  • StarFileImporter
  • ActiveCampaign
  • SummaryAndDetailsExport
  • Telleroo
  • EmployeeAdvancedHoursUpload
  • BusinessCentral
  • Paytron
  • AccessFinancials
  • Comma
  • Zoho
  • FlatFileEmployeeImporter
  • Twinfield
  • SageAccounting
  • Square
  • Quickfile
  • Tide
  • TideSso
  • FreeAgent
  • Akahu
  • InstaPay
  • Zepto
  • Slack
  • Caxton
  • QuickbooksStandalonePayroll
  • ImportEmployeeSelfSetup
  • XeroIdentityPayrollSignUp
  • XeroIdentityHrSignUp
  • SageIntacct
  • InstaPayDaily
journalExportResult.message string String
journalExportResult.status string JournalExportStatus

Possible values are:

  • NotExported
  • Success
  • FailureUnknownError
  • FailureAccountsNotConfigured
  • FailureItemsDeleted
  • FailureAccountPeriodClosed
  • FailureNotAuthenticated
  • FailureAlreadyExported
  • FailureFunctionDisabled
  • FailureCannotUseAccountsPayableAccount
  • FailureVendorMessage
  • FailureIntercompanyLoanAccountsNotConfigured
  • FailureGSTSetup
  • FailureKnownError
  • FailuresTenantNotSupplied
  • FailureNoJournalId
  • FailureAPIError
  • FailureMissingTaxInfo
  • ResultUnknown
lodgePayRun string PayRunFinaliseActionPreference

Possible values are:

  • Manual
  • Immediate
  • Scheduled
lodgePayRunScheduledDateTimeUtc date-time Nullable
notifications object PaySlipNotificationResponse
notifications.errors object PayRunWarningResult
notifications.errors.templateName string String
notifications.errors.warningMessage string String
notifications.errors.warnings[] array
notifications.errors.warnings[].employeeExternalId string String
notifications.errors.warnings[].employeeId int32 Int32
notifications.errors.warnings[].employeeName string String
notifications.errors.warnings[].formattedWarningMessage string String
notifications.errors.warnings[].metaData object Object
notifications.errors.warnings[].metaDataJson string String
notifications.errors.warnings[].payRunTotalId int32 Int32
notifications.errors.warnings[].warning string String
notifications.errors.warnings[].warningType string PayRunWarningType

Possible values are:

  • PaymentFile
  • MoreLeaveThanAccrued
  • UnpaidEarnings
  • Birthday
  • Anniversary
  • NegativeEarnings
  • PreviouslyTerminated
  • TerminatedWithExpenseReimbursements
  • ExpiredQualification
  • DuplicateEarningsLines
  • TaxCodeMissing
  • Bpay
  • LeaveYearCapReached
  • AutoEnrolmentChanges
  • EmployeePensionContributionRefund
  • PensionSchemeRequiresAuthorization
  • UkTaxCodeUpdate
  • UkTaxCodeUpdateError
  • NINOUnknown
  • ProRataEarnings
  • HmrcLateReasonWarning
  • BelowMinimumWage
  • ExpiredSpecialTaxRate
  • ExpiredStudentLoanRate
  • PendingLeaveRequest
  • LeaveRequestBeyondPayPeriod
  • PrecedingLeaveRequest
  • IncompletePayRunTasks
  • PendingExpenseRequests
  • PayDayFiling
  • PayDayFilingAmendment
  • EmployeeInformation
  • IrdSettings
  • AutoUpdatedNICategory
  • UkStudentLoanUpdate
  • PensionProviderDoesNotAllowOverseasAddress
  • MissingLeaveYearEntitlement
  • LeaveRequestUnitTypeMismatch
  • ExpiredNric
  • ExcessOvertime
  • ForeignEmployee
  • ExcessDeductions
  • TerminatedForeignEmployee
  • StatutoryPaymentApplied
  • StatutoryPaymentAppliedPrevious
  • NationalInsuranceValidations
  • MixedOffsets
  • PendingSapPayment
  • ScheduledUpdateApplied
  • PensionSettingsUpdated
  • TaxReliefThresholdExceeded
  • UkNotNoticeUpdate
  • EarningsAutomaticallyAdjusted
  • EarningsRequireAdjustment
  • UkTaxCodeP9Update
  • HrdfEmployeeWarning
  • NewPayrolledBenefits
  • SubmitTerminatedEmployeeToHmrc
  • SuperReconciliationPreviousPayRun
  • SuperReconciliationThisPayRun
  • MoreThan28DaysWithoutTfnQuoted
  • BackCalculationsApplied
  • LeaveAccrualReconciliationPreviousPayRun
  • LeaveAccrualReconciliationThisPayRun
  • PublicHolidayAutomation
  • CisSubcontractorRequiresVerification
  • ItnRequiresUpdate
  • CisSubcontractorLastPaymentDate
  • CisSubcontractorUnmatched
  • CpfRefundRequired
  • CpfYearEndRecalculationRequired
  • TaxCodeDisplayNameTooLong
  • TimesheetOutOfSequence
  • ExpiredContractorTaxRate
  • ConcurrentPayRun
  • StudentLoanAdjustment
  • UnpaidLeaveWithAvailableBalance
  • OccupationalLeaveApplied
  • OccupationalLeaveAppliedPrevious
  • OccupationalLeaveEntitlementExhausted
  • AnnualLeaveCashedOut
  • EmployeeHasTakenPaidFamilyAndDomesticViolenceLeave
  • ConcurrentPayRunAU
  • EmployeePensionOptoutForPeriod
  • EmployeePensionContributionsCeased
  • EmployeePensionOptoutOrCease
  • PensionOptOutCouldNotConnect
  • PensionOptoutScopeUnauthorised
  • PensionOptoutUnmatched
  • PensionCeaseUnmatched
notifications.hasPartiallySentNotifications boolean Boolean
notifications.totalEmailNotificationsSent int32 Int32
notifications.totalSmsNotificationsSent int32 Int32
payRunLodgementJobId uuid Nullable
paySlipsPublished boolean Boolean
pensionSyncJobId uuid Nullable
publishPaySlips string PayRunFinaliseActionPreference

Possible values are:

  • Manual
  • Immediate
  • Scheduled
publishPaySlipsScheduledDateTimeUtc date-time Nullable
publishPreference string PublishPaySlipsPreference

Possible values are:

  • Manual
  • Immediate
  • Scheduled
publishPreferenceTimeOfDay string Nullable
removedEmployees[] array of int32
runReportPacks string PayRunFinaliseActionPreference

Possible values are:

  • Manual
  • Immediate
  • Scheduled
runReportPacksScheduledDateTimeUtc date-time Nullable
selectedReportPacks[] array of string
submitToPensionSync string PayRunFinaliseActionPreference

Possible values are:

  • Manual
  • Immediate
  • Scheduled
submitToPensionSyncScheduledDateTimeUtc date-time Nullable
superPayments[] array
superPayments[].description string String
superPayments[].superInterchangeId int32 Int32