Methods

  • post - Finalise Pay Run

Resource

{
    "activeEmployees": "int32",
    "datePaid": "date-time",
    "exportJournalsPreference": "boolean",
    "journalExportFailedMessage": "string",
    "journalExportResult": {
        "items": [
            "string"
        ],
        "message": "string",
        "status": "string"
    },
    "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",
    "publishPaySlipsScheduledDateTimeUtc": "date-time",
    "publishPreference": "string",
    "publishPreferenceTimeOfDay": "string",
    "removedEmployees": [
        "int32"
    ]
}

Properties

Name Type Description
activeEmployees int32 Int32
datePaid date-time Nullable
exportJournalsPreference boolean Boolean
journalExportFailedMessage string String
journalExportResult object JournalExportResult
journalExportResult.items[] array of string
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
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
notifications.hasPartiallySentNotifications boolean Boolean
notifications.totalEmailNotificationsSent int32 Int32
notifications.totalSmsNotificationsSent int32 Int32
payRunLodgementJobId uuid Nullable
paySlipsPublished boolean Boolean
pensionSyncJobId uuid Nullable
publishPaySlipsScheduledDateTimeUtc date-time Nullable
publishPreference string PublishPaySlipsPreference

Possible values are:

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