Used By Operations

• POST Link Task to Conversation
  /tenants/{tenant}/email-configs/{code}/conversations/{conversationId}/tasks
• PUT Map External Service
  /tenants/{tenant}/external-proposals/service-mapping

Contained in Schemas

• AiSettingsDto Configuration for AI/LLM integration settings at the tenant level. Controls which AI model to use an...
• AvailableClientDto A customer/client retrieved from a third-party accounting platform (Xero, QuickBooks, FreeAgent, etc...
• BackgroundImageDto A background image configured on a design theme for PDF rendering.
• BillableServiceDto Response DTO for billable service information
• BillingAccountResponse Response model representing a billing account.
• ClientBillableServiceDto Response DTO for client billable service information
• ClientBillableServiceStageHistoryDto One stage change in a client billable service's history, newest first. Powers the time-in-stage view...
• ClientBillableServiceSummaryDto Lightweight projection of a client billable service for kanban board cards. Contains only the fields...
• ClientBillingLineItemDto Response DTO for a billable line item
• ClientConfirmationDto Summary DTO for a client confirmation workflow step
• ClientContactDto Response DTO for client-contact relationship information
• ClientDocumentDto Represents a document associated with a client, such as letters, engagement letters, proposals, or o...
• ClientDto Response DTO for client information
• ClientEmailRuleDto A rule that associates emails with a client. The value determines the matching behaviour: email addr...
• ClientInvoiceSubmissionDto Response DTO for an invoice submission
• ClientPipelineDto Response DTO for a client's placement on a sales pipeline (a kanban card).
• ClientPipelineSummaryDto Lightweight projection of a client pipeline card for kanban board display. Reuses SodiumHQ.DTOs.Clie...
• ClientPortalSettingsDto Client portal settings for the tenant
• ClientRequestSettingsDto Client request and chasing settings for the tenant
• ClientResponsivenessRowDto One row of the Client Responsiveness breakdown table.
• CompanyDetailsDto Company registration and filing details (Companies House)
• ConditionDto A conditional-visibility rule shared by data form sections/questions and workflow groups/steps: the ...
• ContactDto Represents a person or contact within the tenant's organization. Contacts can be associated with one...
• ConversationWithAssociationsDto A conversation's messages enriched with client associations derived from email rules.
• DataFormDto A custom form definition (list view)
• DataFormQuestionDto A question within a form section
• DataFormRequestDto A form request sent to a client
• DeadlineComplianceRowDto One row of the Deadline Compliance breakdown table.
• DeadlineComplianceSummaryDto Headline KPIs for the Deadline Compliance report. Every cohort task lands in exactly one of Met / La...
• DesignThemeDto Complete visual styling and branding configuration for generated documents (proposals, engagement le...
• DirectDebitSettingsDto Tenant-level configuration for direct debit request behavior and email settings. Controls how direct...
• DocumentApprovalStepConfigDto Configuration for DocumentApproval workflow steps. Used for both workflow template definition and ta...
• DocumentRequestDetailDto Detailed response DTO for a document request, including documents and responses
• DocumentRequestDto Response DTO for a document request
• DocumentRequestResponseDto Response DTO for a document request submission/response
• DocumentTemplateDto Reusable document template for generating HTML documents such as proposals, engagement letters, repo...
• EmailBroadcastDto An email broadcast: an ad-hoc mass email to a filtered set of clients with per-client Liquid token r...
• EmailConfigDto Response DTO for an email configuration
• EmailSettingsDto Tenant-level configuration for outbound email branding and sender information. Controls the visual a...
• EngagementAcceptanceDto Response DTO for anonymous engagement acceptance page
• EngagementDto Response DTO for engagement information
• EngagementSettingsDto Tenant-level configuration for engagement behavior, branding, and notification settings. Controls ho...
• ExternalDocumentDto A file from the external storage provider, enriched with metadata from our DB when the file is track...
• ExternalMailboxEmailSummaryDto Summary DTO for a mailbox email (used in list views)
• ExternalProposalDto A proposal from an external platform (Socket, etc.)
• ExternalProposalLineDto A line item on an external proposal
• MailboxThreadSummaryDto Summary DTO for a mailbox conversation (one entry per conversation in list views)
• NoteDto A note attached to an entity such as a client or task
• OnboardingTaskTemplateDto DTO for onboarding task templates, exposing only codes and enums (never DB IDs).
• PackageDto A system-level collection of modules that can be assigned to a tenant
• PendingWorkflowStepDto Lightweight projection of a manual-mode outbound workflow step that is ready to send. These are step...
• PipelineDto Response DTO for sales pipeline information
• PipelineOnboardingTaskTemplateDto DTO for pipeline intake task templates, exposing only codes and enums (never DB IDs).
• PracticeDetailsDto Core practice/firm information for the accounting practice or professional services firm. Used for b...
• ProfessionalClearanceLetterSettingsDto Tenant-level settings for professional clearance letters
• RecurringTaskItemDto DTO for recurring task templates, exposing only codes and enums.
• RoleInfo Information about a user's role within a tenant, including permissions and special designations
• RunningTimerDto The calling user's live timer
• SavedClientFilterDto A saved client filter belonging to a tenant user, defining reusable criteria for filtering client li...
• SavedTaskFilterDto A saved task filter belonging to a tenant user, defining reusable criteria for filtering task lists
• SendDataFormStepConfigDto Configuration for SendDataForm workflow steps. Used for both workflow template definition and task w...
• ServiceDeliveryRowDto One row of the Service Delivery Turnaround breakdown table - the cohort aggregated for a single grou...
• ServiceDeliveryStepsDto Step-level bottleneck drill-down for one billable service: per-step duration aggregates plus the cli...
• ServiceImportPreviewActionDto Preview for a single service action within a client
• ServiceImportPreviewClientDto Preview for a single client row in the CSV
• ServicePackageDto Response DTO for service package information
• SubscriptionDto Response DTO for subscription information (excludes internal IDs)
• SubscriptionPricePreviewDto Preview of the subscription price for a package based on the tenant's active client count.
• TaskFocusConfigItemDto Response DTO for a single item in the task focus panel configuration
• TaskItemDto A task, either standalone or a workflow step (with parent task context)
• TaskItemHistoryEventDto A single event in a task's history timeline — a status or assignee change on the task itself or one ...
• TaskTemplateDto DTO for one-off task templates, exposing only codes and enums (never DB IDs).
• TeamDto Response DTO for a team
• TenantDto An organisation (tenant) and its configuration
• TenantInfo Information about a tenant that a user belongs to, including statistics and role information
• ThirdPartyConnectionDto Represents an OAuth or API key connection to a third-party platform such as Xero, FreeAgent, Sage, o...
• TimeEntryDto A recorded block of time worked by a team member
• UnbilledTimeClientDto A client with unbilled billable time, and how much of it there is
• UpdatePracticeDetailsRequest Request to update practice/firm details
• WipAgeingRowDto One row of the WIP / Ageing breakdown table.
• WipAgeingSummaryDto Headline KPIs for the WIP / Ageing report.
• WorkflowOccurrenceDto One occurrence (task) of the workflow: its total elapsed time and the client-wait vs internal split ...
• WorkflowStepAnalysisReportDto The Workflow Step Analysis report: for one workflow template, where does the time go across every oc...
• WorkflowStepAnalysisStepDto Per-step duration distribution across the workflow's occurrences. Steps are per-task snapshots, so a...
• WorkflowStepDetailsDto Details about a specific workflow step when a TaskItemDto represents a workflow step view
• WorkflowStepDto DTO for workflow steps within a workflow group. Used for both create/update requests and GET respons...
• WorkflowStepProgressDto Represents the progress of a single workflow step within a TaskItem. Contains both the step template...