CreateHmrcAgentCredentialRequest

Adds a credential set. The practice's first set becomes the default.

Properties

Name Type Description
name*string

What the practice calls this set. Unique within the practice.

What the practice calls this set. Unique within the practice.

agentReferenceNumberstring

Agent Reference Number (ARN) from the Agent Services Account.

Agent Reference Number (ARN) from the Agent Services Account.

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.

First name of the agent contact.

contactLastNamestring

Last name of the agent contact.

Last name of the agent contact.

contactEmailstring

Email of the agent contact.

Email of the agent contact.

govGatewayUserIdstring

Government Gateway user ID.

Government Gateway user ID.

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

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

Used By Operations