ActivityModel

An Activity contains information about work being done on a specific accounting task.
You can use Activities to track information about who has been assigned a specific task,
the current status of the task, the name and description given for the particular task,
the priority of the task, and any amounts collected, paid, or credited for the task.

Methods

The following API methods use this data model.

Read-Only Fields

These fields are assigned by the API server and cannot be changed.

activityId

uuid, read-only

The unique ID of this record, automatically assigned by Lockstep when this record is
added to the Lockstep platform.

groupKey

uuid, read-only

The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
account will share the same GroupKey value. GroupKey values cannot be changed once created.

For more information, see Accounts and GroupKeys.

created

date-time, read-only

The date on which this activity was created.

createdUserId

uuid, read-only

The ID of the user who created this activity.

modified

date-time, read-only

The date on which this activity was last modified.

modifiedUserId

uuid, read-only

The ID of the user who last modified this activity.

userAssignedToName

string, nullable, read-only

The name of the user the activity is assigned to

Required Fields

companyId

uuid

The ID of the company to which this activity belongs.

activityName

string, 0-100 characters

The name of the activity. The name is a short name provided by the
person who created the activity that can be displayed in a list.

isOpen

boolean

True if this activity is currently "open", which indicates that the activity is
currently in progress.

isUnread

boolean

True if this activity is to be shown in an "unread" state. When an activity
is read by a person it is assigned to, this flag is set to false.

isArchived

boolean

Activities may be archived when they should be hidden from the user. When
this flag is true, this activity should be hidden.

Optional Fields

activityTypeCode

string, nullable, 0-20 characters

The type code of the activity

activityDescription

string, nullable

A description of the activity. This field contains more detailed text about the
activity and can be lengthy.

activityStatus

string, nullable, 0-40 characters

The status of the activity.

priority

string, nullable, 0-25 characters

The priority of the activity.

userAssignedTo

uuid, nullable

The ID of the user the activity is assigned to.

dateAssigned

date-time, nullable

The date the activity was assigned.

dateClosed

date-time, nullable

The date the activity was closed.

snoozeUntilDate

date-time, nullable

If this activity has been "snoozed", this field will be non-null and will contain
the date when the activity will be displayed. Until that date arrives, the activity
will remain hidden.

amountCollected

double, nullable

Amount collected (if any) for the activity.

amountPaid

double, nullable

Amount paid (if any) for the activity.

creditGiven

double, nullable

Credit given (if any) for the activity.

Included Collections

These fields are available when using Retrieve or Query API calls if you specify the associated Include parameter.

company

CompanyModel, nullable, read-only

The company associated with the activity

To retrieve this collection, specify Company in the "Include" parameter for your query.

attachments

AttachmentModel[], nullable, read-only

A collection of attachments linked to this record. To retrieve this collection, specify Attachments in
the include parameter when retrieving data.

To create an attachment, use the Upload Attachment
endpoint with the TableKey to Activity and the ObjectKey set to the ActivityId for this record. For
more information on extensibility, see linking extensible metadata to objects.

notes

NoteModel[], nullable, read-only

A collection of notes linked to this record. To retrieve this collection, specify Notes in the
include parameter when retrieving data.

To create a note, use the Create Note
endpoint with the TableKey to Activity and the ObjectKey set to the ActivityId for this record. For
more information on extensibility, see linking extensible metadata to objects.

customFieldDefinitions

CustomFieldDefinitionModel[], nullable, read-only

A collection of custom fields linked to this record. To retrieve this collection, specify
CustomFieldDefinitions in the include parameter when retrieving data.

To create a custom field, use the Create Custom Field
endpoint with the TableKey to Activity and the ObjectKey set to the ActivityId for this record. For
more information on extensibility, see linking extensible metadata to objects.

customFieldValues

CustomFieldValueModel[], nullable, read-only

A collection of custom fields linked to this record. To retrieve this collection, specify
CustomFieldValues in the include parameter when retrieving data.

To create a custom field, use the Create Custom Field
endpoint with the TableKey to Activity and the ObjectKey set to the ActivityId for this record. For
more information on extensibility, see linking extensible metadata to objects.

references

ActivityXRefModel[], nullable, read-only

All references attached to this applied activity.

To retrieve this collection, specify References in the "Include" parameter for your query.


Did this page help you?