Create Pension Scheme

Create Pension Scheme for business

Request

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

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "adminAddressLine1": "string",
    "adminAddressLine2": "string",
    "adminAutoEnrolmentSignatoryEmailAddress": "string",
    "adminAutoEnrolmentSignatoryFullname": "string",
    "adminAutoEnrolmentSignatoryTitle": "string",
    "adminEmailAddress": "string",
    "adminFirstName": "string",
    "adminPhoneNumber": "string",
    "adminPostcode": "string",
    "adminSuburb": "string",
    "adminSurname": "string",
    "adminTitle": "string",
    "employerNumber": "string",
    "id": "int32",
    "name": "string",
    "providerName": "string"
}

Properties

Name Type Description
adminAddressLine1 string String
adminAddressLine2 string String
adminAutoEnrolmentSignatoryEmailAddress string String
adminAutoEnrolmentSignatoryFullname string String
adminAutoEnrolmentSignatoryTitle string String
adminEmailAddress string String
adminFirstName string String
adminPhoneNumber string String
adminPostcode string String
adminSuburb string String
adminSurname string String
adminTitle string String
employerNumber string String
id int32 Int32
name string String
providerName string String

Response

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

Status code Description Resource
200 OK

OK

 PensionSchemeApiModel