Add a public holiday

Adds a new public holiday.

Request

POST https://api.yourpayroll.co.uk/api/v2/business/{businessId}/publicholiday

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "date": "date-time",
    "description": "string",
    "id": "int32",
    "isSystem": "boolean",
    "locationIds": [
        "int32"
    ],
    "mondayisedAlternativeToId": "int32",
    "notAPublicHoliday": "boolean",
    "note": "string",
    "states": [
        "string"
    ]
}

Properties

Name Type Description
date date-time Nullable
description string String
id int32 Nullable
isSystem boolean Boolean
locationIds[] array of int32
mondayisedAlternativeToId int32 Int32
notAPublicHoliday boolean Boolean
note string String
states[] array of string

Response

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

Status code Description Resource
200 OK

OK

 PublicHolidayModel