Updates the leave allowance template with the specified ID.


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",
            "leaveAccrualRuleAccrualType": "string",
            "leaveAccrualRuleAccrueInAdvance": "boolean",
            "leaveAccrualRuleCapType": "string",
            "leaveAccrualRuleCarryOverAmount": "double",
            "leaveAccrualRuleCarryOverBehaviour": "string",
            "leaveAccrualRuleId": "int32",
            "leaveAccrualRuleUnitCap": "double",
            "leaveCategoryId": "int32",
            "leaveLoading": "double",
            "unitType": "string",
            "units": "double"
    "name": "string",
    "source": "string"


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

Possible values are:

  • Ongoing
  • Yearly
leaveCategories[].leaveAccrualRuleAccrueInAdvance boolean Boolean
leaveCategories[].leaveAccrualRuleCapType string LeaveAccrualCapType

Possible values are:

  • NotLimited
  • Limited
leaveCategories[].leaveAccrualRuleCarryOverAmount double Decimal
leaveCategories[].leaveAccrualRuleCarryOverBehaviour string LeaveAccrualCarryOverBehaviour

Possible values are:

  • CarryEntireAmount
  • CarryHours
leaveCategories[].leaveAccrualRuleId int32 Int32
leaveCategories[].leaveAccrualRuleUnitCap double Decimal
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
  • NetSuiteOneWorld
  • Sage50
  • PensionSync


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

Status code Description Resource
200 OK