OBJECT
LeadEntity

GraphQL Schema definition

type LeadEntity {
# Arguments
#   apiNames: Api names of custom fields to retrieve. All are 
#   returned if not set.
customFields(apiNames: [String!]): JSONString! 
#   Deferred property. Will return data only if called via get_by_id. Otherwise null 
#   or empty array is used.
pendingScheduledActions: Int 
#   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! 
#   Unique identifier of entity.
id: ID! 
#   Specifies if the entity is considered deleted.
isDeleted: Boolean 
#   Last modification time.
modified: DateTime 
#   Creation time.
created: DateTime 
currencyExchangeRatesList: CurrencyExchangeRatesListEntity 
leadSource: DataEntity 
leadType: LeadTypeEntity 
owner: ClientEntity 
reasonOfClose: DataEntity 
step: StepEntity 
unit: SalesUnitEntity 
#   Relation to single entity instance.
currencyExchangeRatesListId: ID 
#   Multi-line text input field.
description: String 
#   Boolean value.
isArchived: Boolean 
#       Opportunity label flag.
#     
#   Options:
#   Priority = 1 (0b001)
#   Hot = 2 (0b010)
#   Stalled = 4 (0b100)
labelFlag: Int 
#   Relation to single entity instance.
leadSourceId: ID 
#   Relation to single entity instance.
leadTypeId: ID 
#   Name of the entity and its default text representation.
name: String! 
#   Relation to single entity instance.
ownerId: ID 
#   Simple text input field.
quickAccountEmail: String 
#   Simple text input field.
quickAccountName: String 
#   Simple text input field.
quickAccountPhone: String 
#   Simple text input field.
quickContactName: String 
#   Simple text input field.
quickEmail: String 
#   Simple text input field.
quickPhone: String 
#   Qualitative ranking of the opportunity.
ranking: Int 
#   Multi-line text input field.
reasonOfCloseDescription: String 
#   Relation to single entity instance.
reasonOfCloseId: ID 
#   Field whose values are strictly defined with an enumeration of values.
shareMode: ShareModeEnum 
#   Relation to single entity instance.
stepId: ID 
#       Generic field wrapping sqlalchemy column, configurable by constructor.
#     
#   Good for one-of fields / generated fields.
#     
tableName: String! 
#   Relation to single entity instance.
unitId: ID 
#   Revision when entity was lastly changed.
revision: Int 
#   Primary Contact.
primaryContact: ContactEntity 
#   Primary Account.
primaryAccount: AccountEntity 
#   Relations to Contacts.
# 
# Arguments
#   filter: Filter Contact relations by target Contact attributes.
#   filterEdge: Filter LeadOpptyContactRelation relations by edge 
#   (relation) LeadOpptyContactRelation attributes.
#   orderBy: Order Contact relations by target Contact 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.
contactRelations(
filter: ContactFilterInput,
filterEdge: LeadOpptyContactRelationFilterInput,
orderBy: [ContactOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): LeadOpptyContactRelationEntityConnection 
#   Relations to Accounts.
# 
# Arguments
#   filter: Filter Account relations by target Account attributes.
#   filterEdge: Filter LeadOpptyAccountRelation relations by edge 
#   (relation) LeadOpptyAccountRelation attributes.
#   orderBy: Order Account relations by target Account 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.
accountRelations(
filter: AccountFilterInput,
filterEdge: LeadOpptyAccountRelationFilterInput,
orderBy: [AccountOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): LeadOpptyAccountRelationEntityConnection 
#   Field whose values are strictly defined with an enumeration of values.
status: LeadStatusEnum! 
#   Relations to SalesUnits.
# 
# Arguments
#   filter: Filter SalesUnit relations by target SalesUnit 
#   attributes.
#   filterEdge: Filter LeadOpptySharingSalesUnitRelation relations 
#   by edge (relation) LeadOpptySharingSalesUnitRelation attributes.
#   orderBy: Order SalesUnit relations by target SalesUnit 
#   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.
sharingUnits(
filter: SalesUnitFilterInput,
filterEdge: LeadOpptySharingSalesUnitRelationFilterInput,
orderBy: [SalesUnitOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): LeadOpptySharingSalesUnitRelationEntityConnection 
#   Relations to Clients.
# 
# Arguments
#   filter: Filter Client relations by target Client attributes.
#   filterEdge: Filter LeadOpptySharingClientRelation relations by 
#   edge (relation) LeadOpptySharingClientRelation attributes.
#   orderBy: Order Client relations by target Client 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.
sharingClients(
filter: ClientFilterInput,
filterEdge: LeadOpptySharingClientRelationFilterInput,
orderBy: [ClientOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): LeadOpptySharingClientRelationEntityConnection 
#   Relations to CloudObjects.
# 
# Arguments
#   filter: Filter CloudObject relations by target CloudObject 
#   attributes.
#   filterEdge: Filter CloudObjectRelation relations by edge 
#   (relation) CloudObjectRelation 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.
documents(
filter: CloudObjectFilterInput,
filterEdge: CloudObjectRelationFilterInput,
orderBy: [CloudObjectOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): CloudObjectRelationEntityConnection 
enrolledEmailSequences: Int! 
#   Relations to Tags.
# 
# Arguments
#   filter: Filter Tag relations by target Tag attributes.
#   filterEdge: Filter TagRelation relations by edge (relation) 
#   TagRelation attributes.
#   orderBy: Order Tag relations by target Tag 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.
tags(
filter: TagFilterInput,
filterEdge: TagRelationFilterInput,
orderBy: [TagOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): TagRelationEntityConnection 
#   Relations to Profiles.
# 
# Arguments
#   filter: Filter Profile relations by target Profile attributes.
#   filterEdge: Filter ProfileRelation relations by edge (relation) 
#   ProfileRelation attributes.
#   orderBy: Order Profile relations by target Profile 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.
staticProfiles(
filter: ProfileFilterInput,
filterEdge: ProfileRelationFilterInput,
orderBy: [ProfileOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): ProfileRelationEntityConnection 
qualifyDate: DateTime 
daysInStep: Int! 
#   Deferred property. Will return data only if called via get_by_id. Otherwise null 
#   or empty array is used.
fitness: WarningLevelEnum! 
#   Deferred property. Will return data only if called via get_by_id. Otherwise null 
#   or empty array is used.
fitnessDescription: FitnessDescription! 
isFavorite: Boolean! 
lostDate: DateTime 
formattedName: String! 
scoring: EntityScoringResult 
#   Deferred property. Will return data only if called via get_by_id. Otherwise null 
#   or empty array is used.
viewerIdsPerSalesUnit: [UUID!]! 
modifiedByUser: DateTime 
#   Checks which permissions current user has on concrete entity instance.
# 
# Arguments
#   permissions: [Not documented]
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
# Arguments
#   entityType: [Not documented]
relatedEntitiesDrilldown(entityType: EntityNameEnum!): CompactViewDrilldownModel! 
# Arguments
#   ids: [Not documented]
charts(ids: [UUID!]!): [DashboardChartData!] 
# Arguments
#   id: [Not documented]
#   seriesIndex: [Not documented]
#   itemIndex: [Not documented]
chartsDrilldown(id: UUID!, seriesIndex: Int, itemIndex: Int): CompactViewDrilldownModel! 
# Arguments
#   ids: Null to load all fields defined on InterfacePreview entity
#   first: [Not documented]
fields(ids: [UUID!], first: Int): [InterfaceFieldData]! 
# Arguments
#   stepChecklistIds: [Not documented]
stepChecklists(stepChecklistIds: [UUID]): [StepChecklistActivityItem]! 
approval: ApprovalEntity 
}
LeadEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
