NzPayScheduleModel resource

Methods

  • get - Get Pay Schedule by ID
  • get - List Pay Schedules
  • post - Create Pay Schedule
  • put - Update Pay Schedule

Resource

{
    "autoPayConfiguration": {
        "adjustDatePaidToWorkDay": "boolean",
        "adjustRunDateToWorkDay": "boolean",
        "dayOfWeek": "int32",
        "enabled": "boolean",
        "exportJournals": "boolean",
        "finalise": "boolean",
        "initialDatePaid": "date-time",
        "initialPayPeriodEnding": "date-time",
        "initialPayRunCreationDateTime": "date-time",
        "nextScheduledCreationDateTimeUtc": "date-time",
        "paused": "boolean",
        "publishPaySlips": "string",
        "publishPaySlipsHour": "int32",
        "reportPacksToRun": [
            "int32"
        ],
        "runOnSpecificDayOfMonth": "boolean",
        "scheduledEndDate": "date-time",
        "specificDayOfMonth": "int32",
        "suppressNotifications": "boolean",
        "timesheetImportOption": "string",
        "usersToNotify": [
            "string"
        ],
        "weekOfMonth": "int32"
    },
    "defaultFinaliseSettings": {
        "exportJournals": "string",
        "exportJournalsDay": "int32",
        "exportJournalsTimeOfDay": "date-span",
        "exportJournalsTimeline": "string",
        "lodgePayRun": "string",
        "lodgePayRunDay": "int32",
        "lodgePayRunTimeOfDay": "date-span",
        "lodgePayRunTimeline": "string",
        "paymentAccountDebitSetting": "string",
        "publishPaySlips": "string",
        "publishPaySlipsDay": "int32",
        "publishPaySlipsTimeOfDay": "date-span",
        "publishPaySlipsTimeline": "string",
        "reportPacksToRun": [
            "int32"
        ],
        "runReportPacks": "string",
        "runReportPacksDay": "int32",
        "runReportPacksTimeOfDay": "date-span",
        "runReportPacksTimeline": "string",
        "submitToPensionSync": "string",
        "submitToPensionSyncDay": "int32",
        "submitToPensionSyncTimeOfDay": "date-span",
        "submitToPensionSyncTimeline": "string",
        "superPayment": "boolean",
        "suppressNotifications": "boolean"
    },
    "employeeSelectionStrategy": "string",
    "equalMonthlyPayments": "boolean",
    "externalId": "string",
    "frequency": "string",
    "id": "int32",
    "ignoredPayRunWarnings": [
        "int32"
    ],
    "lastDatePaid": "date-time",
    "lastPayRun": "date-time",
    "locations": [
        "int32"
    ],
    "name": "string",
    "payScheduleApprovalSettings": {
        "approversToNotify": [
            "string"
        ],
        "notificationSubject": "string",
        "notificationTemplate": "string",
        "reminderDay": "int32",
        "reminderSubject": "string",
        "reminderTemplate": "string",
        "requireApproval": "boolean",
        "sendReminder": "boolean"
    },
    "paySchedulePaymentApprovalSettings": {
        "approversToNotify": [
            "string"
        ],
        "notificationSubject": "string",
        "notificationTemplate": "string",
        "reminderDay": "int32",
        "reminderSubject": "string",
        "reminderTemplate": "string",
        "requireApproval": "boolean",
        "sendReminder": "boolean"
    },
    "source": "string"
}

Properties

Name Type Description
autoPayConfiguration object NzAutoPayConfigurationModel
autoPayConfiguration.adjustDatePaidToWorkDay boolean Boolean
autoPayConfiguration.adjustRunDateToWorkDay boolean Boolean
autoPayConfiguration.dayOfWeek int32 Int32
autoPayConfiguration.enabled boolean Boolean
autoPayConfiguration.exportJournals boolean Boolean
autoPayConfiguration.finalise boolean Boolean
autoPayConfiguration.initialDatePaid date-time DateTime
autoPayConfiguration.initialPayPeriodEnding date-time DateTime
autoPayConfiguration.initialPayRunCreationDateTime date-time DateTime
autoPayConfiguration.nextScheduledCreationDateTimeUtc date-time DateTime
autoPayConfiguration.paused boolean Boolean
autoPayConfiguration.publishPaySlips string PublishPaySlipsPreference

Possible values are:

  • Manual
  • Immediate
  • Scheduled
autoPayConfiguration.publishPaySlipsHour int32 Int32
autoPayConfiguration.reportPacksToRun[] array of int32
autoPayConfiguration.runOnSpecificDayOfMonth boolean Boolean
autoPayConfiguration.scheduledEndDate date-time Nullable
autoPayConfiguration.specificDayOfMonth int32 Int32
autoPayConfiguration.suppressNotifications boolean Boolean
autoPayConfiguration.timesheetImportOption string TimesheetImportOption

Possible values are:

  • None
  • ThisPayPeriod
  • AllOutstanding
  • CustomPeriod
autoPayConfiguration.usersToNotify[] array of string
autoPayConfiguration.weekOfMonth int32 Int32
defaultFinaliseSettings object PayRunFinaliseDefaultSettingsModel
defaultFinaliseSettings.exportJournals string PayRunFinaliseActionPreference

Possible values are:

  • Manual
  • Immediate
  • Scheduled
defaultFinaliseSettings.exportJournalsDay int32 Int32
defaultFinaliseSettings.exportJournalsTimeOfDay date-span Nullable
defaultFinaliseSettings.exportJournalsTimeline string PayRunFinaliseActionTimeline

Possible values are:

  • Before
  • After
  • On
defaultFinaliseSettings.lodgePayRun string PayRunFinaliseActionPreference

Possible values are:

  • Manual
  • Immediate
  • Scheduled
defaultFinaliseSettings.lodgePayRunDay int32 Int32
defaultFinaliseSettings.lodgePayRunTimeOfDay date-span Nullable
defaultFinaliseSettings.lodgePayRunTimeline string PayRunFinaliseActionTimeline

Possible values are:

  • Before
  • After
  • On
defaultFinaliseSettings.paymentAccountDebitSetting string Nullable

Possible values are:

  • Manual
  • Immediate
defaultFinaliseSettings.publishPaySlips string PayRunFinaliseActionPreference

Possible values are:

  • Manual
  • Immediate
  • Scheduled
defaultFinaliseSettings.publishPaySlipsDay int32 Int32
defaultFinaliseSettings.publishPaySlipsTimeOfDay date-span Nullable
defaultFinaliseSettings.publishPaySlipsTimeline string PayRunFinaliseActionTimeline

Possible values are:

  • Before
  • After
  • On
defaultFinaliseSettings.reportPacksToRun[] array of int32
defaultFinaliseSettings.runReportPacks string PayRunFinaliseActionPreference

Possible values are:

  • Manual
  • Immediate
  • Scheduled
defaultFinaliseSettings.runReportPacksDay int32 Int32
defaultFinaliseSettings.runReportPacksTimeOfDay date-span Nullable
defaultFinaliseSettings.runReportPacksTimeline string PayRunFinaliseActionTimeline

Possible values are:

  • Before
  • After
  • On
defaultFinaliseSettings.submitToPensionSync string PayRunFinaliseActionPreference

Possible values are:

  • Manual
  • Immediate
  • Scheduled
defaultFinaliseSettings.submitToPensionSyncDay int32 Int32
defaultFinaliseSettings.submitToPensionSyncTimeOfDay date-span Nullable
defaultFinaliseSettings.submitToPensionSyncTimeline string PayRunFinaliseActionTimeline

Possible values are:

  • Before
  • After
  • On
defaultFinaliseSettings.superPayment boolean Boolean
defaultFinaliseSettings.suppressNotifications boolean Boolean
employeeSelectionStrategy string Nullable

Possible values are:

  • None
  • PayRunDefault
  • TimesheetLocations
  • PayRunDefaultWithTimesheets
  • ActiveSubcontractors
  • EmployingEntity
equalMonthlyPayments boolean Boolean
externalId string String
frequency string NzPayCycleFrequencyEnum

Possible values are:

  • Weekly
  • Fortnightly
  • Monthly
  • AdHoc
  • Initial
  • HistoricGrossEarnings
  • HalfMonthly
id int32 Int32
ignoredPayRunWarnings[] array of int32
lastDatePaid date-time Nullable
lastPayRun date-time Nullable
locations[] array of int32
name string String
payScheduleApprovalSettings object PayScheduleApprovalSettingsModel
payScheduleApprovalSettings.approversToNotify[] array of string
payScheduleApprovalSettings.notificationSubject string String
payScheduleApprovalSettings.notificationTemplate string String
payScheduleApprovalSettings.reminderDay int32 Int32
payScheduleApprovalSettings.reminderSubject string String
payScheduleApprovalSettings.reminderTemplate string String
payScheduleApprovalSettings.requireApproval boolean Boolean
payScheduleApprovalSettings.sendReminder boolean Boolean
paySchedulePaymentApprovalSettings object PayScheduleApprovalSettingsModel
paySchedulePaymentApprovalSettings.approversToNotify[] array of string
paySchedulePaymentApprovalSettings.notificationSubject string String
paySchedulePaymentApprovalSettings.notificationTemplate string String
paySchedulePaymentApprovalSettings.reminderDay int32 Int32
paySchedulePaymentApprovalSettings.reminderSubject string String
paySchedulePaymentApprovalSettings.reminderTemplate string String
paySchedulePaymentApprovalSettings.requireApproval boolean Boolean
paySchedulePaymentApprovalSettings.sendReminder boolean Boolean
source string String