ClientAgentAuthorisationDto
Represents one of the 11 HMRC agent authorisation types for a client
Properties
| Name | Type | Description |
|---|---|---|
| authorisationType | enum | SelfAssessment CorporationTax PayeForEmployers IndividualPayAsYouEarn VAT ConstructionIndustryScheme TaxCredits HighIncomeChildBenefitCharge MakingTaxDigitalIncomeTax MakingTaxDigitalVat Trusts |
SelfAssessment CorporationTax PayeForEmployers IndividualPayAsYouEarn VAT ConstructionIndustryScheme TaxCredits HighIncomeChildBenefitCharge MakingTaxDigitalIncomeTax MakingTaxDigitalVat Trusts | ||
| status | enum | NotRequested Requested Granted |
NotRequested Requested Granted | ||
| isRequired | boolean | True if any of the client's active or proposed services require this authorisation type |
True if any of the client's active or proposed services require this authorisation type | ||
| hmrcInvitation | HmrcInvitationDetailsDto | |
| hmrcVerificationResult | enum | NotChecked Confirmed NotFound MissingDetails Failed |
NotChecked Confirmed NotFound MissingDetails Failed | ||
| hmrcAgentRole | enum | None Main Supporting NotApplicable |
None Main Supporting NotApplicable | ||
| hmrcLastVerifiedDate | string | When HMRC last answered a verification check for this authorisation. |
When HMRC last answered a verification check for this authorisation. | ||
| codeEntrySource | enum | None Practice Client |
None Practice Client | ||
JSON Example
{
"authorisationType": "SelfAssessment",
"status": "NotRequested",
"isRequired": false,
"hmrcInvitation": {
"status": "...",
"clientActionUrl": "string",
"dateRequested": "2024-01-01T00:00:00Z",
"expiresOn": "2024-01-01T00:00:00Z",
"codeEntryEmailSentDate": "2024-01-01T00:00:00Z"
},
"hmrcVerificationResult": "NotChecked"
}