API Docs / Schemas / AgentAuthorisationSummaryEntryDto

AgentAuthorisationSummaryEntryDto

One authorisation type a client's services require, and what the practice holds against it.

Properties

Name Type Description
authorisationTypeenum

SelfAssessment CorporationTax PayeForEmployers IndividualPayAsYouEarn VAT ConstructionIndustryScheme TaxCredits HighIncomeChildBenefitCharge MakingTaxDigitalIncomeTax MakingTaxDigitalVat Trusts

SelfAssessment CorporationTax PayeForEmployers IndividualPayAsYouEarn VAT ConstructionIndustryScheme TaxCredits HighIncomeChildBenefitCharge MakingTaxDigitalIncomeTax MakingTaxDigitalVat Trusts

statusenum

NotRequested Requested Granted

NotRequested Requested Granted

hmrcAgentRoleenum

None Main Supporting NotApplicable

None Main Supporting NotApplicable

verificationResultenum

NotChecked Confirmed NotFound MissingDetails Failed

NotChecked Confirmed NotFound MissingDetails Failed

canVerifyboolean

Whether enough is known about the client to ask HMRC. Only meaningful for the Making Tax
Digital types — always false for the letter-based ones, which HMRC offer no check for.

Whether enough is known about the client to ask HMRC. Only meaningful for the Making Tax
Digital types — always false for the letter-based ones, which HMRC offer no check for.

JSON Example

{
  "authorisationType": "SelfAssessment",
  "status": "NotRequested",
  "hmrcAgentRole": "None",
  "verificationResult": "NotChecked",
  "canVerify": false
}

Contained in Schemas