Create subcontractor

Creates a new subcontractor

Request

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

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "addressLine1": "string",
    "addressLine2": "string",
    "businessType": "string",
    "companyRegistrationNumber": "string",
    "countryId": "string",
    "county": "string",
    "dateMatched": "date-time",
    "emailAddress": "string",
    "firstName": "string",
    "isContractAgreed": "boolean",
    "lastPaymentDate": "date-time",
    "middleName": "string",
    "nationalInsuranceNumber": "string",
    "partnershipUniqueTaxpayerReference": "string",
    "phoneNumber": "string",
    "postcode": "string",
    "surname": "string",
    "taxStatus": "string",
    "town": "string",
    "tradingName": "string",
    "uniqueTaxpayerReference": "string",
    "verificationNumber": "string"
}

Properties

Name Type Description
addressLine1 string String
addressLine2 string String
businessType string Nullable

Possible values are:

  • SoleTrader
  • Partnership
  • Company
  • Trust
companyRegistrationNumber string String
countryId string String
county string String
dateMatched date-time Nullable
emailAddress string String
firstName string String
isContractAgreed boolean Nullable
lastPaymentDate date-time Nullable
middleName string String
nationalInsuranceNumber string String
partnershipUniqueTaxpayerReference string String
phoneNumber string String
postcode string String
surname string String
taxStatus string Nullable

Possible values are:

  • Unmatched
  • Standard
  • Gross
  • VerificationRequired
town string String
tradingName string String
uniqueTaxpayerReference string String
verificationNumber string String

Response

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

Status code Description Resource
200 OK

OK

 UkSubcontractorReadModel