API Docs / Schemas / ClientBillableServiceDto

ClientBillableServiceDto

Response DTO for client billable service information

Properties

Name Type Description
codestring

The unique code for this client service assignment

The unique code for this client service assignment

billableServiceCodeAndNameDto
billingFrequencyenum

OneOff Annual Quarterly Monthly

OneOff Annual Quarterly Monthly

pricenumber

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.

overridePricingboolean

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 PriceAdjustmentPercentage 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 PriceAdjustmentPercentage is applied

priceAdjustmentPercentagenumber

The percentage adjustment applied on top of the base Price (can be positive or negative).
Final price = Price + (Price * PriceAdjustmentPercentage / 100).
For example: Price = 100, PriceAdjustmentPercentage = 20 results in EffectivePrice = 120.

The percentage adjustment applied on top of the base Price (can be positive or negative).
Final price = Price + (Price * PriceAdjustmentPercentage / 100).
For example: Price = 100, PriceAdjustmentPercentage = 20 results in EffectivePrice = 120.

effectivePricenumber

Read-only. The effective price after applying PriceAdjustmentPercentage to the base Price.
Calculated as: Price + (Price * PriceAdjustmentPercentage / 100).
For example: Price = 100, PriceAdjustmentPercentage = 20 results in EffectivePrice = 120.

Read-only. The effective price after applying PriceAdjustmentPercentage to the base Price.
Calculated as: Price + (Price * PriceAdjustmentPercentage / 100).
For example: Price = 100, PriceAdjustmentPercentage = 20 results in EffectivePrice = 120.

startDatestring

The start date for this service

The start date for this service

endDatestring

The end date for this service (null means ongoing)

The end date for this service (null means ongoing)

statusenum

Active Inactive Paused Proposed

Active Inactive Paused Proposed

managedByUserCodeAndNameDto
pricingAnswersobject

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

pricingTierCodestring

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.

createdDatestring

When the service assignment was created

When the service assignment was created

updatedDatestring

When the service assignment was last updated

When the service assignment was last updated

JSON Example

{
  "code": "string",
  "billableService": {
    "code": "string",
    "name": "string"
  },
  "billingFrequency": "OneOff",
  "price": 0,
  "overridePricing": false
}

Used By Operations

Contained in Schemas