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.

GET AccountingConnectionType
Retrieves metadata (such as the display name) for the AccountingConnectionType enum.
/metadata/accounting-connection-types
GET AgentAuthorisationStatus
Retrieves metadata (such as the display name) for the AgentAuthorisationStatus enum.
/metadata/agent-authorisation-statuses
GET AgentAuthorisationType
Retrieves metadata (such as the display name) for the AgentAuthorisationType enum.
/metadata/agent-authorisation-types
GET AmlContactStatus
Retrieves metadata for the AmlContactStatus enum (onboarding/AML check status per contact).
/metadata/aml-contact-statuses
GET AmlRiskAssessmentStatus
Retrieves metadata (such as the display name and colors) for the AmlRiskAssessmentStatus enum.
/metadata/aml-risk-assessment-statuses
GET AmlRiskLevel
Retrieves metadata (such as the display name and colors) for the AmlRiskLevel enum.
/metadata/aml-risk-levels
GET AmlStatus
Retrieves metadata (such as the display name and colors) for the AmlStatus enum.
/metadata/aml-statuses
GET AiActivity
Retrieves metadata (such as the display name) for the AiActivity enum.
/metadata/ai-activities
GET AiContext
Retrieves metadata (such as the display name) for the AiContext enum.
/metadata/ai-contexts
GET AssignmentType
Retrieves metadata (such as the display name) for the AssignmentType enum.
/metadata/assignment-types
GET AuthenticationType
Retrieves metadata (such as the display name) for the AuthenticationType enum.
/metadata/authentication-types
GET BillingFrequency
Retrieves metadata (such as the display name) for the BillingFrequency enum.
/metadata/billing-frequencies
GET ClientAssociationType
Retrieves metadata (such as the display name) for the ClientAssociationType enum.
/metadata/client-association-types
GET ClientContactType
Retrieves metadata (such as the display name) for the ClientContactType enum.
/metadata/client-contact-types
GET ClientDateSourceType
Retrieves 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 ClientDateType
Retrieves metadata (such as the display name) for the ClientDateType enum.
/metadata/client-date-types
GET ClientCsvTargetField
Retrieves metadata (such as the display name) for the ClientCsvTargetField enum.
/metadata/client-csv-target-fields
GET CsvImportMatchField
Retrieves metadata (such as the display name) for the CsvImportMatchField enum.
/metadata/csv-import-match-fields
GET ClientStatus
Retrieves metadata (such as the display name and colors) for the ClientStatus enum.
/metadata/client-statuses
GET ClientType
Retrieves metadata (such as the display name) for the ClientType enum.
/metadata/client-types
GET CompanyStatus
Retrieves metadata (such as the display name) for the CompanyStatus enum.
/metadata/company-status
GET ConnectionStatus
Retrieves metadata (such as the display name) for the ConnectionStatus enum.
/metadata/connection-statuses
GET ContentBlockCategory
Retrieves metadata (such as the display name) for the ContentBlockCategory enum.
/metadata/content-block-categories
GET CustomFieldDataType
Retrieves metadata for the CustomFieldDataType enum, including display names for each custom field data type.
/metadata/custom-field-data-types
GET CustomFieldEntityType
Retrieves metadata for the CustomFieldEntityType enum, including display names for each entity type that supports custom fields.
/metadata/custom-field-entity-types
GET BooleanDisplayMode
Retrieves metadata for the BooleanDisplayMode enum, including display mode options for Boolean fields.
/metadata/boolean-display-modes
GET FieldDisplayWidth
Retrieves metadata for the FieldDisplayWidth enum, including preset width options for custom field and data form inputs.
/metadata/field-display-widths
GET BackgroundImagePosition
Controls the positioning of a background image on PDF pages.
/metadata/background-image-positions
GET PageSelection
Controls which pages a feature applies to in PDF documents.
/metadata/page-selections
GET TemplateType
Retrieves metadata (such as the display name) for the TemplateType enum.
/metadata/template-types
GET ThemeFont
Retrieves metadata for the ThemeFont enum, including font family, fallback, and Google Font URL.
/metadata/theme-fonts
GET DaysBeforeOrAfter
Retrieves metadata (such as the display name) for the DaysBeforeOrAfter enum.
/metadata/days-before-or-after
GET DataFormAnswerReviewStatus
Retrieves metadata (such as the display name and colors) for the DataFormAnswerReviewStatus enum.
/metadata/data-form-answer-review-statuses
GET DataFormRequestStatus
Retrieves metadata (such as the display name and colors) for the DataFormRequestStatus enum.
/metadata/data-form-request-statuses
GET DataFormStatus
Retrieves metadata (such as the display name and colors) for the DataFormStatus enum.
/metadata/data-form-statuses
GET DocumentRequestStatus
Retrieves metadata (such as the display name and colors) for the DocumentRequestStatus enum.
/metadata/document-request-statuses
GET FilingHistoryCategory
Retrieves metadata (such as the display name) for the FilingHistoryCategory enum.
/metadata/filing-history-categories
GET HolidayAdjustment
Retrieves metadata (such as the display name) for the HolidayAdjustment enum.
/metadata/holiday-adjustments
GET InvoiceStatus
Retrieves metadata (such as the display name) for the InvoiceStatus enum.
/metadata/invoice-statuses
GET KpiPeriod
Retrieves metadata (such as the display name) for the KpiPeriod enum.
/metadata/kpi-periods
GET LinkType
Retrieves metadata (such as the display name and icon) for the LinkType enum.
/metadata/link-types
GET MaritalStatus
Retrieves metadata (such as the display name) for the MaritalStatus enum.
/metadata/marital-statuses
GET MonthDayType
Retrieves metadata (such as the display name) for the MonthDayType enum.
/metadata/month-day-types
GET Nationality
Retrieves metadata (such as the display name) for the Nationality enum.
/metadata/nationalities
GET Permission
Retrieves metadata for the Permission enum, including display names and descriptions of each permission level.
/metadata/permissions
GET PermissibleEntity
Retrieves metadata for the PermissibleEntity enum, including display names of entities that can have permissions applied to them.
/metadata/permissible-entities
GET PlatformCapability
Retrieves metadata for the PlatformCapability enum, including display names of capabilities that third-party platforms can provide.
/metadata/platform-capabilities
GET PresetDateRange
Retrieves metadata for the PresetDateRange enum, including display names for preset date range options.
/metadata/preset-date-ranges
GET ProfessionalBody
Retrieves metadata (such as the display name) for the ProfessionalBody enum.
/metadata/professional-bodies
GET EngagementStatus
Retrieves metadata (such as the display name) for the EngagementStatus enum.
/metadata/engagement-statuses
GET EngagementType
Retrieves metadata (such as the display name) for the EngagementType enum.
/metadata/engagement-types
GET RecurrenceUnit
Retrieves metadata (such as the display name) for the RecurrenceUnit enum.
/metadata/recurrence-units
GET RoleType
Retrieves metadata (such as the display name) for the RoleType enum.
/metadata/role-types
GET ServiceCategory
Retrieves metadata (such as the display name) for the ServiceCategory enum.
/metadata/service-categories
GET ServicePricingMode
Retrieves metadata for the ServicePricingMode enum, indicating whether a service uses Revenue Range or Custom Tiers pricing.
/metadata/service-pricing-modes
GET ServiceStatus
Retrieves metadata (such as the display name, icon, and colors) for the ServiceStatus enum.
/metadata/service-statuses
GET SicCode
Retrieves metadata (such as the code and description) for the SicCode enum.
/metadata/sic-codes
GET SystemRole
Retrieves metadata (such as the display name) for the SystemRole enum.
/metadata/system-roles
GET TaskItemStatus
Retrieves metadata (such as the display name, icon, and colors) for the TaskItemStatus enum.
/metadata/task-item-statuses
GET TenantStatus
Retrieves metadata (such as the display name and colors) for the TenantStatus enum.
/metadata/tenant-statuses
GET TaskStartType
Retrieves metadata (such as the display name) for the TaskStartType enum.
/metadata/task-start-types
GET UserActivityType
Retrieves metadata (such as the display name) for the UserActivityType enum.
/metadata/user-activity-types
GET VatRate
Retrieves metadata (such as the display name) for the VatRate enum.
/metadata/vat-rates
GET VatReportingPeriod
Retrieves metadata (such as the display name) for the VatReportingPeriod enum.
/metadata/vat-reporting-periods
GET VatScheme
Retrieves metadata (such as the display name) for the VatScheme enum.
/metadata/vat-schemes
GET SmartNameToken
Retrieves the available tokens for smart name templates. Use {{ TokenName }} syntax in TaskNameTemplate or OutputNameTemplate (e.g. "VAT Return - {{ C...
/metadata/smart-name-tokens
GET WeekDayType
Retrieves metadata (such as the display name) for the WeekDayType enum.
/metadata/week-day-types
GET WorkflowStepAssignmentType
Retrieves metadata (such as the display name) for the WorkflowStepAssignmentType enum.
/metadata/workflow-step-assignment-types
GET ThirdPartyPlatforms
Retrieves metadata about available third-party platforms and their capabilities.
/metadata/third-party-platforms