Create Employee Group

Creates a new employee group for the business.

Request

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

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "filterCombinationStrategy": "string",
    "filters": [
        {
            "filterType": "string",
            "operator": "string",
            "value": "string"
        }
    ],
    "id": "int32",
    "name": "string"
}

Properties

Name Type Description
filterCombinationStrategy string FilterCombinationStrategyEnum

Possible values are:

  • Or
  • And
filters[] array
filters[].filterType string UkFilterTypeEnum

Possible values are:

  • Location
  • LocationOrParents
  • Employee
  • PaySchedule
  • Tag
filters[].operator string FilterOperatorEnum

Possible values are:

  • In
  • NotIn
filters[].value string String
id int32 Int32
name string String

Response

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

Status code Description Resource
200 OK

OK

 UkEmployeeGroupModel