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 price for this client's service
If OverridePricing = false: Loaded from BillableService based on BillingFrequency
If OverridePricing = true: Custom price set by user

The price for this client's service
If OverridePricing = false: Loaded from BillableService based on BillingFrequency
If OverridePricing = true: Custom price set by user

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 to apply to the base price from BillableService (can be positive or negative)
Only used when OverridePricing = false. Defaults to 0 (no adjustment)
Use -10 for 10% discount, 15 for 15% markup

The percentage adjustment to apply to the base price from BillableService (can be positive or negative)
Only used when OverridePricing = false. Defaults to 0 (no adjustment)
Use -10 for 10% discount, 15 for 15% markup

calculatedPricenumber

The final calculated price for this service
If OverridePricing = true: Returns Price as-is
If OverridePricing = false: Returns Price + (Price * PriceAdjustmentPercentage / 100)
Used when calculating annual value

The final calculated price for this service
If OverridePricing = true: Returns Price as-is
If OverridePricing = false: Returns Price + (Price * PriceAdjustmentPercentage / 100)
Used when calculating annual value

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

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