Updates the leave allowance template with the specified ID.

Request

PUT https://keypay.yourpayroll.com.au/api/v2/business/{businessId}/leaveallowancetemplate/{id}

Path parameters

Parameter name Value Description Additional
id int32 Required
businessId string Required

Request body

The request body takes a complete LeaveAllowanceTemplateModel resource, containing the following writable properties:

{
    "externalId": "string",
    "id": "int32",
    "leaveCategories": [
        {
            "canApplyForLeave": "boolean",
            "contingentPeriod": "double",
            "entitlementPeriod": "double",
            "leaveCategoryId": "int32",
            "leaveLoading": "double",
            "unitType": "string",
            "units": "double"
        }
    ],
    "name": "string",
    "source": "string"
}

Properties

Name Type Description
externalId string String
id int32 Int32
leaveCategories[] array
leaveCategories[].canApplyForLeave boolean Boolean
leaveCategories[].contingentPeriod double Nullable
leaveCategories[].entitlementPeriod double Nullable
leaveCategories[].leaveCategoryId int32 Int32
leaveCategories[].leaveLoading double Nullable
leaveCategories[].unitType string Nullable

Possible values are:

  • Days
  • Weeks
  • HoursPerHourWorked
  • HoursPerPayRun
leaveCategories[].units double Nullable
name string String
source string ExternalService

Possible values are:

  • None
  • Saasu
  • Xero
  • MYOB
  • Deputy
  • EmployeeTimePunch
  • ClickSuper
  • IntegratedTimesheets
  • FileImport
  • FileExport
  • QuickBooks
  • Harmony
  • AwardStore
  • Attache
  • IntegratedRostering
  • ReckonAccounts
  • API
  • MicroPower
  • RosterLive
  • NetSuite
  • Kounta
  • TimeAndAttendanceKiosk
  • DetailedFileExport
  • JonasPremier
  • WageEasy
  • Maestrano
  • WorkZone
  • EmployeePortal
  • RosterTemplate
  • Onboarding
  • Admin
  • WorkZoneClockOnOff

Response

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

Status code Description Resource
200 OK

OK