UpdatePracticeHmrcCredentialsRequest
A full replacement of a set of practice credentials. The password is optional: omitted or null keeps the stored one.
Properties
| Name | Type | Description |
|---|---|---|
| name* | string | What the HMRC settings page offers the set as |
What the HMRC settings page offers the set as | ||
| senderType* | enum | Employer, agent or acting in capacity |
Employer, agent or acting in capacity | ||
| senderId* | string | The gateway user id |
The gateway user id | ||
| 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 | ||
| password | string | The gateway password; null keeps the stored one |
The gateway password; null keeps the stored one | ||
| isDefault* | boolean | Make it the practice's default. False leaves the default where it is: the default moves only by naming another |
Make it the practice's default. False leaves the default where it is: the default moves only by naming another | ||
JSON Example
{
"name": "string",
"senderType": "ActingInCapacity",
"senderId": "string",
"testInLive": false,
"useTestGateway": false,
"isDefault": false
}