OBJECT

CustomEntityEntity

link GraphQL Schema definition

  • type CustomEntityEntity {
  • # 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
  • owner: ClientEntity
  • type: CustomEntityTypeEntity
  • unit: SalesUnitEntity
  • # Relation to single entity instance.
  • currencyExchangeRatesListId: ID
  • # Name of the entity and its default text representation.
  • name: String
  • # Relation to single entity instance.
  • ownerId: ID!
  • # Field whose values are strictly defined with an enumeration of values.
  • shareMode: ShareModeEnum
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • tableName: String!
  • # Relation to single entity instance.
  • typeId: ID
  • # Relation to single entity instance.
  • unitId: ID
  • # Relations to SalesUnits.
  • #
  • # Arguments
  • # filter: Filter SalesUnit relations by target SalesUnit
  • # attributes.
  • # filterEdge: Filter CustomEntitySharingSalesUnitRelation
  • # relations by edge (relation) CustomEntitySharingSalesUnitRelation 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: CustomEntitySharingSalesUnitRelationFilterInput,
  • orderBy: [SalesUnitOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): CustomEntitySharingSalesUnitRelationEntityConnection
  • # Relations to Clients.
  • #
  • # Arguments
  • # filter: Filter Client relations by target Client attributes.
  • # filterEdge: Filter CustomEntitySharingClientRelation relations
  • # by edge (relation) CustomEntitySharingClientRelation 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: CustomEntitySharingClientRelationFilterInput,
  • orderBy: [ClientOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): CustomEntitySharingClientRelationEntityConnection
  • # 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
  • isFavorite: Boolean!
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Deferred property. Will return data only if called via get_by_id. Otherwise null
  • # or empty array is used.
  • viewerIdsPerSalesUnit: [UUID!]!
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }