ClientPipelineDto
Response DTO for a client's placement on a sales pipeline (a kanban card).
Properties
| Name | Type | Description |
|---|---|---|
| code | string | The unique code for this pipeline card |
The unique code for this pipeline card | ||
| client | CodeAndNameDto | |
| pipeline | CodeAndNameDto | |
| stage | CodeAndNameDto | |
| stageIcon | string | Stage icon (Lucide icon name) |
Stage icon (Lucide icon name) | ||
| stageColor | string | Stage colour (hex) |
Stage colour (hex) | ||
| stageSetTime | string | When the current stage was set (UTC) |
When the current stage was set (UTC) | ||
| managedByUser | CodeAndNameDto | |
| startDate | string | The date the client entered the pipeline |
The date the client entered the pipeline | ||
| endDate | string | The date the client left the pipeline (optional) |
The date the client left the pipeline (optional) | ||
JSON Example
{
"code": "string",
"client": {
"code": "string",
"name": "string"
},
"pipeline": {
"code": "string",
"name": "string"
},
"stage": {
"code": "string",
"name": "string"
},
"stageIcon": "string"
}
Used By Operations
-
POST
Create Client Pipeline for Client
/tenants/{tenant}/clients/{client}/pipelines/clientpipeline
-
GET
Get Client Pipeline for Client
/tenants/{tenant}/clients/{client}/pipelines/clientpipeline/{code}
-
PUT
Update Client Pipeline for Client
/tenants/{tenant}/clients/{client}/pipelines/clientpipeline/{code}