--- schema_version: "1" id: 5ca16421f4f03f91362caf8c5f6c6d05cec5497c1bece80596e76a9632985942 title: cgcloud__Rate_Based_Funding__c collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/retail_api/sforce_api_objects_cgcloud__rate_based_funding__c.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__rate_based_funding__c.htm source_site: developer.salesforce.com content_type: documentation content_hash: 32d47b18ee2aef4dce47232ac5ebe6f62bac07e48fa7dd61fc0ba590c732a1e1 description: This object stores general information along with metadata that's associated with the RBF Template from which it was created. This object is available in API version 54.0 and later. --- # cgcloud\_\_Rate\_Based\_Funding\_\_c This object stores general information along with metadata that's associated with the RBF Template from which it was created. 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 ### 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 ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Anchor Account for which the RBF is defined. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether Rate Based Funds can be used. - **Default value**: true ### cgcloud\_\_Currency\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Currency of the rate based funding template. This is a calculated field. - **Formula**: cgcloud\_\_Rate\_Based\_Funding\_Template\_\_r.cgcloud\_\_Currency\_\_c ### cgcloud\_\_Date\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Start date of the rate based fund. ### cgcloud\_\_Date\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Sort, Update - **Description**: End date of the rate based fund. ### cgcloud\_\_Description\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Description of the rate based fund. ### cgcloud\_\_External\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique identifier for the external system RBF record. ### cgcloud\_\_Fund\_Anchor\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Anchor of the fund. - **Possible values**: - Planning\_Level - RBF\_Anchor ### cgcloud\_\_Fund\_Template\_Type\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Label of a Fund Template. Funds of this type are to be filled by this RBF (if the anchor accounts, products, and time ranges also match). This is a calculated field. - **Formula**: cgcloud\_\_Fund\_Template\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Fund\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the fund template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Fund\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Fund\_Template\_\_c ### cgcloud\_\_KPI\_Subset\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: KPI subset allows to filter KPI definitions in the GridHierarchyView component. No subset filter is applied when no KPI subset is chosen This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Rate\_Based\_Funding\_Template\_\_r.cgcloud\_\_KPI\_Subset\_\_c) ### cgcloud\_\_Manual\_Override\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls when a child can be updated by the parent in the RBF Distribution process. - **Default value**: false ### cgcloud\_\_Original\_Reference\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Reference to the parent RBF record. ### cgcloud\_\_Parent\_RBF\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Contains the reference of the parent in the RBF Distribution process. This is a relationship field. - **Relationship Name**: cgcloud\_\_Parent\_RBF\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Rate\_Based\_Funding\_\_c ### cgcloud\_\_RBF\_Anchor\_Type\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Reference to the anchor of the rate based fund. This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Rate\_Based\_Funding\_Template\_\_r.cgcloud\_\_Anchor\_Type\_\_c) ### cgcloud\_\_RBF\_KPI\_Set\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: KPI set that's assigned to the rate based fund. This is a calculated field. - **Formula**: cgcloud\_\_Rate\_Based\_Funding\_Template\_\_r.cgcloud\_\_KPI\_Set\_\_r.Name ### cgcloud\_\_RBF\_Rate\_Type\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Type of rate that's used for the rate based funding record. This is a calculated field. - **Formula**: TEXT( cgcloud\_\_Rate\_Based\_Funding\_Template\_\_r.cgcloud\_\_Rate\_Type\_\_c ) ### cgcloud\_\_RBF\_Total\_KPI\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Name of the KPI definition that represents the total calculated value. This is a calculated field. - **Formula**: cgcloud\_\_Rate\_Based\_Funding\_Template\_\_r.cgcloud\_\_RBF\_Total\_KPI\_\_r.Name ### cgcloud\_\_Rate\_Based\_Funding\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Template that's used for the rate based funding record. This is a relationship field. - **Relationship Name**: cgcloud\_\_Rate\_Based\_Funding\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_RBF\_Template\_\_c ### cgcloud\_\_Status\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Status of the rate based funding record. - **Default value**: Initial - **Possible values**: - Approved - Initial - Processed - Processing - Ready to Approve ### cgcloud\_\_Stop\_Transacting\_Unlock\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: This field is used to signal that the record can be safely unlocked as part of the stop transacting process. - **Default value**: false ### cgcloud\_\_Total\_Amount\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total calculated as derived from interaction with the RBF Grid (aggregate of all RBF-Product calculated values). ## 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\_\_Rate\_Based\_Funding\_\_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\_\_Rate\_Based\_Funding\_\_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\_\_Rate\_Based\_Funding\_\_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\_\_Rate\_Based\_Funding\_\_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\_\_Rate\_Based\_Funding\_\_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.