Create benefit category

Creates a new benefit category

Request

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

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "amountForegone": "double",
    "benefitType": "string",
    "carryBenefitForward": "boolean",
    "name": "string",
    "niTreatment": "string",
    "year": "int32"
}

Properties

Name Type Description
amountForegone double Nullable
benefitType string String
carryBenefitForward boolean Boolean
name string String
niTreatment string String
year int32 Nullable

Response

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

Status code Description Resource
200 OK

OK

 UkBenefitCategoryReadModel