Set Leave Allowances

Sets the leave allowances for the specified employees (dictionary keyed by employee ID).

Request

PUT https://apisg.yourpayroll.io/api/v2/business/{businessId}/leaveallowances

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "employeeIdType": "string",
    "leaveAllowances": {
        "<key>": "array"
    },
    "leaveCategoryIdType": "string"
}

Properties

Name Type Description
employeeIdType string IdType

Possible values are:

  • Standard
  • External
leaveAllowances object Dictionary
leaveAllowances.<key> map of array IList
leaveAllowances.<key>.automaticallyAccrues boolean Boolean
leaveAllowances.<key>.canApplyForLeave boolean Boolean
leaveAllowances.<key>.hoursPerYear double Decimal
leaveAllowances.<key>.leaveAccrualRule object SgLeaveAccrualRuleModel
leaveAllowances.<key>.leaveAccrualRule.accrualType string LeaveAccrualType

Possible values are:

  • Ongoing
  • Yearly
  • BasedOnLengthOfService
leaveAllowances.<key>.leaveAccrualRule.accrueInAdvance boolean Boolean
leaveAllowances.<key>.leaveAccrualRule.capType string LeaveAccrualCapType

Possible values are:

  • NotLimited
  • Limited
leaveAllowances.<key>.leaveAccrualRule.carryOverAmount double Decimal
leaveAllowances.<key>.leaveAccrualRule.carryOverBehaviour string LeaveAccrualCarryOverBehaviour

Possible values are:

  • CarryEntireAmount
  • CarryHours
leaveAllowances.<key>.leaveAccrualRule.id int32 Int32
leaveAllowances.<key>.leaveAccrualRule.leaveYearOffsetAmount int32 Nullable
leaveAllowances.<key>.leaveAccrualRule.unitCap double Decimal
leaveAllowances.<key>.leaveCategoryId string String
leaveAllowances.<key>.leaveCategoryName string String
leaveAllowances.<key>.leaveUnitType string String
leaveAllowances.<key>.unitType string String
leaveAllowances.<key>.units double Nullable
leaveCategoryIdType string IdType

Possible values are:

  • Standard
  • External

Response

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

Status code Description Resource
200 OK

OK

 SgLeaveAllowanceModel