Create Work Type

Creates a new work type for the business.

Request

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

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "accruesLeave": "boolean",
    "employmentTypes": [
        "string"
    ],
    "externalId": "string",
    "id": "int32",
    "leaveCategoryId": "int32",
    "mappingType": "string",
    "name": "string",
    "payCategoryId": "int32",
    "shortCode": "string",
    "source": "string"
}

Properties

Name Type Description
accruesLeave boolean Boolean
employmentTypes[] array of string

Possible values are:

  • Unknown
  • FullTime
  • PartTime
  • Casual
  • NotApplicable
externalId string String
id int32 Int32
leaveCategoryId int32 Nullable
mappingType string Nullable

Possible values are:

  • PayCategory
  • LeaveCategory
  • PrimaryPayCategory
  • ShiftCondition
name string String
payCategoryId int32 Nullable
shortCode string String
source string String

Response

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

Status code Description Resource
200 OK

OK

 UkWorkTypeModel