UpdateClientBillableServiceRequest
Request DTO for updating an existing 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 | ||
| price | number | The base price for this client's service (before any adjustment). |
The base price for this client's service (before any adjustment). | ||
| overridePricing | boolean | Indicates whether to use a custom Price value instead of BillableService pricing |
Indicates whether to use a custom Price value instead of BillableService pricing | ||
| 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 |
The pricing factor answers that determined the final price | ||
| 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. |
The code of the service package this service was created from, if any. | ||
| autoInvoice | boolean | Whether this service should automatically generate invoice line items |
Whether this service should automatically generate invoice line items | ||
| nextBillingDate | string | The next date a billable line item should be generated. When omitted and AutoInvoice = true, |
The next date a billable line item should be generated. When omitted and AutoInvoice = true, | ||
JSON Example
{
"billableServiceCode": "string",
"billingFrequency": "OneOff",
"price": 0,
"overridePricing": false,
"priceAdjustmentPercentage": 0,
"startDate": "2024-01-01T00:00:00Z",
"status": "Active"
}