API Docs / Schemas / ClientBillableServiceSummaryDto

ClientBillableServiceSummaryDto

Lightweight projection of a client billable service for kanban board cards.
Contains only the fields needed for board display — not the full ClientBillableServiceDto.

Properties

Name Type Description
codestring

The unique code for this client service

The unique code for this client service

clientCodeAndNameDto
billableServiceCodeAndNameDto
stageCodeAndNameDto
stageSetTimestring

When the current stage was set (UTC). Used for calculating time-in-stage on the frontend.

When the current stage was set (UTC). Used for calculating time-in-stage on the frontend.

managedByUserCodeAndNameDto
tasksarray of KanbanTaskDto

Open tasks for this client (not completed or skipped). Only populated in non-verbose mode.

Open tasks for this client (not completed or skipped). Only populated in non-verbose mode.

statusenum

Active Inactive Paused Proposed

Active Inactive Paused Proposed

pricenumber

The base price. Only populated when verbose=true.

The base price. Only populated when verbose=true.

effectivePricenumber

The effective price after adjustments. Only populated when verbose=true.

The effective price after adjustments. Only populated when verbose=true.

overridePricingboolean

Whether pricing is overridden. Only populated when verbose=true.

Whether pricing is overridden. Only populated when verbose=true.

billingFrequencyenum

OneOff Annual Quarterly Monthly

OneOff Annual Quarterly Monthly

startDatestring

The start date. Only populated when verbose=true.

The start date. Only populated when verbose=true.

endDatestring

The end date. Only populated when verbose=true.

The end date. Only populated when verbose=true.

autoInvoiceboolean

Whether auto-invoicing is enabled. Only populated when verbose=true.

Whether auto-invoicing is enabled. Only populated when verbose=true.

nextBillingDatestring

Next billing date. Only populated when verbose=true.

Next billing date. Only populated when verbose=true.

stageIconstring

Stage icon (Lucide icon name). Only populated when verbose=true.

Stage icon (Lucide icon name). Only populated when verbose=true.

stageColorstring

Stage colour (hex). Only populated when verbose=true.

Stage colour (hex). Only populated when verbose=true.

JSON Example

{
  "code": "string",
  "client": {
    "code": "string",
    "name": "string"
  },
  "billableService": {
    "code": "string",
    "name": "string"
  },
  "stage": {
    "code": "string",
    "name": "string"
  },
  "stageSetTime": "2024-01-01T00:00:00Z"
}

Contained in Schemas