API Schemas

Browse all data models and schemas used in the API

AcceptEngagementRequest1 endpoint
Request DTO for accepting an engagement
AcceptanceDto
Acceptance information for an engagement
AddAmlContactRequest1 endpoint
Request to push a Sodium contact to the AML platform. The API looks up all contact fields server-sid...
AddTeamMembersRequest1 endpoint
Request DTO for adding members to a team
AiGenerationRequest1 endpoint
Request to generate content using AI based on the specified activity
AiSettingsDto2 endpoints
Configuration for AI/LLM integration settings at the tenant level. Controls which AI model to use an...
AiUsageSummaryDto1 endpoint
Summary of AI usage tokens for a specific date range
AmlClientDto2 endpoints
AmlClientDtoPagedResult1 endpoint
AmlContactDto3 endpoints
Contact details from the AML platform.
AmlMailTemplateDto
A mail template configured in the AML platform.
AmlOnboardingLevelDto
An onboarding level configured in the AML platform.
AmlRiskAssessmentDto1 endpoint
AmlRiskAssessmentDtoPagedResult1 endpoint
ApiKeyDto1 endpoint
Represents an API key for authentication
ApplyServicePackageRequest1 endpoint
Request DTO for applying a service package to a client
AvailableClientDto
A customer/client retrieved from a third-party accounting platform (Xero, QuickBooks, FreeAgent, etc...
AvailableClientDtoPagedResult1 endpoint
BackgroundImageDto2 endpoints
A background image configured on a design theme for PDF rendering.
BackgroundImageRequest2 endpoints
Request DTO for creating or updating a background image on a design theme.
BankHolidayDto
Bank holiday information
BillableServiceDto6 endpoints
Response DTO for billable service information
BillableServiceDtoPagedResult1 endpoint
BillableServicePricingOptionDto
DTO for billable service pricing option information
BillableServicePricingOverrideDto
DTO for revenue range-specific pricing overrides
BillableServicePricingTierDto
DTO for a custom pricing tier defined on a billable service
BillableServicePricingTierOverrideDto
DTO for a custom tier-specific pricing override
BillableServiceStageDto
DTO for a user-defined workflow stage on a billable service
BillingAccountResponse3 endpoints
Response model representing a billing account.
BillingAddress
Represents a billing address.
BulkDeleteResult1 endpoint
BulkDeleteTasksRequest1 endpoint
BulkSendDataFormRequest1 endpoint
DTO for sending a form to multiple clients
BulkUpdateClientsRequest1 endpoint
Request to bulk update multiple clients. At least one update field must be provided. For PartnerCode...
BulkUpdateResult2 endpoints
BulkUpdateTasksRequest1 endpoint
BusinessDetailsDto3 endpoints
Business-specific details for clients, including companies and sole traders. Includes UK Companies H...
ButtonStyleDto
Button styling configuration for a design theme. All properties are nullable - when null, buttons fa...
ChangeSubscriptionRequest1 endpoint
Request to change a tenant's subscription to a different package. The pricing tier is automatically ...
ChecklistItemDto
ClientAgentAuthorisationDto
Represents one of the 11 HMRC 64-8 agent authorisation types for a client
ClientBillableServiceDto3 endpoints
Response DTO for client billable service information
ClientBillableServiceDtoPagedResult1 endpoint
ClientBillableServiceStageDto
Stage information for display on a client's billable service
ClientBillableServiceSummaryDto
Lightweight projection of a client billable service for kanban board cards. Contains only the fields...
ClientBillableServiceSummaryDtoPagedResult1 endpoint
ClientConfirmationDto
Summary DTO for a client confirmation workflow step
ClientConfirmationDtoPagedResult1 endpoint
ClientConfirmationExecutionStateDto
Execution state for a ClientConfirmation workflow step. Read-only - written by the system during ste...
ClientConfirmationStepConfigDto
Configuration for ClientConfirmation workflow steps. Email template is configured in ClientPortalSet...
ClientContactDto4 endpoints
Response DTO for client-contact relationship information
ClientContactDtoPagedResult1 endpoint
ClientDateDto
Represents an important date associated with a client, such as year-end, accounts due date, or VAT r...
ClientDocumentDto9 endpoints
Represents a document associated with a client, such as letters, engagement letters, proposals, or o...
ClientDocumentDtoPagedResult2 endpoints
ClientDocumentPortalViewResult1 endpoint
Paginated list of client documents with portal folder navigation, as seen by the client. Used by the...
ClientDto3 endpoints
Response DTO for client information
ClientDtoPagedResult1 endpoint
ClientEmailRuleDto3 endpoints
A rule that associates emails with a client. The value determines the matching behaviour: email addr...
ClientEmailRuleDtoPagedResult1 endpoint
ClientImportRequestDto1 endpoint
Request to import clients from a third-party platform
ClientLinkDto3 endpoints
Response DTO for client link information
ClientLinkDtoPagedResult1 endpoint
ClientPortalSettingsDto2 endpoints
Client portal settings for the tenant
ClientSettingsDto2 endpoints
Tenant-level configuration for client field visibility and behavior
ClientThirdPartyMappingDto1 endpoint
Lightweight DTO for viewing client third-party platform mappings
ClientThirdPartyMappingDtoPagedResult1 endpoint
CodeAndNameDto1 endpoint
Company1 endpoint
CompanyAddress
CompanyDetailsDto
Company registration and filing details (Companies House)
CompanySearchResponse1 endpoint
CompanySearchResult
CompleteMandateSetupRequest1 endpoint
Request model for completing a GoCardless Direct Debit mandate setup after the user has authorised t...
ConfirmCsvImportRequest1 endpoint
Request to confirm column mapping configuration and start a CSV import job. Used after uploading a C...
ConnectionCredentialsResponse1 endpoint
Response containing OAuth credentials for a connection
ConnectionFolderDto
A folder available in a document storage connection. Returned by the list-folders endpoint used to d...
ContactDto3 endpoints
Represents a person or contact within the tenant's organization. Contacts can be associated with one...
ContactDtoPagedResult1 endpoint
ContactPreferencesDto
Contact preferences for a client
ContentBlockCollection
Collection of content block references. Generic wrapper that can be reused for any list of content b...
ContentBlockDto5 endpoints
DTO for content blocks, exposing only codes and structured data (never DB IDs).
ContentBlockDtoPagedResult1 endpoint
ContentBlockReference
Generic container for passing dynamic content blocks with variables and metadata to templates. This ...
ConversationClientAssociationDto
A client associated with a conversation
ConversationClientSuggestionDto
A suggested client to associate with a conversation, based on matching participant emails
ConversationWithAssociationsDto1 endpoint
A conversation's messages enriched with client associations derived from email rules.
ConvertFormFieldWarning
A warning about a field that could not be automatically mapped during conversion
ConvertFormFileRequest1 endpoint
Request to convert an external form definition file into the Sodium import format. The raw file cont...
ConvertFormFileResponse1 endpoint
Result of converting an external form definition file into the Sodium import format
CreateAmlClientRequest1 endpoint
CreateAmlContactRequest
CreateApiKeyRequest1 endpoint
Request to create a new API key
CreateBillableServiceRequest1 endpoint
Request DTO for creating a new billable service
CreateClientBillableServiceRequest1 endpoint
Request DTO for creating a new client billable service assignment
CreateClientContactRequest1 endpoint
Request DTO for creating a new client-contact relationship
CreateClientDocumentFromTemplateRequest1 endpoint
Request to generate a PDF document from a template and save it as a client document.
CreateClientEmailRuleRequest1 endpoint
Request to create a new email rule for a client. Provide an email address (e.g. "john@acme.com") to ...
CreateClientLinkRequest1 endpoint
Request DTO for creating a new client link
CreateClientNoteRequest1 endpoint
Request DTO for creating a new client note
CreateClientRequest1 endpoint
Request DTO for creating a new client
CreateContactRequest1 endpoint
DTO for creating a contact
CreateContentBlockRequest1 endpoint
Request to create a new reusable content block that can be included in document templates. Content b...
CreateCsvMappingRequest1 endpoint
Request to create a new reusable CSV mapping. Saved mappings can be referenced by code in future imp...
CreateCustomFieldDefinitionRequest1 endpoint
CreateCustomFieldGroupRequest1 endpoint
CreateCustomTokenRequest1 endpoint
DTO for creating a custom token
CreateCustomerRequest1 endpoint
DTO for creating a customer in an accounting platform
CreateDataFormCategoryRequest1 endpoint
DTO for creating a form category
CreateDataFormRequest1 endpoint
DTO for creating or updating a form (whole-form save including sections and questions)
CreateDesignThemeRequest1 endpoint
Request to create a new design theme for document styling
CreateDocumentCategoryRequest1 endpoint
DTO for creating a document category
CreateDocumentRequestRequest1 endpoint
Request DTO for creating a new document request
CreateDocumentTemplateRequest1 endpoint
Request to create a new document template that can generate documents using Liquid syntax. Templates...
CreateEmailConfigRequest1 endpoint
Request DTO for creating a new email configuration
CreateEngagementRequest1 endpoint
Request DTO for creating a new engagement
CreateOnboardingReportRequest1 endpoint
Request to create an onboarding report for a contact in the AML platform.
CreateOnboardingTaskTemplateRequest1 endpoint
Request DTO for creating a new onboarding task template
CreateProfessionalClearanceRequestItemRequest1 endpoint
DTO for creating a professional clearance request item
CreateRecurringTaskItemRequest1 endpoint
Request DTO for creating a new recurring task template
CreateRevenueRangeRequest1 endpoint
DTO for creating a revenue range
CreateSavedClientFilterRequest1 endpoint
Request model for creating a new saved client filter
CreateSavedTaskFilterRequest1 endpoint
Request model for creating a new saved task filter
CreateServicePackageItemRequest
Request DTO for a service to include in a service package
CreateServicePackageRequest1 endpoint
Request DTO for creating a new service package
CreateTaskCategoryRequest1 endpoint
DTO for creating a task category
CreateTaskItemNoteRequest2 endpoints
Request DTO for creating a new task item note
CreateTaskItemRequest1 endpoint
Request model for creating a new task
CreateTeamRequest1 endpoint
Request DTO for creating a team
CreateTenantHolidayRequest1 endpoint
Request to create a tenant-specific holiday
CreateTenantUserRequest1 endpoint
DTO for creating a user within a tenant. Inherits update fields and adds email/name for creation.
CreateThirdPartyConnectionRequest1 endpoint
Request for creating a new ThirdPartyConnection
CreateWorkflowRequest1 endpoint
Request to create a new workflow
CsvColumnMappingDto
Represents a single column mapping from a CSV header to a client field. Used in column mapping confi...
CsvExportFilterDto
Filter criteria for selecting which clients to export. Matches the same filters available on the cli...
CsvExportJobDto3 endpoints
Represents the current status and progress of a CSV export job. Returned when starting an export or ...
CsvExportRequestDto1 endpoint
Request to start a CSV export of clients. Specify column mappings and optional filter criteria to co...
CsvImportJobDto4 endpoints
Represents the current status and progress of a CSV import job. Returned when starting an import or ...
CsvMappingDto3 endpoints
Represents a saved CSV mapping configuration. Mappings define how CSV columns map to client fields a...
CsvMappingDtoPagedResult1 endpoint
CsvUploadResponseDto1 endpoint
Response from uploading a CSV file with showPreview=true. Contains a preview of the CSV data and aut...
CurrentUserResponse1 endpoint
Response DTO for the current authenticated user
CustomFieldDefinitionDto3 endpoints
Defines a custom field that can be attached to entities such as clients. Custom fields allow tenants...
CustomFieldDefinitionDtoPagedResult1 endpoint
CustomFieldGroupDto3 endpoints
A named group for organising custom field definitions. Each group renders as its own card on the ent...
CustomFieldGroupDtoPagedResult1 endpoint
CustomFieldValueDto
A custom field value for a client. Use the custom field definitions endpoint to retrieve data types,...
CustomTokenDto3 endpoints
A user-defined custom token for document templates
CustomTokenDtoPagedResult1 endpoint
CustomerDto2 endpoints
Customer data retrieved from third-party accounting platforms (Xero, QuickBooks, FreeAgent, etc.). R...
DataFormAnswerDto
An individual answer to a form question
DataFormCategoryDto3 endpoints
A grouping used to classify forms
DataFormCategoryDtoPagedResult1 endpoint
DataFormDto6 endpoints
A custom form definition (list view)
DataFormDtoPagedResult1 endpoint
DataFormPreviewDto1 endpoint
Preview of a form as the client would see it (sections + questions, no internal metadata)
DataFormPreviewQuestionDto
DataFormPreviewSectionDto
DataFormQuestionDto
A question within a form section
DataFormRequestDto6 endpoints
A form request sent to a client
DataFormRequestDtoPagedResult1 endpoint
DataFormSectionDto
A section within a form
DesignThemeDto4 endpoints
Complete visual styling and branding configuration for generated documents (proposals, engagement le...
DesignThemeDtoPagedResult1 endpoint
DetectedServiceDto
A service detected from the CSV headers during analysis
DirectDebitSettingsDto2 endpoints
Tenant-level configuration for direct debit request behavior and email settings. Controls how direct...
DocumentApprovalExecutionStateDto
Execution state for a DocumentApproval workflow step. Contains information about the document sent f...
DocumentApprovalStepConfigDto
Configuration for DocumentApproval workflow steps. Used for both workflow template definition and ta...
DocumentCategoryDto3 endpoints
A tenant-defined grouping used to classify client documents
DocumentCategoryDtoPagedResult1 endpoint
DocumentRequestDetailDto1 endpoint
Detailed response DTO for a document request, including documents and responses
DocumentRequestDto4 endpoints
Response DTO for a document request
DocumentRequestDtoPagedResult2 endpoints
DocumentRequestExecutionStateDto
Execution state for a DocumentRequest workflow step. Contains information about the created document...
DocumentRequestResponseDto2 endpoints
Response DTO for a document request submission/response
DocumentRequestStepConfigDto
Configuration for DocumentRequest workflow steps. Used for both workflow template definition and tas...
DocumentTemplateDto6 endpoints
Reusable document template for generating HTML documents such as proposals, engagement letters, repo...
DocumentTemplateDtoPagedResult1 endpoint
DocumentTemplateTokenInfo
Information about a token found in a document template, including metadata from custom token definit...
DueDateConfigDto
Configuration for due date intervals on recurring tasks. Specifies how long after the task start dat...
EmailAttachmentDto
Email attachment DTO
EmailAttachmentInfoDto
Email attachment information DTO (for responses)
EmailConfigDto3 endpoints
Response DTO for an email configuration
EmailConfigDtoPagedResult1 endpoint
EmailExecutionStateDto
Execution state for a SendEmail workflow step. Contains information about the sent email after execu...
EmailPreviewRecipientDto
A resolved email recipient for preview display.
EmailRecipient
EmailRecipientConfig1 endpoint
Configuration for resolving email recipients from client contacts, user roles, and static addresses....
EmailRecipientDto
Email recipient DTO
EmailSettingsDto2 endpoints
Tenant-level configuration for outbound email branding and sender information. Controls the visual a...
EmailStepConfigDto
Configuration for SendEmail workflow steps. Used for both workflow template definition and task work...
EmailSummaryDto
Lightweight email summary for list responses
EngagementAcceptanceDto1 endpoint
Response DTO for anonymous engagement acceptance page
EngagementDto3 endpoints
Response DTO for engagement information
EngagementDtoPagedResult1 endpoint
EngagementEmailDto
Represents an email sent for an engagement
EngagementSettingsDto2 endpoints
Tenant-level configuration for engagement behavior, branding, and notification settings. Controls ho...
EngagementSummaryDto1 endpoint
Summary of engagements grouped by status, including counts and total values
EnumMetadata
ExecuteWorkflowStepRequest1 endpoint
Optional request body for executing a workflow step. Required for DocumentApproval steps (must provi...
ExternalDocumentDto
A file from the external storage provider, enriched with metadata from our DB when the file is track...
ExternalDocumentDtoPagedResult1 endpoint
ExternalFolderReferenceDto4 endpoints
DTO for an external folder reference
ExternalMailboxEmailDetailResponse1 endpoint
Full email detail response with body content fetched on-demand from the provider
ExternalMailboxEmailSummaryDto
Summary DTO for a mailbox email (used in list views)
ExternalMailboxEmailSummaryDtoPagedResult1 endpoint
ExternalMailboxFolderDto
One folder (Outlook) or label (Gmail) belonging to a mailbox configuration. Returned by the tenant-s...
FilingHistoryAnnotation
FilingHistoryAssociatedFiling
FilingHistoryDocument
FilingHistoryItem1 endpoint
FilingHistoryItemPagedResult1 endpoint
FilingHistoryResolution
FontSettingsDto
Typography settings for a specific text element (headings, body, tables, etc.) in a design theme. De...
GenerateBillableServiceRequest1 endpoint
Request to generate a BillableService using AI
GenerateWorkflowRequest1 endpoint
Request to generate a Workflow using AI
GetMessageResponse1 endpoint
Response for get message request containing full message details
HttpValidationProblemDetails3 endpoints
IResult
ImageAssetDto3 endpoints
Data transfer object for image asset details
ImageAssetDtoPagedResult1 endpoint
ImportBillableServicesFromLibraryRequest1 endpoint
Request DTO for importing one or more billable services from the library
ImportFromLibraryRequest3 endpoints
Request body for single-item library imports (Workflow, DocumentTemplate, DataForm). Optional — empt...
ImportJobDto4 endpoints
DTO representing an import job status
InitializeWorkflowStepsRequest1 endpoint
Request DTO for initializing or re-initializing workflow steps for a TaskItem. Used when a workflow ...
InitiateMandateSetupRequest1 endpoint
Request model for initiating a GoCardless Direct Debit mandate setup.
InvitationDetailsResponse
Response containing details about an invitation
InviteCodeDto
Represents an invite code used to create new tenants in the system. Invite codes are generated by Su...
InvoiceDto
Invoice data retrieved from third-party accounting platforms (Xero, QuickBooks, FreeAgent, etc.). Us...
InvoiceDtoPagedResult1 endpoint
InvoiceLineItemResponse
Response model representing a single line item on an invoice.
InvoiceRecipient
Represents an additional invoice recipient.
InvoiceResponse1 endpoint
Response model representing an invoice with its line items.
InvoiceSummaryResponse
Summary response model for listing invoices (without line items).
InvoiceSummaryResponsePagedResult1 endpoint
KanbanTaskDto
Lightweight task summary for kanban board cards
LibraryServiceImportItem
A single library service to import, with its code and optional overrides
LinkConversationTaskRequest1 endpoint
Request to link a task to a conversation
ListEmailsResponse1 endpoint
Paginated response for listing emails
MailboxAttachmentDto
Attachment metadata from the provider
MailboxThreadSummaryDto
Summary DTO for a mailbox conversation (one entry per conversation in list views)
MailboxThreadSummaryDtoPagedResult3 endpoints
MailingListSubscriptionDto
MandateDto1 endpoint
Response DTO for a direct debit mandate
MandateSetupResponse1 endpoint
Response model returned when initiating a GoCardless mandate setup. Contains the URL to redirect the...
MandateSummaryResponse
Summary of the active or most recent payment mandate for a billing account.
MarginsDto
Page margin configuration for generated documents. All measurements are in millimeters.
MaterialiseProjectedTaskRequest1 endpoint
Request to materialise a projected task into the database
NoteDto9 endpoints
A note attached to an entity such as a client or task
NoteDtoPagedResult3 endpoints
OAuthSettingsRequest
OAuth settings for initiating OAuth flow (used with Microsoft365 or Google provider types)
OAuthStatusResponse
Response containing OAuth connection status for Microsoft365/Google providers
Officer
OfficerAddress
OnboardingTaskTemplateDto4 endpoints
DTO for onboarding task templates, exposing only codes and enums (never DB IDs).
OnboardingTaskTemplateDtoPagedResult1 endpoint
OpenDocumentRequestRequest1 endpoint
Request DTO for opening (sending to client) a document request. Requires at least one recipient emai...
OpenRouterChoice
A completion choice from the AI model
OpenRouterError
Error information from OpenRouter
OpenRouterMessage
Message content from the AI model
OpenRouterResponse1 endpoint
Response from OpenRouter API for AI generation requests
OpenRouterUsage
Token usage statistics for the AI request
PackageDto1 endpoint
A system-level collection of modules that can be assigned to a tenant
PatchMailboxMessageRequest1 endpoint
Request to bulk-update mailbox message properties (e.g., mark as read/unread)
PayerDto
Simplified DTO for displaying payer (customer) information. Payers are created by GoCardless via Bil...
PaymentMandateResponse2 endpoints
Response model representing a payment mandate.
PortalFolderDto
A folder entry for portal document navigation. Shared between the main API portal-view and client po...
PortalUserDto2 endpoints
A contact who has been granted access to the client portal.
PracticeDetailsDto2 endpoints
Core practice/firm information for the accounting practice or professional services firm. Used for b...
PricingFactorDto
DTO for pricing factor information
PricingFactorOptionDto
DTO for pricing factor option information
PricingTierDto
Response DTO for pricing tier information
ProblemDetails6 endpoints
ProcessInvitationRequest1 endpoint
Request model for processing a user invitation response to join a tenant
ProcessInvitationResponse1 endpoint
Response model for processing an invitation (accept or decline)
ProfessionalClearanceLetterSettingsDto2 endpoints
Tenant-level settings for professional clearance letters
ProfessionalClearanceRequestItemDto3 endpoints
An individual item within a professional clearance request during client onboarding
ProfessionalClearanceRequestItemDtoPagedResult1 endpoint
ReconnectOAuthRequest1 endpoint
Request to initiate OAuth reconnection for an expired or scope-upgraded configuration
ReconnectOAuthResponse1 endpoint
Response containing the OAuth authorisation URL for reconnecting a configuration
RecurrenceConfigDto
Configuration for how often a recurring task repeats.
RecurringTaskItemDto4 endpoints
DTO for recurring task templates, exposing only codes and enums (never DB IDs).
RecurringTaskItemDtoPagedResult1 endpoint
RedeemDiscountCodeRequest1 endpoint
Request to redeem a discount code for a tenant's subscription.
RenderContentBlockRequest1 endpoint
Request to render a content block's body HTML with template variables. Optionally wraps the rendered...
RenderDocumentTemplateRequest1 endpoint
Request to render a document template with dynamic data. The template will be processed with the pro...
RenderTemplateStringRequest1 endpoint
Request to render an arbitrary Liquid template string with the provided variables. Use for rendering...
ReplyEmailRequest1 endpoint
Request to reply to a mailbox email. All fields except HtmlBody are optional — omit them to use prov...
ReplyEmailResponse1 endpoint
Response after replying to a mailbox email
RequestClientApprovalRequest1 endpoint
Request to send a document approval request to specified recipients
ResendDataFormRequestRequest1 endpoint
DTO for resending the notification email for a form request
ResendVerificationResponse1 endpoint
Response DTO for resending verification email
RevenueRangeDto3 endpoints
A revenue band used for tiered service pricing
RevenueRangeDtoPagedResult1 endpoint
ReviewClientDocumentRequest1 endpoint
Request to approve or reject a client-uploaded document
ReviewDataFormAnswerRequest1 endpoint
Request body for reviewing (accepting/rejecting) a single form answer.
ReviewDocumentRequestResponseRequest1 endpoint
Request DTO for reviewing (accepting or rejecting) a document request response
RoleInfo
Information about a user's role within a tenant, including permissions and special designations
SaveClientDateDto
Request DTO for creating or updating an important client date. Used to set dates like year-end, acco...
SavedClientFilterDto3 endpoints
A saved client filter belonging to a tenant user, defining reusable criteria for filtering client li...
SavedClientFilterDtoPagedResult1 endpoint
SavedTaskFilterDto3 endpoints
A saved task filter belonging to a tenant user, defining reusable criteria for filtering task lists
SavedTaskFilterDtoPagedResult1 endpoint
SendDataFormExecutionStateDto
Execution state for a SendDataForm workflow step. Contains information about the created data form r...
SendDataFormRequest1 endpoint
DTO for sending a form to a single client
SendDataFormStepConfigDto
Configuration for SendDataForm workflow steps. Used for both workflow template definition and task w...
SendDirectDebitSetupEmailRequest1 endpoint
SendEmailResponse1 endpoint
Response from send email request
SendInvitationRequest1 endpoint
Request model for sending an invitation to a user
SendMailboxEmailRequest3 endpoints
Request DTO for sending a new email from a tenant's connected mailbox.
ServiceImportJobDto3 endpoints
Represents the current status and progress of a service import job. Returned when starting an import...
ServiceImportPreviewActionDto
Preview for a single service action within a client
ServiceImportPreviewClientDto
Preview for a single client row in the CSV
ServiceImportPreviewDto1 endpoint
Preview of what a service CSV import will do, returned before the user confirms.
ServicePackageDto3 endpoints
Response DTO for service package information
ServicePackageDtoPagedResult1 endpoint
ServicePackageItemDto
DTO for a service included in a service package
SetOrganizationRequest1 endpoint
Request to set organization for a third-party connection
SetPortalAccessRequest1 endpoint
Request to grant or revoke portal access for a contact.
SetServiceStageStepConfigDto
Configuration for SetServiceStage workflow steps. Sets the stage on the client's billable service wh...
SmtpSettingsRequest
SMTP settings for API requests
SmtpSettingsResponseDto
SMTP settings response (passwords are never returned)
StartSubscriptionBillingRequest1 endpoint
Request to start subscription billing for a tenant. Name, billing contact, and tenant are auto-popul...
SubmitDocumentRequestRequest1 endpoint
Request DTO for submitting a document request response
SubscriptionDiscountDto2 endpoints
Response DTO for an active subscription discount on a tenant.
SubscriptionDto3 endpoints
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.
TaskCategoryDto3 endpoints
A grouping used to classify tasks
TaskCategoryDtoPagedResult1 endpoint
TaskFocusConfigDto2 endpoints
Response DTO for a user's task focus panel configuration
TaskFocusConfigItemDto
Response DTO for a single item in the task focus panel configuration
TaskItemDto5 endpoints
A task, either standalone or a workflow step (with parent task context)
TaskItemDtoPagedResult1 endpoint
TaskStartConfigDto
Configuration for when a recurring task should start. Different properties are required based on the...
TaskSummaryDto1 endpoint
DTO for task summary by status
TeamDto3 endpoints
Response DTO for a team
TeamDtoPagedResult1 endpoint
TemplateVariables1 endpoint
Root object containing all variables available for document template rendering. This class serves as...
TenantCreateRequest1 endpoint
Request DTO for creating a new tenant organization
TenantDto3 endpoints
An organisation (tenant) and its configuration
TenantHolidayDto3 endpoints
Tenant-specific custom holiday
TenantHolidayDtoPagedResult1 endpoint
TenantInfo
Information about a tenant that a user belongs to, including statistics and role information
TenantInfoDto
Tenant information for engagement acceptance
TenantUpdateRequest1 endpoint
Request DTO for updating a tenant
TenantUserDto4 endpoints
DTO for a user within a tenant, including their role and basic information.
TenantUserDtoPagedResult1 endpoint
TestEmailRequest1 endpoint
Request to send a test email for verifying configuration
TestEmailResponse1 endpoint
Response from sending a test email
ThirdPartyConnectionDto3 endpoints
Represents an OAuth or API key connection to a third-party platform such as Xero, FreeAgent, Sage, o...
ThirdPartyConnectionDtoPagedResult1 endpoint
ThirdPartyPlatformMetadata
TrackExternalFileRequest1 endpoint
Request to track an existing external file in our system, creating a ClientDocument record that refe...
UpdateAiSettingsRequest1 endpoint
Request DTO for updating AI settings for a tenant
UpdateAmlContactRequest1 endpoint
Request to update a contact in the AML platform. All fields are optional — only provided fields are ...
UpdateBillableServiceRequest1 endpoint
Request DTO for updating an existing billable service
UpdateClientAgentAuthorisationRequest
UpdateClientBillableServiceRequest1 endpoint
Request DTO for updating an existing client billable service assignment
UpdateClientBillableServiceStageRequest1 endpoint
Request DTO for updating a client billable service stage (kanban drag-and-drop)
UpdateClientContactRequest1 endpoint
Request DTO for updating a client-contact relationship
UpdateClientDocumentRequest1 endpoint
UpdateClientEmailRuleRequest1 endpoint
Request to update an existing email matching rule. Provide an email address (e.g. "john@acme.com") t...
UpdateClientLinkRequest1 endpoint
Request DTO for updating a client link
UpdateClientNoteRequest1 endpoint
Request DTO for updating a client note
UpdateClientPortalSettingsRequest1 endpoint
Request to update client portal settings for the tenant
UpdateClientRequest1 endpoint
Request DTO for updating an existing client
UpdateClientSettingsRequest1 endpoint
Request to update client settings for the tenant
UpdateClientThirdPartyMappingRequest1 endpoint
Request DTO for updating a client's third-party platform mappings. Implements RFC 7396 JSON Merge Pa...
UpdateContactRequest1 endpoint
DTO for updating a contact
UpdateContentBlockRequest1 endpoint
Request to update an existing content block
UpdateCsvMappingRequest1 endpoint
Request to update an existing CSV mapping.
UpdateCustomFieldDefinitionRequest1 endpoint
UpdateCustomFieldGroupRequest1 endpoint
UpdateCustomTokenRequest1 endpoint
DTO for updating a custom token
UpdateDataFormCategoryRequest1 endpoint
DTO for updating a form category
UpdateDataFormRequest1 endpoint
DTO for updating a form (whole-form save including sections and questions)
UpdateDesignThemeRequest1 endpoint
Request to update an existing design theme
UpdateDirectDebitSettingsRequest1 endpoint
Request to update direct debit settings for the tenant
UpdateDocumentCategoryRequest1 endpoint
DTO for updating a document category
UpdateDocumentRequestRequest1 endpoint
Request DTO for updating a document request (only allowed while in Draft status)
UpdateDocumentTemplateRequest1 endpoint
UpdateEmailConfigRequest1 endpoint
Request DTO for updating an existing email configuration
UpdateEmailSettingsRequest1 endpoint
Request to update email settings for the tenant
UpdateEngagementRequest1 endpoint
Request DTO for updating an existing engagement
UpdateEngagementSettingsRequest1 endpoint
Request to update engagement settings for the tenant
UpdateImageAssetRequest1 endpoint
Request to update an existing image asset
UpdateOnboardingTaskTemplateRequest1 endpoint
Request DTO for updating an onboarding task template
UpdatePortalUserStatusRequest1 endpoint
Request to activate or deactivate a portal user.
UpdatePracticeDetailsRequest1 endpoint
Request to update practice/firm details
UpdateProfessionalClearanceLetterSettingsRequest1 endpoint
Request to update professional clearance letter settings for the tenant
UpdateProfessionalClearanceRequestItemRequest1 endpoint
DTO for updating a professional clearance request item
UpdateRecurringTaskItemRequest1 endpoint
UpdateRevenueRangeRequest1 endpoint
DTO for updating a revenue range
UpdateSavedClientFilterRequest1 endpoint
Request model for updating an existing saved client filter
UpdateSavedTaskFilterRequest1 endpoint
Request model for updating an existing saved task filter
UpdateServicePackageRequest1 endpoint
Request DTO for updating a service package
UpdateSubscriptionBillingRequest1 endpoint
Request to update billing address and invoice recipients. Name and billing contact are not user-sett...
UpdateTaskCategoryRequest1 endpoint
DTO for updating a task category
UpdateTaskFocusConfigItemRequest
Request DTO for a single item in the task focus panel configuration
UpdateTaskFocusConfigRequest1 endpoint
Request DTO for upserting a user's task focus panel configuration
UpdateTaskItemNoteRequest2 endpoints
Request DTO for updating a task item note
UpdateTaskItemRequest1 endpoint
Request model for updating an existing task
UpdateTeamRequest1 endpoint
Request DTO for updating a team
UpdateTenantHolidayRequest1 endpoint
Request to update a tenant-specific holiday
UpdateTenantUserRequest1 endpoint
DTO for Updating a user within a tenant. Does not include email as it cannot be changed. FirstName/L...
UpdateThirdPartyConnectionRequest1 endpoint
Request for updating an existing ThirdPartyConnection
UpdateUserProfileRequest1 endpoint
Request DTO for updating user profile information (name only)
UpdateWorkflowRequest1 endpoint
Request to update an existing workflow
UpdateWorkflowStepRequest1 endpoint
Request DTO for updating workflow step properties. Supports updating status, assignment, time tracki...
UpdateWorkingDaySettingsRequest1 endpoint
Request to update working day settings for the tenant
UploadEngagementPdfRequest2 endpoints
Request DTO for uploading PDF documents to an engagement
UpsertBaseFolderRequest2 endpoints
Request DTO for upserting the base folder for a connection
UserProfileResponse4 endpoints
Response DTO for user profile information
UtmInfoDto1 endpoint
DTO containing UTM tracking information
ValidationProblemDetails4 endpoints
VatDetailsDto
VAT registration and scheme details for a business
VatPeriodTokens
Computed VAT period tokens for the client's currently open VAT period. Usage: {{ Vat.Period }}, {{ V...
VerificationResponse3 endpoints
Response DTO for email verification operations
VerifyEmailRequest1 endpoint
Request DTO for email verification
WeekDayPatternDto
DTO for positional weekday patterns in recurring tasks. Example: { Position: "First", Day: "Monday" ...
WorkflowDto7 endpoints
DTO for workflow templates, exposing only codes and structured data (never DB IDs).
WorkflowDtoPagedResult1 endpoint
WorkflowGroupDto
DTO for workflow groups within a workflow. Workflow Group Deadlines: Groups define dead...
WorkflowGroupProgressDto
Represents a workflow group with its associated step progress. Used for organizing workflow steps in...
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...
WorkflowStepEmailPreviewDto1 endpoint
Preview of a workflow step email with rendered content and resolved recipients. Returned before send...
WorkflowStepProgressDto2 endpoints
Represents the progress of a single workflow step within a TaskItem. Contains both the step template...
WorkingDaySettingsDto2 endpoints
Working day settings for a tenant