HmrcSettingsDto
The tenant's HMRC gateway settings for CIS submissions. The gateway password is never returned: hasPassword
says whether one is stored. With useSharedCredentials the sender fields come from the shared credentials and
are not shown.
Properties
| Name | Type | Description |
|---|---|---|
| useSharedCredentials* | boolean | Whether the tenant signs in with one of the owner's shared credentials rather than its own |
Whether the tenant signs in with one of the owner's shared credentials rather than its own | ||
| sharedCredentialsId | string | The shared credentials in use: one of the practice's sets (/settings/hmrc/shared-credentials). Null with |
The shared credentials in use: one of the practice's sets (/settings/hmrc/shared-credentials). Null with | ||
| senderType* | enum | Whether the tenant submits as the employer, an agent or acting in capacity |
Whether the tenant submits as the employer, an 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 | ||
| employerPayeReference | string | The employer PAYE reference, office number and reference in one: "123/AB45678" |
The employer PAYE reference, office number and reference in one: "123/AB45678" | ||
| accountsOfficeReference | string | The accounts office reference |
The accounts office reference | ||
| utr | string | The tenant's Unique Taxpayer Reference as a contractor |
The tenant's Unique Taxpayer Reference as a contractor | ||
| 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 | ||
| needsConfig* | boolean | True until the settings can be submitted with: own credentials need a sender id and an accounts office reference |
True until the settings can be submitted with: own credentials need a sender id and an accounts office reference | ||
JSON Example
{
"useSharedCredentials": false,
"sharedCredentialsId": "00000000-0000-0000-0000-000000000000",
"senderType": "ActingInCapacity",
"senderId": "string",
"hasPassword": false,
"testInLive": false,
"useTestGateway": false,
"needsConfig": false
}