Consumer Goods Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
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
Trade Promotion Management Service APIs
Trade Promotion Management Business APIs
Promotion Wizards & Customization
Metadata Wizard
Apex Classes for Trade Promotion Management
Business Objects API
Custom Objects for Retail Execution and Trade Promotion Management
Custom Objects for Future Use
API End-of-Life Policy
PDF

cgcloud__Account_Plan__c

Contains the details of the account data for one planning account, one business year and one or multiple categories. 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
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user referenced this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The 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
cgcloud__Account__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Refers to the account on which the plan is anchored.
This is a relationship field.
Relationship Name
cgcloud__Account__r
Relationship Type
Lookup
Refers To
Account
cgcloud__Available_Product_Level__c
Type
multipicklist
Properties
Create, Defaulted on create, Filter, Nillable, Restricted picklist, Update
Description
Specifies the multiple sets of values a user can choose, which are further used for aggregation on the calculation grid for account plan.
Possible values are:
  • Brand
  • Category
  • Flavor—Sub Brand
  • Package—Product Price Group
  • Product
  • SubCategory
The default value is 'Category'.
cgcloud__Business_Year_Label__c
Type
string
Properties
Filter, Nillable, Sort
Description
Describes the Business Year for which the plan is created.
This field is a calculated field.
This field is available in API version 55.0 and later.
Formula
TEXT( cgcloud__Business_Year__c )
cgcloud__Business_Year__c
Type
double
Properties
Create, Filter, idLookup, Nillable, Sort, Update
Description
Refers to the business year for which the plan is defined.
cgcloud__Category_Labels_Language_1__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the category labels in short descriptions of language 1 for all categories associated with the plan.
cgcloud__Category_Labels_Language_2__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the category labels in short descriptions of language 2 for all categories associated with the plan.
cgcloud__Category_Labels_Language_3__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the category labels in short descriptions of language 3 for all categories associated with the plan.
cgcloud__Category_Labels_Language_4__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the category labels in short descriptions of language 4 for all categories associated with the plan.
cgcloud__Category_Labels__c
Type
string
Properties
Filter, Nillable, Sort
Description
Category labels for all categories associated with the plan based on the user-specific language.
This is a calculated field.
Formula
CASE($User.cgcloud__Language_Postfix__c,
"Language1", cgcloud__Category_Labels_Language_1__c,
"Language2", cgcloud__Category_Labels_Language_2__c,
"Language3", cgcloud__Category_Labels_Language_3__c,
"Language4",cgcloud__Category_Labels_Language_4__c,
cgcloud__Category_Labels_Language_1__c)
cgcloud__Description_Language_1__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the description of language 1.
cgcloud__Description_Language_2__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the description of language 2.
cgcloud__Description_Language_3__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the description of language 3.
cgcloud__Description_Language_4__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the description of language 4.
cgcloud__Description__c
Type
string
Properties
Filter, Nillable, Sort
Description
Description based on the user-specific 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__KPI_Set__c
Type
reference
Properties
Create, Filter, Group, Nillable, 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__Note__c
Type
textarea
Properties
Create, Nillable, Update
Description
Comments to track the changes made in the customer's business plan record.
cgcloud__Sales_Org__c
Type
string
Properties
Filter, Nillable, Sort
Description
Describes the sales organization to which the account plan belongs.
This is a calculated field.
Formula
TEXT (cgcloud__Account__r.cgcloud__Account_Template__r.cgcloud__Sales_Org__c)
cgcloud__Version__c
Type
double
Properties
Create, Defaulted on create, Filter, Nillable, Sort, Update
Description
Refers to the version number.

Associated Objects

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

cgcloud__Account_Plan__cChangeEvent
Change events are available for the object.
cgcloud__Account_Plan__cFeed
Feed tracking is available for the object.
cgcloud__Account_Plan__cHistory
History is available for tracked fields of the object.
cgcloud__Account_Plan__cOwnerSharingRule
Sharing rules are available for the object.
cgcloud__Account_Plan__cShare
Sharing is available for the object.