My Practices
The practices the caller is a member of, under /me: a practice is a group of client organisations whose members reach every one of them. Its HMRC gateway credentials (several sets, one the default) are what its organisations' HMRC settings share. A practice managed in Sodium is read-only here (409); SodiumHQ keeps it. Passwords are never returned.
-
GET List My PracticesThe practices the caller is a member of, by name./me/practices
-
POST Create My PracticeCreates a practice, managed here, with the caller its first member, and puts the named organisations in it: each one the caller owns (400 otherwise) a.../me/practices
-
GET Get My PracticeOne of the caller's practices; 404 when the caller is not a member./me/practices/{practice}
-
PUT Rename My PracticeReplaces the practice's name. 409 for a practice managed in Sodium./me/practices/{practice}
-
GET List My Practice MembersThe practice's members, who reach every organisation it runs, by name./me/practices/{practice}/members
-
DELETE Remove My Practice MemberTakes a member out of the practice and the organisations it granted them; organisations they are a member of in their own right, and those they own, a.../me/practices/{practice}/members/{user}
-
GET List My Practice OrganisationsThe organisations the practice runs, by name, with their owners./me/practices/{practice}/organisations
-
POST Add My Practice OrganisationPuts one of the caller's organisations in the practice: one they own (400 otherwise) and in no practice (409 otherwise). The practice's members reach .../me/practices/{practice}/organisations
-
DELETE Remove My Practice OrganisationTakes the organisation out of the practice. The practice members named in keep (user codes) keep access as members of the organisation itself, at thei.../me/practices/{practice}/organisations/{tenant}
-
GET List Practice HMRC CredentialsThe practice's HMRC gateway credentials, the default first. Its organisations' HMRC settings can point at any of them (sharedCredentialsId). 404 when .../me/practices/{practice}/hmrc-credentials
-
POST Create Practice HMRC CredentialsAdds a set of credentials to the practice: the default when isDefault, or when it is the practice's first. The first set is also given to every contra.../me/practices/{practice}/hmrc-credentials
-
GET Get Practice HMRC CredentialsOne of the practice's credentials./me/practices/{practice}/hmrc-credentials/{credentials}
-
PUT Update Practice HMRC CredentialsReplaces the credentials; a null password keeps the stored one. isDefault moves the practice's default to them; false leaves the default where it is. .../me/practices/{practice}/hmrc-credentials/{credentials}
-
DELETE Delete Practice HMRC CredentialsDeletes the credentials. An organisation filing with them falls back to its own settings; when they were the default, the practice's oldest remaining .../me/practices/{practice}/hmrc-credentials/{credentials}
-
POST Test Practice HMRC CredentialsSends a dummy subcontractor verification through the gateway with the credentials, using the named tenant's HMRC references as the context (the caller.../me/practices/{practice}/hmrc-credentials/{credentials}/test