Gets the HMRC Settings for the business.

Request

PUT https://api.yourpayroll.co.uk/api/v2/business/{businessId}/hmrcsettings

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "accountsOfficeReference": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "alreadyReportedApprenticeshipLevy": "boolean",
    "apprenticeshipLevyAllowance": "double",
    "businessName": "string",
    "claimEmploymentAllowance": "boolean",
    "claimSmallEmployersRelief": "boolean",
    "country": "string",
    "epsAccountBuildingSocietyRef": "string",
    "epsAccountName": "string",
    "epsAccountNumber": "string",
    "epsAccountSortCode": "string",
    "epsSubmissionDay": "int32",
    "firstName": "string",
    "isAgent": "boolean",
    "isRtiEnabled": "boolean",
    "lastName": "string",
    "previouslyReportedApprenticeshipLevyAllowance": "double",
    "previouslyReportedApprenticeshipLevyAmount": "double",
    "requiredToPayApprenticeshipLevy": "boolean",
    "rtiPassword": "string",
    "rtiTestMode": "boolean",
    "rtiUserId": "string",
    "suburb": "string",
    "taxOfficeNumber": "string",
    "taxOfficeReference": "string"
}

Properties

Name Type Description
accountsOfficeReference string String
addressLine1 string String
addressLine2 string String
alreadyReportedApprenticeshipLevy boolean Boolean
apprenticeshipLevyAllowance double Nullable
businessName string String
claimEmploymentAllowance boolean Boolean
claimSmallEmployersRelief boolean Boolean
country string String
epsAccountBuildingSocietyRef string String
epsAccountName string String
epsAccountNumber string String
epsAccountSortCode string String
epsSubmissionDay int32 Int32
firstName string String
isAgent boolean Boolean
isRtiEnabled boolean Boolean
lastName string String
previouslyReportedApprenticeshipLevyAllowance double Nullable
previouslyReportedApprenticeshipLevyAmount double Nullable
requiredToPayApprenticeshipLevy boolean Boolean
rtiPassword string String
rtiTestMode boolean Boolean
rtiUserId string String
suburb string String
taxOfficeNumber string String
taxOfficeReference string String

Response

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

Status code Description Resource
200 OK

OK

HmrcSettingsModel