API Docs / Operations / HMRC Settings / Update HMRC Settings

Update HMRC Settings

PUT /tenants/{tenant}/settings/hmrc

Replaces the tenant's HMRC settings. A null password keeps the stored one; with useSharedCredentials the tenant's own sender id, password and agent are discarded. The UTR is validated (400).

Parameters

NameTypeDescription
tenant* path string

The tenant code (the organisation's URL stub)

The tenant code (the organisation's URL stub)

{
  "useSharedCredentials": false,
  "sharedCredentialsId": "00000000-0000-0000-0000-000000000000",
  "senderType": "ActingInCapacity",
  "senderId": "string",
  "password": "string",
  "testInLive": false,
  "useTestGateway": false
}

Responses

400 Bad Request
application/problem+json
401 Unauthorized – Invalid or missing API key
403 Forbidden
application/problem+json
404 Not Found
application/problem+json