UpdateBillableServiceRequest

Request DTO for updating an existing billable service

Properties

Name	Type	Description
name*	string	The name of the service
The name of the service
description	string	The description of the service
The description of the 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
isArchived	boolean	Indicates whether this service is archived (inactive)
Indicates whether this service is archived (inactive)
accountingCode	string	The accounting code for this service (max 20 characters)
The accounting code for this service (max 20 characters)
defaultManagedByUserCode	string	The code of the user who is the default manager for this service
The code of the user who is the default manager for this service
serviceScheduleContentCode	string	The code of the content block to use for service schedule
The code of the content block to use for service schedule
proposalContentCode	string	The code of the content block to use for proposals
The code of the content block to use for proposals
categoryCode*	string	The code of the category for this service
The code of the category for this service
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. Required when PricingMode = CustomTiers.
Custom pricing tiers. Required when PricingMode = CustomTiers.
showKanbanBoard	boolean	Whether this service should appear on the Boards kanban view
Whether this service should appear on the Boards kanban view
stages	array of BillableServiceStageDto	User-defined workflow stages for this service
User-defined workflow stages for this service
pricing	array of BillableServicePricingOptionDto	The pricing options for this service
The pricing options for this service
pricingFactors	array of PricingFactorDto	The pricing factors that can affect the service pricing calculations
The pricing factors that can affect the service pricing calculations
pcrItemCodes	array of string	The codes of professional clearance request items for this service
The codes of professional clearance request items for this service
invoiceLineDescriptionTemplate	string	Smart name token template for invoice line descriptions (e.g. "{{ ServiceName }} - {{ Month }} {{ Year }}")
Smart name token template for invoice line descriptions (e.g. "{{ ServiceName }} - {{ Month }} {{ Year }}")
setupFee	number	Optional one-off setup fee charged when the service is first billed for a client. Null means no setup fee.
Optional one-off setup fee charged when the service is first billed for a client. Null means no setup fee.
pricingBasis	enum	Fixed PerHour PerDay PerUnit
Fixed PerHour PerDay PerUnit
unitName	string	The unit label for PerUnit pricing (e.g. "employee", "timesheet"). Required when PricingBasis is PerUnit, must be blank otherwise.
The unit label for PerUnit pricing (e.g. "employee", "timesheet"). Required when PricingBasis is PerUnit, must be blank otherwise.
quantityVariesPerPeriod	boolean	Whether the billed quantity is expected to change from period to period. When true (default), generated billing lines for non-Fixed services are always created Pending so the quantity can be confirmed before invoicing, regardless of the approval settings. Used as the default when assigning the service to a client. Ignored when PricingBasis is Fixed.
Whether the billed quantity is expected to change from period to period. When true (default), generated billing lines for non-Fixed services are always created Pending so the quantity can be confirmed before invoicing, regardless of the approval settings. Used as the default when assigning the service to a client. Ignored when PricingBasis is Fixed.
defaultUnitQuantity	number	The typical quantity per billing period, used as the default when assigning the service to a client. Null means the volume is unknown. Ignored when PricingBasis is Fixed.
The typical quantity per billing period, used as the default when assigning the service to a client. Null means the volume is unknown. Ignored when PricingBasis is Fixed.

JSON Example

{
  "name": "string",
  "description": "string",
  "clientTypes": [
    "PrivateLimitedCompany"
  ],
  "agentAuthorisations": [
    "SelfAssessment"
  ],
  "isArchived": false,
  "categoryCode": "string"
}

Used By Operations

PUT Update BillableService
/tenants/{tenant}/services/{code}