Methods

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

Resource

[
    {
        "abaDetailsId": "int32",
        "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"
        },
        "employeeSelectionStrategy": "string",
        "equalMonthlyPayments": "boolean",
        "externalId": "string",
        "frequency": "string",
        "id": "int32",
        "ignoredPayRunWarnings": [
            "int32"
        ],
        "lastDatePaid": "date-time",
        "lastPayRun": "date-time",
        "locations": [
            "int32"
        ],
        "name": "string",
        "paygAccountBsb": "string",
        "paygAccountName": "string",
        "paygAccountNumber": "string",
        "paygReference": "string",
        "source": "string"
    }
]

Properties

Name Type Description
abaDetailsId int32 Nullable
autoPayConfiguration object AutoPayConfigurationModel
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
autoPayConfiguration.usersToNotify[] array of string
autoPayConfiguration.weekOfMonth int32 Int32
employeeSelectionStrategy string Nullable

Possible values are:

  • None
  • PayRunDefault
  • TimesheetLocations
  • PayRunDefaultWithTimesheets
equalMonthlyPayments boolean Boolean
externalId string String
frequency string PayCycleFrequencyEnum

Possible values are:

  • Weekly
  • Fortnightly
  • Monthly
  • AdHoc
  • Initial
  • PreviousEmployer
  • FourWeekly
  • Quarterly
  • Annually
  • HistoricGrossEarnings
id int32 Int32
ignoredPayRunWarnings[] array of int32
lastDatePaid date-time Nullable
lastPayRun date-time Nullable
locations[] array of int32
name string String
paygAccountBsb string String
paygAccountName string String
paygAccountNumber string String
paygReference string String
source string String