{
"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": [
{
"disableAutoProgression": "boolean",
"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"
}
]
}
Name | Type | Description |
---|---|---|
activeEmployees | int32 | Int32 |
areReportPacksProcessed | boolean | Boolean |
datePaid | date-time |
Nullable |
exportJournals | string |
PayRunFinaliseActionPreference
Possible values are:
|
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:
|
journalExportResult.message | string | String |
journalExportResult.status | string |
JournalExportStatus
Possible values are:
|
lodgePayRun | string |
PayRunFinaliseActionPreference
Possible values are:
|
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[].disableAutoProgression | boolean |
Nullable |
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:
|
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:
|
publishPaySlipsScheduledDateTimeUtc | date-time |
Nullable |
publishPreference | string |
PublishPaySlipsPreference
Possible values are:
|
publishPreferenceTimeOfDay | string |
Nullable |
removedEmployees[] | array of int32 | |
runReportPacks | string |
PayRunFinaliseActionPreference
Possible values are:
|
runReportPacksScheduledDateTimeUtc | date-time |
Nullable |
selectedReportPacks[] | array of string | |
submitToPensionSync | string |
PayRunFinaliseActionPreference
Possible values are:
|
submitToPensionSyncScheduledDateTimeUtc | date-time |
Nullable |
superPayments[] | array | |
superPayments[].description | string | String |
superPayments[].superInterchangeId | int32 | Int32 |