Create Leave Allowance Template

Creates a new leave allowance template for the business.

Request

POST https://api.yourpayroll.co.uk/api/v2/business/{businessId}/leaveallowancetemplate

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "externalId": "string",
    "id": "int32",
    "leaveAccrualStartDateType": "string",
    "leaveCategories": [
        {
            "canApplyForLeave": "boolean",
            "leaveAccrualRuleAccrualType": "string",
            "leaveAccrualRuleAccrueInAdvance": "boolean",
            "leaveAccrualRuleCapType": "string",
            "leaveAccrualRuleCarryOverAmount": "double",
            "leaveAccrualRuleCarryOverBehaviour": "string",
            "leaveAccrualRuleUnitCap": "double",
            "leaveCategoryId": "int32",
            "leaveCategoryName": "string",
            "leaveUnitType": "string",
            "unitType": "string",
            "units": "double"
        }
    ],
    "leaveYearStart": "date-time",
    "name": "string",
    "source": "string"
}

Properties

Name Type Description
externalId string String
id int32 Int32
leaveAccrualStartDateType string Nullable

Possible values are:

  • EmployeeStartDate
  • SpecifiedDate
  • CalendarYear
  • CategorySpecificDate
leaveCategories[] array
leaveCategories[].canApplyForLeave boolean Boolean
leaveCategories[].leaveAccrualRuleAccrualType string LeaveAccrualType

Possible values are:

  • Ongoing
  • Yearly
  • BasedOnLengthOfService
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[].leaveAccrualRuleUnitCap double Decimal
leaveCategories[].leaveCategoryId int32 Int32
leaveCategories[].leaveCategoryName string String
leaveCategories[].leaveUnitType string Nullable

Possible values are:

  • Hours
  • Days
  • Weeks
leaveCategories[].unitType string Nullable

Possible values are:

  • HoursPerHourWorked
  • HoursPerPayRun
  • StandardDays
  • StandardWeeks
  • DayPerCalendarDay
leaveCategories[].units double Nullable
leaveYearStart date-time 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
  • FinancialsOffice
  • ProntoXI
  • PayRunDefault
  • StandardWorkDay
  • Beam
  • PayRunAutomation
  • BureauDashboard
  • Wiise
  • QBOMigrationTool
  • AbridgedFileImport
  • QBOForcedMigration
  • HmrcDpsUpdate
  • HmrcDpsStudentLoan
  • HmrcDpsPostGradLoan
  • Sage50FileImporter
  • FPSFileImporter
  • OAuth
  • FreshBooks
  • StarFileImporter
  • ActiveCampaign
  • SummaryAndDetailsExport
  • Telleroo
  • EmployeeAdvancedHoursUpload
  • BusinessCentral
  • Paytron
  • AccessFinancials
  • Comma
  • Zoho
  • FlatFileEmployeeImporter
  • Twinfield
  • SageAccounting
  • Square
  • Quickfile
  • Tide
  • TideSso
  • FreeAgent
  • Akahu
  • InstaPay
  • Zepto
  • Slack
  • Caxton
  • QuickbooksStandalonePayroll
  • ImportEmployeeSelfSetup
  • XeroIdentityPayrollSignUp
  • XeroIdentityHrSignUp
  • SageIntacct
  • InstaPayDaily
  • Salesforce
  • AutomatedPublicHolidayNotWorked
  • EmployeePayRatesUpload
  • Zapier
  • StapledSuperFund
  • Swag

Response

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

Status code Description Resource
200 OK

OK

 UkLeaveAllowanceTemplateModel