Metadata
System metadata including enums, display names, colors, icons, and configuration options for all system enums. Provides read-only endpoints for retrieving metadata for enums such as client statuses, task statuses, service categories, billing frequencies, permissions, and many others. Also includes third-party platform metadata with capabilities and OAuth configuration details, and the currency/locale whitelists a practice can be configured with.
-
GET AccountingConnectionTypeRetrieves metadata (such as the display name) for the AccountingConnectionType enum./metadata/accounting-connection-types
-
GET AgentAuthorisationStatusRetrieves metadata (such as the display name) for the AgentAuthorisationStatus enum./metadata/agent-authorisation-statuses
-
GET AgentAuthorisationTypeRetrieves metadata (such as the display name) for the AgentAuthorisationType enum./metadata/agent-authorisation-types
-
GET AmlContactStatusRetrieves metadata for the AmlContactStatus enum (onboarding/AML check status per contact)./metadata/aml-contact-statuses
-
GET AmlRiskAssessmentStatusRetrieves metadata (such as the display name and colors) for the AmlRiskAssessmentStatus enum./metadata/aml-risk-assessment-statuses
-
GET AmlRiskLevelRetrieves metadata (such as the display name and colors) for the AmlRiskLevel enum./metadata/aml-risk-levels
-
GET AmlStatusRetrieves metadata (such as the display name and colors) for the AmlStatus enum./metadata/aml-statuses
-
GET AiActivityRetrieves metadata (such as the display name) for the AiActivity enum./metadata/ai-activities
-
GET AiContextRetrieves metadata (such as the display name) for the AiContext enum./metadata/ai-contexts
-
GET AssignmentTypeRetrieves metadata (such as the display name) for the AssignmentType enum./metadata/assignment-types
-
GET AuthenticationTypeRetrieves metadata (such as the display name) for the AuthenticationType enum./metadata/authentication-types
-
GET BillingFrequencyRetrieves metadata (such as the display name) for the BillingFrequency enum./metadata/billing-frequencies
-
GET ClientBillingLineItemStatusRetrieves metadata (such as the display name and colors) for the ClientBillingLineItemStatus enum./metadata/client-billing-line-item-statuses
-
GET ClientInvoiceSubmissionStatusRetrieves metadata (such as the display name and colors) for the ClientInvoiceSubmissionStatus enum./metadata/client-invoice-submission-statuses
-
GET ClientAssociationTypeRetrieves metadata (such as the display name) for the ClientAssociationType enum./metadata/client-association-types
-
GET ClientContactTypeRetrieves metadata (such as the display name) for the ClientContactType enum./metadata/client-contact-types
-
GET ClientDateSourceTypeRetrieves metadata for the ClientDateSourceType enum, indicating whether a recurring task uses a built-in key date or a tenant-defined custom field da.../metadata/client-date-source-types
-
GET ClientDateTypeRetrieves metadata (such as the display name) for the ClientDateType enum./metadata/client-date-types
-
GET ClientCsvTargetFieldRetrieves metadata (such as the display name) for the ClientCsvTargetField enum./metadata/client-csv-target-fields
-
GET CsvImportMatchFieldRetrieves metadata (such as the display name) for the CsvImportMatchField enum./metadata/csv-import-match-fields
-
GET ClientStatusRetrieves metadata (such as the display name and colors) for the ClientStatus enum./metadata/client-statuses
-
GET ClientTypeRetrieves metadata (such as the display name) for the ClientType enum./metadata/client-types
-
GET CompanyStatusRetrieves metadata (such as the display name) for the CompanyStatus enum./metadata/company-status
-
GET ConnectionStatusRetrieves metadata (such as the display name) for the ConnectionStatus enum./metadata/connection-statuses
-
GET ContentBlockCategoryRetrieves metadata (such as the display name) for the ContentBlockCategory enum./metadata/content-block-categories
-
GET CustomFieldDataTypeRetrieves metadata for the CustomFieldDataType enum, including display names for each custom field data type./metadata/custom-field-data-types
-
GET CustomFieldEntityTypeRetrieves metadata for the CustomFieldEntityType enum, including display names for each entity type that supports custom fields./metadata/custom-field-entity-types
-
GET BooleanDisplayModeRetrieves metadata for the BooleanDisplayMode enum, including display mode options for Boolean fields./metadata/boolean-display-modes
-
GET FieldDisplayWidthRetrieves metadata for the FieldDisplayWidth enum, including preset width options for custom field and data form inputs./metadata/field-display-widths
-
GET BackgroundImagePositionControls the positioning of a background image on PDF pages./metadata/background-image-positions
-
GET PageSelectionControls which pages a feature applies to in PDF documents./metadata/page-selections
-
GET TemplateTypeRetrieves metadata (such as the display name) for the TemplateType enum./metadata/template-types
-
GET ThemeFontRetrieves metadata for the ThemeFont enum, including font family, fallback, and Google Font URL./metadata/theme-fonts
-
GET DaysBeforeOrAfterRetrieves metadata (such as the display name) for the DaysBeforeOrAfter enum./metadata/days-before-or-after
-
GET DataFormAnswerReviewStatusRetrieves metadata (such as the display name and colors) for the DataFormAnswerReviewStatus enum./metadata/data-form-answer-review-statuses
-
GET DataFormRequestStatusRetrieves metadata (such as the display name and colors) for the DataFormRequestStatus enum./metadata/data-form-request-statuses
-
GET DataFormStatusRetrieves metadata (such as the display name and colors) for the DataFormStatus enum./metadata/data-form-statuses
-
GET DocumentRequestStatusRetrieves metadata (such as the display name and colors) for the DocumentRequestStatus enum./metadata/document-request-statuses
-
GET DueDateTypeHow a recurring task's projected DueDate is calculated: offset from start, fixed annual date, or anchored to a client date./metadata/due-date-types
-
GET EmailBroadcastStatusRetrieves metadata (such as the display name and colors) for the EmailBroadcastStatus enum./metadata/email-broadcast-statuses
-
GET EmailBroadcastRecipientStatusRetrieves metadata (such as the display name and colors) for the EmailBroadcastRecipientStatus enum./metadata/email-broadcast-recipient-statuses
-
GET FilingHistoryCategoryRetrieves metadata (such as the display name) for the FilingHistoryCategory enum./metadata/filing-history-categories
-
GET HolidayAdjustmentRetrieves metadata (such as the display name) for the HolidayAdjustment enum./metadata/holiday-adjustments
-
GET HmrcVerificationResultRetrieves metadata (such as the display name and colors) for the HmrcVerificationResult enum — what HMRC last said about an agent authorisation./metadata/hmrc-verification-results
-
GET InvoiceStatusRetrieves metadata (such as the display name) for the InvoiceStatus enum./metadata/invoice-statuses
-
GET KpiPeriodRetrieves metadata (such as the display name) for the KpiPeriod enum./metadata/kpi-periods
-
GET LinkTypeRetrieves metadata (such as the display name and icon) for the LinkType enum./metadata/link-types
-
GET MaritalStatusRetrieves metadata (such as the display name) for the MaritalStatus enum./metadata/marital-statuses
-
GET MonthDayTypeRetrieves metadata (such as the display name) for the MonthDayType enum./metadata/month-day-types
-
GET NationalityRetrieves metadata (such as the display name) for the Nationality enum./metadata/nationalities
-
GET PermissionRetrieves metadata for the Permission enum, including display names and descriptions of each permission level./metadata/permissions
-
GET PermissibleEntityRetrieves metadata for the PermissibleEntity enum, including display names of entities that can have permissions applied to them./metadata/permissible-entities
-
GET PlatformCapabilityRetrieves metadata for the PlatformCapability enum, including display names of capabilities that third-party platforms can provide./metadata/platform-capabilities
-
GET PresetDateRangeRetrieves metadata for the PresetDateRange enum, including display names for preset date range options./metadata/preset-date-ranges
-
GET PricingBasisRetrieves metadata for the PricingBasis enum, indicating whether a service's price is a flat amount per period or a rate multiplied by a quantity (per.../metadata/pricing-bases
-
GET ProfessionalBodyRetrieves metadata (such as the display name) for the ProfessionalBody enum./metadata/professional-bodies
-
GET EngagementStatusRetrieves metadata (such as the display name) for the EngagementStatus enum./metadata/engagement-statuses
-
GET EngagementTypeRetrieves metadata (such as the display name) for the EngagementType enum./metadata/engagement-types
-
GET RecurrenceUnitRetrieves metadata (such as the display name) for the RecurrenceUnit enum./metadata/recurrence-units
-
GET RoleTypeRetrieves metadata (such as the display name) for the RoleType enum./metadata/role-types
-
GET ServicePricingModeRetrieves metadata for the ServicePricingMode enum, indicating whether a service uses Revenue Range or Custom Tiers pricing./metadata/service-pricing-modes
-
GET ServiceStatusRetrieves metadata (such as the display name, icon, and colors) for the ServiceStatus enum./metadata/service-statuses
-
GET SicCodeRetrieves metadata (such as the code and description) for the SicCode enum./metadata/sic-codes
-
GET StatutoryDateTypeHow a recurring task's projected StatutoryDueDate is calculated: none, fixed annual date, or anchored to a client date./metadata/statutory-date-types
-
GET SystemRoleRetrieves metadata (such as the display name) for the SystemRole enum./metadata/system-roles
-
GET TaskItemStatusRetrieves metadata (such as the display name, icon, and colors) for the TaskItemStatus enum./metadata/task-item-statuses
-
GET TenantStatusRetrieves metadata (such as the display name and colors) for the TenantStatus enum./metadata/tenant-statuses
-
GET TimeBillingLineModeRetrieves metadata (such as the display name and description) for the TimeBillingLineMode enum — how billed time entries are shaped into billing line .../metadata/time-billing-line-modes
-
GET TimeEntryBillingStateRetrieves metadata (such as the display name and colors) for the TimeEntryBillingState enum./metadata/time-entry-billing-states
-
GET TenantUserStatusRetrieves metadata (such as the display name and colors) for the TenantUserStatus enum./metadata/tenant-user-statuses
-
GET StartDateTypeRetrieves metadata (such as the display name) for the StartDateType enum./metadata/task-start-types
-
GET TaskDateBasisWhich date is the user-set driving date on a recurring task (StartDate or DueDate). Also used as a filter discriminator on task list queries./metadata/task-date-bases
-
GET UserActivityTypeRetrieves metadata (such as the display name) for the UserActivityType enum./metadata/user-activity-types
-
GET VatRateRetrieves metadata (such as the display name) for the VatRate enum./metadata/vat-rates
-
GET VatReportingPeriodRetrieves metadata (such as the display name) for the VatReportingPeriod enum./metadata/vat-reporting-periods
-
GET VatSchemeRetrieves metadata (such as the display name) for the VatScheme enum./metadata/vat-schemes
-
GET SmartNameTokenRetrieves the available tokens for smart name templates. Use {{ TokenName }} syntax in TaskNameTemplate or OutputNameTemplate (e.g. "VAT Return - {{ C.../metadata/smart-name-tokens
-
GET ScheduledSendStatusRetrieves metadata (such as the display name and colors) for the ScheduledSendStatus enum./metadata/scheduled-send-statuses
-
GET ScheduledSendTypeRetrieves metadata (such as the display name) for the ScheduledSendType enum — the kinds of deferred send shown on the Scheduled tab./metadata/scheduled-send-types
-
GET WeekDayTypeRetrieves metadata (such as the display name) for the WeekDayType enum./metadata/week-day-types
-
GET WorkflowStepAssignmentTypeRetrieves metadata (such as the display name) for the WorkflowStepAssignmentType enum./metadata/workflow-step-assignment-types
-
GET WorkflowStepTypeRetrieves metadata (such as the display name) for the WorkflowStepType enum./metadata/workflow-step-types
-
GET CurrenciesRetrieves the ISO 4217 currencies a practice can be configured to bill in, with each one's symbol./metadata/currencies
-
GET LocalesRetrieves the locales a practice can be configured to format numbers and dates with./metadata/locales
-
GET ThirdPartyPlatformsRetrieves metadata about available third-party platforms and their capabilities./metadata/third-party-platforms