Newer Version Available

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

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

Field Details
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.
The default value is 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
1CASE($User.cgcloud__Language_Postfix__c,
2"Language1", cgcloud__Description_Language_1__c,
3"Language2", BLANKVALUE(cgcloud__Description_Language_2__c,cgcloud__Description_Language_1__c),
4"Language3", BLANKVALUE(cgcloud__Description_Language_3__c,cgcloud__Description_Language_1__c),
5"Language4", BLANKVALUE(cgcloud__Description_Language_4__c,cgcloud__Description_Language_1__c),
6cgcloud__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.
Possible values are:
  • Adjustment
  • BaselineManagement—Baseline Management
  • Broker
  • Finance
  • MidLevelPlanning—Mid Level Planning
  • Monitoring
  • Planning
  • PromoUI
  • PromotionScenarios—Promotion Scenarios
  • Retailer
  • SPC
  • SPCLumpSum
  • SPCPR
  • VPC
The default value is Planning.
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 are:
  • 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.
Possible values are:
  • Brand
  • Category
  • Flavor—Sub Brand
  • Package—Product Price Group
  • Product
  • SubCategory—Sub Category
The default value is 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
1TEXT( 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 are:
  • 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.
The default value is 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

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
Change events are available for the object.
cgcloud__Payment_Template__cFeed
Feed tracking is available for the object.
cgcloud__Payment_Template__cHistory
History is available for the tracked fields of the object.
cgcloud__Payment_Template__cOwnerSharingRule
Sharing rules are available for the object.
cgcloud__Payment_Template__cShare
Sharing is available for the object.