afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/ProducerCommission.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "field_reference"
  ],
  "title": "ProducerCommission - Data API",
  "description": "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.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "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"
    }
  },
  "field_reference": {
    "CommissionAmount": {
      "field_label": "Commission Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "CommissionableAmount": {
      "field_label": "Commissionable Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "Id": {
      "field_label": "Producer Commission ID",
      "type": "id",
      "length": "18"
    },
    "InsurancePolicyAssetId": {
      "field_label": "Insurance Policy Asset ID",
      "type": "reference",
      "length": "18"
    },
    "InsurancePolicyCoverageId": {
      "field_label": "Insurance Policy Coverage ID",
      "type": "reference",
      "length": "18"
    },
    "InsurancePolicyId": {
      "field_label": "Insurance Policy ID",
      "type": "reference",
      "length": "18"
    },
    "InsurancePolicyTransactionId": {
      "field_label": "Insurance Policy Transaction ID",
      "type": "reference",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "MaxCommissionAmount": {
      "field_label": "Max Commission Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "MinCommissionAmount": {
      "field_label": "Min Commission Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "Name": {
      "field_label": "Name",
      "type": "string",
      "length": "255"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "ParentProducerCommissionId": {
      "field_label": "Producer Commission ID",
      "type": "reference",
      "length": "18"
    },
    "PaymentDatetime": {
      "field_label": "Payment Date",
      "type": "datetime"
    },
    "ProcessingProducerId": {
      "field_label": "Producer ID",
      "type": "reference",
      "length": "18"
    },
    "ProducerId": {
      "field_label": "Producer ID",
      "type": "reference",
      "length": "18"
    },
    "ProducerProductionCode": {
      "field_label": "Producer Production Code",
      "type": "string",
      "length": "255"
    },
    "SourceSystem": {
      "field_label": "Source System",
      "type": "string",
      "length": "255"
    },
    "SourceSystemIdentifier": {
      "field_label": "Source System Identifier",
      "type": "string",
      "length": "255"
    },
    "Status": {
      "field_label": "Status",
      "type": "picklist",
      "length": "40"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "Type": {
      "field_label": "Type",
      "type": "picklist",
      "length": "40"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "precision",
    "scale",
    "length"
  ]
}