Represents a hold that pauses the recovery process for a repossession item
due to legal or operational constraints. This object is available in API version
68.0 and later.
Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields
EndDate
- Type: date
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The date the hold is scheduled to expire or was actually concluded.
HoldReason
- Type: picklist
- Properties: Create, Filter, Group, Sort, Update
- Description: A categorized explanation for why the recovery process has been paused. Possible values are: Bankruptcy Stay, Promise To Pay, or Legal Dispute.
HoldReasonReferenceId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The payment schedule record associated with the repossession hold, that justifies the hold. This field is a relationship field.
- Relationship Name: HoldReasonReference
- Relationship Type: Lookup
- Refers To: PaymentSchedule
Name
- Type: string
- Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
- Description: The auto-generated unique identifier for a repossession hold record.
Notes
- Type: textarea
- Properties: Create, Nillable, Update
- Description: The detailed qualitative information regarding the circumstances of the hold or specific instructions for the recovery representative.
PlacedById
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The internal user associated with the repossession hold, who authorized and initiated the hold. This field is a relationship field.
- Relationship Name: PlacedBy
- Relationship Type: Lookup
- Refers To: User
ReleasedById
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The internal user associated with the repossession hold, who authorized the resumption of the repossession process. This field is a relationship field.
- Relationship Name: ReleasedBy
- Relationship Type: Lookup
- Refers To: User
ReleaseReason
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The justification for lifting the hold. Possible values are: Bankruptcy dismissed by court, or Funds verified in account.
RepossessionItemId
- Type: reference
- Properties: Create, Filter, Group, Sort, Update
- Description: The repossession item record associated with the repossession hold. This field is a relationship field.
- Relationship Name: RepossessionItem
- Relationship Type: Lookup
- Refers To: RepossessionItem
StartDate
- Type: date
- Properties: Create, Filter, Group, Sort, Update
- Description: The date the hold was officially applied and recovery efforts were ordered to stop.
Status
- Type: picklist
- Properties: Create, Filter, Group, Sort, Update
- Description: The current status of the repossession hold record. Possible values are: Active, Released, or Expired.