Home Pricing AI Features Integrations Guides API About Contact Get Started

Home Pricing AI Features Integrations Guides API About Contact Get Started

API Docs / Operations / Metadata / VatScheme

VatScheme

GET /metadata/vat-schemes

Retrieves metadata (such as the display name) for the VatScheme enum.

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.

GETAccountingConnectionType GETAgentAuthorisationStatus GETAgentAuthorisationType GETAmlContactStatus GETAmlRiskAssessmentStatus GETAmlRiskLevel GETAmlStatus GETAiActivity GETAiContext GETAssignmentType GETAuthenticationType GETBillingFrequency GETBillingScheduleDisplayStatus GETBillingScheduleItemKind GETBillingTiming GETSetupFeeBillingMoment GETClientBillingLineItemStatus GETClientInvoiceSubmissionStatus GETClientAssociationType GETClientContactType GETClientDateSourceType GETClientDateType GETClientCsvTargetField GETCsvImportMatchField GETClientStatus GETClientType GETCompanyStatus GETConnectionStatus GETContentBlockCategory GETCustomFieldDataType GETCustomFieldEntityType GETBooleanDisplayMode GETFieldDisplayWidth GETBackgroundImagePosition GETPageSelection GETTemplateType GETThemeFont GETDaysBeforeOrAfter GETDataFormAnswerReviewStatus GETDataFormRequestStatus GETDataFormStatus GETDocumentRequestStatus GETDueDateType GETEmailBroadcastStatus GETEmailBroadcastRecipientStatus GETFilingHistoryCategory GETHolidayAdjustment GETHmrcVerificationResult GETInvoiceStatus GETKpiPeriod GETLinkType GETMaritalStatus GETMonthDayType GETNationality GETPermission GETPermissibleEntity GETPlatformCapability GETPresetDateRange GETPricingBasis GETProfessionalBody GETEngagementStatus GETEngagementType GETRecurrenceUnit GETRecurringTaskOccurrenceStatus GETRoleType GETServicePricingMode GETServiceStatus GETSodiumProduct GETSicCode GETStatutoryDateType GETSystemRole GETTaskItemStatus GETTenantStatus GETTimeBillingLineMode GETWorkTypeRatePrecedence GETTimeEntryBillingState GETTenantUserStatus GETStartDateType GETTaskDateBasis GETUserActivityType GETVatRate GETVatReportingPeriod GETVatScheme GETSmartNameToken GETScheduledSendStatus GETScheduledSendType GETWeekDayType GETWorkflowEmailSenderSource GETWorkflowStepAssignmentType GETWorkflowStepType GETCurrencies GETLocales GETMTD Books Pull Targets GETThirdPartyPlatforms

Responses

200 OK

401 Unauthorized – Invalid or missing API key

Try it

Related Schemas

ProblemDetails

© 2026 Sodium Software Ltd. The Essential Element for Practice Management.