API Docs / Schemas / UpdateHmrcCredentialsRequest

UpdateHmrcCredentialsRequest

A full replacement of shared credentials. The password is optional: omitted or null keeps the stored one.

Properties

Name Type Description
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

passwordstring

The gateway password; null keeps the stored one

The gateway password; null keeps the stored one

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

JSON Example

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

Used By Operations