OBJECT

AppointmentEntity

link GraphQL Schema definition

  • type AppointmentEntity {
  • # 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!
  • activeReminder: String
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • activityType: AppointmentTypeEntity
  • owner: ClientEntity
  • recurrenceMaster: AppointmentEntity
  • schedule: AppointmentScheduleEntity
  • unit: SalesUnitEntity
  • # Relation to single entity instance.
  • activityTypeId: ID
  • # Multi-line text input field.
  • description: String
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • duration: Float
  • # Datetime information.
  • endDate: DateTime!
  • # Boolean value.
  • inviteesCanEdit: Boolean
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • isRecurrenceActive: Boolean
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • isRecurrenceException: Boolean
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • location: String
  • # Field containing json.
  • meetingUrl: AppointmentMeeting
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • occurenceDate: DateTime
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • organizer: String
  • # Relation to single entity instance.
  • ownerId: ID!
  • # Relation to single entity instance.
  • recurrenceMasterId: ID
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • recurrenceRule: String
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • recurrenceTzid: String
  • # Relation to single entity instance.
  • scheduleId: ID
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • scheduleTzid: String
  • # Datetime information.
  • startDate: DateTime
  • # Name of the entity and its default text representation.
  • subject: String!
  • # 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
  • # Field whose values are strictly defined with an enumeration of values.
  • status: ActivityStatusEnum!
  • # Relations to Accounts.
  • #
  • # Arguments
  • # filter: Filter Account relations by target Account attributes.
  • # filterEdge: Filter ActivityRelation relations by edge
  • # (relation) ActivityRelation 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: ActivityRelationFilterInput,
  • orderBy: [AccountOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ActivityRelationEntityConnection
  • # Relations to Contacts.
  • #
  • # Arguments
  • # filter: Filter Contact relations by target Contact attributes.
  • # filterEdge: Filter ActivityRelation relations by edge
  • # (relation) ActivityRelation 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: ActivityRelationFilterInput,
  • orderBy: [ContactOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ActivityRelationEntityConnection
  • # Relations to Leads.
  • #
  • # Arguments
  • # filter: Filter Lead relations by target Lead attributes.
  • # filterEdge: Filter ActivityRelation relations by edge
  • # (relation) ActivityRelation attributes.
  • # orderBy: Order Lead relations by target Lead 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.
  • leadRelations(
  • filter: LeadFilterInput,
  • filterEdge: ActivityRelationFilterInput,
  • orderBy: [LeadOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ActivityRelationEntityConnection
  • # Relations to Opportunitys.
  • #
  • # Arguments
  • # filter: Filter Opportunity relations by target Opportunity
  • # attributes.
  • # filterEdge: Filter ActivityRelation relations by edge
  • # (relation) ActivityRelation attributes.
  • # orderBy: Order Opportunity relations by target Opportunity
  • # 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.
  • opportunityRelations(
  • filter: OpportunityFilterInput,
  • filterEdge: ActivityRelationFilterInput,
  • orderBy: [OpportunityOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ActivityRelationEntityConnection
  • # Relations to Projects.
  • #
  • # Arguments
  • # filter: Filter Project relations by target Project attributes.
  • # filterEdge: Filter ActivityRelation relations by edge
  • # (relation) ActivityRelation attributes.
  • # orderBy: Order Project relations by target Project 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.
  • projectRelations(
  • filter: ProjectFilterInput,
  • filterEdge: ActivityRelationFilterInput,
  • orderBy: [ProjectOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ActivityRelationEntityConnection
  • # Relations to Quotes.
  • #
  • # Arguments
  • # filter: Filter Quote relations by target Quote attributes.
  • # filterEdge: Filter ActivityRelation relations by edge
  • # (relation) ActivityRelation attributes.
  • # orderBy: Order Quote relations by target Quote 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.
  • quoteRelations(
  • filter: QuoteFilterInput,
  • filterEdge: ActivityRelationFilterInput,
  • orderBy: [QuoteOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ActivityRelationEntityConnection
  • # Relations to CustomEntitys.
  • #
  • # Arguments
  • # filter: Filter CustomEntity relations by target CustomEntity
  • # attributes.
  • # filterEdge: Filter ActivityRelation relations by edge
  • # (relation) ActivityRelation attributes.
  • # orderBy: Order CustomEntity relations by target CustomEntity
  • # 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.
  • customEntityRelations(
  • filter: CustomEntityFilterInput,
  • filterEdge: ActivityRelationFilterInput,
  • orderBy: [CustomEntityOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ActivityRelationEntityConnection
  • # Relations to AppointmentContactInviteesRelations.
  • #
  • # Arguments
  • # filter: Filter AppointmentContactInviteesRelation relations by
  • # target AppointmentContactInviteesRelation attributes.
  • # orderBy: Order AppointmentContactInviteesRelation relations by
  • # target AppointmentContactInviteesRelation 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.
  • inviteesContacts(
  • filter: AppointmentContactInviteesRelationFilterInput,
  • orderBy: [AppointmentContactInviteesRelationOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): AppointmentContactInviteesRelationEntityConnection
  • # Relations to Clients.
  • #
  • # Arguments
  • # filter: Filter Client relations by target Client attributes.
  • # filterEdge: Filter AppointmentClientInviteesRelation relations
  • # by edge (relation) AppointmentClientInviteesRelation 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.
  • inviteesClients(
  • filter: ClientFilterInput,
  • filterEdge: AppointmentClientInviteesRelationFilterInput,
  • orderBy: [ClientOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): AppointmentClientInviteesRelationEntityConnection
  • has3rdPartyMapping: Boolean!
  • reminder: AppointmentReminderEntity
  • # 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
  • # Relations to ActivityComments.
  • #
  • # Arguments
  • # filter: Filter ActivityComment relations by target
  • # ActivityComment attributes.
  • # orderBy: Order ActivityComment relations by target
  • # ActivityComment 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.
  • comments(
  • filter: ActivityCommentFilterInput,
  • orderBy: [ActivityCommentOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ActivityCommentEntityConnection
  • formattedName: String!
  • recurrence: AppointmentRecurrence
  • 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]!
  • }