HmrcAgentCredentialDto - SodiumHQ API Schema

Properties

Name	Type	Description
code	string
name	string	What the practice calls this set.
What the practice calls this set.
isDefault	boolean	The set MTD uses for the ARN, and that letter-based requests use when no set is chosen.
The set MTD uses for the ARN, and that letter-based requests use when no set is chosen.
agentReferenceNumber	string	Agent Reference Number (ARN) from the Agent Services Account. Used for MTD digital authorisations.
Agent Reference Number (ARN) from the Agent Services Account. Used for MTD digital authorisations.
saAgentCode	string	Self Assessment agent code (e.g. A12345).
Self Assessment agent code (e.g. A12345).
payeAgentCode	string	PAYE/CIS agent code (e.g. 123/A12345).
PAYE/CIS agent code (e.g. 123/A12345).
ctAgentCode	string	Corporation Tax agent code.
Corporation Tax agent code.
contactFirstName	string	First name of the agent contact. Included in HMRC XML submissions.
First name of the agent contact. Included in HMRC XML submissions.
contactLastName	string	Last name of the agent contact. Included in HMRC XML submissions.
Last name of the agent contact. Included in HMRC XML submissions.
contactEmail	string	Email of the agent contact. Included in HMRC XML submissions.
Email of the agent contact. Included in HMRC XML submissions.
govGatewayUserId	string	Government Gateway user ID for HMRC XML API submissions.
Government Gateway user ID for HMRC XML API submissions.
govGatewayPasswordSet	boolean	Whether a Government Gateway password is stored.
Whether a Government Gateway password is stored.

{
  "code": "string",
  "name": "string",
  "isDefault": false,
  "agentReferenceNumber": "string",
  "saAgentCode": "string"
}