API Docs / Schemas / CreatePracticeHmrcCredentialsRequest

CreatePracticeHmrcCredentialsRequest

A new set of practice credentials.

Properties

Name Type Description
name*string

What the HMRC settings page offers the set as

What the HMRC settings page offers the set as

senderType*enum

Employer, agent or acting in capacity

ActingInCapacity Agent Bureau Company Employer Government Individual Other Partnership Trust

Employer, agent or acting in capacity

ActingInCapacity Agent Bureau Company Employer Government Individual Other Partnership Trust

senderId*string

The gateway user id

The gateway user id

testInLive*boolean

Send submissions to the live gateway flagged as tests

Send submissions to the live gateway flagged as tests

useTestGateway*boolean

Send submissions to HMRC's test gateway

Send submissions to HMRC's test gateway

agentHmrcAgentDto

The agent details, when the sender is an agent

The agent details, when the sender is an agent

password*string

The gateway password

The gateway password

isDefault*boolean

Make it the practice's default (the practice's first set is the default whatever this says)

Make it the practice's default (the practice's first set is the default whatever this says)

JSON Example

{
  "name": "string",
  "senderType": "ActingInCapacity",
  "senderId": "string",
  "testInLive": false,
  "useTestGateway": false,
  "password": "string",
  "isDefault": false
}

Used By Operations