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 Weekly
OneOff Annual Quarterly Monthly Weekly
price	number	The base price for this client's service (before any adjustment). The final price is: Price + (Price * PriceAdjustmentPercentage / 100) + PriceAdjustmentFixedAmount. Required when OverridePricing = true; ignored when OverridePricing = false (price comes from BillableService). Negative values are allowed (e.g. discounts / credit lines on a proposal).
The base price for this client's service (before any adjustment). The final price is: Price + (Price * PriceAdjustmentPercentage / 100) + PriceAdjustmentFixedAmount. Required when OverridePricing = true; ignored when OverridePricing = false (price comes from BillableService). Negative values are allowed (e.g. discounts / credit lines on a proposal).
overridePricing	boolean	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 the client-level adjustment 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 the client-level adjustment is applied
priceAdjustmentPercentage	number	Percentage contribution from selected Percentage-mode pricing factors (positive or negative). Use -10 for 10% discount, 20 for 20% markup. Defaults to 0.
Percentage contribution from selected Percentage-mode pricing factors (positive or negative). Use -10 for 10% discount, 20 for 20% markup. Defaults to 0.
priceAdjustmentFixedAmount	number	Absolute currency contribution from selected FixedAmount-mode pricing factors (positive or negative). Defaults to 0.
Absolute currency contribution from selected FixedAmount-mode pricing factors (positive or negative). Defaults to 0.
startDate*	string	The start date for this service
The start date for this service
endDate	string	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
managedByUserCode	string	The code of the user managing this service
The code of the user managing this service
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 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.
stageCode	string	The code of the current workflow stage to set on this service (optional)
The code of the current workflow stage to set on this service (optional)
servicePackageCode	string	The code of the service package this service was created from, if any. Links the service to its originating package for display and pricing purposes.
The code of the service package this service was created from, if any. Links the service to its originating package for display and pricing purposes.
setupFee	number	The one-off setup fee for this client's service. Null means no setup fee. When OverrideSetupFee = false, pass the BillableService.SetupFee default (or null). When OverrideSetupFee = true, pass the custom fee (null/0 removes the fee for this client).
The one-off setup fee for this client's service. Null means no setup fee. When OverrideSetupFee = false, pass the BillableService.SetupFee default (or null). When OverrideSetupFee = true, pass the custom fee (null/0 removes the fee for this client).
overrideSetupFee	boolean	Indicates whether to use a custom SetupFee value instead of the BillableService default
Indicates whether to use a custom SetupFee value instead of the BillableService default
autoInvoice	boolean	Whether this service is on the billing schedule. On: occurrences are generated from the start date, frequency and end date, 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 from the start date, frequency and end date, and due ones become billing lines nightly. Off: the service is billed outside Sodium.
setupFeeBillingMoment	enum	OnAcceptance WithFirstInvoice
OnAcceptance WithFirstInvoice
unitQuantity	number	The expected quantity per billing period for services with a non-Fixed pricing basis (e.g. 12 employees). Null means the volume is unknown. Ignored for Fixed services.
The expected quantity per billing period for services with a non-Fixed pricing basis (e.g. 12 employees). Null means the volume is unknown. Ignored for Fixed services.
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. Seeded from the BillableService default at assignment. Ignored for Fixed services.
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. Seeded from the BillableService default at assignment. Ignored for Fixed services.

JSON Example

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

Used By Operations

POST Create Client Service for Client
/tenants/{tenant}/clients/{client}/services/clientbillableservice