OBJECT

OpportunityTypeEntity

link GraphQL Schema definition

  • type OpportunityTypeEntity {
  • # Unique identifier of entity.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Pipeline this opportunity type drives. Each opportunity type maps to exactly one
  • # pipeline.
  • pipeline: PipelineEntity
  • # JSON definition of the form layout used by the UI when creating or editing
  • # opportunities of this type.
  • formEdit: JSONString!
  • # JSON definition of the form shown when archiving (losing) an opportunity of this
  • # type. Used to capture reason of close and any required closing fields.
  • formLost: JSONString!
  • # JSON definition of the form shown when qualifying a lead into an opportunity of
  • # this type.
  • formQualify: JSONString!
  • # JSON definition of the form shown when winning an opportunity of this type. Used
  • # to capture won-deal fields.
  • formWon: JSONString!
  • # True when the opportunity type is system-managed and cannot be edited or deleted
  • # by users.
  • isReadonly: Boolean!
  • # Name of the entity and its default text representation.
  • name: String!
  • # Id of the pipeline.
  • pipelineId: ID!
  • # Per-type configuration for records of this entity type, e.g. allowed task and
  • # appointment types that may be linked to records of this type.
  • settings: EntityTypeSettings!
  • # True when the entity configuration is published; false while it exists only as
  • # an unpublished draft.
  • isPublished: Boolean
  • # Revision when entity was lastly changed.
  • revision: Int
  • hasDraft: Boolean
  • # Tells if the entity instance is protected against delete (Entities that need to
  • # be present in the system at any time). Delete action still may fail if entity is
  • # deletable, due some other additional validations.
  • isDeleteProtected: Boolean!
  • formEditApi: Form
  • # Returns if user can change readonly flag on this entity_type.
  • canChangeReadonly: Boolean
  • formLostApi: Form
  • formQualifyApi: [UUID]
  • formWonApi: [UUID]
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }