--- schema_version: "1" id: e6cf355c5ac6285fc96b0176058be8260ba07f8b2251dd6b1b025eb2f9c4ac04 title: cgcloud__Payment__c collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/retail_api/sforce_api_objects_cgcloud__payment__c.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__payment__c.htm source_site: developer.salesforce.com content_type: documentation content_hash: c421dcc1ff33cad867c30f7ea152f28c8b9639af9ca2d303a2b2331e9eb3786f description: 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. --- # 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**: cgcloud\_\_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**: cgcloud\_\_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**: cgcloud\_\_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**: cgcloud\_\_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**: IF( 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**: cgcloud\_\_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**: cgcloud\_\_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**: TODAY() - 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**: cgcloud\_\_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**: TEXT(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**: cgcloud\_\_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**: cgcloud\_\_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. - **[cgcloud\_\_Payment\_\_cChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.")**: Change events are available for the object. - **[cgcloud\_\_Payment\_\_cFeed](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.")**: Feed tracking is available for the object. - **[cgcloud\_\_Payment\_\_cHistory](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.")**: History is available for the tracked fields of the object. - **[cgcloud\_\_Payment\_\_cOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.")**: Sharing rules are available for the object. - **[cgcloud\_\_Payment\_\_cShare](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.")**: Sharing is available for the object.