Create Pay Schedule

Creates a new pay schedule for the business.

Request

POST ../api/v1/client/payschedule/

Request body

The request body takes the following writable properties:

{
    "autoPayConfiguration": {
        "adjustDatePaidToWorkDay": "boolean",
        "adjustRunDateToWorkDay": "boolean",
        "dayOfWeek": "int32",
        "enabled": "boolean",
        "exportJournals": "boolean",
        "finalise": "boolean",
        "initialDatePaid": "date-time",
        "initialPayPeriodEnding": "date-time",
        "initialPayRunCreationDateTime": "date-time",
        "lodgePayRun": "boolean",
        "nextScheduledCreationDateTimeUtc": "date-time",
        "paused": "boolean",
        "publishPaySlips": "string",
        "publishPaySlipsHour": "int32",
        "reportPacksToRun": [
            "int32"
        ],
        "runOnSpecificDayOfMonth": "boolean",
        "scheduledEndDate": "date-time",
        "specificDayOfMonth": "int32",
        "submitToPensionSync": "boolean",
        "suppressNotifications": "boolean",
        "timesheetImportOption": "string",
        "usersToNotify": [
            "string"
        ],
        "weekOfMonth": "int32"
    },
    "defaultFinaliseSettings": {
        "exportJournals": "string",
        "exportJournalsDay": "int32",
        "exportJournalsTimeOfDay": "string",
        "exportJournalsTimeline": "string",
        "lodgePayRun": "string",
        "lodgePayRunDay": "int32",
        "lodgePayRunTimeOfDay": "string",
        "lodgePayRunTimeline": "string",
        "publishPaySlips": "string",
        "publishPaySlipsDay": "int32",
        "publishPaySlipsTimeOfDay": "string",
        "publishPaySlipsTimeline": "string",
        "reportPacksToRun": [
            "int32"
        ],
        "runReportPacks": "string",
        "runReportPacksDay": "int32",
        "runReportPacksTimeOfDay": "string",
        "runReportPacksTimeline": "string",
        "submitToPensionSync": "string",
        "submitToPensionSyncDay": "int32",
        "submitToPensionSyncTimeOfDay": "string",
        "submitToPensionSyncTimeline": "string",
        "superPayment": "boolean",
        "suppressNotifications": "boolean"
    },
    "employeeSelectionStrategy": "string",
    "emptyPaysIncludeSystemDeductions": "boolean",
    "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"
    },
    "source": "string"
}

Properties

Name	Type	Description
autoPayConfiguration	object	MyAutoPayConfigurationModel
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.lodgePayRun	boolean	Boolean
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.submitToPensionSync	boolean	Boolean
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	string	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	string	Nullable
defaultFinaliseSettings.lodgePayRunTimeline	string	PayRunFinaliseActionTimeline Possible values are: Before After On
defaultFinaliseSettings.publishPaySlips	string	PayRunFinaliseActionPreference Possible values are: Manual Immediate Scheduled
defaultFinaliseSettings.publishPaySlipsDay	int32	Int32
defaultFinaliseSettings.publishPaySlipsTimeOfDay	string	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	string	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	string	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
emptyPaysIncludeSystemDeductions	boolean	Boolean
equalMonthlyPayments	boolean	Boolean
externalId	string	String
frequency	string	MyPayCycleFrequencyEnum Possible values are: Monthly
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
source	string	String