OBJECT

NoteEntity

Note a user wrote on a record such as an account, contact, lead, opportunity, project or quote.

link GraphQL Schema definition

  • type NoteEntity {
  • # 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.
  • 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
  • # Account the note is attached to. Exactly one of account / contact / leadOppty /
  • # project / quote / customEntity must be set.
  • account: AccountEntity
  • # Contact the note is attached to.
  • contact: ContactEntity
  • # Custom entity record the note is attached to.
  • customEntity: CustomEntityEntity
  • # Lead the note is attached to. Set when leadOpptyId resolves to a Lead.
  • lead: LeadEntity
  • # Opportunity the note is attached to. Set when leadOpptyId resolves to an
  • # Opportunity.
  • oppty: OpportunityEntity
  • # User who authored the note.
  • owner: ClientEntity
  • # Project the note is attached to.
  • project: ProjectEntity
  • # Quote the note is attached to.
  • quote: QuoteEntity
  • # Id of the account the note is attached to.
  • accountId: ID
  • # Id of the contact the note is attached to.
  • contactId: ID
  • # Id of the custom entity record the note is attached to.
  • customEntityId: ID
  • # Id of the lead or opportunity the note is attached to.
  • leadOpptyId: ID
  • # Free-form text body of the note (sanitized HTML allowed).
  • note: String!
  • # Id of the note author.
  • ownerId: ID!
  • # Id of the project the note is attached to.
  • projectId: ID
  • # Id of the quote the note is attached to.
  • quoteId: ID
  • # Revision when entity was lastly changed.
  • revision: Int
  • # 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.
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }

link Require by