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 60.0 and later.

Supported Calls

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

Special Access Rules

To access this object on your Public Sector org, Benefit Disbursement must be enabled and you must have the Benefit Disbursement Access permission set or the Benefit Disbursement permission set license.

Fields

InsurancePolicyId

Type: reference
Properties: Create, Filter, Group, Sort, Update
Description: Required. The insurance policy this transaction is related to.

This field is a relationship field.
Relationship Name: InsurancePolicy
Relationship Type: Lookup
Refers To: InsurancePolicy

InsurancePolicyVersionId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The current version of the insurance policy.

This field is a relationship field.
Relationship Name: InsurancePolicyVersion
Relationship Type: Lookup
Refers To: InsurancePolicy

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: Required. 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.

This field is a relationship field.
Relationship Name: ParentTransaction
Relationship Type: Lookup
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
- Rejected
- Reversed

TotalTransactionAmount

Type: currency
Properties: Filter, Nillable, Sort
Description: The total amount of transaction, including transaction fee and tax.

This field 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.

InsurancePolicyTransactionFeed: Feed tracking is available for the object.
InsurancePolicyTransactionHistory: History is available for tracked fields of the object.