Newer Version Available

This content describes an older version of this product. View Latest

ProducerCommission

Represents a producer's commission for an insurance policy. The commission can be calculated from the commissionable transactions or can be populated from an external system. 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

Field Details
CommissionableAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The amount on which the commission is applied. This can be a transaction amount or a portion of the premium.
CommissionAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The calculated commission amount for the insurance policy transaction.
CommissionScheduleId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the associated Commission Schedule, which is the commission calculation tied to the product or producer.
This is a relationship field.
Relationship Name
CommissionSchedule
Relationship Type
Lookup
Refers To
CommissionSchedule
InsurancePolicyAssetId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The insured item for which the commission was calculated.
This is a relationship field.
Relationship Name
InsurancePolicyAsset
Relationship Type
Lookup
Refers To
InsurancePolicyAsset
InsurancePolicyCoverageId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the policy coverage for which the commission was calculated.
This is a relationship field.
Relationship Name
InsurancePolicyCoverage
Relationship Type
Lookup
Refers To
InsurancePolicyCoverage
InsurancePolicyId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The insurance policy for which the commission was calculated.
This is a relationship field.
Relationship Name
InsurancePolicy
Relationship Type
Lookup
Refers To
InsurancePolicy
InsurancePolicyTransactionId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The transaction for which the commission record was created.
This is a relationship field.
Relationship Name
InsurancePolicyTransaction
Relationship Type
Lookup
Refers To
InsurancePolicyTransaction
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.
MaxCommissionAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The maximum commission calculated for the product or producer for a commissionable event. Constrains the output from the commission schedule.
MinCommissionAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The minimum commission calculated for the product or producer for a commissionable event. Constrains the output from the commission schedule.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the producer commission.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the record owner.
This is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
ParentProducerCommissionId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The original commission record that was adjusted or modified.
This is a relationship field.
Relationship Name
ParentProducerCommission
Relationship Type
Lookup
Refers To
ProducerCommission
PaymentDatetime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date on which the commission was paid.
ProcessingProducerId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The producer who performed the commissionable event.
This is a relationship field.
Relationship Name
ProcessingProducer
Relationship Type
Lookup
Refers To
Producer
ProducerId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The producer, broker, brokerage, or other user who receives the commission.
This is a polymorphic relationship field.
Relationship Name
Producer
Relationship Type
Lookup
Refers To
Account, Contact, Producer
ProducerProductionCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The production code for the producer who performs the commissionable event.
SourceSystem
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The system from which the producer commission record was sourced.
SourceSystemIdentifier
Type
string
Properties
Create, Filter, Group, idLookup, Nillable, Sort, Update
Description
The ID of the producer commission record in the source system. This field is unique within your organization.
Status
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the status of the commission payment.
Possible values are:
  • Disputed
  • Paid
  • Pending
  • Reversed
Type
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the type of commission paid to a producer, account, or contact for a commissionable transaction.
Possible values are:
  • Advance
  • Bonus
  • Chargeback
  • Commission
  • Contingent Commission