Prepare Leave Liability report

Prepare Leave Liability Report job.

Request

POST https://api.yourpayroll.co.uk/api/v2/business/{businessId}/report/leaveliability/preparation

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "asAtDate": "date-time",
    "employingEntityId": "int32",
    "filterType": "string",
    "groupBy": "string",
    "includeApprovedLeave": "boolean",
    "jobId": "uuid",
    "leaveTypeId": "int32",
    "leaveTypeIds": [
        "int32"
    ],
    "locationId": "int32",
    "payRunId": "int32"
}

Properties

Name Type Description
asAtDate date-time Nullable
employingEntityId int32 Nullable
filterType string DateTypeEnum

Possible values are:

  • DateRange
  • PayRun
  • SuperBatch
groupBy string Nullable

Possible values are:

  • AccrualLocation
  • DefaultLocation
includeApprovedLeave boolean Boolean
jobId uuid Nullable
leaveTypeId int32 Int32
leaveTypeIds[] array of int32
locationId int32 Int32
payRunId int32 Nullable

Response

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

Status code Description Resource
200 OK

OK

 ReportLeaveLiabilityPreparationResponse