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	CodeAndNameDto
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 Weekly
OneOff Annual Quarterly Monthly Weekly
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. For non-Fixed pricing bases this is the effective rate per unit, not the amount per period.
Read-only. Effective price = Price + (Price * PriceAdjustmentPercentage / 100) + PriceAdjustmentFixedAmount. Both contributions are always applied — they're snapshots from different pricing factors and can coexist. For non-Fixed pricing bases this is the effective rate per unit, not the amount per period.
pricingBasis	enum	Fixed PerHour PerDay PerUnit
Fixed PerHour PerDay PerUnit
unitName	string	The unit label of the underlying billable service for PerUnit pricing (e.g. "employee")
The unit label of the underlying billable service for PerUnit pricing (e.g. "employee")
unitQuantity	number	The expected quantity per billing period for non-Fixed pricing bases (e.g. 12 employees). Null means the volume is unknown. Ignored when PricingBasis is Fixed.
The expected quantity per billing period for non-Fixed pricing bases (e.g. 12 employees). Null means the volume is unknown. Ignored when PricingBasis is Fixed.
quantityVariesPerPeriod	boolean	Whether the billed quantity is expected to change from period to period. When true (default), generated billing lines for this service are always created Pending so the quantity can be confirmed before invoicing, regardless of the approval settings. Ignored when PricingBasis is Fixed.
Whether the billed quantity is expected to change from period to period. When true (default), generated billing lines for this service are always created Pending so the quantity can be confirmed before invoicing, regardless of the approval settings. Ignored when PricingBasis is Fixed.
effectivePeriodAmount	number	Read-only. The amount charged per billing period: EffectivePrice for Fixed services, EffectivePrice × UnitQuantity otherwise (0 when the quantity is unknown).
Read-only. The amount charged per billing period: EffectivePrice for Fixed services, EffectivePrice × UnitQuantity otherwise (0 when the quantity is unknown).
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 Weekly
OneOff Annual Quarterly Monthly Weekly
servicePackageSetupFee	number	The package-level setup fee from the originating service package
The package-level setup fee from the originating service package
setupFee	number	The one-off setup fee for this client's service. Null means no setup fee. If OverrideSetupFee = false: Mirrors the BillableService default at the time of assignment. If OverrideSetupFee = true: Custom setup fee set by user.
The one-off setup fee for this client's service. Null means no setup fee. If OverrideSetupFee = false: Mirrors the BillableService default at the time of assignment. If OverrideSetupFee = true: Custom setup fee set by user.
overrideSetupFee	boolean	Indicates whether the setup fee is overridden with a custom value
Indicates whether the setup fee is overridden with a custom value
isSetupFeeBilled	boolean	Read-only. True once the setup fee has been billed (a Billed SetupFee item exists on the client's billing schedule for this service or its package).
Read-only. True once the setup fee has been billed (a Billed SetupFee item exists on the client's billing schedule for this service or its package).
autoInvoice	boolean	Whether this service is on the billing schedule. On: occurrences are generated and due ones become billing lines nightly. Off: the service is billed outside Sodium.
Whether this service is on the billing schedule. On: occurrences are generated and due ones become billing lines nightly. Off: the service is billed outside Sodium.
setupFeeBillingMoment	enum	OnAcceptance WithFirstInvoice
OnAcceptance WithFirstInvoice
nextBillingDate	string	Read-only. The billing date of the earliest scheduled occurrence for this service (or its package) on the client's billing schedule. Null when nothing is scheduled.
Read-only. The billing date of the earliest scheduled occurrence for this service (or its package) on the client's billing schedule. Null when nothing is scheduled.
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": {
    "code": "string",
    "name": "string"
  },
  "recurringTaskCount": 0,
  "billingFrequency": "OneOff"
}

ClientBillableServiceDto

Properties

JSON Example

Used By Operations

Contained in Schemas