ClientBillableServiceDto

Response DTO for client billable service information

Properties

Name	Type	Description
code	string	The unique code for this client service assignment
The unique code for this client service assignment
billableService	CodeAndNameDto
billableServiceCategory	enum	Other CoreAccounting Tax Payroll CompanySecretarial Advisory SoftwareAndTraining
Other CoreAccounting Tax Payroll CompanySecretarial Advisory SoftwareAndTraining
recurringTaskCount	integer	The number of recurring tasks associated with the billable service
The number of recurring tasks associated with the billable service
billingFrequency	enum	OneOff Annual Quarterly Monthly
OneOff Annual Quarterly Monthly
price	number	The base price for this client's service (before any adjustment). If OverridePricing = false: Loaded from BillableService based on BillingFrequency. If OverridePricing = true: Custom base price set by user. The final price after adjustment is in EffectivePrice.
The base price for this client's service (before any adjustment). If OverridePricing = false: Loaded from BillableService based on BillingFrequency. If OverridePricing = true: Custom base price set by user. The final price after adjustment is in EffectivePrice.
overridePricing	boolean	Indicates whether the pricing is overridden with a custom Price value If true: Price is used as-is, ignoring BillableService pricing If false: Price comes from BillableService, and the client-level adjustment is applied
Indicates whether the pricing is overridden with a custom Price value If true: Price is used as-is, ignoring BillableService pricing If false: Price comes from BillableService, and the client-level adjustment is applied
priceAdjustmentPercentage	number	Snapshot of the percentage contribution from selected Percentage-mode pricing factors (positive or negative).
Snapshot of the percentage contribution from selected Percentage-mode pricing factors (positive or negative).
priceAdjustmentFixedAmount	number	Snapshot of the absolute currency contribution from selected FixedAmount-mode pricing factors (positive or negative).
Snapshot of the absolute currency contribution from selected FixedAmount-mode pricing factors (positive or negative).
effectivePrice	number	Read-only. Effective price = Price + (Price * PriceAdjustmentPercentage / 100) + PriceAdjustmentFixedAmount. Both contributions are always applied — they're snapshots from different pricing factors and can coexist.
Read-only. Effective price = Price + (Price * PriceAdjustmentPercentage / 100) + PriceAdjustmentFixedAmount. Both contributions are always applied — they're snapshots from different pricing factors and can coexist.
startDate	string	The start date for this service
The start date for this service
endDate	string	The end date for this service (null means ongoing)
The end date for this service (null means ongoing)
status	enum	Active Inactive Paused Proposed
Active Inactive Paused Proposed
managedByUser	CodeAndNameDto
pricingAnswers	object	The pricing factor answers that determined the final price Key: Question, Value: Answer
The pricing factor answers that determined the final price Key: Question, Value: Answer
pricingTierCode	string	The code of the selected custom pricing tier. Only present when the BillableService uses CustomTiers pricing mode.
The code of the selected custom pricing tier. Only present when the BillableService uses CustomTiers pricing mode.
stage	ClientBillableServiceStageDto
servicePackage	CodeAndNameDto
servicePackageUsePackagePricing	boolean	Whether the originating service package uses package-level pricing
Whether the originating service package uses package-level pricing
servicePackagePrice	number	The package-level price from the originating service package
The package-level price from the originating service package
servicePackageBillingFrequency	enum	OneOff Annual Quarterly Monthly
OneOff Annual Quarterly Monthly
autoInvoice	boolean	Whether this service automatically generates invoice line items
Whether this service automatically generates invoice line items
nextBillingDate	string	The next date a billable line item will be generated
The next date a billable line item will be generated
createdDate	string	When the service assignment was created
When the service assignment was created
updatedDate	string	When the service assignment was last updated
When the service assignment was last updated

JSON Example

{
  "code": "string",
  "billableService": {
    "code": "string",
    "name": "string"
  },
  "billableServiceCategory": "Other",
  "recurringTaskCount": 0,
  "billingFrequency": "OneOff"
}

ClientBillableServiceDto

Properties

JSON Example

Used By Operations

Contained in Schemas