CollectionPlanReason

Represents the reason for initiating the collection process, including non-payment of bills, bankruptcy, outstanding invoices, and deceased account holders. This object is available in API version 63.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Fields

Code

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: A unique code that represents the collection plan reason.

Description

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: A description of the reason for initiating the collection.

IsActive

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates if the collection plan reason is active (true) or not (false).
Default value: false

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last viewed this record or list view. If this value is null, and <parmname>LastReferenceDate</parmname> is not null, the user accessed this record or list view indirectly.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The reason for initiating the collection.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The ID of the owner of the collection plan reason record.

This field is a relationship field.
Relationship Name: Owner
Refers To: User

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

CollectionPlanReasonChangeEvent: Change events are available for the object.
CollectionPlanReasonHistory: History is available for tracked fields of the object.
CollectionPlanReasonOwnerSharingRule: Sharing rules are available for the object.
CollectionPlanReasonShare: Sharing is available for the object.