API Schemas
Browse all data models and schemas used in the API
- AcceptanceDtoAcceptance information for an engagement
- AccountingLinkResponseA record on Sodium's accounting platform (a customer or an invoice): which platform holds it, its ID...
- AccountingPeriodResponseDtoOne accounting period for an income source.
- ActivateServicesResponse1 endpointResponse from activating proposed services
- AddAmlContactRequest1 endpointRequest to push a Sodium contact to the AML platform. The API looks up all contact fields server-sid...
- AddMtdCustomEmploymentRequest1 endpointAdds a custom employment for a tax year — an employment HMRC do not already hold from the employer's...
- AddMtdSavingsAccountRequest1 endpointRegisters a UK savings account for the client at HMRC. Accounts are registered once rather than per ...
- AddTeamMembersRequest1 endpointRequest DTO for adding members to a team
- AgentAuthorisationCountsDto1 endpointPractice-wide tallies of required agent authorisations, counted across every client rather than one ...
- AgentAuthorisationSummaryClientDtoOne client on the authorisation summary, with an entry per authorisation type its active or proposed...
- AgentAuthorisationSummaryClientDtoPagedResult1 endpoint
- AgentAuthorisationSummaryEntryDtoOne authorisation type a client's services require, and what the practice holds against it.
- AiGenerationRequest1 endpointRequest to generate content using AI based on the specified activity
- AiSettingsDto2 endpointsConfiguration for AI/LLM integration settings at the tenant level. Controls which AI model to use an...
- AiUsageSummaryDto1 endpointSummary of AI usage tokens for a specific date range
- AmendMtdBroughtForwardLossRequest1 endpointChanges a brought forward loss's amount — the only part of a loss HMRC let you change. ...
- AmendMtdCustomEmploymentRequest1 endpointAmends a custom employment — a <strong>full replacement</strong> of its record at HMRC, so every val...
- AmendMtdLossClaimTypeRequest1 endpointChanges an existing loss claim's type — the only part of a claim HMRC let you amend.
- AmendMtdLossClaimsOrderRequest1 endpointReplaces the order in which HMRC apply the year's carry-sideways loss claims. A full re...
- AmlClientDto2 endpoints
- AmlClientDtoPagedResult1 endpoint
- AmlContactDto3 endpointsContact details from the AML platform.
- AmlMailTemplateDtoA mail template configured in the AML platform.
- AmlOnboardingLevelDtoAn onboarding level configured in the AML platform.
- AmlOnboardingUrlResponse1 endpointResponse containing the onboarding URL for a contact.
- AmlRiskAssessmentDto1 endpoint
- AmlRiskAssessmentDtoPagedResult1 endpoint
- ApiKeyDto2 endpointsRepresents an API key for authentication
- ApplyServicePackageRequest1 endpointRequest DTO for applying a service package to a client
- ApplyTimeEntryRateRecalculationRequest1 endpointRe-applies the current rates to the chosen entries from a preview. The rates are worked out again on...
- ApproveTimePaymentRequest1 endpointRequest to approve (or un-approve) time entries for payment to the team members who logged them. Ent...
- AssignClientScheduleRequest1 endpointLinks one client to an existing schedule on a recurring task. The client and task come from the rout...
- AvailableBookkeepingOrganisationDtoAn organisation that could be linked to a client, read live from the bookkeeping-health provider.
- AvailableBooksOrganisationDtoAn organisation that could be linked to a client, read live from the accounting platform.
- AvailableClientDtoA customer/client retrieved from a third-party accounting platform (Xero, QuickBooks, FreeAgent, etc...
- AvailableClientDtoPagedResult1 endpoint
- BackgroundImageDto2 endpointsA background image configured on a design theme for PDF rendering.
- BackgroundImageRequest2 endpointsRequest DTO for creating or updating a background image on a design theme.
- BankHolidayDtoBank holiday information
- BenefitsInKind
- BillClientTimeResultDtoWhat happened to one client in a bulk time-billing run. Clients are billed independently, so a run c...
- BillClientsTimeRequest1 endpointRequest to bill several clients' unbilled time in one run — the whole-book equivalent of billing a s...
- BillForWorkExecutionStateDtoWhat a BillForWork step billed. Read-only: written by the system when the step runs.
- BillForWorkPreviewDto1 endpointWhat a Bill for Work step will bill if it runs now, worked out the way the step itself works it out,...
- BillForWorkStepConfigDtoConfiguration for BillForWork workflow steps: bills the client when the work is done, from the task'...
- BillTimeEntriesRequest1 endpointRequest to convert billable time entries with open WIP into client billing line items. All entries m...
- BillableServiceDto6 endpointsResponse DTO for billable service information
- BillableServiceDtoPagedResult1 endpoint
- BillableServicePricingOptionDtoDTO for billable service pricing option information
- BillableServicePricingOverrideDtoDTO for revenue range-specific pricing overrides
- BillableServicePricingTierDtoDTO for a custom pricing tier defined on a billable service
- BillableServicePricingTierOverrideDtoDTO for a custom tier-specific pricing override
- BillableServiceStageDtoDTO for a user-defined workflow stage on a billable service
- BillingAccountResponse3 endpointsResponse model representing a billing account.
- BillingAddressRepresents a billing address.
- BillingScheduleMonthTotalDtoPlanned billing for one calendar month across the practice: what the schedule expects to promote, at...
- BookkeepingActivityPeriodDtoThe provider's activity figures over one time bucket.
- BookkeepingHealthDto1 endpointEverything the bookkeeping-health provider reports about a client's books — quality and activity, ev...
- BookkeepingQualityPeriodDtoThe provider's quality scoring over one time bucket.
- BooksAgeingContactDtoOne customer's or supplier's share of an ageing side.
- BooksAgeingDto1 endpointA client's debtors and creditors as at one day: what customers owe the client (receivables) and what...
- BooksAgeingSideDtoOne side of the ageing in one currency. Split by currency rather than converted, so amounts in diffe...
- BooksBalanceSheetDto1 endpointA balance sheet over a client's own books, as at one date.
- BooksBankAccountDtoA bank account held in a client's own books.
- BooksBillDtoA bill (purchase invoice) in a client's own books: something the client owes a supplier.
- BooksBillDtoPagedResult1 endpoint
- BooksContactDtoA contact held in a client's own books.
- BooksContactDtoPagedResult1 endpoint
- BooksOutstandingTotalsDto1 endpointWhat customers owe a client and what the client owes suppliers, as two totals from the client's bala...
- BooksProfitAndLossDto1 endpointA profit and loss report over a client's own books.
- BooksProfitAndLossSummaryDtoA platform-reported profit and loss summary.
- BooksReportLineDtoOne line of a report.
- BooksReportSectionDtoOne named group of lines within a report.
- BooksTrialBalanceDto1 endpointA trial balance over a client's own books — one signed balance per nominal account, as the platform ...
- BooksTrialBalanceRowDtoOne account's balance on a trial balance.
- BroughtForwardLoss
- BsasInputs
- BsasMetadata
- BsasSummaryInfo
- BuildingDetails
- BulkApplyServicePackageRequest1 endpointRequest to apply a service package to multiple clients at once
- BulkAssignResult2 endpoints
- BulkAssignServiceRequest1 endpointRequest to assign a billable service to multiple clients at once
- BulkDeleteClientBillingLineItemsRequest1 endpointRequest to delete several of a client's billing line items at once
- BulkDeleteClientDocumentsRequest1 endpointDeletes one or more client documents, including their stored files.
- BulkDeleteContactsRequest1 endpointDeletes one or more contacts. Contacts still linked to a client are skipped.
- BulkDeleteContactsResultDto1 endpointThe result of a bulk contact delete.
- BulkDeleteResult3 endpoints
- BulkDeleteTasksRequest1 endpoint
- BulkRemoveClientServicesRequest1 endpointRequest to remove multiple client service assignments
- BulkRestoreResult1 endpoint
- BulkRestoreTasksRequest1 endpointThe occurrences to restore, as the projected codes (proj-{recurringTaskCode}-{clientCode}-{yyyyMMdd}...
- BulkSendDataFormRequest1 endpointDTO for sending a form to multiple clients
- BulkTrackExternalFilesRequest1 endpointTracks multiple existing external files in Sodium, creating a ClientDocument record for each. No fil...
- BulkUpdateClientServicesRequest1 endpointRequest to update fields across multiple client service assignments. Only provided (non-null) fields...
- BulkUpdateClientsRequest1 endpointRequest to bulk update multiple clients. At least one update field must be provided. For PartnerCode...
- BulkUpdateResult4 endpoints
- BulkUpdateTasksRequest1 endpoint
- BulkUpdateWorkflowStepsRequest1 endpointRequest to bulk-update workflow steps across multiple tasks. At least one of Status or AssignedUserC...
- BusinessDetailsDto3 endpointsBusiness-specific details for clients, including companies and sole traders. Includes UK Companies H...
- ButtonStyleDtoButton styling configuration for a design theme. All properties are nullable - when null, buttons fa...
- CalendarFeedDto2 endpointsThe current user's iCalendar subscription feed.
- CalendarSubscriptionDto4 endpointsOne of the current user's external calendar subscriptions.
- CapitalLosses
- CarryBackLossesDecrease
- CatchUpFeeDtoA client service's catch-up fee (story 2109): a one-off charge for the backlog before the service st...
- CgtPpdOverrides
- CgtResidentialDisposals
- ChangeSubscriptionRequest1 endpointRequest to change a tenant's subscription to a different package. The pricing tier is automatically ...
- ChangeTenantUserRateRequest1 endpointChanges a team member's current rates. When the user has no rate entries yet, one is created. Otherw...
- ChangeWorkTypeRateRequest2 endpointsSets the current rate for a type of work. When the type of work has no rate entries yet (for this te...
- CharitableGifts
- CharitableGivingReliefs
- Charity1 endpoint
- CharitySearchResult
- CharityTrustee
- CharityTrusteeOtherCharity
- ChaseScheduleDtoThe automatic-chase schedule for something the practice is waiting on a client for — a document appr...
- ChecklistDtoWraps the checklist items applied to tasks created from a recurring task template.
- ChecklistItemDto
- ClientAgentAuthorisationDtoRepresents one of the 11 HMRC agent authorisation types for a client
- ClientBillableServiceDto3 endpointsResponse DTO for client billable service information
- ClientBillableServiceDtoPagedResult1 endpoint
- ClientBillableServiceStageDtoStage information for display on a client's billable service
- ClientBillableServiceStageHistoryDtoOne stage change in a client billable service's history, newest first. Powers the time-in-stage view...
- ClientBillableServiceSummaryDtoLightweight projection of a client billable service for kanban board cards. Contains only the fields...
- ClientBillableServiceSummaryDtoPagedResult1 endpoint
- ClientBillingLineItemDto2 endpointsResponse DTO for a billable line item
- ClientBillingLineItemDtoPagedResult2 endpoints
- ClientBillingScheduleItemDto5 endpointsOne planned charge on a client's billing schedule. Amounts are the effective values: the pinned valu...
- ClientBillingScheduleItemDtoPagedResult1 endpoint
- ClientBillingSettingsDto2 endpointsTenant-level settings for recurring client billing and invoicing defaults
- ClientBookkeepingLinkDto2 endpointsThe organisation a client's record is bound to at the practice's bookkeeping-health provider, and th...
- ClientBooksLinkDto2 endpointsThe organisation a client's record is bound to in that client's own accounting software, and the con...
- ClientConfirmationDtoSummary DTO for a client confirmation workflow step
- ClientConfirmationDtoPagedResult1 endpoint
- ClientConfirmationExecutionStateDtoExecution state for a ClientConfirmation workflow step. Read-only - written by the system during ste...
- ClientConfirmationStepConfigDtoConfiguration for ClientConfirmation workflow steps. Email template is configured in ClientPortalSet...
- ClientContactDto4 endpointsResponse DTO for client-contact relationship information
- ClientContactDtoPagedResult1 endpoint
- ClientDateDtoRepresents an important date associated with a client, such as year-end, accounts due date, or VAT r...
- ClientDocumentApprovalDtoThe client's sign-off on a document: whether it was asked for, how it was asked for, who answered an...
- ClientDocumentDto8 endpointsRepresents a document associated with a client, such as letters, engagement letters, proposals, or o...
- ClientDocumentDtoPagedResult2 endpoints
- ClientDocumentFileDtoThe physical file behind a client document — what it is called, what it weighs, where it lives and h...
- ClientDocumentPortalViewResult1 endpointPaginated list of client documents with portal folder navigation, as seen by the client. Used by the...
- ClientDocumentSignatureDtoThe e-signature leg of a document's approval, when the practice sent it to a signing platform instea...
- ClientDocumentVersionDtoOne earlier or current file in a document's version history, as the practice's storage provider keep...
- ClientDto5 endpointsResponse DTO for client information
- ClientDtoPagedResult1 endpoint
- ClientEmailRuleDto3 endpointsA rule that associates emails with a client. The value determines the matching behaviour: email addr...
- ClientEmailRuleDtoPagedResult1 endpoint
- ClientFeeRequestOne client's fee in a bulk billing run
- ClientImportRequestDto1 endpointRequest to import clients from a third-party platform
- ClientInvoiceSubmissionDto1 endpointResponse DTO for an invoice submission
- ClientInvoiceSubmissionDtoPagedResult2 endpoints
- ClientLinkDto3 endpointsResponse DTO for client link information
- ClientLinkDtoPagedResult1 endpoint
- ClientPipelineDto3 endpointsResponse DTO for a client's placement on a sales pipeline (a kanban card).
- ClientPipelineDtoPagedResult1 endpoint
- ClientPipelineSummaryDtoLightweight projection of a client pipeline card for kanban board display. Reuses SodiumHQ.DTOs.Clie...
- ClientPipelineSummaryDtoPagedResult1 endpoint
- ClientPortalSettingsDto2 endpointsClient portal settings for the tenant
- ClientPreviewDataFormRequest1 endpointRequest to create a client-context preview link for a data form.
- ClientRefDtoA reference to a client from another record: its code and name plus the logo that identifies it visu...
- ClientRequestSettingsDto2 endpointsClient request and chasing settings for the tenant
- ClientResponsivenessReportDto1 endpointThe Client Responsiveness report: how fast clients answer the client-facing steps we send them (conf...
- ClientResponsivenessRowDtoOne row of the Client Responsiveness breakdown table.
- ClientResponsivenessRowDtoPagedResult
- ClientResponsivenessSummaryDtoHeadline KPIs for the Client Responsiveness report.
- ClientServiceReferenceIdentifies a specific ClientBillableService assignment by its client code and service assignment cod...
- ClientSettingsDto2 endpointsTenant-level configuration for client field visibility and behavior
- ClientThirdPartyMappingDto1 endpointLightweight DTO for viewing client third-party platform mappings
- ClientThirdPartyMappingDtoPagedResult1 endpoint
- CodeAndNameDto2 endpoints
- CodeAndNameDtoPagedResult1 endpoint
- CompaniesHouseAddress
- CompaniesHouseDateOfBirth
- CompaniesHouseNameElements
- CompaniesHousePsc
- Company1 endpoint
- CompanyAddress
- CompanyDetailsDtoCompany registration and filing details (Companies House)
- CompanySearchResponse1 endpoint
- CompanySearchResult
- CompleteMandateSetupRequest1 endpointRequest model for completing a GoCardless Direct Debit mandate setup after the user has authorised t...
- ConditionDtoA conditional-visibility rule shared by data form sections/questions and workflow groups/steps: the ...
- ConfirmCsvImportRequest1 endpointRequest to confirm column mapping configuration and start a CSV import job. Used after uploading a C...
- ConnectHmrcRequest1 endpointRequest to start the HMRC consent journey.
- ConnectionCredentialsResponse1 endpointResponse containing OAuth credentials for a connection
- ConnectionFolderDto1 endpointA folder available in a document storage connection. Returned by the list-folders endpoint used to d...
- ContactClientLinkDtoA client a contact is linked to, with the contact's role on it.
- ContactCsvExportFilterDtoFilters for selecting which contacts to export.
- ContactCsvExportRequestDto1 endpointRequest to start a CSV export of contacts. Without filters every contact is exported.
- ContactDto4 endpointsRepresents a person or contact within the tenant's organization. Contacts can be associated with one...
- ContactDtoPagedResult1 endpoint
- ContactMatchDtoOne existing contact that might be the same person, and how sure we are.
- ContactMatchResultDtoThe existing contacts that might be one person from a match request.
- ContactMergeBlockerDtoA reason the contacts cannot be merged.
- ContactMergeClientDtoWhat happens to a client the contacts are linked to.
- ContactMergeContactDtoA contact taking part in a merge.
- ContactMergeFieldDtoA single-value field across the contacts.
- ContactMergeFieldValueDtoOne contact's value for a field.
- ContactMergePortalAccessDtoWhat happens to the active portal login.
- ContactMergePreviewDto1 endpointWhat merging contacts into a kept contact would produce. Nothing is changed.
- ContactMergeSharedValueDtoAn email address or phone number and the contacts that hold it.
- ContactMergeWarningDtoSomething worth checking before merging.
- ContactPreferencesDtoContact preferences for a client
- ContentBlockCollectionCollection of content block references. Generic wrapper that can be reused for any list of content b...
- ContentBlockDto5 endpointsDTO for content blocks, exposing only codes and structured data (never DB IDs).
- ContentBlockDtoPagedResult1 endpoint
- ContentBlockReferenceGeneric container for passing dynamic content blocks with variables and metadata to templates. This ...
- ConversationClientAssociationDto1 endpointA client associated with a conversation
- ConversationClientSuggestionDtoA suggested client to associate with a conversation, based on matching participant emails
- ConversationWithAssociationsDto1 endpointA conversation's messages enriched with client associations derived from email rules.
- ConvertFormFieldWarningA warning about a field that could not be automatically mapped during conversion
- ConvertFormFileRequest1 endpointRequest to convert an external form definition file into the Sodium import format. The raw file cont...
- ConvertFormFileResponse1 endpointResult of converting an external form definition file into the Sodium import format
- CostProfitReportDto1 endpointThe Cost & Profit report: what tracked time cost the practice over a period, what the billable porti...
- CostProfitRowDtoOne group's row on the Cost & Profit report — a team member or a client
- CostProfitRowDtoPagedResult
- CostProfitSummaryDtoHeadline aggregates for the Cost & Profit report
- CreateAdHocChargeRequest1 endpointRequest to add a one-off charge to a client's billing schedule. It bills on the given date like any ...
- CreateAmlClientRequest1 endpoint
- CreateAmlContactRequest
- CreateApiKeyRequest1 endpointRequest to create a new API key. Leave the scope fields empty for a normal key that fully impersonat...
- CreateBillableServiceRequest1 endpointRequest DTO for creating a new billable service
- CreateCalendarSubscriptionRequest1 endpointRequest to subscribe to an external calendar by ICS URL. The URL is validated by fetching it, so a b...
- CreateClientBillableServiceRequest1 endpointRequest DTO for creating a new client billable service assignment
- CreateClientBillingLineItemRequest1 endpointRequest to manually create a billing line item for a client
- CreateClientContactRequest1 endpointRequest DTO for creating a new client-contact relationship
- CreateClientDocumentFromTemplateRequest1 endpointRequest to generate a PDF document from a template and save it as a client document.
- CreateClientEmailRuleRequest1 endpointRequest to create a new email rule for a client. Provide an email address (e.g. "john@acme.com") to ...
- CreateClientLinkRequest1 endpointRequest DTO for creating a new client link
- CreateClientNoteRequest1 endpointRequest DTO for creating a new client note
- CreateClientPipelineRequest1 endpointRequest DTO for placing a client on a sales pipeline (creating a card)
- CreateClientRequest1 endpointRequest DTO for creating a new client
- CreateContactRequest1 endpointDTO for creating a contact
- CreateContentBlockRequest1 endpointRequest to create a new reusable content block that can be included in document templates. Content b...
- CreateCsvMappingRequest1 endpointRequest to create a new reusable CSV mapping. Saved mappings can be referenced by code in future imp...
- CreateCustomFieldDefinitionRequest1 endpoint
- CreateCustomFieldGroupRequest1 endpoint
- CreateCustomTokenRequest1 endpointDTO for creating a custom token
- CreateCustomerRequest1 endpointDTO for creating a customer in an accounting platform
- CreateDataFormCategoryRequest1 endpointDTO for creating a form category
- CreateDataFormPreviewTokenResult1 endpoint
- CreateDataFormRequest1 endpointDTO for creating or updating a form (whole-form save including sections and questions)
- CreateDesignThemeRequest1 endpointRequest to create a new design theme for document styling
- CreateDocumentCategoryRequest1 endpointDTO for creating a document category
- CreateDocumentRequestRequest1 endpointRequest DTO for creating a new document request
- CreateDocumentTemplateRequest1 endpointRequest to create a new document template that can generate documents using Liquid syntax. Templates...
- CreateDraftResponse1 endpointResponse after creating a new mailbox draft.
- CreateEmailBroadcastRequest1 endpointRequest to create a draft email broadcast. Provide either a ContentBlockCode or inline SubjectLine +...
- CreateEmailConfigRequest1 endpointRequest DTO for creating a new email configuration
- CreateEngagementRequest1 endpointRequest DTO for creating a new engagement
- CreateExternalFolderRequest1 endpointRequest to create a new folder in the client's external storage provider.
- CreateHmrcAgentCredentialRequest1 endpointAdds a credential set. The practice's first set becomes the default.
- CreateMailboxDraftRequest1 endpointRequest to create a mailbox draft, extending the email service contract with practice document attac...
- CreateMailboxShareRuleRequest1 endpointRequest to add a share or exclusion rule to a mailbox configuration. Creating a rule that already ex...
- CreateMtdBroughtForwardLossRequest1 endpointRecords a loss the client carries forward from a year before Making Tax Digital (to 2025-26). ...
- CreateMtdLossClaimRequest1 endpointClaims a loss (to 2025-26). HMRC accept nothing until the income source's accounting period has ende...
- CreateOnboardingReportRequest1 endpointRequest to create an onboarding report for a contact in the AML platform.
- CreateOnboardingTaskTemplateRequest1 endpointRequest DTO for creating a new onboarding task template
- CreatePipelineOnboardingTaskTemplateRequest1 endpointRequest DTO for creating a new pipeline intake task template
- CreatePipelineRequest1 endpointRequest DTO for creating a new sales pipeline
- CreateProfessionalClearanceRequestItemRequest1 endpointDTO for creating a professional clearance request item
- CreateRecurringTaskItemRequest1 endpointRequest DTO for creating a new recurring task template
- CreateRevenueRangeRequest1 endpointDTO for creating a revenue range
- CreateRiskAssessmentRequest1 endpointRequest to create a new risk assessment in the AML platform.
- CreateRoleRequest1 endpointRequest to create a custom role.
- CreateSavedClientFilterRequest1 endpointRequest model for creating a new saved client filter
- CreateSavedTaskFilterRequest1 endpointRequest model for creating a new saved task filter
- CreateServiceCategoryRequest1 endpointDTO for creating a service category
- CreateServicePackageItemRequestRequest DTO for a service to include in a service package
- CreateServicePackageRequest1 endpointRequest DTO for creating a new service package
- CreateTaskCategoryRequest1 endpointDTO for creating a task category
- CreateTaskItemNoteRequest2 endpointsRequest DTO for creating a new task item note
- CreateTaskItemRequest1 endpointRequest model for creating a new task
- CreateTaskTemplateRequest1 endpointRequest DTO for creating a new one-off task template
- CreateTeamRequest1 endpointRequest DTO for creating a team
- CreateTenantHolidayRequest1 endpointRequest to create a tenant-specific holiday
- CreateTenantUserRequest1 endpointDTO for creating a user within a tenant. Inherits update fields and adds email/name for creation.
- CreateThirdPartyConnectionRequest1 endpointRequest for creating a new ThirdPartyConnection
- CreateTimeEntryRequest1 endpointRequest to create a time entry
- CreateUserNoteRequest1 endpointRequest DTO for creating one of the caller's own notes
- CreateWorkflowRequest1 endpointRequest to create a new workflow
- CreateWorkingPatternRequest1 endpointRequest to create a working pattern. Days left unset expect no time, which is how a pattern says "th...
- CreateWriteOffReasonRequest1 endpointRequest to create a write-off reason
- CreatedClientBillingLineItemDto1 endpointThe line item a create returned, with the outcome of invoicing it when the request asked for that. A...
- CryptoassetDisposal
- CsvColumnMappingDtoRepresents a single column mapping from a CSV header to a client field. Used in column mapping confi...
- CsvExportFilterDtoFilter criteria for selecting which clients to export. Matches the same filters available on the cli...
- CsvExportJobDto9 endpointsRepresents the current status and progress of a CSV export job. Returned when starting an export or ...
- CsvExportRequestDto1 endpointRequest to start a CSV export of clients. Specify column mappings and optional filter criteria to co...
- CsvImportJobDto4 endpointsRepresents the current status and progress of a CSV import job. Returned when starting an import or ...
- CsvMappingDto3 endpointsRepresents a saved CSV mapping configuration. Mappings define how CSV columns map to client fields a...
- CsvMappingDtoPagedResult1 endpoint
- CsvUploadResponseDto1 endpointResponse from uploading a CSV file with showPreview=true. Contains a preview of the CSV data and aut...
- CumulativeDisallowableExpenses
- CumulativeExpenses
- CumulativeIncome
- CumulativePeriodDates
- CurrencyMetadata
- CurrentAnnouncementDto1 endpointThe currently active platform announcement banner, as shown to all users in the web app.
- CurrentUserResponse1 endpointResponse DTO for the current authenticated user
- CustomFieldDefinitionDto3 endpointsDefines a custom field that can be attached to entities such as clients. Custom fields allow tenants...
- CustomFieldDefinitionDtoPagedResult1 endpoint
- CustomFieldGroupDto3 endpointsA named group for organising custom field definitions. Each group renders as its own card on the ent...
- CustomFieldGroupDtoPagedResult1 endpoint
- CustomFieldValueDtoA custom field value for a client. Use the custom field definitions endpoint to retrieve data types,...
- CustomTokenDto3 endpointsA user-defined custom token for document templates
- CustomTokenDtoPagedResult1 endpoint
- CustomerDto2 endpointsCustomer data retrieved from third-party accounting platforms (Xero, QuickBooks, FreeAgent, etc.). R...
- DashboardPinnedNoteDtoA client or task note pinned to the dashboard, with the entity it belongs to so the dashboard can la...
- DataFormAnswerDtoAn individual answer to a form question
- DataFormCategoryDto3 endpointsA grouping used to classify forms
- DataFormCategoryDtoPagedResult1 endpoint
- DataFormDto6 endpointsA custom form definition (list view)
- DataFormDtoPagedResult1 endpoint
- DataFormPreviewDto1 endpointPreview of a form as the client would see it (sections + questions, no internal metadata)
- DataFormPreviewQuestionDto
- DataFormPreviewSectionDto
- DataFormQuestionDtoA question within a form section
- DataFormRequestDto8 endpointsA form request sent to a client
- DataFormRequestDtoPagedResult1 endpoint
- DataFormSectionDtoA section within a form
- DeadlineComplianceReportDto1 endpointThe Deadline Compliance report: which deadlines did we miss, and which are we about to? The cohort i...
- DeadlineComplianceRowDtoOne row of the Deadline Compliance breakdown table.
- DeadlineComplianceRowDtoPagedResult
- DeadlineComplianceSummaryDtoHeadline KPIs for the Deadline Compliance report. Every cohort task lands in exactly one of Met / La...
- DesignThemeDto4 endpointsComplete visual styling and branding configuration for generated documents (proposals, engagement le...
- DesignThemeDtoPagedResult1 endpoint
- DetectedAssigneeDtoA distinct assignee name found in a foreign task export
- DetectedProgressValueDtoA distinct task progress value found in a foreign task export
- DetectedServiceDtoA service detected from the CSV headers during analysis
- DirectDebitSettingsDto2 endpointsTenant-level configuration for direct debit request behavior and email settings. Controls how direct...
- DirectorshipDividend
- DividendGross
- DividendsIncome
- DocumentActionResultDtoThe outcome of a bulk action on a single document within a batch.
- DocumentApprovalBatchDto2 endpointsA group of client documents sent for approval together and decided with a single approve or reject a...
- DocumentApprovalExecutionStateDtoExecution state for a DocumentApproval workflow step. Contains information about the document sent f...
- DocumentApprovalStepConfigDtoConfiguration for DocumentApproval workflow steps. Used for both workflow template definition and ta...
- DocumentBulkActionResultDto3 endpointsThe result of a bulk document action. Documents are handled independently, so a batch can contain a ...
- DocumentCategoryDto3 endpointsA tenant-defined grouping used to classify client documents
- DocumentCategoryDtoPagedResult1 endpoint
- DocumentMoveResultDtoThe outcome of moving a single document within a batch move.
- DocumentRequestDetailDto1 endpointDetailed response DTO for a document request, including documents and responses
- DocumentRequestDto6 endpointsResponse DTO for a document request
- DocumentRequestDtoPagedResult2 endpoints
- DocumentRequestExecutionStateDtoExecution state for a DocumentRequest workflow step. Contains information about the created document...
- DocumentRequestResponseDto2 endpointsResponse DTO for a document request submission/response
- DocumentRequestStepConfigDtoConfiguration for DocumentRequest workflow steps. Used for both workflow template definition and tas...
- DocumentTemplateDto6 endpointsReusable document template for generating HTML documents such as proposals, engagement letters, repo...
- DocumentTemplateDtoPagedResult1 endpoint
- DocumentTemplateTokenInfoInformation about a token found in a document template, including metadata from custom token definit...
- DocumentUploadBatchResultDto1 endpointThe result of a batch document upload. Files are uploaded independently, so a batch can contain a mi...
- DocumentUploadExecutionStateDtoExecution state for a DocumentUpload workflow step. Contains information about the uploaded document...
- DocumentUploadResultDtoThe outcome of uploading a single file within a batch upload.
- DocumentUploadStepConfigDtoConfiguration for DocumentUpload (Upload a Document) workflow steps. Used for both workflow template...
- DraftOperationResponse3 endpointsResponse shared by the update/send/delete draft endpoints — all three are a single provider call wit...
- DueDateConfigDtoConfiguration for the projected DueDate on tasks created from a recurring task. Different properties...
- EmailAttachmentDtoEmail attachment DTO
- EmailAttachmentInfoDtoEmail attachment information DTO (for responses)
- EmailBroadcastAudienceRequest1 endpointThe client-selection part of an email broadcast, used to summarise the audience before a draft exist...
- EmailBroadcastAudienceSummaryDto1 endpointSummary counts for an email broadcast audience: how many clients the selection resolves to, and how ...
- EmailBroadcastDto6 endpointsAn email broadcast: an ad-hoc mass email to a filtered set of clients with per-client Liquid token r...
- EmailBroadcastDtoPagedResult1 endpoint
- EmailBroadcastFilterDtoFilter criteria for selecting which clients receive an email broadcast. Same wire shape as the CSV e...
- EmailBroadcastPreviewDto1 endpointPreview of a broadcast email rendered for a specific sample client, with resolved recipients. Return...
- EmailBroadcastRecipientDtoA single client within an email broadcast with its resolved recipients and delivery status. Before s...
- EmailBroadcastRecipientDtoPagedResult1 endpoint
- EmailConfigDto3 endpointsResponse DTO for an email configuration
- EmailConfigDtoPagedResult1 endpoint
- EmailExecutionStateDtoExecution state for a SendEmail workflow step. Contains information about the sent email after execu...
- EmailPreviewRecipientDtoA resolved email recipient for preview display.
- EmailRecipient
- EmailRecipientConfig1 endpointConfiguration for resolving email recipients from client contacts, user roles, and static addresses....
- EmailRecipientDtoEmail recipient DTO
- EmailSettingsDto2 endpointsTenant-level configuration for outbound email branding and sender information. Controls the visual a...
- EmailStepConfigDtoConfiguration for SendEmail workflow steps. Used for both workflow template definition and task work...
- EmailSummaryDtoLightweight email summary for list responses
- EmploymentDeductionItem
- EmploymentDeductions
- EmploymentDetails
- EmploymentEmployer
- EmploymentFinancialDetail
- EmploymentFinancialDetails
- EmploymentListItem
- EmploymentLumpSums
- EmploymentPay
- EmploymentPayInput
- EmploymentsList
- EngagementAcceptanceUrlDto1 endpointThe client portal URL at which an engagement's acceptance flow is hosted.
- EngagementDto3 endpointsResponse DTO for engagement information
- EngagementDtoPagedResult1 endpoint
- EngagementEmailDtoRepresents an email sent for an engagement
- EngagementSettingsDataFormDtoA form presented as a step in the proposal acceptance flow.
- EngagementSettingsDto2 endpointsTenant-level configuration for engagement behavior, branding, and notification settings. Controls ho...
- EngagementSummaryDto1 endpointSummary of engagements grouped by status, including counts and total values
- EnumMetadata
- ExecuteWorkflowStepRequest1 endpointOptional request body for executing a workflow step. For document steps: provide documentCodes to li...
- ExpectedTimeDayDtoOne day's expectation within an expected-time window
- ExpectedTimeDto1 endpointWhat a team member's working pattern expects of them over a date window, day by day. Backs the Time ...
- ExternalCalendarEventDtoOne concrete occurrence from an external calendar subscription, with recurrences already expanded an...
- ExternalDocumentDtoA file from the external storage provider, enriched with metadata from our DB when the file is track...
- ExternalDocumentDtoPagedResult1 endpoint
- ExternalFileMoveResultDtoThe outcome of moving a single file within a batch move.
- ExternalFolderReferenceDto4 endpointsDTO for an external folder reference
- ExternalMailboxEmailDetailResponse1 endpointFull email detail response with body content fetched on-demand from the provider
- ExternalMailboxEmailSummaryDtoSummary DTO for a mailbox email (used in list views)
- ExternalMailboxEmailSummaryDtoPagedResult1 endpoint
- ExternalMailboxFolderDtoOne folder (Outlook) or label (Gmail) belonging to a mailbox configuration. Returned by the tenant-s...
- ExternalProposalDto1 endpointA proposal from an external platform (Socket, etc.)
- ExternalProposalDtoPagedResult1 endpoint
- ExternalProposalLineDtoA line item on an external proposal
- FilingCreditBalanceDto1 endpointThe practice's spendable filing credit balance.
- FilingHistoryAnnotation
- FilingHistoryAssociatedFiling
- FilingHistoryDocument
- FilingHistoryItem1 endpoint
- FilingHistoryItemPagedResult1 endpoint
- FilingHistoryResolution
- FontSettingsDtoTypography settings for a specific text element (headings, body, tables, etc.) in a design theme. De...
- ForeignDividendItem
- ForeignIncomeTaxCreditRelief
- ForeignInterestItem
- ForeignPropertyAnnualAdjustments
- ForeignPropertyAnnualAllowances
- ForeignPropertyAnnualEntry
- ForeignPropertyAnnualSubmission
- ForeignPropertyBsas
- ForeignPropertyBsasAdditions
- ForeignPropertyBsasAdjustmentEntry
- ForeignPropertyBsasAdjustments
- ForeignPropertyBsasCalculation
- ForeignPropertyBsasCountryDetail
- ForeignPropertyBsasDeductions
- ForeignPropertyBsasExpenses
- ForeignPropertyBsasIncome
- ForeignPropertyBsasPropertyDetail
- ForeignPropertyCumulativeSummary
- ForeignPropertyExpenses
- ForeignPropertyFigureInputs
- ForeignPropertyIncome
- ForeignPropertyPeriodEntry
- ForeignPropertyRentIncome
- ForeignReliefs
- GenerateBillableServiceRequest1 endpointRequest to generate a BillableService using AI
- GenerateWorkflowRequest1 endpointRequest to generate a Workflow using AI
- GetMessageResponse1 endpointResponse for get message request containing full message details
- GiftAidPayments
- HmrcAgentCredentialDto4 endpointsOne set of HMRC agent details: a Government Gateway login with the ARN, agent codes and agent contac...
- HmrcAgentCredentialDtoPagedResult1 endpoint
- HmrcAgentCredentialOptionDtoA credential set as the request dialog lists it: enough to choose one, nothing more.
- HmrcBatchRequestError
- HmrcBatchRequestResult1 endpoint
- HmrcConnectResponseDto1 endpointResponse to starting the HMRC consent journey.
- HmrcConnectionStatusDto1 endpointThe practice's HMRC connection status.
- HmrcInvitationDetailsDtoDetails of an HMRC digital authorisation invitation
- HttpValidationProblemDetails76 endpoints
- IResult
- ImageAssetDto3 endpointsData transfer object for image asset details
- ImageAssetDtoPagedResult1 endpoint
- ImportBillableServicesFromLibraryRequest1 endpointRequest DTO for importing one or more billable services from the library
- ImportFromLibraryRequest3 endpointsRequest body for single-item library imports (Workflow, DocumentTemplate, DataForm). Optional — empt...
- ImportJobClientDtoThe outcome of a single client within an import job, including why it failed
- ImportJobClientDtoPagedResult1 endpoint
- ImportJobDto4 endpointsDTO representing an import job status
- ImportPipelinesFromLibraryRequest1 endpointRequest to import one or more pipelines from the library
- ImportTaskTemplatesFromLibraryRequest1 endpointRequest DTO for importing one or more one-off task templates from the library
- ImportWorkflowsFromLibraryRequest1 endpointRequest DTO for importing one or more workflows from the library in a single call.
- InitializeWorkflowStepsRequest1 endpointRequest DTO for initializing or re-initializing workflow steps for a TaskItem. Used when a workflow ...
- InitiateMandateSetupRequest1 endpointRequest model for initiating a GoCardless Direct Debit mandate setup.
- InvestmentReliefs
- InvestmentSubscription
- InvitationDetailsResponseResponse containing details about an invitation
- InviteCodeDtoRepresents an invite code used to create new tenants in the system. Invite codes are generated by Su...
- InvoiceClientBillingLineItemsRequest1 endpointRequest to invoice several of a client's billing line items now, together on one invoice
- InvoiceDtoInvoice data retrieved from third-party accounting platforms (Xero, QuickBooks, FreeAgent, etc.). Us...
- InvoiceDtoPagedResult2 endpoints
- InvoiceLineItemResponseResponse model representing a single line item on an invoice.
- InvoiceRecipientRepresents an additional invoice recipient.
- InvoiceResponse1 endpointResponse model representing an invoice with its line items.
- InvoiceSubmissionResult3 endpoints
- InvoiceSummaryResponseSummary response model for listing invoices (without line items).
- InvoiceSummaryResponsePagedResult1 endpoint
- KanbanStageCountDtoPer-stage card count for a kanban board, including the stage's display settings. One row per stage o...
- KanbanTaskDtoLightweight task summary for kanban board cards
- LateAccountingDateRuleDtoThe late accounting date rule (LADR) election HMRC hold for one self-employment income source and ta...
- LateAccountingDateRuleResponse
- LibraryPipelineImportItemA single library pipeline to import, with its code and optional overrides
- LibraryServiceImportItemA single library service to import, with its code and optional overrides
- LibraryTaskTemplateImportItemA single library task template to import
- LibraryWorkflowImportItemA single library workflow to import, with its code and optional name suffix.
- LifetimeAllowances
- LinkClientBookkeepingRequest1 endpointBinds a client to one organisation at the practice's bookkeeping-health provider.
- LinkClientBooksRequest1 endpointBinds a client to one organisation in their own accounting software, reached through an existing con...
- LinkConversationClientRequest1 endpointRequest to link a client to a conversation
- LinkConversationTaskRequest1 endpointRequest to link a task to a conversation
- LinkedWorkflowStepDtoA workflow step linked from a time entry or running timer. Steps have no public code — they are iden...
- ListEmailsResponse1 endpointPaginated response for listing emails
- LocaleMetadata
- LossCarryBack
- LossCarryForward
- LossCarrySideways
- LossClaim
- LossClaimOrderItem
- LossClaims
- LossPreferenceOrder
- LossesAndClaims
- LossesBroughtForward
- LumpSumAmount
- MailboxAttachmentDtoAttachment metadata from the provider
- MailboxShareRuleDto1 endpointOne share rule on a mailbox configuration.
- MailboxThreadSummaryDtoSummary DTO for a mailbox conversation (one entry per conversation in list views)
- MailboxThreadSummaryDtoPagedResult3 endpoints
- MailingListSubscriptionDto
- MaintenancePayment
- MandateDto1 endpointResponse DTO for a direct debit mandate
- MandateSetupResponse1 endpointResponse model returned when initiating a GoCardless mandate setup. Contains the URL to redirect the...
- MandateSummaryResponseSummary of the active or most recent payment mandate for a billing account.
- MapExternalClientRequest1 endpointRequest to manually map an external platform client to an existing Sodium client
- MarginsDtoPage margin configuration for generated documents. All measurements are in millimeters.
- MarkNotificationsSeenRequest1 endpoint
- MatchContactsPersonRequestOne person to look for among the practice's existing contacts.
- MatchContactsRequest1 endpointRequest DTO for asking which of a batch of people the practice already holds as contacts.
- MaterialiseProjectedTaskRequest1 endpointRequest to materialise a projected task into a saved task
- MergeContactRequest1 endpointRequest to merge contacts into this (kept) contact.
- MoveDocumentsToPortalFolderRequest1 endpointMoves one or more documents to a different folder in the client portal. This only changes where the ...
- MoveDocumentsToPortalFolderResultDto1 endpointThe result of a batch portal folder move. Documents are moved independently, so a batch can contain ...
- MoveExternalFilesRequest1 endpointMoves one or more files into a different folder in the practice's external storage provider. This ph...
- MoveExternalFilesResultDto1 endpointThe result of a batch file move. Files are moved independently, so a batch can contain a mix of succ...
- MoveMailboxConversationRequest1 endpointRequest to move a conversation's messages from one folder of a mailbox to another
- MoveMailboxMessagesResponse1 endpointResponse from the move-messages endpoint. Same success/failure shape as Sodium.EmailService.Contract...
- MtdAdjustableSummaryDetailDto1 endpointOne retrieved adjustable summary in full: the figures as submitted, the adjustments made to them, an...
- MtdAdjustableSummaryDtoAn adjustable summary (BSAS) HMRC have generated for one income source — the accounting result of ev...
- MtdAnnualSubmissionDto1 endpointThe year-end annual submission HMRC currently holds for one income source and tax year — the adjustm...
- MtdBroughtForwardLossDto1 endpointOne loss brought forward from a year before Making Tax Digital (to 2025-26).
- MtdBusinessDetailsDto1 endpointOne MTD income source in detail, with its accounting periods and quarterly reporting choice.
- MtdBusinessYearConfigDto1 endpointThe per-tax-year configuration HMRC hold for one income source: the accounting basis, the periods of...
- MtdCgtPpdOverridesDto1 endpointThe residential property disposals HMRC hold for a client and tax year from their own 'Report and pa...
- MtdCgtResidentialDisposalsDtoThe UK residential property disposals HMRC hold for a client and tax year, as reported for Self Asse...
- MtdCharitableGivingDtoThe charitable giving reliefs HMRC hold for a client and tax year: gift aid payments and gifts of sh...
- MtdDirectorshipDividendDto1 endpointThe additional directorship and dividend information HMRC hold against one of the client's employmen...
- MtdDividendsIncomeDtoThe foreign and special dividends HMRC hold for a client and tax year: dividends from foreign compan...
- MtdEmploymentCreatedDto1 endpointThe employment HMRC created, with the identifier they issued for it.
- MtdEmploymentDetailDto1 endpointOne employment in full: HMRC's record of it, the financial details held against it, and who last cha...
- MtdEmploymentDtoOne employment in the year's list.
- MtdEmploymentsDtoThe employments HMRC know for a client and tax year, and the employment income that belongs to no si...
- MtdFigureMappingDto2 endpointsThe practice's remembered spreadsheet mapping for MTD quarterly-update imports: their own category l...
- MtdFigureTargetDtoOne box a nominal account's figures can be mapped into, derived from the MTD figure models rather th...
- MtdForeignPropertiesDto1 endpointThe foreign properties HMRC hold registered against one foreign property income source for a tax yea...
- MtdForeignPropertyCreatedDto1 endpointWhat registering a foreign property returns: the identifier HMRC issued.
- MtdForeignPropertyDtoOne registered foreign property, with who registered or last changed it from Sodium.
- MtdForeignReliefsDtoThe foreign tax reliefs HMRC hold for a client and tax year.
- MtdHeldPositionDto1 endpointThe cumulative position HMRC currently holds for one income source and tax year — whichever software...
- MtdIncomeSourceDtoOne income source for a tax year, with its deadlines.
- MtdIncomeSourcesDto1 endpointA client's MTD income sources with every deadline HMRC expects of them, and their tax return deadlin...
- MtdInvestmentReliefsDtoThe investment reliefs HMRC hold for a client and tax year: venture capital trust, enterprise invest...
- MtdLossClaimDto1 endpointOne loss claim — what HMRC are being asked to do with a loss (to 2025-26).
- MtdLossCreatedDto2 endpointsWhat creating a loss or a claim returns: the identifier HMRC issued.
- MtdLossesAndClaimsDtoOne income source's losses and claims for a tax year from 2026-27 onwards — the whole position as a ...
- MtdLossesDto1 endpointA client's losses and loss claims for one tax year, in whichever of HMRC's two shapes that year uses...
- MtdMappedFiguresDto1 endpointA draft set of figures read from the client's books for the cumulative period, ready for review in t...
- MtdMappedLineDtoOne account's figure as it landed in a box.
- MtdNominalMappingDto2 endpointsA client's chart-of-accounts mapping for one MTD business — either the stored one or, before anythin...
- MtdNominalMappingEntryDtoOne nominal account's place in a quarterly update.
- MtdNominalMappingStatusDto1 endpointWhether one client's books can feed their figures — the per-business badges on the MTD panel, in one...
- MtdNominalMappingSummaryDtoA stored mapping in the one line the MTD panel's badge needs.
- MtdNonPayeEmploymentDtoThe non-PAYE employment income HMRC hold for a client and tax year — tips received outside PAYE.
- MtdObligationPeriodDtoA single obligation period and its deadline.
- MtdOtherCapitalGainsDtoThe capital gains HMRC hold for a client and tax year other than UK residential property: listed and...
- MtdOtherEmploymentIncomeDtoThe other employment income HMRC hold for a client and tax year: share options, shares awarded or re...
- MtdOtherIncomeDto1 endpointEverything HMRC hold for a client's tax year outside their trading income: dividends, savings, emplo...
- MtdOtherReliefsDtoThe other reliefs HMRC hold for a client and tax year: non-deductible loan interest, payroll giving,...
- MtdOtherSavingsDtoThe savings income HMRC hold for a client and tax year that does not belong to a named account: inte...
- MtdPensionsReliefsDtoThe pension contribution reliefs HMRC hold for a client and tax year.
- MtdPeriodTypeReceiptDto1 endpointThe result of electing a quarterly period type with HMRC. MTD issues no receipt — the correlation id...
- MtdQuarterlySubmissionDto3 endpointsAn MTD Income Tax quarterly update the practice has prepared or sent for one income source. Figures ...
- MtdReliefsDtoEvery relief HMRC hold for a client and tax year, in one read. HMRC split reliefs acros...
- MtdSavingsAccountCreatedDto1 endpointThe account HMRC created, with the identifier they issued for it.
- MtdSavingsAccountDtoOne UK savings account, with whatever interest HMRC hold against it for the year.
- MtdSavingsAccountsDtoThe client's UK savings accounts and the interest reported against each for one tax year. ...
- MtdStudentLoanBenefitDto1 endpointThe payrolled benefits that affect student loan repayments, as HMRC hold them for one of a client's ...
- MtdSubmissionReceiptDto27 endpointsThe result of a year-end write to HMRC — an annual submission, an adjustment, or an other-income res...
- MtdSubmissionStampDtoA record of one year-end submission Sodium sent to HMRC, or one it deleted. HMRC cannot answer who s...
- MtdTaxCalculationDto1 endpointHMRC's tax calculation for a client's year, run after a quarterly update was accepted — the estimate...
- MtdTaxLiabilityAdjustmentsDto1 endpointThe tax liability adjustments HMRC hold for a client's tax year: what a carry-back loss claim is wor...
- MtdTaxReturnCalculationDto1 endpointWhat triggering a tax return calculation returns: the calculation HMRC started.
- MtdTaxReturnDto1 endpointEverything a practice has to look at before sending a client's tax return: every income source's obl...
- MtdTaxReturnSubmissionDto2 endpointsA tax return sent to HMRC from Sodium, for the filing history on a client's year. ⚠ A s...
- MtdTriggeredSummaryDto1 endpointThe result of asking HMRC for a new adjustable summary. The identifier is what the practice retrieve...
- MtdUkDividendsDtoThe plain UK dividends HMRC hold for a client and tax year — dividends from UK companies and other U...
- MtdUnmappableLineDtoA figure that can never be mapped, because the books report it with no key at all.
- MtdUnmappedLineDtoAn account with figures that the mapping says nothing about — the "needs a box" list.
- MtdVerificationItemDto1 endpointOne client's MTD authorisation and what HMRC has confirmed about it.
- MtdVerificationSweepResultDto1 endpointThe outcome of starting a practice-wide verification sweep.
- NameTokenDtoOne token offered by the recurring-task-name and document-name editors. Used to build the token pick...
- NextStepDtoA workflow step on a task that is executable right now: not omitted, not complete, and with all its ...
- NominalCodeDtoOne account in a chart of accounts, as the connected accounting platform holds it. Shar...
- NominalCodeDtoPagedResult1 endpoint
- NonPayeEmploymentIncome
- NonStandardGains
- NonUkCharities
- NoteDto9 endpointsA note attached to an entity such as a client or task
- NoteDtoPagedResult3 endpoints
- NotificationDto
- NotificationFeedDto1 endpoint
- NotificationPreferenceCategoryDto
- NotificationPreferenceChannelDto
- NotificationPreferenceTypeDto
- NotificationPreferenceUpdate
- NotificationPreferencesDto1 endpoint
- NotificationSummaryDto1 endpoint
- NotifyClientDocumentsRequest1 endpointSends the specified recipients one email covering one or more documents, each with its own secure li...
- OAuthSettingsRequestOAuth settings for initiating OAuth flow (used with Microsoft365 or Google provider types)
- OAuthStatusResponseResponse containing OAuth connection status for Microsoft365/Google providers
- ObligationPeriod
- Officer
- OfficerAddress
- OnboardingTaskTemplateDto4 endpointsDTO for onboarding task templates, exposing only codes and enums (never DB IDs).
- OnboardingTaskTemplateDtoPagedResult1 endpoint
- OpenDocumentRequestRequest1 endpointRequest DTO for opening (sending to client) a document request. Requires at least one recipient emai...
- OpenRouterChoiceA completion choice from the AI model
- OpenRouterErrorError information from OpenRouter
- OpenRouterMessageMessage content from the AI model
- OpenRouterResponse1 endpointResponse from OpenRouter API for AI generation requests
- OpenRouterUsageToken usage statistics for the AI request
- OtherCapitalGains
- OtherEmploymentIncome
- OtherGainDisposal
- OtherReliefs
- OtherSavingsIncome
- PackageDto1 endpointA system-level collection of modules that can be assigned to a tenant
- PatchMailboxMessageRequest1 endpointRequest to bulk-update mailbox message properties (e.g., mark as read/unread)
- PatchTaskItemRequest1 endpointPartial update for a task, following JSON Merge Patch: send only the fields to change. A field left ...
- PatchTenantUserRequest1 endpointPartial update for a user within a tenant. Extend with further patchable fields as needed. Rates are...
- PayTimeEntriesRequest1 endpointRequest to pay a batch of time entries on a new pay run. All entries must belong to the same team me...
- PayerDtoSimplified DTO for displaying payer (customer) information. Payers are created by GoCardless via Bil...
- PaymentMandateResponse2 endpointsResponse model representing a payment mandate.
- PendingWorkflowStepDtoLightweight projection of a manual-mode outbound workflow step that is ready to send. These are step...
- PendingWorkflowStepDtoPagedResult1 endpoint
- PensionsReliefs
- PeriodOfAccount
- PeriodsOfAccountResponse
- PeriodsOfAccountResponseDtoThe periods of account HMRC hold for one self-employment income source and tax year — the accounting...
- PipelineDto5 endpointsResponse DTO for sales pipeline information
- PipelineDtoPagedResult1 endpoint
- PipelineOnboardingTaskTemplateDto4 endpointsDTO for pipeline intake task templates, exposing only codes and enums (never DB IDs).
- PipelineOnboardingTaskTemplateDtoPagedResult1 endpoint
- PipelineStageDtoDTO for a user-defined stage on a sales pipeline
- PipelineStageValueTotalDtoDeal value totals for one stage of a pipeline board, across every card in the stage that matches the...
- PortalAccessStatusDto1 endpointPortal access state for a contact on a client, including what granting access would do.
- PortalFolderDtoA folder entry for portal document navigation. Shared between the main API portal-view and client po...
- PortalUserDto2 endpointsA contact who has been granted access to the client portal.
- PostCessationRelief
- PpdMultiplePropertyDisposal
- PpdSinglePropertyDisposal
- PracticeDetailsDto2 endpointsCore practice/firm information for the accounting practice or professional services firm. Used for b...
- PracticeDocumentDto3 endpointsData transfer object for a practice document (tenant-level document library file)
- PracticeDocumentDtoPagedResult1 endpoint
- PracticeNoteDto1 endpointResponse DTO for the practice's shared note
- PreviewWorkflowStepEmailRequest1 endpointPreviews the email of a SendEmail workflow step while it is being built, before the workflow is save...
- PricingFactorDtoDTO for pricing factor information
- PricingFactorOptionDtoDTO for pricing factor option information
- PricingTierDtoResponse DTO for pricing tier information
- ProblemDetails1186 endpoints
- ProcessConfigDtoGroups the workflow and checklist applied to tasks created from a recurring task template. Response ...
- ProcessConfigRequestDtoGroups the workflow and checklist applied to tasks created from a recurring task template. Request s...
- ProcessInvitationRequest1 endpointRequest model for processing a user invitation response to join a tenant
- ProcessInvitationResponse1 endpointResponse model for processing an invitation (accept or decline)
- ProductAccountUrlDto4 endpointsWhere to open a client's account in another Sodium product
- ProfessionalClearanceLetterSettingsDto2 endpointsTenant-level settings for professional clearance letters
- ProfessionalClearanceRequestItemDto3 endpointsAn individual item within a professional clearance request during client onboarding
- ProfessionalClearanceRequestItemDtoPagedResult1 endpoint
- ProposalCatchUpCostsThe catch-up fees on a proposal, for the optional "Proposal - Catch-up fees" content block.
- ProposalCatchUpInstalmentOne billing date in a proposal's catch-up payment plan.
- ProposalCostGroupA billing-frequency section of the proposal costs table (one heading + table per group).
- ProposalCostRowA single line of the proposal costs table: a package, a standalone service, or a setup fee.
- ProposalCostsStructured pricing data for the proposal costs table, computed server-side from the client's live bi...
- QahcGains
- QualifyingLoanInterest
- ReauthoriseConnectionRequest1 endpointStarts a fresh sign-in for a connection the practice already has.
- ReconnectOAuthRequest1 endpointRequest to initiate OAuth reconnection for an expired or scope-upgraded configuration
- ReconnectOAuthResponse1 endpointResponse containing the OAuth authorisation URL for reconnecting a configuration
- RecurrenceConfigDtoConfiguration for how often a recurring task repeats.
- RecurringTaskItemDto4 endpointsDTO for recurring task templates, exposing only codes and enums.
- RecurringTaskItemDtoPagedResult2 endpoints
- RecurringTaskOccurrenceDtoOne occurrence of a recurring task for one client: a date the schedule produces (or produced), and w...
- RecurringTaskOccurrenceDtoPagedResult1 endpoint
- RecurringTaskScheduleDto4 endpointsA schedule a recurring task runs on. Every task has one default schedule (its own dates) plus any nu...
- RecurringTaskScheduleDtoPagedResult1 endpoint
- RedeemDiscountCodeRequest1 endpointRequest to redeem a discount code for a tenant's subscription.
- RegisterMtdForeignPropertyRequest1 endpointRegisters a foreign property with HMRC so figures can be filed against it (2026-27 onwards). HMRC is...
- RelativeIntervalDtoNumeric interval (value + unit) used by the Start/Due date configs to express a relative offset, e.g...
- ReliefAmount
- ReliefClaim
- RenameMtdSavingsAccountRequest1 endpointRenames a UK savings account at HMRC. The account keeps its identifier and every year's interest rep...
- RenderContentBlockRequest1 endpointRequest to render a content block's body HTML with template variables. Optionally wraps the rendered...
- RenderDocumentTemplateRequest1 endpointRequest to render a document template with dynamic data. The template will be processed with the pro...
- RenderTemplateStringRequest1 endpointRequest to render an arbitrary Liquid template string with the provided variables. Use for rendering...
- ReopenDataFormRequestRequest1 endpointDTO for sending an already-submitted form back to the client to complete again
- ReorderProfessionalClearanceRequestItemsRequest1 endpointRequest to reorder professional clearance request items
- ReplyEmailResponse1 endpointResponse after replying to a mailbox email
- ReplyMailboxEmailRequest1 endpointRequest to reply to a mailbox message, extending the email service reply contract with practice docu...
- RequestClientApprovalForDocumentsRequest1 endpointSends one or more documents to a client for approval, either as a single batch decided together or a...
- RequestClientApprovalForDocumentsResultDto1 endpointThe result of a multi-document approval request. In Individual mode each document is sent independen...
- RequestRecipientsDto4 endpointsWho an outstanding client request currently counts as its recipients: the addresses it was sent to a...
- RequestSummaryDto1 endpointOutstanding counts for each kind of item on the Requests page, in one call. Every count is null whe...
- ResendDataFormRequestRequest1 endpointDTO for resending the notification email for a form request
- ResendRequestRequest3 endpointsRequest to resend an outstanding client request (a document request, an approval request or a client...
- ResendVerificationResponse1 endpointResponse DTO for resending verification email
- ResidentialDisposal
- ResolvedTimeEntryRatesDto1 endpointThe charge-out rate a time entry would get if logged now with the given team member, date, task and ...
- RetirementSchemeBenefit
- RevenueRangeDto3 endpointsA revenue band used for tiered service pricing
- RevenueRangeDtoPagedResult1 endpoint
- ReviewClientDocumentRequest1 endpointRequest to approve or reject a client-uploaded document
- ReviewDataFormAnswerRequest1 endpointRequest body for reviewing (accepting/rejecting) a single form answer.
- ReviewDocumentRequestResponseRequest1 endpointRequest DTO for reviewing (accepting or rejecting) a document request response
- ReviewLoggedTimeDefaultsDto1 endpointWhat a Review & Bill Time step pre-fills when its time is billed, with the line description's tokens...
- ReviewLoggedTimeStepConfigDtoConfiguration for ReviewLoggedTime workflow steps: which time the reviewer sees. The step never exec...
- RoleDto3 endpointsA custom (tenant-defined) role and the capabilities it grants per entity.
- RoleDtoPagedResult1 endpoint
- RoleInfoInformation about a user's role within a tenant, including permissions and special designations
- RunningTimerDto5 endpointsThe calling user's live timer
- SalesPipelineSettingsDto2 endpointsTenant-level settings for the Sales Pipeline feature.
- SaveClientDateDtoRequest DTO for creating or updating an important client date. Used to set dates like year-end, acco...
- SaveMtdAnnualSubmissionRequest1 endpointSaves the year-end annual submission for one income source and tax year. A **full repla...
- SaveMtdCgtPpdOverridesRequest1 endpointSaves the year's overrides to residential property disposals HMRC already hold from their 'Report an...
- SaveMtdCgtResidentialDisposalsRequest1 endpointSaves the year's UK residential property disposals for Self Assessment at HMRC — a full replacement ...
- SaveMtdCharitableGivingRequest1 endpointSaves the year's charitable giving reliefs at HMRC — a full replacement of both halves, so send gift...
- SaveMtdDirectorshipDividendRequest1 endpointSaves the directorship and dividend information for one employment — a full replacement.
- SaveMtdDividendsIncomeRequest1 endpointSaves the year's foreign and special dividends at HMRC. A <strong>full replacement</str...
- SaveMtdEmploymentFinancialDetailsRequest1 endpointSaves the financial details for one employment — pay, tax, benefits in kind and deductions — as a <s...
- SaveMtdFigureMappingRequest1 endpointSaves (or replaces) the remembered mapping for one income source type.
- SaveMtdForeignReliefsRequest1 endpointSaves the year's foreign tax reliefs at HMRC — a full replacement.
- SaveMtdInvestmentReliefsRequest1 endpointSaves the year's investment reliefs at HMRC. A <strong>full replacement</strong>: every...
- SaveMtdLossesAndClaimsRequest1 endpointCreates or amends one income source's losses and claims for a tax year from 2026-27 onwards — a full...
- SaveMtdNominalMappingRequest1 endpointConfirms a client's chart-of-accounts mapping for one MTD business, replacing any previous one.
- SaveMtdNonPayeEmploymentRequest1 endpointSaves the year's non-PAYE employment income — tips received outside PAYE. A full replacement at HMRC...
- SaveMtdOtherCapitalGainsRequest1 endpointSaves the year's capital gains other than UK residential property at HMRC. A <strong>fu...
- SaveMtdOtherEmploymentIncomeRequest1 endpointSaves the year's other employment income at HMRC — share options, shares awarded or received, lump s...
- SaveMtdOtherReliefsRequest1 endpointSaves the year's other reliefs at HMRC — a full replacement, so every entry that should survive must...
- SaveMtdOtherSavingsRequest1 endpointSaves the year's other savings income — securities interest and foreign interest — at HMRC. ...
- SaveMtdPensionsReliefsRequest1 endpointSaves the year's pension contribution reliefs at HMRC — a full replacement of all five figures, so s...
- SaveMtdQuarterlySubmissionRequest1 endpointSaves the figures for an MTD quarterly update, creating the draft if it does not exist yet. A full r...
- SaveMtdSavingsAccountInterestRequest1 endpointSaves one savings account's interest for a tax year — a full replacement of the pair at HMRC. Omitti...
- SaveMtdStudentLoanBenefitRequest1 endpointSaves the payrolled benefits that affect student loan repayments for one employment. A full replacem...
- SaveMtdTaxLiabilityAdjustmentsRequest1 endpointCreates or amends a tax year's liability adjustments, a full replacement of what HMRC hold. Send eve...
- SaveMtdUkDividendsRequest1 endpointSaves the year's plain UK dividends at HMRC — a full replacement of the pair. Omitting one of the tw...
- SavePracticeNoteResponse1 endpointResult of saving the practice's shared note. A rejected save is an ordinary outcome of two people ed...
- SaveRecurringTaskScheduleRequest2 endpointsCreate or replace a schedule on a recurring task. On PUT the client list is the schedule's full memb...
- SaveWorkflowStepClientDataRequest1 endpointRequest to save client data values from an UpdateClientData workflow step.
- SavedClientFilterDto3 endpointsA saved client filter belonging to a tenant user, defining reusable criteria for filtering client li...
- SavedClientFilterDtoPagedResult1 endpoint
- SavedTaskFilterDto3 endpointsA saved task filter belonging to a tenant user, defining reusable criteria for filtering task lists
- SavedTaskFilterDtoPagedResult1 endpoint
- SavingsAccountInterest
- ScheduleConfigDtoGroups all scheduling configuration for a recurring task template: which date drives the cycle, how ...
- ScheduledSendBlobAttachmentA raw uploaded attachment held in blob storage while its send is pending
- ScheduledSendDetailDto1 endpointA scheduled send including its stored payload, used to prefill the edit dialogs
- ScheduledSendDto11 endpointsA pending, dispatched, cancelled or failed scheduled send, as shown on the Scheduled list
- ScheduledSendDtoPagedResult1 endpoint
- ScheduledSendPayloadThe stored payload of a scheduled send — everything needed to replay the underlying send at dispatch...
- SecuritiesIncome
- SecuritySettingsDto2 endpointsTenant-level security settings.
- SelfEmploymentAnnualAdjustments
- SelfEmploymentAnnualAllowances
- SelfEmploymentAnnualNonFinancials
- SelfEmploymentAnnualSubmission
- SelfEmploymentBsas
- SelfEmploymentBsasAccountingAdjustments
- SelfEmploymentBsasAdditions
- SelfEmploymentBsasAdjustmentInputsThe sole-trade adjustment figures, as deltas.
- SelfEmploymentBsasAdjustments
- SelfEmploymentBsasCalculation
- SelfEmploymentBsasDeductions
- SelfEmploymentBsasExpenses
- SelfEmploymentBsasIncome
- SelfEmploymentCumulativeSummary
- SelfEmploymentFigureInputs
- SendDataFormExecutionStateDtoExecution state for a SendDataForm workflow step. Contains information about the created data form r...
- SendDataFormRequest1 endpointDTO for sending a form to a single client
- SendDataFormStepConfigDtoConfiguration for SendDataForm workflow steps. Used for both workflow template definition and task w...
- SendDirectDebitSetupEmailRequest1 endpoint
- SendEmailBroadcastRequest1 endpointOptional body for the send broadcast endpoint. An empty body (or null ScheduledAt) sends immediately...
- SendEmailResponse1 endpointResponse from send email request
- SendEngagementEmailRequest1 endpointOptional per-send options for emailing an engagement. The body may be omitted entirely, in which cas...
- SendHmrcAuthorisationRequestDto1 endpointRequest to send HMRC agent authorisation requests for multiple types at once. Supports both digital ...
- SendInvitationRequest1 endpointRequest model for sending an invitation to a user
- SendMailboxEmailRequest3 endpointsRequest DTO for sending a new email from a tenant's connected mailbox.
- ServiceBillForWorkCoverageDto1 endpointWhether anything bills a service set to bill when the work is done.
- ServiceBulkUpdateResult1 endpoint
- ServiceCatalogImportResultDto1 endpointThe outcome of a services catalog CSV import
- ServiceCatalogImportRowDtoA single service parsed from an uploaded services catalog CSV, ready for user review. Returned by th...
- ServiceCatalogImportRowResultDtoThe outcome of importing a single selected row
- ServiceCatalogPricingEntryDtoA single price at a billing frequency for an imported service
- ServiceCategoryDto3 endpointsA grouping used to classify billable services
- ServiceCategoryDtoPagedResult1 endpoint
- ServiceCsvAnalysisDto1 endpointResult of analysing a foreign service CSV: the detected source and the services to map. Whether each...
- ServiceDeliveryReportDto1 endpointThe Service Delivery Turnaround report: headline KPIs plus the breakdown table for the requested gro...
- ServiceDeliveryRowDtoOne row of the Service Delivery Turnaround breakdown table - the cohort aggregated for a single grou...
- ServiceDeliveryRowDtoPagedResult
- ServiceDeliveryStepsDto1 endpointStep-level bottleneck drill-down for one billable service: per-step duration aggregates plus the cli...
- ServiceDeliverySummaryDtoHeadline KPIs for the Service Delivery Turnaround report, computed over the completion cohort (tasks...
- ServiceImportJobDto3 endpointsRepresents the current status and progress of a service import job. Returned when starting an import...
- ServiceImportPreviewActionDtoPreview for a single service action within a client
- ServiceImportPreviewClientDtoPreview for a single client row in the CSV
- ServiceImportPreviewDto1 endpointPreview of what a service CSV import will do, returned before the user confirms.
- ServicePackageDto3 endpointsResponse DTO for service package information
- ServicePackageDtoPagedResult1 endpoint
- ServicePackageItemDtoDTO for a service included in a service package
- ServiceTimeContextDtoThe names behind the Service Time drill parameters. A part is null when the level doesn't reach it, ...
- ServiceTimeReportDto1 endpointThe Service Time report: estimated vs actual time per service ("we sold this for X hours — did it ta...
- ServiceTimeRowDtoOne Service Time breakdown row
- ServiceTimeRowDtoPagedResult
- ServiceTimeSummaryDtoHeadline aggregates for the Service Time report, over the window narrowed to the drill scope: everyt...
- SetAllWorkflowStepsStatusRequest1 endpointRequest to set every open step of a task's workflow to Completed or Skipped in one go, regardless of...
- SetDocumentsPortalVisibilityRequest1 endpointShows or hides one or more documents in the client portal. Documents already in the requested state ...
- SetMtdAccountingTypeRequest1 endpointSets the accounting basis — cash or accruals — for one income source and tax year. HMRC...
- SetMtdPeriodsOfAccountRequest1 endpointDeclares whether a self-employment income source draws its accounts to periods other than the tax ye...
- SetMtdQuarterlyPeriodTypeRequest1 endpointElects standard (6 April) or calendar (1 April) quarterly reporting periods for one income source an...
- SetOrganizationRequest1 endpointRequest to set organization for a third-party connection
- SetPipelineStageStepConfigDtoConfiguration for SetPipelineStage workflow steps. Sets the stage on the client's pipeline card when...
- SetPortalAccessRequest1 endpointRequest to grant or revoke portal access for a contact.
- SetSavedFilterMenuOrderRequest2 endpointsRequest to set the order of the current user's saved-view menu entries
- SetSavedFilterMenuRequest2 endpointsRequest to set the current user's menu preference for a saved filter
- SetServiceStageStepConfigDtoConfiguration for SetServiceStage workflow steps. Sets the stage on the client's billable service wh...
- ShareOptionItem
- SharesAwardedOrReceivedItem
- SmtpSettingsRequestSMTP settings for API requests
- SmtpSettingsResponseDtoSMTP settings response (passwords are never returned)
- StartClientBooksConnectionRequest1 endpointStarts a fresh authorisation against a client's own accounting software.
- StartRunningTimerRequest1 endpointRequest to start the calling user's timer, or update the details of the one already running (the sta...
- StartSubscriptionBillingRequest1 endpointRequest to start subscription billing for a tenant. Name, billing contact, and tenant are auto-popul...
- StatutoryDateConfigDtoConfiguration for the projected StatutoryDueDate on tasks created from a recurring task. Different p...
- StepBottleneckDtoDuration aggregates for one workflow step across the cohort's workflow tasks for a single billable s...
- StorageLocationDtoA group of selectable storage locations available through a connection (e.g. a SharePoint site conta...
- StorageLocationItemDtoA selectable storage location (e.g. a document library / drive) that can be assigned to a client.
- StructuredBuildingAllowanceItem
- StructuredBuildingFirstYear
- StudentLoanBenefitInKind
- StudentLoanDeductions
- SubmissionStampResponse
- SubmitDocumentRequestRequest1 endpointRequest DTO for submitting a document request response
- SubmitInvoiceRequest1 endpointRequest body for submitting an invoice for a specific billing date
- SubmitLetterAuthCodeRequest1 endpointRequest to submit the authorisation code received by post from HMRC (letter-based flow).
- SubmitMtdBsasAdjustmentsRequest1 endpointSubmits accounting adjustments against one adjustable summary. Values are **deltas** to...
- SubmitMtdQuarterlyUpdateRequest1 endpointSends a prepared quarterly update to HMRC. The declaration is part of the request because it is made...
- SubmitMtdTaxReturnRequest1 endpointSends a client's tax return to HMRC. ⚠ <strong>The highest-stakes call in the product, ...
- SubscriptionDiscountDto2 endpointsResponse DTO for an active subscription discount on a tenant.
- SubscriptionDto3 endpointsResponse DTO for subscription information (excludes internal IDs)
- SubscriptionPricePreviewDtoPreview of the subscription price for a package based on the tenant's active client count.
- SystemRolePermissionsDtoA built-in system role and the capabilities it grants per entity, as they apply within this tenant. ...
- TaskCategoryDto3 endpointsA grouping used to classify tasks
- TaskCategoryDtoPagedResult1 endpoint
- TaskClientMatchSummaryDtoHow a foreign task export's client names matched against existing clients. Unmatched names still con...
- TaskCsvConversionAnalysisDto1 endpointResult of analysing a foreign task CSV: the detected source plus the assignees and progress values n...
- TaskDateSummaryDtoOne date's slice of a task date summary: the first tasks on that date plus the total number of tasks...
- TaskFocusConfigDto2 endpointsResponse DTO for a user's task focus panel configuration
- TaskFocusConfigItemDtoResponse DTO for a single item in the task focus panel configuration
- TaskImportResultDto1 endpointThe outcome of a task CSV import
- TaskImportRowDtoA single task parsed from an uploaded task CSV, ready for user review. Returned by the analyze endpo...
- TaskImportRowResultDtoThe outcome of importing a single task CSV row
- TaskItemDto6 endpointsA task, either standalone or a workflow step (with parent task context)
- TaskItemDtoPagedResult1 endpoint
- TaskItemHistoryEventDtoA single event in a task's history timeline — a status or assignee change on the task itself or one ...
- TaskStartConfigDtoConfiguration for when a recurring task should start. Different properties are required based on the...
- TaskSummaryDto1 endpointDTO for task summary by status
- TaskTemplateDto5 endpointsDTO for one-off task templates, exposing only codes and enums (never DB IDs).
- TaskTemplateDtoPagedResult1 endpoint
- TaskTokensThe task a piece of content is being produced from, exposed as {{ Task.* }}. Only popul...
- TaskWorkloadSummaryDto1 endpointThe standard workload buckets for a scope (user, team, or whole practice): how many open tasks are o...
- TaxCalculation
- TaxCalculationEndOfYearEstimate
- TaxCalculationMessage
- TaxCalculationMessages
- TaxCalculationTotals
- TaxLiabilityAdjustments
- TaxReturnBlocker
- TaxReturnDeclaration
- TaxReturnIncomeSource
- TaxReturnSubmissionResponse
- TaxYearIncomeSourceConfiguration
- TaxYearOtherIncomeResponse
- TaxYearReturnResponse
- TaxYearSavingsAccount
- TeamDto3 endpointsResponse DTO for a team
- TeamDtoPagedResult1 endpoint
- TeamTimeCategoryDtoOne member's minutes in one task category
- TeamTimeCategoryTotalDtoOne task category in the report's breakdown, with what the whole team logged against it
- TeamTimeDayDtoOne day's logged minutes within a Team Time row
- TeamTimeReportDto1 endpointThe Team Time report: how many hours each team member logged over a period, against how many they we...
- TeamTimeRowDtoOne team member's row on the Team Time report
- TeamTimeRowDtoPagedResult
- TeamTimeSummaryDtoHeadline aggregates for the Team Time report
- TeamWorkloadReportDto1 endpointThe Team Workload & Productivity report: who's carrying how much open work right now, and who comple...
- TeamWorkloadRowDtoOne row of the Team Workload breakdown table - one assignee's open workload and throughput.
- TeamWorkloadRowDtoPagedResult
- TeamWorkloadSummaryDtoHeadline KPIs for the Team Workload report.
- TemplateValidationResultDto1 endpointResult of validating a Liquid template fragment. Reports whether the content parses under the same e...
- TemplateVariables1 endpointRoot object containing all variables available for document template rendering. This class serves as...
- TenantCreateRequest1 endpointRequest DTO for creating a new tenant organization
- TenantDto3 endpointsAn organisation (tenant) and its configuration
- TenantHolidayDto3 endpointsTenant-specific custom holiday
- TenantHolidayDtoPagedResult1 endpoint
- TenantInfoInformation about a tenant that a user belongs to, including statistics and role information
- TenantUpdateRequest1 endpointRequest DTO for updating a tenant
- TenantUserDto4 endpointsDTO for a user within a tenant, including their role and basic information.
- TenantUserDtoPagedResult1 endpoint
- TenantUserRateDto2 endpointsA date-effective rate entry for a team member. A user has at most one open entry (null effectiveTo —...
- TestEmailBroadcastRequest1 endpointRequest to send a test of a broadcast email to the current user. The email is rendered with the samp...
- TestEmailRequest1 endpointRequest to send a test email for verifying configuration
- TestEmailResponse1 endpointResponse from sending a test email
- ThirdPartyConnectionDto5 endpointsRepresents an OAuth or API key connection to a third-party platform such as Xero, FreeAgent, Sage, o...
- ThirdPartyConnectionDtoPagedResult1 endpoint
- ThirdPartyPlatformMetadata
- TimeEntryAllocationDtoOne disposal event against a time entry: the WIP it drew down, what the client was charged for it, a...
- TimeEntryAllocationRequestAn explicit per-entry allocation for the cherry-picking case: how much of the entry's open WIP to se...
- TimeEntryDto3 endpointsA recorded block of time worked by a team member
- TimeEntryDtoPagedResult1 endpoint
- TimeEntryRateChangeDtoOne logged time entry whose stamped rates differ from the rates that apply now. Cost rates are only ...
- TimeEntryRateRecalculationRequest1 endpointWhich logged time to re-apply the current rates to: unpaid entries dated from FromDate, optionally f...
- TimeEntryRateRecalculationResultDto1 endpointThe outcome of re-applying rates to logged time
- TimeImportAnalysisDto1 endpointResult of analysing an uploaded time CSV: the parsed rows for review plus the distinct team member a...
- TimeImportClientDtoA distinct client name found in a time CSV
- TimeImportResultDto1 endpointThe outcome of a time CSV import (or of one batch of it — the frontend imports large files in batche...
- TimeImportRowDtoA single time entry parsed from an uploaded time CSV, ready for user review
- TimeImportRowResultDtoThe outcome of importing a single time CSV row
- TimeImportTeamMemberDtoA distinct team member name found in a time CSV
- TimePayRunDto1 endpointA payment of tracked time to one team member — the receipt for a batch of their time entries paid at...
- TimePayRunDtoPagedResult1 endpoint
- TimeRecordingSettingsDto2 endpointsTenant-level settings for time recording
- TimeWipReportDto1 endpointThe WIP Value report: a point-in-time snapshot of billable time not yet billed or written off, value...
- TimeWipRowDtoOne group's row on the WIP Value report: a client, client service or team member
- TimeWipRowDtoPagedResult
- TimeWipSummaryDtoHeadline aggregates for the WIP Value report
- TimerBlockDtoOne block of work on a timer or time entry — either a wall-clock span (start and end time) or a plai...
- TrackExternalFileItemDtoOne external file to track within a bulk track request.
- TrackExternalFileRequest1 endpointRequest to track an existing external file in our system, creating a ClientDocument record that refe...
- TriggerMtdAdjustableSummaryRequest1 endpointAsks HMRC to generate a new adjustable summary for an income source and accounting period. The perio...
- TriggerMtdTaxReturnCalculationRequest1 endpointAsks HMRC to work out the calculation a tax return declares. A tax return does not decl...
- UkDividendsIncome
- UkPropertyAnnualAdjustments
- UkPropertyAnnualAllowances
- UkPropertyAnnualRentARoom
- UkPropertyAnnualSubmission
- UkPropertyBsas
- UkPropertyBsasAdditions
- UkPropertyBsasAdjustmentInputsThe property adjustment figures, as deltas.
- UkPropertyBsasAdjustments
- UkPropertyBsasCalculation
- UkPropertyBsasDeductions
- UkPropertyBsasExpenses
- UkPropertyBsasIncome
- UkPropertyCumulativeSummary
- UkPropertyExpenses
- UkPropertyFigures
- UkPropertyIncome
- UkPropertyRentARoomExpenses
- UkPropertyRentARoomIncome
- UnbilledTimeClientDtoA client with unbilled billable time, and how much of it there is. The figures reflect whatever date...
- UnbilledTimeClientDtoPagedResult1 endpoint
- UnlistedSharesDisposal
- UnpaidTimeUserDtoA team member the practice pays for tracked time, and how much of their time is still unpaid. The fi...
- UnpaidTimeUserDtoPagedResult1 endpoint
- UpcomingDeadlineBucketDtoOne days-remaining bucket of the upcoming-deadlines snapshot.
- UpdateAiSettingsRequest1 endpointRequest DTO for updating AI settings for a tenant
- UpdateAmlContactRequest1 endpointRequest to update a contact in the AML platform. All fields are optional — only provided fields are ...
- UpdateApiKeyRequest1 endpointRequest to update an API key. This is a full replacement of the key's name and scope: omit the scope...
- UpdateBillableServiceRequest1 endpointRequest DTO for updating an existing billable service
- UpdateCalendarSubscriptionRequest1 endpointFull replacement of a calendar subscription's editable fields. A changed URL is re-validated by fetc...
- UpdateClientAgentAuthorisationRequest
- UpdateClientBillableServiceRequest1 endpointRequest DTO for updating an existing client billable service assignment
- UpdateClientBillableServiceStageRequest1 endpointRequest DTO for updating a client billable service stage (kanban drag-and-drop)
- UpdateClientBillingLineItemRequest1 endpointRequest to update a billing line item. A line derived from time (billed time entries behind it) keep...
- UpdateClientBillingLineItemStatusRequest1 endpointRequest to update the status of a billing line item
- UpdateClientBillingScheduleItemRequest1 endpointRequest to edit one scheduled occurrence: its billing date, amount and description. The date is alwa...
- UpdateClientBillingSettingsRequest1 endpointRequest to update client billing settings for the tenant
- UpdateClientContactRequest1 endpointRequest DTO for updating a client-contact relationship
- UpdateClientDataFieldDtoA single field within an UpdateClientData step configuration.
- UpdateClientDataStepConfigDtoConfiguration for UpdateClientData workflow steps. Defines which client/custom fields the user shoul...
- UpdateClientDocumentRequest1 endpoint
- UpdateClientEmailRuleRequest1 endpointRequest to update an existing email matching rule. Provide an email address (e.g. "john@acme.com") t...
- UpdateClientLinkRequest1 endpointRequest DTO for updating a client link
- UpdateClientNoteRequest1 endpointRequest DTO for updating a client note
- UpdateClientPipelineDealRequest1 endpointRequest DTO for setting a client pipeline card's deal value and likelihood. Both are optional; null ...
- UpdateClientPipelineRequest1 endpointRequest DTO for updating a client's pipeline card (full replacement)
- UpdateClientPipelineStageRequest1 endpointRequest DTO for updating a client pipeline card's stage (kanban drag-and-drop)
- UpdateClientPortalSettingsRequest1 endpointRequest to update client portal settings for the tenant
- UpdateClientRequest1 endpointRequest DTO for updating an existing client
- UpdateClientRequestSettingsRequest1 endpointRequest to update client request and chasing settings for the tenant
- UpdateClientSettingsRequest1 endpointRequest to update client settings for the tenant
- UpdateClientThirdPartyMappingRequest1 endpointRequest DTO for updating a client's third-party platform mappings. Implements RFC 7396 JSON Merge Pa...
- UpdateContactRequest1 endpointDTO for updating a contact
- UpdateContentBlockRequest1 endpointRequest to update an existing content block
- UpdateCsvMappingRequest1 endpointRequest to update an existing CSV mapping.
- UpdateCustomFieldDefinitionRequest1 endpoint
- UpdateCustomFieldGroupRequest1 endpoint
- UpdateCustomTokenRequest1 endpointDTO for updating a custom token
- UpdateDataFormCategoryRequest1 endpointDTO for updating a form category
- UpdateDataFormRequest1 endpointDTO for updating a form (whole-form save including sections and questions)
- UpdateDesignThemeRequest1 endpointRequest to update an existing design theme
- UpdateDirectDebitSettingsRequest1 endpointRequest to update direct debit settings for the tenant
- UpdateDocumentCategoryRequest1 endpointDTO for updating a document category
- UpdateDocumentRequestRequest1 endpointRequest DTO for updating a document request (only allowed while in Draft status)
- UpdateDocumentTemplateRequest1 endpoint
- UpdateEmailBroadcastRequest1 endpointRequest to update a draft email broadcast. PUT is a full replacement — all fields are applied as pro...
- UpdateEmailConfigRequest1 endpointRequest DTO for updating an existing email configuration
- UpdateEmailSettingsRequest1 endpointRequest to update email settings for the tenant
- UpdateEngagementRequest1 endpointRequest DTO for updating an existing engagement
- UpdateEngagementSettingsDataFormRequestRequest to configure a form as a step in the proposal acceptance flow.
- UpdateEngagementSettingsRequest1 endpointRequest to update engagement settings for the tenant
- UpdateHmrcAgentCredentialRequest1 endpointReplaces a credential set's fields. The password follows the null/empty/value rule.
- UpdateImageAssetRequest1 endpointRequest to update an existing image asset
- UpdateMailboxDraftRequest1 endpointRequest to update a mailbox draft, extending the email service contract with references to existing ...
- UpdateMtdForeignPropertyRequest1 endpointRenames a registered foreign property, or records that it stopped producing income. The...
- UpdateOnboardingTaskTemplateRequest1 endpointRequest DTO for updating an onboarding task template
- UpdatePipelineOnboardingTaskTemplateRequest1 endpointRequest DTO for updating a pipeline intake task template
- UpdatePipelineRequest1 endpointRequest DTO for updating an existing sales pipeline (full replacement)
- UpdatePortalUserStatusRequest1 endpointRequest to activate or deactivate a portal user.
- UpdatePracticeDetailsRequest1 endpointRequest to update practice/firm details
- UpdatePracticeDocumentRequest1 endpointRequest to update a practice document's metadata (the file itself is immutable)
- UpdatePracticeNoteRequest1 endpointRequest DTO for saving the practice's shared note
- UpdateProfessionalClearanceLetterSettingsRequest1 endpointRequest to update professional clearance letter settings for the tenant
- UpdateProfessionalClearanceRequestItemRequest1 endpointDTO for updating a professional clearance request item
- UpdateRecurringTaskItemRequest1 endpoint
- UpdateRevenueRangeRequest1 endpointDTO for updating a revenue range
- UpdateRoleRequest1 endpointRequest to update a custom role. This is a full replacement — the role's name, description and entir...
- UpdateSalesPipelineSettingsRequest1 endpointRequest to update the tenant's Sales Pipeline settings.
- UpdateSavedClientFilterRequest1 endpointRequest model for updating an existing saved client filter
- UpdateSavedTaskFilterRequest1 endpointRequest model for updating an existing saved task filter
- UpdateScheduledSendRequest1 endpointReschedules a pending scheduled send and optionally replaces its editable payload content. Only Sche...
- UpdateSecuritySettingsRequest1 endpointRequest to update the practice's security settings. A full replacement: both flags are required.
- UpdateServiceCategoryRequest1 endpointDTO for updating a service category. Updating a system category records the change as a per-tenant c...
- UpdateServicePackageRequest1 endpointRequest DTO for updating a service package
- UpdateSubscriptionBillingRequest1 endpointRequest to update billing address and invoice recipients. Name and billing contact are not user-sett...
- UpdateTaskCategoryRequest1 endpointDTO for updating a task category
- UpdateTaskFocusConfigItemRequestRequest DTO for a single item in the task focus panel configuration
- UpdateTaskFocusConfigRequest1 endpointRequest DTO for upserting a user's task focus panel configuration
- UpdateTaskItemNoteRequest2 endpointsRequest DTO for updating a task item note
- UpdateTaskItemRequest1 endpointRequest model for updating an existing task
- UpdateTaskTemplateRequest1 endpointRequest DTO for updating a one-off task template
- UpdateTeamRequest1 endpointRequest DTO for updating a team
- UpdateTenantHolidayRequest1 endpointRequest to update a tenant-specific holiday
- UpdateTenantUserRateRequest1 endpointFull replacement of one rate entry — for correcting a historical entry's rates or dates. The edited ...
- UpdateTenantUserRequest1 endpointDTO for Updating a user within a tenant. Does not include email as it cannot be changed. FirstName/L...
- UpdateThirdPartyConnectionRequest1 endpointRequest for updating an existing ThirdPartyConnection
- UpdateTimeEntryRequest1 endpointRequest to update a time entry (full replacement)
- UpdateTimeRecordingSettingsRequest1 endpointRequest to update time recording settings for the tenant
- UpdateUserNoteRequest1 endpointRequest DTO for saving one of the caller's own notes
- UpdateUserProfileRequest1 endpointRequest DTO for updating user profile information (name only)
- UpdateWorkflowRequest1 endpointRequest to update an existing workflow
- UpdateWorkflowStepRequest1 endpointRequest DTO for updating workflow step properties. Supports updating status, assignment, and step-ty...
- UpdateWorkingDaySettingsRequest1 endpointRequest to update working day settings for the tenant
- UpdateWorkingPatternRequest1 endpointRequest to update a working pattern. A full replacement — every day is applied as sent, so omitting ...
- UpdateWriteOffReasonRequest1 endpointRequest to update a write-off reason. Deactivate a reason rather than deleting it once it has been u...
- UploadEngagementPdfRequest2 endpointsRequest DTO for uploading PDF documents to an engagement
- UpsertBaseFolderRequest2 endpointsRequest DTO for upserting the base folder for a connection
- UpsertServiceMappingRequest1 endpointRequest to map an external service template to a Sodium BillableService
- UpsertUserViewPreferenceRequest1 endpointRequest DTO for creating or updating a user's view preference
- UserBillingSummaryDto1 endpointSummary of the tenant's per-user billing position: how many users are included in their subscription...
- UserNoteDto3 endpointsResponse DTO for one of the caller's own notes
- UserProfileResponse4 endpointsResponse DTO for user profile information
- UserViewPreferenceDto2 endpointsResponse DTO for a user's view preference configuration
- UtmInfoDto1 endpointDTO containing UTM tracking information
- ValidateTemplateRequest1 endpointRequest to validate a Liquid template fragment (email body, subject, content block, etc.) without re...
- ValidationProblemDetails5 endpoints
- VatDetailsDtoVAT registration and scheme details for a business
- VatNumberVerificationDto1 endpointThe outcome of verifying a client's VAT number against HMRC's Check a UK VAT Number service. When th...
- VatPeriodTokensComputed VAT period tokens for the return the client is currently filing - the most recently closed ...
- VerificationResponse3 endpointsResponse DTO for email verification operations
- VerifyEmailRequest1 endpointRequest DTO for email verification
- VerifyMtdAuthorisationRequest1 endpointRequest to verify one client's MTD authorisation against HMRC.
- WeekDayPatternDtoDTO for positional weekday patterns in recurring tasks. Example: { Position: "First", Day: "Monday" ...
- WipAgeingReportDto1 endpointThe WIP / Ageing report: a point-in-time snapshot of open work - what's sitting untouched, how old i...
- WipAgeingRowDtoOne row of the WIP / Ageing breakdown table.
- WipAgeingRowDtoPagedResult
- WipAgeingSummaryDtoHeadline KPIs for the WIP / Ageing report.
- WorkTypeRateDto2 endpointsA date-effective rate for a type of work — a task category or a library service — for one team membe...
- WorkflowDto7 endpointsDTO for workflow templates, exposing only codes and structured data (never DB IDs).
- WorkflowDtoPagedResult1 endpoint
- WorkflowGroupDtoDTO for workflow groups within a workflow. Workflow Group Deadlines: Each group's deadl...
- WorkflowGroupProgressDtoRepresents a workflow group with its associated step progress. Used for organizing workflow steps in...
- WorkflowOccurrenceDtoOne occurrence (task) of the workflow: its total elapsed time and the client-wait vs internal split ...
- WorkflowOccurrenceDtoPagedResult1 endpoint
- WorkflowStepAnalysisReportDto1 endpointThe Workflow Step Analysis report: for one workflow template, where does the time go across every oc...
- WorkflowStepAnalysisStepDtoPer-step duration distribution across the workflow's occurrences. Steps are per-task snapshots, so a...
- WorkflowStepAnalysisSummaryDtoHeadline KPIs for the Workflow Step Analysis report.
- WorkflowStepClientDataDto1 endpointResponse containing the current client field values for an UpdateClientData workflow step.
- WorkflowStepClientDataFieldDtoA single field with its current value and rendering metadata.
- WorkflowStepClientDataValueDtoA single field value being saved.
- WorkflowStepDetailsDtoDetails about a specific workflow step when a TaskItemDto represents a workflow step view
- WorkflowStepDtoDTO for workflow steps within a workflow group. Used for both create/update requests and GET respons...
- WorkflowStepEmailPreviewAttachmentDtoA pre-specified practice document attachment shown in the email preview / compose dialog.
- WorkflowStepEmailPreviewDto2 endpointsPreview of a workflow step email with rendered content and resolved recipients. Returned before send...
- WorkflowStepProgressDto2 endpointsRepresents the progress of a single workflow step within a TaskItem. Contains both the step template...
- WorkflowStepReferenceIdentifies a specific workflow step within a task.
- WorkingDaySettingsDto2 endpointsWorking day settings for a tenant
- WorkingPatternDto3 endpointsA named working week team members can be put on, holding the minutes expected on each day. The Team ...
- WorkingPatternDtoPagedResult1 endpoint
- WriteOffReasonDto3 endpointsA reason for writing time off (or on) against a fee. Tenant-configurable; deactivated rather than de...
- WriteOffReasonDtoPagedResult1 endpoint
- WriteOffReportDto1 endpointThe Write-off Analysis report: time written off (or on) against fees over a period, by reason, team ...
- WriteOffRowDtoOne group's row on the Write-off Analysis report: a reason, team member or client
- WriteOffRowDtoPagedResult
- WriteOffSummaryDtoHeadline aggregates for the Write-off Analysis report
- WriteOffTimeEntriesRequest1 endpointRequest to write off open WIP on time entries with no bill raised. Omit the amount to write off ever...