ClaimPayoutPlan

Represents the payout plan details for a claim, such as payment frequency, duration, and payouts. This object is available in API version 56.0 and later.

Supported Calls

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

Fields

Field Details
ClaimId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The claim associated with the claim payout plan.
This field is a relationship field.
Relationship Name
Claim
Relationship Type
Lookup
Refers To
Claim
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
If multiple currencies are enabled, this field contains the currency ISO code associated with the record.
Possible values are:
  • AED—UAE Dirham
  • CAD—Canadian Dollar
  • GBP—British Pound
  • JPY—Japanese Yen
  • USD—U.S. Dollar
The default value is USD.
EndDate
Type
date
Properties
Create, Filter, Group, Sort, Update
Description
The date the claim payout plan ends.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Name of the claim payout plan.
PaymentFrequency
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Specifies the frequency of the payment if the coverage entails a recurring payout to the insured.
Possible values are:
  • Bi-Weekly
  • Monthly
  • Weekly
  • Yearly
PlannedPaymentAmount
Type
currency
Properties
Create, Filter, Sort, Update
Description
The amount paid to the party at each payout.
PreviousClaimPayoutPlanId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The previous payout plan associated with the claim payout plan.
This field is a relationship field.
Relationship Name
PreviousClaimPayoutPlan
Relationship Type
Lookup
Refers To
ClaimPayoutPlan
StartDate
Type
date
Properties
Create, Filter, Group, Sort, Update
Description
The date the claim payout plan starts.

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.

ClaimPayoutPlanChangeEvent
Change events are available for the object in API version 63.0 and later.
ClaimPayoutPlanFeed
Feed tracking is available for the object.
ClaimPayoutPlanHistory
History is available for tracked fields of the object.