API Docs / Schemas / CreateClientBillableServiceRequest

CreateClientBillableServiceRequest

Request DTO for creating a new client billable service assignment

Properties

Name Type Description
billableServiceCode*string

The code of the billable service to assign to this client

The code of the billable service to assign to this client

billingFrequency*enum

OneOff Annual Quarterly Monthly

OneOff Annual Quarterly Monthly

pricenumber

The base price for this client's service (before any adjustment).
This should be the standard/list price, not the final adjusted amount.
The final price is calculated as: Price + (Price * PriceAdjustmentPercentage / 100).
For example, to charge £120 with a 20% increase, send Price = 100 and PriceAdjustmentPercentage = 20.
Required when OverridePricing = true (custom price).
Ignored when OverridePricing = false (price comes from BillableService).

The base price for this client's service (before any adjustment).
This should be the standard/list price, not the final adjusted amount.
The final price is calculated as: Price + (Price * PriceAdjustmentPercentage / 100).
For example, to charge £120 with a 20% increase, send Price = 100 and PriceAdjustmentPercentage = 20.
Required when OverridePricing = true (custom price).
Ignored when OverridePricing = false (price comes from BillableService).

overridePricingboolean

Indicates whether to use a custom Price value instead of BillableService pricing
If true: Must provide Price value
If false: Price is loaded from BillableService, and PriceAdjustmentPercentage is applied

Indicates whether to use a custom Price value instead of BillableService pricing
If true: Must provide Price value
If false: Price is loaded from BillableService, and PriceAdjustmentPercentage is applied

priceAdjustmentPercentagenumber

The percentage adjustment to apply 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 a final price of 120.
Use -10 for a 10% discount, 20 for a 20% markup.
Defaults to 0 (no adjustment).

The percentage adjustment to apply 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 a final price of 120.
Use -10 for a 10% discount, 20 for a 20% markup.
Defaults to 0 (no adjustment).

startDate*string

The start date for this service

The start date for this service

endDatestring

The end date for this service (optional - null means ongoing)

The end date for this service (optional - null means ongoing)

status*enum

Active Inactive Paused Proposed

Active Inactive Paused Proposed

managedByUserCodestring

The code of the user managing this service

The code of the user managing this service

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 custom pricing tier to apply. Required when the BillableService uses CustomTiers and OverridePricing = false.

The code of the custom pricing tier to apply. Required when the BillableService uses CustomTiers and OverridePricing = false.

JSON Example

{
  "billableServiceCode": "string",
  "billingFrequency": "OneOff",
  "price": 0.01,
  "overridePricing": false,
  "priceAdjustmentPercentage": 0,
  "startDate": "2024-01-01T00:00:00Z",
  "status": "Active"
}

Used By Operations