HmrcCredentialsDto
A set of HMRC gateway credentials the caller owns and can share across the tenants they manage. The password
is never returned.
Properties
| Name | Type | Description |
|---|---|---|
| code* | string | The credentials' identifier (what a tenant's HMRC settings reference as sharedCredentialsId) |
The credentials' identifier (what a tenant's HMRC settings reference as sharedCredentialsId) | ||
| displayName* | string | The agent's company (and id) or the sender id, for picking them |
The agent's company (and id) or the sender id, for picking them | ||
| 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 credentials were created |
When the credentials were created | ||
| updatedDate | string | When they were last changed |
When they were last changed | ||
JSON Example
{
"code": "00000000-0000-0000-0000-000000000000",
"displayName": "string",
"senderType": "ActingInCapacity",
"senderId": "string",
"hasPassword": false,
"testInLive": false,
"useTestGateway": false,
"createdDate": "2024-01-01T00:00:00Z"
}