Activity DTO v16

This is a commonly-used object that can be used for different purposes, and can be linked attachments (see Attachment).

  1. It is used for several cases like meetings, service task planning and appointments to store reminder, start and end date (see ActivityType.MEETING).
  2. After a meeting or engagement on customer side it is usually the case that there are some notes to be taken, so the next visitor has the full history about what is going on (see ActivityType.NOTE)
  3. In case of one had a call with a customer, there is the possibility to create an activity of an according type to make some notes that this phone call happened and what the content was (see ActivityType.CONVERSATION)

Activities can be linked to objects (see object parameter) of different types like:

  • Opportunities
  • ServiceCalls
  • SalesQuotation
  • SalesOrder
  • BusinessPartner

Field Name Type Category Constraint Reference Description
activityTemplate Identifier Optional ActivityTemplate : 8, 9, 10, 11
address Identifier Optional Address : 15, 16, 17, 18 Reference to the physical location of this activity (in normal case the address is related the corresponding business partner).
attachmentEntryCode String Optional length >= 0 & length <= 255 For internal use only.
businessPartner Identifier Optional BusinessPartner : 16, 17, 18, 19, 20 Reference to the corresponding business partner, this field should be set regardless of the reference given by object parameter.
checkedOut Boolean Optional Used only in case of group checkouts.
code String Optional length >= 1 & length <= 512 System code of this object, normally this correlates to the erp id given by the source system.
contact Identifier Optional Contact : 12, 13, 14, 15, 16 Reference to the corresponding contact of the related business partner defined in the above 'businessPartner' property.
endDateTime DateTime Optional Start date and time of this activity. This property is normally used for activities of type 'MEETING'.
equipment Identifier Optional Equipment : 14, 15, 16, 17, 18
number String Optional length >= 0 & length <= 512
object ObjectRef Optional Referenced object of this activity. Standard referenced objects are opportunities, service calls, sales quotations, sales orders, business partners.
personal boolean Optional This flag indicates a personal activity. Regularly a personal activity does not have an object reference set.
previousActivity Identifier Optional Activity : 13, 14, 15, 16, 17 Reference to the previous activity if available. If set, then the activity is interpreted as follow up activity.
remarks String Optional length >= 1 & length <= 2147483647 Remarks or notes of this activity, can be used for any string based content which contains necessary information.
reminderDateTime DateTime Optional Date and time when a reminder should be triggered to notify the user about this upcoming event.
responsibles Set<Identifier> Optional Person : 15, 16, 17, 18, 19 List of person objects (of type erpUsers) which are responsible for this activity. This list is considered by the permission system whenever read/write permission is set to OWN.
startDateTime DateTime Optional Start date time of this activity. This property is normally used for activities of type 'MEETING'.
status String Optional length >= 0 & length <= 255

Allowed values are defined into Enumerations having enumType = ACTIVITY_STATUS.
For learning about Enumerations, please check this.
Indicates the current status of this activity. See Enumeration.name (type = 'ACTIVITY_STATUS') for more information.
subType Identifier Optional ActivitySubType : 11, 12, 13, 14 Reference to the sub type of this activity.
subject String Optional length >= 1 & length <= 512 Describes the activity subject. This is a short text summary or title of the object.
topic Identifier Optional ActivityTopic : 11, 12, 13, 14 Reference to the activities topic.
type String Optional length >= 0 & length <= 255

Allowed values are defined into Enumerations having enumType = ACTIVITY_TYPE.
For learning about Enumerations, please check this.
Defines the type of the activity. See ActivityType for more information.