Save Leave Accruals

Saves a set of leave accruals for the pay run.

Request

POST https://api.nzpayroll.co.nz/api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued

Path parameters

Parameter name Value Description Additional
payRunId int32 Required
businessId string Required

Request body

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

{
    "employeeIdType": "string",
    "leave": {
        "<key>": "array"
    },
    "replaceExisting": "boolean",
    "suppressCalculations": "boolean"
}

Properties

Name Type Description
employeeIdType string IdType

Possible values are:

  • Standard
  • External
leave object Dictionary
leave.<key> map of array List
leave.<key>.accrualType string SaveLeaveAccrualTypeEnum

Possible values are:

  • LeaveAccrued
  • LeaveTaken
  • LeaveAdjustment
leave.<key>.adjustEarnings boolean Boolean
leave.<key>.amount double Decimal
leave.<key>.applyLeaveLoading boolean Boolean
leave.<key>.externalReferenceId string String
leave.<key>.leaveCategoryId int32 Int32
leave.<key>.notes string String
replaceExisting boolean Boolean
suppressCalculations boolean Boolean

Response

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

Status code Description Resource
200 OK

OK