Create Employer Liabilities

Add employer liabilities to the specified pay run.

Request

POST https://api.yourpayroll.co.uk/api/v2/business/{businessId}/payrun/{payRunId}/employerliabilities

Path parameters

Parameter name Value Description Additional
payRunId int32 Required
businessId string Required

Request body

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

{
    "employeeIdType": "string",
    "employerLiabilities": {
        "<key>": "array"
    },
    "employerLiabilityCategoryIdType": "string",
    "payRunId": "int32",
    "replaceExisting": "boolean",
    "suppressCalculations": "boolean"
}

Properties

Name Type Description
employeeIdType string IdType

Possible values are:

  • Standard
  • External
employerLiabilities object Dictionary
employerLiabilities.<key> map of array List
employerLiabilities.<key>.amount double Decimal
employerLiabilities.<key>.employeeExternalId string String
employerLiabilities.<key>.employeeId string String
employerLiabilities.<key>.employeeName string String
employerLiabilities.<key>.employerLiabilityCategoryId string String
employerLiabilities.<key>.employerLiabilityCategoryName string String
employerLiabilities.<key>.externalId string String
employerLiabilities.<key>.id int32 Int32
employerLiabilities.<key>.locationId string String
employerLiabilities.<key>.locationName string String
employerLiabilities.<key>.notes string String
employerLiabilityCategoryIdType string IdType

Possible values are:

  • Standard
  • External
payRunId int32 Int32
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