---
schema_version: "1"
id: 1fc05f84b6bc9cab706665746493d2f8f199000da327b9b0c32416d574fb21d5
title: cgcloud__Payment_Template__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_template__c.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__payment_template__c.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 6eecfc3828bb41abbe4731ee17303c0d5c36a37fa800275cc25f47d60e16b6d0
description: Stores the details of the payment template that's to be used for payments. This object is available in API version 54.0 and later.
---
# cgcloud\_\_Payment\_Template\_\_c

Stores the details of the payment template that's to be used for payments. 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 last 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**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update
- **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

### cgcloud\_\_Active\_\_c

- **Type**: boolean
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: Controls whether the template can be used to create a payment.
- **Default value**: true

### cgcloud\_\_Additional\_PTP\_Kpi\_Definition\_1\_\_c

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Reference to the additional KPI. The KPI is written back into the payment tactic product records at the defined product level.
    
    This is a relationship field.
- **Relationship Name**: cgcloud\_\_Additional\_PTP\_Kpi\_Definition\_1\_\_r
- **Relationship Type**: Lookup
- **Refers To**: cgcloud\_\_KPI\_Definition\_\_c

### cgcloud\_\_Additional\_PTP\_Kpi\_Definition\_2\_\_c

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Reference to the additional KPI. The KPI is written back into the payment tactic product records at the defined product level.
    
    This is a relationship field.
- **Relationship Name**: cgcloud\_\_Additional\_PTP\_Kpi\_Definition\_2\_\_r
- **Relationship Type**: Lookup
- **Refers To**: cgcloud\_\_KPI\_Definition\_\_c

### cgcloud\_\_Additional\_PTP\_Kpi\_Definition\_3\_\_c

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Reference to the additional KPI. The KPI is written back into the payment tactic product records at the defined product level.
    
    This is a relationship field.
- **Relationship Name**: cgcloud\_\_Additional\_PTP\_Kpi\_Definition\_3\_\_r
- **Relationship Type**: Lookup
- **Refers To**: cgcloud\_\_KPI\_Definition\_\_c

### cgcloud\_\_Currency\_\_c

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Currency of the payment template based on the sales org currency.

### cgcloud\_\_Date\_From\_Offset\_\_c

- **Type**: double
- **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update
- **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\].

### cgcloud\_\_Date\_Thru\_Offset\_\_c

- **Type**: double
- **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update
- **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\].

### cgcloud\_\_Description\_Language\_1\_\_c

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Stores the description of language 1.

### cgcloud\_\_Description\_Language\_2\_\_c

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Stores the description of language 2.

### cgcloud\_\_Description\_Language\_3\_\_c

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Stores the description of language 3.

### cgcloud\_\_Description\_Language\_4\_\_c

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Stores the description of language 4.

### cgcloud\_\_Description\_\_c

- **Type**: string
- **Properties**: Filter, Nillable, Sort
- **Description**: Description based on the user-specified language.
    
    This is a calculated field.
- **Formula**:
    
    CASE($User.cgcloud\_\_Language\_Postfix\_\_c,
    "Language1", cgcloud\_\_Description\_Language\_1\_\_c,
    "Language2", BLANKVALUE(cgcloud\_\_Description\_Language\_2\_\_c,cgcloud\_\_Description\_Language\_1\_\_c),
    "Language3", BLANKVALUE(cgcloud\_\_Description\_Language\_3\_\_c,cgcloud\_\_Description\_Language\_1\_\_c),
    "Language4", BLANKVALUE(cgcloud\_\_Description\_Language\_4\_\_c,cgcloud\_\_Description\_Language\_1\_\_c),
    cgcloud\_\_Description\_Language\_1\_\_c)

### cgcloud\_\_Internal\_Id\_\_c

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Internal ID that's created to ensure that the same short code doesn't correspond to the same sales org.

### cgcloud\_\_KPI\_Set\_\_c

- **Type**: reference
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: Reference to the KPI set.
    
    This is a relationship field.
- **Relationship Name**: cgcloud\_\_KPI\_Set\_\_r
- **Relationship Type**: Lookup
- **Refers To**: cgcloud\_\_KPI\_Set\_\_c

### cgcloud\_\_KPI\_Subset\_\_c

- **Type**: picklist
- **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- **Description**: Allows the filtering of KPI definitions in the GridHierarchyView component.
- **Default value**: Planning
- **Possible values**:
    - Adjustment
    - BaselineManagement—Baseline Management
    - Broker
    - Finance
    - MidLevelPlanning—Mid Level Planning
    - Monitoring
    - Planning
    - PromoUI
    - PromotionScenarios—Promotion Scenarios
    - Retailer
    - SPC
    - SPCLumpSum
    - SPCPR
    - VPC

### cgcloud\_\_Payment\_Adjustment\_Process\_Type\_\_c

- **Type**: picklist
- **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- **Description**: Defines the payment adjustment process type of the payment template.
- **Possible values**:
    - Interfaced
    - Manual
    - None

### cgcloud\_\_Payment\_Tactic\_Product\_Level\_\_c

- **Type**: picklist
- **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- **Description**: Defines the product level of the payment tactic at which the calculation is performed.
- **Default value**: Category
- **Possible values**:
    - Brand
    - Category
    - Flavor—Sub Brand
    - Package—Product Price Group
    - Product
    - SubCategory—Sub Category

### cgcloud\_\_Payment\_Type\_Formula\_\_c

- **Type**: string
- **Properties**: Filter, Nillable, Sort
- **Description**: Defines the payment type of the payment template.
    
    This is a calculated field.
- **Formula**:
    
    TEXT( cgcloud\_\_Payment\_Type\_\_c )

### cgcloud\_\_Payment\_Type\_\_c

- **Type**: picklist
- **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update
- **Description**: Defines the payment type of the payment template.
- **Possible values**:
    - Check Request
    - Credit Memo
    - Deduction
    - Invoice-Based

### cgcloud\_\_Requires\_Funds\_\_c

- **Type**: boolean
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: Defines whether the payment requires funds to be approved.
- **Default value**: true

### cgcloud\_\_Sales\_Org\_\_c

- **Type**: reference
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: Reference to the sales organization.
    
    This is a relationship field.
- **Relationship Name**: cgcloud\_\_Sales\_Org\_\_r
- **Relationship Type**: Lookup
- **Refers To**: cgcloud\_\_Sales\_Organization\_\_c

### cgcloud\_\_Short\_Code\_\_c

- **Type**: string
- **Properties**: Create, Filter, Group, idLookup, Sort, Update
- **Description**: Unique code that's used as a Legacy System Reference.

### cgcloud\_\_Sort\_\_c

- **Type**: double
- **Properties**: Create, Filter, Nillable, Sort, Update
- **Description**: Sort number.

### cgcloud\_\_Tactic\_Payout\_KPI\_Definition\_\_c

- **Type**: reference
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: KPI on the Tactic - Product that's used to distribute the Tactic Payout.
    
    This is a relationship field.
- **Relationship Name**: cgcloud\_\_Tactic\_Payout\_KPI\_Definition\_\_r
- **Relationship Type**: Lookup
- **Refers To**: cgcloud\_\_KPI\_Definition\_\_c

## 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\_Template\_\_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\_Template\_\_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\_Template\_\_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\_Template\_\_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\_Template\_\_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.