PracticeHmrcCredentialsDto
One of a practice's sets of HMRC gateway credentials: its organisations file with it when their HMRC settings point
at it (sharedCredentialsId), and a new organisation of the practice starts on the default. The password is never
returned.
Properties
| Name | Type | Description |
|---|---|---|
| code* | string | The set's code (what an organisation's HMRC settings reference as sharedCredentialsId) |
The set's code (what an organisation's HMRC settings reference as sharedCredentialsId) | ||
| name* | string | What the HMRC settings page offers the set as |
What the HMRC settings page offers the set as | ||
| isDefault* | boolean | The set a new organisation of the practice files with. A practice with sets always has one |
The set a new organisation of the practice files with. A practice with sets always has one | ||
| senderType* | enum | Employer, agent or acting in capacity |
Employer, agent or acting in capacity | ||
| senderId | string | The gateway user id |
The gateway user id | ||
| hasPassword* | boolean | Whether a gateway password is stored |
Whether a gateway password is stored | ||
| 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 | ||
| createdDate* | string | When the set was created |
When the set was created | ||
| updatedDate | string | When it was last changed |
When it was last changed | ||
JSON Example
{
"code": "00000000-0000-0000-0000-000000000000",
"name": "string",
"isDefault": false,
"senderType": "ActingInCapacity",
"senderId": "string",
"hasPassword": false,
"testInLive": false,
"useTestGateway": false,
"createdDate": "2024-01-01T00:00:00Z"
}