OperationsSchemas

OpenAPI spec

• AccountInvoiceDto
  An invoice to the caller from Sodium (Account Hub): their CIS Manager charges, with any other Sodium...
• AddPracticeOrganisationRequest1 endpoint
  One of the caller's organisations to put in the practice.
• AddressDto
  A postal address.
• BillingMandateDto2 endpoints
  The caller's Direct Debit mandate, refreshed from GoCardless through Account Hub.
• BillingProfileDto2 endpoints
  The caller's billing details, kept on their Account Hub billing account: the address their invoices ...
• BillingUsageDto
  Usage recorded for a tenant the caller owns: a monthly return accepted by HMRC and the subcontractor...
• BulkHmrcVerificationRequest1 endpoint
  Asks HMRC to verify or match several subcontractors at once.
• BulkHmrcVerificationResultDto1 endpoint
  The outcome of a bulk HMRC verification request: which contacts were sent to HMRC and which were not...
• CisDetailsDto
  The subcontractor's CIS identity: what HMRC verifies them by. The verification outcome (status, veri...
• CisDetailsPrefillDto
  What the tenant already has on record for the subcontractor, for the public form to start from: how ...
• CisDetailsRequestDto4 endpoints
  A request for a subcontractor's CIS details: the tenant emails the subcontractor a link to a public ...
• CompleteMandateSetupRequest1 endpoint
  Completes a Direct Debit setup the customer has finished on GoCardless (`PUT /me/billing/mandate`).
• ConnectionCisDetailsDto
  The CIS identity a subcontractor tenant shares over a connection.
• ConnectionDto3 endpoints
  A connection between two CIS Manager tenants (an "Interlink"), seen from the viewing tenant's side. ...
• ConnectionPartyDto
  The other tenant on a connection.
• ContactDto3 endpoints
  A contact: a person or organisation the tenant does business with, in one or more roles. Customers a...
• ContactDtoPagedResult1 endpoint
• ContactImportResultDto1 endpoint
  The outcome of a subcontractor import.
• ContactImportResultRowDto
  The outcome of importing one selected row.
• ContactImportRowDto
  One data row of a subcontractor import CSV as the analysis sees it: the contact it would become, or ...
• ContactInvoicingDto
  A contact's invoicing summaries, one per direction. Read-only; maintained by the invoice resources.
• ContactNoteDto3 endpoints
  A free-text note recorded against a contact.
• ContactNoteDtoPagedResult1 endpoint
• CreateCisDetailsRequestRequest1 endpoint
  A new request for a subcontractor's CIS details. Creating it emails the subcontractor the link to th...
• CreateConnectionRequest1 endpoint
  A new connection: the tenant shares its CIS details with one of its contractor contacts.
• CreateContactNoteRequest1 endpoint
  A new note for a contact.
• CreateContactRequest1 endpoint
  Creates a contact. The code is generated from the display name. The role-specific parts may be omitt...
• CreateEmailConfigRequest1 endpoint
  A connection to add. SMTP takes `smtpSettings`; Outlook and Gmail take `returnUrl` and answer with t...
• CreateInvitationRequest1 endpoint
  A new invitation. It is emailed at once and expires after seven days.
• CreateInvoiceLineRequest
  A line of a new invoice.
• CreateInvoicePaymentRequest2 endpoints
  A new payment against an invoice.
• CreateInvoiceRequest2 endpoints
  A new invoice.
• CreateMandateSetupRequest1 endpoint
  Starts a Direct Debit setup (`POST /me/billing/mandate-setups`).
• CreateMonthlyReturnRequest1 endpoint
  A new monthly return for a tax month.
• CreateMyApiKeyRequest1 endpoint
  Issues the caller an API key (`POST /me/api-keys`).
• CreatePracticeHmrcCredentialsRequest1 endpoint
  A new set of practice credentials.
• CreatePracticeRequest1 endpoint
  A new practice, the caller its first member.
• CreateSdcStatementRequest1 endpoint
  A new SDC statement. Creating it emails the subcontractor a link to complete it.
• CreateTenantRequest1 endpoint
  A new tenant, owned by the caller. Its email address and phone number start as the caller's.
• CreateWebhookRequest1 endpoint
  A webhook to create. Its secret is generated.
• EmailConfigDto3 endpoints
  One of the tenant's own email connections (SMTP, Outlook or Gmail), which it sends its emails throug...
• EmailMessageDto3 endpoints
  An email sent of a document (an invoice, a remittance advice) to a contact, with its delivery status...
• EmailSettingsDto2 endpoints
  The tenant's email settings: the signature appended to every email it sends and whether statements g...
• EmailSmtpSettingsDto
  An SMTP connection's settings as stored.
• EmailSmtpSettingsRequest
  SMTP settings to store.
• EmailTemplateDto3 endpoints
  One of the tenant's email templates: the subject and body in use (the defaults until customised) and...
• EnumMetadata
• HmrcAgentDto
  The agent details sent with a submission when the sender is an agent.
• HmrcContactDto
  A person HMRC can contact about a submission.
• HmrcCredentialsTestResultDto2 endpoints
  The outcome of a credentials test against the HMRC gateway.
• HmrcError
• HmrcSettingsDto2 endpoints
  The tenant's HMRC gateway settings for CIS submissions. The gateway password is never returned: hasP...
• HmrcVerificationRequest1 endpoint
  Asks HMRC to verify or match a subcontractor.
• HmrcVerificationRequestDto
  A subcontractor's latest HMRC verification request. Requests are asynchronous: the API submits them ...
• HttpValidationProblemDetails102 endpoints
• InvoiceDto6 endpoints
  An invoice: a purchase invoice received from a supplier or subcontractor (the tenant pays it), or a ...
• InvoiceDtoPagedResult2 endpoints
• InvoiceLineDto
  A line of an invoice: labour or materials.
• InvoicePaymentDto6 endpoints
  A payment recorded against an invoice.
• InvoicingSummaryDto2 endpoints
  A summary of the invoices in one direction, a tenant's or one contact's: count, total, what is still...
• MandateSetupDto1 endpoint
  A started Direct Debit setup: where to send the customer.
• MeDto3 endpoints
  The authenticated user: profile, application roles and the tenants they belong to. The same whicheve...
• MonthAnalysisDto
  One month of invoicing activity, with the month before it for comparison.
• MonthlyReturnDto4 endpoints
  A CIS monthly return (CIS300): the payments made to subcontractors in one tax month (the 6th to the ...
• MonthlyReturnDtoPagedResult1 endpoint
• MonthlyReturnSubmissionDto1 endpoint
  The latest submission of a monthly return to HMRC.
• MyApiKeyDto
  One of the caller's API keys (`GET /me/api-keys`). The key itself is never returned after it is issu...
• MyNewApiKeyDto1 endpoint
  A freshly issued key of the caller's. The key itself is shown this once.
• PaymentDateDto
  The payments made on one date, summarised.
• PaymentDto
  A payment of any invoice of a direction, with the invoice and contact it belongs to.
• PracticeHmrcCredentialsDto3 endpoints
  One of a practice's sets of HMRC gateway credentials: its organisations file with it when their HMRC...
• PracticeMemberDto
  A member of a practice: they reach every organisation it runs.
• PracticeOrganisationSummaryDto1 endpoint
  One of the organisations a practice runs.
• PracticeSummaryDto3 endpoints
  A practice: a group of client organisations whose members reach every one of them.
• ProblemDetails480 endpoints
• PublicCisDetailsRequestDto2 endpoints
  A CIS details request as the subcontractor sees it on the public form, reached through the link in t...
• PublicSdcStatementDto2 endpoints
  An SDC statement as the subcontractor sees it on the public completion page, reached through the lin...
• ReconnectEmailConfigRequest1 endpoint
  Where an Outlook or Gmail sign-in returns to.
• ReconnectEmailConfigResultDto1 endpoint
  Where to send the user to sign in again.
• RegisterMeRequest1 endpoint
  The email address of a caller whose sign-in gave none, to sign them up with.
• RemittanceAdviceDto1 endpoint
  A remittance advice: what the tenant paid one subcontractor between two dates, invoice by invoice, w...
• RemittanceAdvicePaymentDto
  One payment on a remittance advice.
• RemittanceAdviceSettingsDto2 endpoints
  How the tenant's remittance advices are laid out: which columns they show and the custom texts they ...
• RemittanceDeductionSummaryDto
  The deductions on a remittance advice at one CIS rate.
• RenamePracticeRequest1 endpoint
  A practice's new name.
• SdcStatementDto3 endpoints
  A Supervision, Direction and Control (SDC) statement: a questionnaire the tenant sends a subcontract...
• SendCisDetailsRequestEmailRequest1 endpoint
  A request to send the link to the CIS details form again.
• SendEmailRequest3 endpoints
  A request to email a document. Every field is optional: the recipient defaults to the contact's emai...
• SendSdcStatementEmailRequest1 endpoint
  A request to send (or resend) the completion link for a statement.
• SendStatementEmailRequest2 endpoints
  A request to email a statement's PDF. Every field is optional: the recipient defaults to the subcont...
• SetConnectionCounterPartyRequest1 endpoint
  The accepting tenant's side of a connection sent to it.
• SharedHmrcCredentialsDto
  One of the practice's sets a tenant's HMRC settings can point at.
• SignSdcStatementRequest1 endpoint
  The subcontractor's completion of an SDC statement: every question confirmed, their name and their s...
• SkippedHmrcVerificationDto
  A contact a bulk HMRC verification request did not send.
• SodiumPracticeDto
  A SodiumHQ practice the signed-in user belongs to (`GET /me/sodium-practices`).
• StatementDto2 endpoints
  A CIS payment and deduction statement: what one subcontractor was paid and had deducted in one tax m...
• StatementEmailDto2 endpoints
  An email of a statement's PDF to the subcontractor.
• SubcontractorBreakdownRowDto
  One subcontractor's share of a monthly return (a subcontractor paid at two rates in the month appear...
• SubcontractorVerificationDto3 endpoints
  The subcontractor's current CIS verification. On a contact it is read-only: it changes through the c...
• SubmitCisDetailsRequest1 endpoint
  The subcontractor's CIS details, from the public form. What is required depends on the type: a sole ...
• SubmitMonthlyReturnRequest1 endpoint
  The declarations made when submitting a return to HMRC. That the information is correct is always de...
• SubmittedCisDetailsDto
  The CIS details a subcontractor provided in answer to a request, as they entered them.
• SupplierSettingsDto
  Defaults applied to invoices received from a supplier (CIS subcontractors included).
• TenantAddressDto
  A tenant's postal address, in the same parts as a contact's.
• TenantCisDetailsDto2 endpoints
  The tenant's own CIS identity as a subcontractor: what it shares with contractors over a connection ...
• TenantCountsDto
  A tenant's entity counts, maintained by the application as records are created and deleted.
• TenantDto6 endpoints
  A tenant: a CIS Manager organisation the caller is a member of. What the application needs on every ...
• TenantDtoPagedResult1 endpoint
• TenantInvitationDto2 endpoints
  An invitation to join the tenant.
• TenantMemberDto
  A user who is a member of the tenant.
• TenantMembershipDto1 endpoint
  One of the authenticated user's tenant memberships, as reported by `GET /me`.
• TenantSummaryDto
  One of the caller's tenants as the overview page shows them: counts and the returns of this and the ...
• TestEmailConfigRequest1 endpoint
  Where to send a test email.
• TestEmailConfigResultDto1 endpoint
  The outcome of a test email.
• TestHmrcCredentialsRequest1 endpoint
  A request to test a practice's credentials against the HMRC gateway. A submission needs a tenant as ...
• TimesheetImportResultDto1 endpoint
  The outcome of a timesheet import.
• TimesheetImportResultRowDto
  The outcome of importing one selected row.
• TimesheetImportRowDto
  One data row of a timesheet CSV as the analysis sees it: the purchase invoice it would become, or wh...
• TransferOwnershipRequest1 endpoint
  The member to make the tenant's owner.
• UpdateBillingProfileRequest1 endpoint
  The billing address to put on the caller's invoices (`PUT /me/billing/profile`). A full replacement ...
• UpdateContactNoteRequest1 endpoint
  A full replacement of a note's text and date.
• UpdateContactRequest1 endpoint
  Replaces a contact's editable fields, roles included. The code, external id, last SDC date and verif...
• UpdateEmailConfigRequest1 endpoint
  Changes to a connection: a property left out keeps its value.
• UpdateEmailSettingsRequest1 endpoint
  A full replacement of the email settings.
• UpdateEmailTemplateRequest1 endpoint
  A customised subject and body for a template. DELETE the template to go back to the defaults.
• UpdateHmrcSettingsRequest1 endpoint
  A full replacement of the HMRC settings. The password is optional: omitted or null keeps the stored ...
• UpdateInvoiceLineRequest
  A line of an invoice being replaced: with the code of an existing line it updates that line, without...
• UpdateInvoicePaymentRequest2 endpoints
  A full replacement of a payment's date and amount.
• UpdateInvoiceRequest2 endpoints
  A full replacement of an invoice's editable fields and lines. The contact, external id and payments ...
• UpdateMeRequest1 endpoint
  A full replacement of the caller's editable profile fields.
• UpdatePracticeHmrcCredentialsRequest1 endpoint
  A full replacement of a set of practice credentials. The password is optional: omitted or null keeps...
• UpdateRemittanceAdviceSettingsRequest1 endpoint
  A full replacement of the remittance advice settings. A text whose switch is off is discarded.
• UpdateSubcontractorVerificationRequest1 endpoint
  A verification obtained from HMRC outside the API (by phone or through HMRC online services), record...
• UpdateTenantCisDetailsRequest1 endpoint
  A full replacement of the tenant's CIS details.
• UpdateTenantRequest1 endpoint
  A full replacement of the tenant's own details, as the settings page edits them. Counts, the logo, t...
• UpdateWebhookRequest1 endpoint
  A webhook's new name, URL, enabled flag and events. The secret is kept.
• UserInvitationDto1 endpoint
  An invitation to join a tenant, as the invited user sees it. The code is the one in the emailed link...
• VerifyEmailAddressRequest1 endpoint
  The address and key from an emailed verification link.
• WebhookDeliveryDto2 endpoints
  One event sent, or being sent, to a webhook: what was sent, how often it was tried and how the recei...
• WebhookDeliveryDtoPagedResult1 endpoint
• WebhookDto3 endpoints
  One of the tenant's webhooks: an HTTPS URL that is sent the events it subscribes to, each signed wit...
• WebhookDtoPagedResult1 endpoint