Methods

  • get - Get Leave Category by ID
  • get - List Leave Categories
  • post - Create Leave Category
  • put - Update Leave Category

Resource

[
    {
        "automaticallyAccrues": "boolean",
        "contingentPeriod": "double",
        "deductFromPayCategoryId": "int32",
        "deductFromPrimaryPayCategory": "boolean",
        "entitlementPeriod": "double",
        "excludeFromTerminationPayout": "boolean",
        "externalId": "string",
        "hideAccrualsOnPayslip": "boolean",
        "id": "int32",
        "isBalanceUntracked": "boolean",
        "isNamePrivate": "boolean",
        "isPrivate": "boolean",
        "leaveAccrualRule": {
            "accrualType": "string",
            "accrueInAdvance": "boolean",
            "capType": "string",
            "carryOverAmount": "double",
            "carryOverBehaviour": "string",
            "id": "int32",
            "unitCap": "double"
        },
        "leaveCategoryType": "string",
        "leaveLoading": "double",
        "leaveUnitType": "string",
        "name": "string",
        "source": "string",
        "transferToPayCategoryId": "int32",
        "unitType": "string",
        "units": "double",
        "useDeductFromPayCategoryRate": "boolean",
        "useGrossPaymentRate": "boolean"
    }
]

Properties

Name Type Description
automaticallyAccrues boolean Boolean
contingentPeriod double Nullable
deductFromPayCategoryId int32 Nullable
deductFromPrimaryPayCategory boolean Boolean
entitlementPeriod double Nullable
excludeFromTerminationPayout boolean Boolean
externalId string String
hideAccrualsOnPayslip boolean Boolean
id int32 Int32
isBalanceUntracked boolean Boolean
isNamePrivate boolean Boolean
isPrivate boolean Boolean
leaveAccrualRule object LeaveAccrualRuleModel
leaveAccrualRule.accrualType string LeaveAccrualType

Possible values are:

  • Ongoing
  • Yearly
leaveAccrualRule.accrueInAdvance boolean Boolean
leaveAccrualRule.capType string LeaveAccrualCapType

Possible values are:

  • NotLimited
  • Limited
leaveAccrualRule.carryOverAmount double Decimal
leaveAccrualRule.carryOverBehaviour string LeaveAccrualCarryOverBehaviour

Possible values are:

  • CarryEntireAmount
  • CarryHours
leaveAccrualRule.id int32 Int32
leaveAccrualRule.unitCap double Decimal
leaveCategoryType string LeaveCategoryTypeEnum

Possible values are:

  • Standard
  • LongServiceLeave
  • StatutorySickLeave
  • StatutoryMaternityLeave
leaveLoading double Decimal
leaveUnitType string LeaveUnitTypeEnum

Possible values are:

  • Hours
  • Days
  • Weeks
name string String
source string String
transferToPayCategoryId int32 Nullable
unitType string LeaveAllowanceUnitEnum

Possible values are:

  • Days
  • Weeks
  • HoursPerHourWorked
  • HoursPerPayRun
  • StandardDays
  • StandardWeeks
units double Decimal
useDeductFromPayCategoryRate boolean Boolean
useGrossPaymentRate boolean Boolean