InsurancePolicyTransaction
Represents a transaction related to a change that affects the premium of an
insurance policy, such as an endorsement, renewal, or cancellation. This object is
available in API version 51.0 and later.
Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Fields
BillingStatus
Category
CommissionAmount
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The commission amount associated with this policy transaction.
EffectiveFromDate
- Type: date
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The date from when the transaction becomes effective.
InsurancePolicyId
- Type: reference
- Properties: Create, Filter, Group, Sort, Update
- Description: The insurance policy this transaction is related to.
InsurancePolicyVersionId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The current version of the insurance policy.
LastReferencedDate
- Type: dateTime
- Properties: Filter, Nillable, Sort
- Description: The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
- Type: dateTime
- Properties: Filter, Nillable, Sort
- Description: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.
Name
- Type: string
- Properties: Create, Filter, Group, idLookup, Sort, Update
- Description: The name of the transaction.
ParentTransactionId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The transaction this insurance policy transaction is related to. For example, a charge transaction is the parent transaction for a payment made against that charge.
PostedDate
- Type: date
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The date when the customer was charged for the insurance policy.
PriorTransactionId
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description: The reference transaction to which the current transaction is linked.
This field is a relationship field.
- Relationship Name: PriorTransaction
- Refers To: InsurancePolicyTransaction
Status
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The current status of a policy transaction.
-
Possible values:
- Approved
- Pending
- Reversed
TotalTransactionAmount
- Type: currency
- Properties: Filter, Nillable, Sort
-
Description: The total amount of transaction, including transaction fee and tax.
This is a calculated field.
TransactionAmount
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The transaction amount.
TransactionEffectiveDate
- Type: dateTime
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The date of the transaction.
TransactionFeeAmount
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The prorated fee for the transaction.
TransactionNumber
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: An identifier for the transaction from an external system.
TransactionPostedDate
- Type: dateTime
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The date on which the amount was charged to the customer.
TransactionTaxAmount
- Type: currency
- Properties: Create, Filter, Nillable, Sort, Update
- Description: The prorated tax on the transaction amount.
Type
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: Specifies the type of transaction.
-
Possible values:
- Cancellation
- Credit
- Deposit
- Endorsement
- Loan
- Premium Payment
- Renewal
- Surcharge
- Surrender
- Withdrawal
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.
- InsurancePolicyTransactionChangeEvent
- Change events are available for the object in API version 62.0 and later.
- InsurancePolicyTransactionFeed
- Feed tracking is available for the object.
- InsurancePolicyTransactionHistory
- History is available for tracked fields of the object.
- InsurancePolicyTransactionOwnerSharingRule
- Sharing rules are available for the object.
- InsurancePolicyTransactionShare
- Sharing is available for the object.