Updates the pay schedule with the specified ID.

Request

PUT http:///api/v2/business/{businessId}/payschedule/{id}

Path parameters

Request body

The request body takes a complete SgPayScheduleModel resource, containing 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",
        "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",
    "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

Response

The following HTTP status codes may be returned, optionally with a response resource.