API Docs / Schemas / PracticeHmrcDetailsDto

PracticeHmrcDetailsDto

HMRC-specific settings for the practice, used for agent authorisation submissions.

Properties

Name Type Description
agentReferenceNumberstring

Agent Reference Number (ARN) from the HMRC Agent Services Account. Used for MTD digital authorisations.

Agent Reference Number (ARN) from the HMRC Agent Services Account. Used for MTD digital authorisations.

saAgentCodestring

Self Assessment agent code (e.g. A12345)

Self Assessment agent code (e.g. A12345)

payeAgentCodestring

PAYE/CIS agent code (e.g. 123/A12345)

PAYE/CIS agent code (e.g. 123/A12345)

ctAgentCodestring

Corporation Tax agent code

Corporation Tax agent code

contactFirstNamestring

First name of the agent contact person. Included in HMRC XML submissions.

First name of the agent contact person. Included in HMRC XML submissions.

contactLastNamestring

Last name of the agent contact person. Included in HMRC XML submissions.

Last name of the agent contact person. Included in HMRC XML submissions.

contactEmailstring

Email of the agent contact person. Included in HMRC XML submissions.

Email of the agent contact person. Included in HMRC XML submissions.

govGatewayUserIdstring

Government Gateway user ID for HMRC XML API submissions.

Government Gateway user ID for HMRC XML API submissions.

govGatewayPasswordSetboolean

Whether a Government Gateway password is stored.

Whether a Government Gateway password is stored.

govGatewayPasswordstring

Government Gateway password (write-only). Set to update, empty string to clear, null to leave unchanged.

Government Gateway password (write-only). Set to update, empty string to clear, null to leave unchanged.

JSON Example

{
  "agentReferenceNumber": "string",
  "saAgentCode": "string",
  "payeAgentCode": "string",
  "ctAgentCode": "string",
  "contactFirstName": "string"
}

Contained in Schemas