Updates the HMRC Settings for the business.
PUT https://api.yourpayroll.co.uk/api/v2/business/{businessId}/hmrcsettings
Parameter name | Value | Description | Additional |
---|---|---|---|
businessId | string | Required |
The request body takes a complete HmrcSettingsRequestModel resource, containing the following writable properties:
{
"accountsOfficeReference": "string",
"addressLine1": "string",
"addressLine2": "string",
"alreadyReportedApprenticeshipLevy": "boolean",
"apprenticeshipLevyAllowance": "double",
"businessName": "string",
"claimEmploymentAllowance": "boolean",
"claimSmallEmployersRelief": "boolean",
"corporateTaxUniqueTaxpayerReference": "string",
"country": "string",
"epsAccountBuildingSocietyRef": "string",
"epsAccountName": "string",
"epsAccountNumber": "string",
"epsAccountSortCode": "string",
"epsSubmissionDay": "int32",
"firstName": "string",
"hmrcPaymentReminder": {
"enabled": "boolean",
"monthlyBreakdown": "boolean",
"payRunPensionAmounts": "boolean",
"period": "string",
"recipients": "string",
"reminderDay": "int32"
},
"includeEmploymentAllowanceInJournals": "boolean",
"investmentZoneTaxSiteEnabled": "boolean",
"isAgent": "boolean",
"isIR35": "boolean",
"isRtiEnabled": "boolean",
"lastName": "string",
"occupationalPensionsEnabled": "boolean",
"previouslyReportedApprenticeshipLevyAllowance": "double",
"previouslyReportedApprenticeshipLevyAmount": "double",
"requiredToPayApprenticeshipLevy": "boolean",
"rtiPassword": "string",
"rtiTestMode": "boolean",
"rtiUserId": "string",
"secondedEmployeesEnabled": "boolean",
"suburb": "string",
"taxOfficeNumber": "string",
"taxOfficeReference": "string"
}
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 |
corporateTaxUniqueTaxpayerReference | string | String |
country | string | String |
epsAccountBuildingSocietyRef | string | String |
epsAccountName | string | String |
epsAccountNumber | string | String |
epsAccountSortCode | string | String |
epsSubmissionDay | int32 | Int32 |
firstName | string | String |
hmrcPaymentReminder | object | HmrcPaymentReminderModel |
hmrcPaymentReminder.enabled | boolean |
Nullable |
hmrcPaymentReminder.monthlyBreakdown | boolean |
Nullable |
hmrcPaymentReminder.payRunPensionAmounts | boolean |
Nullable |
hmrcPaymentReminder.period | string |
Nullable Possible values are:
|
hmrcPaymentReminder.recipients | string | String |
hmrcPaymentReminder.reminderDay | int32 |
Nullable |
includeEmploymentAllowanceInJournals | boolean |
Nullable |
investmentZoneTaxSiteEnabled | boolean |
Nullable |
isAgent | boolean | Boolean |
isIR35 | boolean | Boolean |
isRtiEnabled | boolean | Boolean |
lastName | string | String |
occupationalPensionsEnabled | boolean |
Nullable |
previouslyReportedApprenticeshipLevyAllowance | double |
Nullable |
previouslyReportedApprenticeshipLevyAmount | double |
Nullable |
requiredToPayApprenticeshipLevy | boolean | Boolean |
rtiPassword | string | String |
rtiTestMode | boolean | Boolean |
rtiUserId | string | String |
secondedEmployeesEnabled | boolean |
Nullable |
suburb | string | String |
taxOfficeNumber | string | String |
taxOfficeReference | string | String |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
HmrcSettingsResponseModel |
Powered by DapperDox