API Docs / Schemas / PipelineDto

PipelineDto

Response DTO for sales pipeline information

Properties

Name Type Description
codestring

Stable identifier. For library-shipped items this is the library code; for tenant-imported
items this is the tenant entity's own code.

Stable identifier. For library-shipped items this is the library code; for tenant-imported
items this is the tenant entity's own code.

namestring

Display name shown to users in lists, dialogs, and the import browser.

Display name shown to users in lists, dialogs, and the import browser.

descriptionstring

Optional human-readable summary of what this entity is for.

Optional human-readable summary of what this entity is for.

libraryCodestring

The Code of the library template this entity was imported from, or null if the entity
is not from the library. Read-only — cannot be changed once set. Example: "vat_returns".

The Code of the library template this entity was imported from, or null if the entity
is not from the library. Read-only — cannot be changed once set. Example: "vat_returns".

libraryStatusenum

Describes a library-imported entity's relationship to its source library template.

NotFromLibrary UpToDate LocallyModified LibraryUpdated

Describes a library-imported entity's relationship to its source library template.

NotFromLibrary UpToDate LocallyModified LibraryUpdated

isImportedboolean

True if the tenant has already imported this library item.

True if the tenant has already imported this library item.

deprecatedboolean

True if this library item has been retired. Deprecated items are hidden from the import
browser (so new tasks cannot be created from them) but remain available for revert-to-library
on existing imports.

True if this library item has been retired. Deprecated items are hidden from the import
browser (so new tasks cannot be created from them) but remain available for revert-to-library
on existing imports.

isArchivedboolean

Indicates whether this pipeline is archived (inactive)

Indicates whether this pipeline is archived (inactive)

defaultManagedByUserCodeAndNameDto
showKanbanBoardboolean

Whether this pipeline should appear on the Boards kanban view

Whether this pipeline should appear on the Boards kanban view

stagesarray of PipelineStageDto

User-defined stages for this pipeline

User-defined stages for this pipeline

stageCountinteger

The number of stages defined on this pipeline

The number of stages defined on this pipeline

recurringTaskCountinteger

The number of recurring tasks associated with this pipeline

The number of recurring tasks associated with this pipeline

createdDatestring

When the pipeline was created

When the pipeline was created

updatedDatestring

When the pipeline was last updated

When the pipeline was last updated

JSON Example

{
  "code": "string",
  "name": "string",
  "description": "string",
  "libraryCode": "string",
  "libraryStatus": "NotFromLibrary"
}

Used By Operations

Contained in Schemas