cgcloud__Payment__c

This object stores the value that retailers expect as compensation for running promotions, which are executed by using tactics. This object is available in API version 54.0 and later.

Supported Calls 

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

Fields 

LastActivityDate 
  • Type: date
  • Properties: Filter, Group, Nillable, Sort
  • Description: Most recent date on which a user performed an action on the record

LastReferencedDate 
  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: Most recent date on which a user referenced this record.

LastViewedDate 
  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: Most recent date on which a user viewed this record.

Name 
  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: Unique identification of the record.

OwnerId 

  • Type: reference

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Description: ID of the record owner.

    This is a polymorphic relationship field.

  • Relationship Name: Owner

  • Relationship Type: Lookup

  • Refers To: Group, User

RecordTypeId 

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: Represents the record type of the record.

    This is a relationship field.

  • Relationship Name: RecordType

  • Relationship Type: Lookup

  • Refers To: RecordType

cgcloud__Addendum_Reference__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Reference to the previous deduction addendum, if applicable.

cgcloud__Adjustment_Reference__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Reference to the adjusted payment or deduction on the original payment.

cgcloud__Adjustment_Type__c 

  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Description: Specifies the type of adjustment.

  • Possible values:

    • Deduction Addendum
    • Deduction Replacement
    • Payment Reversal

cgcloud__Balance__c 

  • Type: double

  • Properties: Filter, Nillable, Sort

  • Description: Balance of the remaining payment amount.

    This is a calculated field.

  • Formula:

    1cgcloud__Payment_Amount__c  -  (  cgcloud__Total_Tactic_Payout_Amount__c  +  cgcloud__Rejected_Amount__c  )

cgcloud__Currency__c 

  • Type: string

  • Properties: Filter, Nillable, Sort

  • Description: Currency that the sales org of the payment template determines.

    This is a calculated field.

  • Formula:

    1cgcloud__Payment_Template__r.cgcloud__Currency__c

cgcloud__Date_From_Reference_Date__c 

  • Type: date

  • Properties: Filter, Group, Nillable, Sort

  • Description: Used for the Link Tactics feature: linkable tactics must overlap with the time range [payment.reference_date__c - Date_From_Offset__c:payment.reference_Date__c + Date_Thru_Offset__c] (calculated helper value defining ther start of the time range).

    This is a calculated field.

  • Formula:

    1cgcloud__Reference_Date__c + cgcloud__Payment_Template__r.cgcloud__Date_From_Offset__c

cgcloud__Date_Thru_Reference_Date__c 

  • Type: date

  • Properties: Filter, Group, Nillable, Sort

  • Description: Used for the Link Tactics feature: linkable tactics must overlap with the time range [payment.reference_date__c - Date_From_Offset__c:payment.reference_Date__c + Date_Thru_Offset__c] (calculated helper value defining the end of the time range).

    This is a calculated field.

  • Formula:

    1cgcloud__Reference_Date__c +  cgcloud__Payment_Template__r.cgcloud__Date_Thru_Offset__c

cgcloud__Default_Anchor__c 

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: Reference to the default anchor.

    This is a relationship field.

  • Relationship Name: cgcloud__Default_Anchor__r

  • Relationship Type: Lookup

  • Refers To: Account

cgcloud__ERP_Status_Date__c 
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Date on which the payment was received.

cgcloud__ERP_Status__c 
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
  • Description: Reference ID of the received payment.

cgcloud__Ext_Ref_Date__c 
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: External reference date.

cgcloud__External_ID__c 
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
  • Description: External ID.

cgcloud__Family_Status__c 

  • Type: string

  • Properties: Filter, Nillable, Sort

  • Description: Status that defines whether the payment has an associated parent payment.

    This is a calculated field.

  • Formula:

    1IF( RecordType.Name == 'Parent' , 'Parent', (IF(ISBLANK(cgcloud__Parent_Payment__c), 'Orphan', 'Adopted')))

cgcloud__Int_Ref_Date__c 
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Internal reference date.

cgcloud__Internal_ID__c 
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
  • Description: Internal ID.

cgcloud__KPI_Set__c 

  • Type: string

  • Properties: Filter, Nillable, Sort

  • Description: KPI set that’s assigned to the payment template.

    This is a calculated field.

  • Formula:

    1cgcloud__Payment_Template__r.cgcloud__KPI_Set__r.Name

cgcloud__KPIs_Outdated__c 

  • Type: boolean

  • Properties: Defaulted on create, Filter, Group, Sort

  • Description: Checks whether the version of the Salesforce org and the corresponding version for Off-Platform are in sync.

    This field is a calculated field.

    This field is available in API version 55.0 and later.

  • Formula:

    1cgcloud__Version__c <> cgcloud__Offplatform_Version__c

cgcloud__Linked_Tactics_Count__c 

  • Type: double

  • Properties: Filter, Nillable, Sort

  • Description: Count of the Payment Tactic records.

    This is a calculated field.

cgcloud__Offplatform_Version__c 
  • Type: double
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Description: Offplatform version of the payment.

cgcloud__Offset_Summary__c 

  • Type: double

  • Properties: Filter, Nillable, Sort

  • Description: Summary of the Payment Tactic records.

    This is a calculated field.

cgcloud__Original_Reference__c 
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Reference to the original payment.

cgcloud__Parent_Payment__c 

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: Reference to the Parent Payment of the record.

    This is a relationship field.

  • Relationship Name: cgcloud__Parent_Payment__r

  • Relationship Type: Lookup

  • Refers To: cgcloud__Payment__c

cgcloud__Payment_Age__c 

  • Type: double

  • Properties: Filter, Nillable, Sort

  • Description: Age of the payment: Number of days that have passed since the payment request was created.

    This is a calculated field.

  • Formula:

    1TODAY()  -  cgcloud__Reference_Date__c

cgcloud__Payment_Amount__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Amount of the payment.

cgcloud__Payment_Anchor_Number__c 

  • Type: string

  • Properties: Filter, Nillable, Sort

  • Description: Customer number of the Payment Anchor, which is populated based on the selected payment anchor.

    This is a calculated field.

  • Formula:

    1cgcloud__Payment_Anchor__r.cgcloud__Account_Number__c

cgcloud__Payment_Anchor__c 

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: Defines the anchor customer of the payment.

    This is a relationship field.

  • Relationship Name: cgcloud__Payment_Anchor__r

  • Relationship Type: Lookup

  • Refers To: Account

cgcloud__Payment_Status__c 

  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Description: Current status of the payment.

  • Default value: Initial

  • Possible values:

    • Adjusted
    • Cancelled
    • Closed—Approved
    • Error
    • Initial—Open
    • Pending Approval—Submitted for Approval
    • ToBeClosed—To Be Closed

cgcloud__Payment_Tactic_Fund_Summary__c 
  • Type: double
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Description: Summary of the Payment Tactic Funds.

cgcloud__Payment_Template__c 

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: Reference to the payment template.

    This is a relationship field.

  • Relationship Name: cgcloud__Payment_Template__r

  • Relationship Type: Lookup

  • Refers To: cgcloud__Payment_Template__c

cgcloud__Payment_Type__c 

  • Type: string

  • Properties: Filter, Nillable, Sort

  • Description: Type of the payment.

    This is a calculated field.

  • Formula:

    1TEXT(cgcloud__Payment_Template__r.cgcloud__Payment_Type__c)

cgcloud__Planning_Anchor_Number__c 

  • Type: string

  • Properties: Filter, Nillable, Sort

  • Description: Customer number of the Planning Anchor, which is populated based on the selected planning anchor.

    This is a calculated field.

  • Formula:

    1cgcloud__Planning_Anchor__r.cgcloud__Account_Number__c

cgcloud__Planning_Anchor__c 

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: Reference to the Planning Anchor.

    This is a relationship field.

  • Relationship Name: cgcloud__Planning_Anchor__r

  • Relationship Type: Lookup

  • Refers To: Account

cgcloud__Pre_Adjustment_Amount__c 
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Amount of deduction prior to the adjustment and creation of the deduction addendum.

cgcloud__Reference_Date__c 
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Reference date of the payment.

cgcloud__Rejected_Amount__c 
  • Type: double
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Description: Rejected amount of the payment.

cgcloud__Rejected_Reason_Codes__c 

  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: Reasons for the rejected amount of the payment.

  • Possible values:

    • Reason 1—Authorized Return
    • Reason 10—Other Reason
    • Reason 2—Automatic Write-Off of less than $50
    • Reason 3—Damages
    • Reason 4—Freight Claim
    • Reason 5—Post Audit
    • Reason 6—Pricing Errors
    • Reason 7—Rejected-Charge back to customer
    • Reason 8—Transfer to Broker
    • Reason 9—UCD - Unearned Cash Discount

cgcloud__Total_Tactic_Payout_Amount__c 

  • Type: double

  • Properties: Filter, Nillable, Sort

  • Description: Sum of the Payment Tactic records.

    This is a calculated field.

cgcloud__Vendor_Anchor_Number__c 

  • Type: string

  • Properties: Filter, Nillable, Sort

  • Description: Customer number of the vendor anchor, which is populated based on the selected vendor anchor.

    This is a calculated field.

  • Formula:

    1cgcloud__Vendor_Anchor__r.cgcloud__Account_Number__c

cgcloud__Vendor_Anchor__c 

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description: Reference to the vendor anchor.

    This is a relationship field.

  • Relationship Name: cgcloud__Vendor_Anchor__r

  • Relationship Type: Lookup

  • Refers To: Account

cgcloud__Version__c 
  • Type: double
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Description: Version of the payment.

Associated Objects 

Associated Objects 

This object has these associated objects. If the API version isn’t specified, they are available in the same API versions as this object. Otherwise, they are available in the specified API version and later.

Get Started with Consumer Goods Cloud
Retail Execution
Trade Promotion Management
Custom Objects for Trade Promotion Management
cgcloud__Account_Sub_Account__c
cgcloud__Account_Plan__c
cgcloud__Account_Plan_Category__c
cgcloud__Account_Plan_User_Filter__c
cgcloud__Account_Product_Profile__c
cgcloud__Auto_Number_Sequence__c
cgcloud__Business_Year__c
cgcloud__Condition_Search_Group__c
cgcloud__Condition_Search_Rule__c
cgcloud__Custom_Period__c
cgcloud__Custom_Calendar__c
cgcloud__Fund__c
cgcloud__Fund_Product__c
cgcloud__Fund_Template__c
cgcloud__Fund_Transaction__c
cgcloud__Fund_Transaction_Header__c
cgcloud__Fund_Transaction_Row__c
cgcloud__Fund_Transaction_Template__c
cgcloud__KPI_Definition__c
cgcloud__KPI_Map__c
cgcloud__KPI_Set__c
cgcloud__KPI_Set_KPI_Definition__c
cgcloud__Payment_Template__c
cgcloud__Payment__c
cgcloud__Payment_External_Reference__c
cgcloud__Payment_Tactic__c
cgcloud__Payment_Tactic_Fund__c
cgcloud__Payment_Tactic_Product__c
cgcloud__Payment_Tactic_Product_Manual_Input__c
cgcloud__Product_Part__c
cgcloud__Product_Assortment_Product_Share__c
cgcloud__Promotion_Calculation_Server_Offset__c
cgcloud__Promotion_Product_Share__c
cgcloud__Promotion_Push_Status__c
cgcloud__Rate_Based_Funding__c
cgcloud__RBF_Template__c
cgcloud__RBF_Category__c
cgcloud__RBF_Product_Manual_Input__c
cgcloud__RTR_Report_Configuration__c
cgcloud__Smart_UI_Lightning_Settings__c
cgcloud__Tactic_Fund__c
cgcloud__Tactic_Condition_Creation_Definition__c
cgcloud__Tactic_Product_Condition__c
cgcloud__Tactic_Template_Cond_Creation_Def__c
cgcloud__Tactic_Template_Fund_Template__c
cgcloud__UI_Contract__c
cgcloud__User_View__c
cgcloud__View__c
cgcloud__Week_Day_Share_Profile__c
Real Time Reporting
Exporting the KPIs from Hyperforce
Trade Promotion Management Business APIs
Apex Classes for Trade Promotion Management
Derive and Copy Promotions with MetadataWizard and Business Object API
Promotion Wizards & Customization
Metadata Wizard
Business Objects API
Custom Objects for Retail Execution and Trade Promotion Management
Standard and Custom Objects for Future Use
API End-of-Life Policy
Previous Versions