UpdateHmrcSettingsRequest
A full replacement of the HMRC settings. The password is optional: omitted or null keeps the stored one. With
useSharedCredentials the tenant's own sender id, password and agent are discarded.
Properties
| Name | Type | Description |
|---|---|---|
| useSharedCredentials* | boolean | Use one of the owner's shared credentials |
Use one of the owner's shared credentials | ||
| sharedCredentialsId | string | The shared credentials to use (a code from /me/hmrc-credentials); required with useSharedCredentials |
The shared credentials to use (a code from /me/hmrc-credentials); required with useSharedCredentials | ||
| senderType* | enum | Employer, agent or acting in capacity |
Employer, agent or acting in capacity | ||
| senderId | string | The gateway user id |
The gateway user id | ||
| password | string | The gateway password; null keeps the stored one |
The gateway password; null keeps the stored one | ||
| officeNumber | string | The HMRC office number |
The HMRC office number | ||
| payeReference | string | The employer PAYE reference |
The employer PAYE reference | ||
| accountsOfficeReference | string | The accounts office reference |
The accounts office reference | ||
| utr | string | The tenant's UTR |
The tenant's UTR | ||
| testInLive* | boolean | Send submissions to the live gateway flagged as tests |
Send submissions to the live gateway flagged as tests | ||
| useTestGateway* | boolean | Send submissions to HMRC's test gateway |
Send submissions to HMRC's test gateway | ||
| agent | HmrcAgentDto | The agent details, when the sender is an agent |
The agent details, when the sender is an agent | ||
JSON Example
{
"useSharedCredentials": false,
"sharedCredentialsId": "00000000-0000-0000-0000-000000000000",
"senderType": "ActingInCapacity",
"senderId": "string",
"password": "string",
"testInLive": false,
"useTestGateway": false
}