BillableServiceDto

Response DTO for billable service information

Properties

Name	Type	Description
code	string	Stable identifier. For library-shipped items this is the library code; for tenant-imported items this is the tenant entity's own code.
Stable identifier. For library-shipped items this is the library code; for tenant-imported items this is the tenant entity's own code.
name	string	Display name shown to users in lists, dialogs, and the import browser.
Display name shown to users in lists, dialogs, and the import browser.
description	string	Optional human-readable summary of what this entity is for.
Optional human-readable summary of what this entity is for.
libraryCode	string	The Code of the library template this entity was imported from, or null if the entity is not from the library. Read-only — cannot be changed once set. Example: "vat_returns".
The Code of the library template this entity was imported from, or null if the entity is not from the library. Read-only — cannot be changed once set. Example: "vat_returns".
libraryStatus	enum	Describes a library-imported entity's relationship to its source library template. NotFromLibrary UpToDate LocallyModified LibraryUpdated
Describes a library-imported entity's relationship to its source library template. NotFromLibrary UpToDate LocallyModified LibraryUpdated
isImported	boolean	True if the tenant has already imported this library item.
True if the tenant has already imported this library item.
deprecated	boolean	True if this library item has been retired. Deprecated items are hidden from the import browser (so new tasks cannot be created from them) but remain available for revert-to-library on existing imports.
True if this library item has been retired. Deprecated items are hidden from the import browser (so new tasks cannot be created from them) but remain available for revert-to-library on existing imports.
isArchived	boolean	Indicates whether this service is archived (inactive)
Indicates whether this service is archived (inactive)
accountingCode	string	The accounting code for this service
The accounting code for this service
defaultManagedByUser	CodeAndNameDto
serviceScheduleContent	CodeAndNameDto
proposalContent	CodeAndNameDto
category	enum	Other CoreAccounting Tax Payroll CompanySecretarial Advisory SoftwareAndTraining
Other CoreAccounting Tax Payroll CompanySecretarial Advisory SoftwareAndTraining
vatRate	enum	Standard Reduced Zero Exempt OutOfScope
Standard Reduced Zero Exempt OutOfScope
pricingMode	enum	RevenueRange CustomTiers
RevenueRange CustomTiers
pricingTiers	array of BillableServicePricingTierDto	Custom pricing tiers defined on this service. Only populated when PricingMode = CustomTiers.
Custom pricing tiers defined on this service. Only populated when PricingMode = CustomTiers.
stages	array of BillableServiceStageDto	User-defined workflow stages for this service
User-defined workflow stages for this service
clientTypes	array of enum	The types of clients this service is applicable to. An empty list means the service is applicable to all client types. PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader Association
The types of clients this service is applicable to. An empty list means the service is applicable to all client types. PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader Association
agentAuthorisations	array of enum	The HMRC agent authorisation types relevant to this service SelfAssessment CorporationTax PayeForEmployers IndividualPayAsYouEarn VAT ConstructionIndustryScheme TaxCredits HighIncomeChildBenefitCharge MakingTaxDigitalIncomeTax MakingTaxDigitalVat Trusts
The HMRC agent authorisation types relevant to this service SelfAssessment CorporationTax PayeForEmployers IndividualPayAsYouEarn VAT ConstructionIndustryScheme TaxCredits HighIncomeChildBenefitCharge MakingTaxDigitalIncomeTax MakingTaxDigitalVat Trusts
pricing	array of BillableServicePricingOptionDto	The pricing options available for this service Price changes will automatically cascade to all ClientBillableService records using this BillableService (unless OverridePricing is set on the ClientBillableService), but any PriceAdjustmentPercentage will still be applied
The pricing options available for this service Price changes will automatically cascade to all ClientBillableService records using this BillableService (unless OverridePricing is set on the ClientBillableService), but any PriceAdjustmentPercentage will still be applied
pricingFactors	array of PricingFactorDto	The pricing factors that can affect the service pricing calculations
The pricing factors that can affect the service pricing calculations
pcrItems	array of CodeAndNameDto	Professional clearance request items for this service
Professional clearance request items for this service
showKanbanBoard	boolean	Whether this service should appear on the Boards kanban view
Whether this service should appear on the Boards kanban view
stageCount	integer	The number of stages defined on this service
The number of stages defined on this service
recurringTaskCount	integer	The number of recurring tasks associated with this service
The number of recurring tasks associated with this service
invoiceLineDescriptionTemplate	string	Smart name token template for invoice line descriptions
Smart name token template for invoice line descriptions
setupFee	number	Optional one-off setup fee charged when the service is first billed for a client. Null means no setup fee. Used as the default when assigning the service to a client.
Optional one-off setup fee charged when the service is first billed for a client. Null means no setup fee. Used as the default when assigning the service to a client.
createdDate	string	When the service was created
When the service was created
updatedDate	string	When the service was last updated
When the service was last updated

JSON Example

{
  "code": "string",
  "name": "string",
  "description": "string",
  "libraryCode": "string",
  "libraryStatus": "NotFromLibrary"
}

Used By Operations

Contained in Schemas

BillableServiceDtoPagedResult