Saves a set of leave accruals for the pay run.
POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/payrun/{payRunId}/leaveaccrued
Parameter name | Value | Description | Additional |
---|---|---|---|
payRunId | int32 | Required | |
businessId | string | Required |
The request body takes a complete SubmitLeaveAccrualsModel resource, containing the following writable properties:
{
"employeeIdType": "string",
"leave": {
"<key>": "array"
},
"replaceExisting": "boolean",
"suppressCalculations": "boolean"
}
Name | Type | Description |
---|---|---|
employeeIdType | string |
IdType
Possible values are:
|
leave | object |
Dictionary |
leave.<key> | map of array |
List |
leave.<key>.accrualType | string |
SaveLeaveAccrualTypeEnum
Possible values are:
|
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 |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
Powered by DapperDox