ClientBillableServiceDto
Response DTO for client billable service information
Properties
| Name | Type | Description |
|---|---|---|
| code | string | The unique code for this client service assignment |
The unique code for this client service assignment | ||
| billableService | CodeAndNameDto | |
| billingFrequency | enum | OneOff Annual Quarterly Monthly |
OneOff Annual Quarterly Monthly | ||
| price | number | The price for this client's service |
The price for this client's service | ||
| overridePricing | boolean | Indicates whether the pricing is overridden with a custom Price value |
Indicates whether the pricing is overridden with a custom Price value | ||
| priceAdjustmentPercentage | number | The percentage adjustment to apply to the base price from BillableService (can be positive or negative) |
The percentage adjustment to apply to the base price from BillableService (can be positive or negative) | ||
| calculatedPrice | number | The final calculated price for this service |
The final calculated price for this service | ||
| startDate | string | The start date for this service |
The start date for this service | ||
| endDate | string | The end date for this service (null means ongoing) |
The end date for this service (null means ongoing) | ||
| status | enum | Active Inactive Paused Proposed |
Active Inactive Paused Proposed | ||
| managedByUser | CodeAndNameDto | |
| pricingAnswers | object | The pricing factor answers that determined the final price |
The pricing factor answers that determined the final price | ||
| createdDate | string | When the service assignment was created |
When the service assignment was created | ||
| updatedDate | string | 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
-
POST
Create Client Service for Client
/api/tenants/{tenant}/clients/{client}/services/clientbillableservice
-
GET
Get Client Service for Client
/api/tenants/{tenant}/clients/{client}/services/clientbillableservice/{code}
-
PUT
Update Client Service for Client
/api/tenants/{tenant}/clients/{client}/services/clientbillableservice/{code}