OBJECT
StepEntity
Step of an opportunity pipeline, lead process or quote process that records move through.
link GraphQL Schema definition
- type StepEntity {
- # True when the record is protected against deletion because it must always exist
- # in the space. Deleting a record that is not protected can still fail on other
- # checks. Read-only.
- : Boolean!
- # Unique identifier of entity.
- : ID!
- # Specifies if the entity is considered deleted.
- : Boolean
- # Last modification time.
- : DateTime
- # Creation time.
- : DateTime
- # Lead process this step belongs to. Set when the step is part of a lead process.
- : LeadProcessEntity
- # Opportunity pipeline this step belongs to. Set when the step is part of an
- # opportunity pipeline.
- : PipelineEntity
- # Quote process this step belongs to. Set when the step is part of a quote
- # process.
- : QuoteProcessEntity
- # Free-text description shown in the step UI.
- : String
- # When true, the record form is read-only while a record is in this step.
- : Boolean
- # When true, transitioning a record into this step bumps its version counter.
- : Boolean
- # Id of the lead process this step belongs to, or empty when the step is not part
- # of a lead process.
- : ID
- # Name of the entity and its default text representation.
- : String!
- # Probability percent associated with the step (0-100). Required for opportunity
- # pipeline steps; null for lead/quote process steps.
- : Int
- # Id of the opportunity pipeline.
- : ID
- # Id of the quote process this step belongs to, or empty when the step is not part
- # of a quote process.
- : ID
- # Position of the step within its pipeline or process; lower values appear first.
- : Int
- # Expected number of days a record should spend in this step. Used to flag overdue
- # records.
- : Int
- # Revision when entity was lastly changed.
- : Int
- # Files attached to the step (e.g. step-specific documentation or templates).
- #
- # Arguments
- # filter: Filter CloudObject relations by target CloudObject
- # attributes.
- # filterEdge: Filter CloudObjectStepRelation relations by edge
- # (relation) CloudObjectStepRelation attributes.
- # orderBy: Order CloudObject relations by target CloudObject
- # attributes.
- # includeDeleted: Returns deleted target records as well. Default
- # is true.
- # before: Cursor until which to take entities to result set.
- # after: Cursor after which to start taking entities to result
- # set.
- # first: Number of entities to return from beginning of the
- # result set.
- # last: Return only the "last" number of entities from result
- # set.
- (
- : CloudObjectFilterInput,
- : CloudObjectStepRelationFilterInput,
- : [CloudObjectOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): CloudObjectStepRelationEntityConnection
- # Checklist items the user must complete before moving a record out of this step.
- #
- # Arguments
- # filter: Filter StepChecklist relations by target StepChecklist
- # attributes.
- # orderBy: Order StepChecklist relations by target StepChecklist
- # attributes.
- # includeDeleted: Returns deleted target records as well. Default
- # is true.
- # before: Cursor until which to take entities to result set.
- # after: Cursor after which to start taking entities to result
- # set.
- # first: Number of entities to return from beginning of the
- # result set.
- # last: Return only the "last" number of entities from result
- # set.
- (
- : StepChecklistFilterInput,
- : [StepChecklistOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): StepChecklistEntityConnection
- # Permissions the current user has on this record, out of the requested ones.
- #
- # Arguments
- # permissions: Permissions to check; the result lists those the
- # current user has.
- (: [EntityPermsEnum!]!): [EntityPermsEnum!]!
- }
link Require by
- CloudObjectStepRelationEntityFile attached to a pipeline step, such as a document the sales team uses in that step.
- CreateStepPayloadResult of the createStep mutation.
- LeadEntityPotential sale in its early stage that moves through a lead process until it is qualified into an opportunity or lost.
- LeadProcessEntityLead process: the ordered steps that leads of its lead types move through.
- OpportunityEntityPotential deal with a value and closing date that moves through the steps of a sales pipeline until it is won or lost.
- OpptyRecurrenceEntityRecurrence rule that creates new copies of an opportunity on a schedule, e.g. for repeat deals once it is won or lost.
- PipelineEntitySales pipeline: the ordered steps that opportunities of its opportunity types move through.
- QuoteEntityPrice offer for a customer, usually prepared from an opportunity, with product line items; it moves through a quote process.
- QuoteProcessEntityQuote process: the ordered steps that quotes of its quote types move through.
- StepChecklistEntityChecklist item of a pipeline step, such as logging an activity, filling a field or attaching a document.
- StepEntityEdgeA Relay edge containing a `StepEntity` and its cursor.
- StepRepositoryRead operations for Step records.
- TimeframeEntityTime a lead or opportunity has spent in a pipeline step.
- UpdateStepPayloadResult of the updateStep mutation.