# legacydeveloper Retail Api - Full Documentation # Abort a Job Chain Stops the running job chain worker for a sales org. Use this feature when a job chain is stuck or when a large number of jobs was scheduled by mistake. A job chain is a set of processing jobs that depend on each other. CG Cloud Processing Services runs job chains outside Salesforce. A job chain worker picks up the jobs and runs them in order. Aborting a job chain ends the job chain worker. Aborting takes two steps. First, get the job identifier of the running job chain worker. Then, delete the job by its identifier. Both steps use the global .OffPlatformCallout class. Pass the sales org to the constructor. The sales org is required. For more information about the effect of the sales org, see [Abort Behavior](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/cgtpm_abort_job_chain_behavior.htm "Understand what an abort stops and what it leaves unchanged."). ## Step 1. Get the Job Identifier This request returns the job identifier of the running job chain worker. **Resource** JOBCHAINWORKER\_ABORT\_GET\_JOB\_ID **Available version** 68.0 **Apex Request Example** String endpointName = 'JOBCHAINWORKER\_ABORT\_GET\_JOB\_ID'; String salesOrg = '9999'; .OffPlatformCallout request = new .OffPlatformCallout(endpointName, salesOrg); // This request has no path variables and no request body. .OffplatformCalloutResponse response = request.execute( .TransactionHandler.getTransactionIdentifier(), null, null ); if (response.status != 200) { // A 404 status means that no job chain worker can be aborted. return; } Map body = (Map) JSON.deserializeUntyped(response.result); String k8sJobId = (String) body.get('k8sJobId'); The response body contains the k8sJobId, jobState, and launchId fields. Use the value of k8sJobId in step 2. ## Step 2. Abort the Job This request deletes the job and ends the job chain worker. The resource path contains the :k8sjobid variable. To set its value, pass a map to execute(). The map key must be k8sjobid, with the same spelling and case. If the key does not match, the variable is not replaced and the request fails. **Resource** JOBCHAINWORKER\_ABORT\_DELETE\_JOB **Available version** 68.0 **Apex Request Example** String endpointName = 'JOBCHAINWORKER\_ABORT\_DELETE\_JOB'; String salesOrg = '9999'; String k8sJobId = 'JOB\_ID\_FROM\_STEP\_1'; .OffPlatformCallout request = new .OffPlatformCallout(endpointName, salesOrg); .OffplatformCalloutResponse response = request.execute( .TransactionHandler.getTransactionIdentifier(), new Map{ 'k8sjobid' => k8sJobId }, null ); if (response.status != 200) { // A 404 status means that the job no longer exists. return; } The response body contains the message, k8sJobId, and abortedAt fields. The response object has the following properties. - status is an Integer that holds the HTTP status code. - result is a String that holds the response body. - message is a String that holds the status message. - **[Abort Behavior](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/cgtpm_abort_job_chain_behavior.htm)** Understand what an abort stops and what it leaves unchanged. - **[Abort Endpoint Configuration](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/cgtpm_abort_job_chain_endpoints.htm)** Review the endpoint records that route the abort requests. - **[Troubleshoot an Abort](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/cgtpm_abort_job_chain_troubleshooting.htm)** Learn why an abort request can fail and how to check that a job chain stopped. - **[Update Batch Run Status Records After an Abort](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/cgtpm_abort_job_chain_update_status.htm)** Change the state of Batch Run Status records that stay in the Running state after an abort. # Abort Behavior Understand what an abort stops and what it leaves unchanged. ## What an Abort Stops The sales org you pass to OffPlatformCallout selects the cloud platform that hosts the sales org. The platform is either Amazon Web Services or Google Cloud Platform. The abort applies to that platform, not to a single sales org. Each tenant has one job chain worker on each platform. There is not one worker for each sales org or for each job chain. When you abort the worker, all job chains of the tenant on that platform stop. For example, you pass sales org 0001. The abort does not stop only the work of sales org 0001. It stops the job chains of every sales org on the same platform. If your tenant runs job chains on both platforms, abort each platform separately. Run the two steps once with a sales org on one platform. Then run them again with a sales org on the other platform. ## What an Abort Does Not Stop An abort affects only the job chain worker. These processes run outside the job chain framework and keep running. - Salesforce data synchronization - Integration inbound and outbound processing - Object change handlers ## Batch Run Status After an Abort An abort ends the job chain worker immediately. The worker does not write a final status. The Batch Run Status records of the stopped run stay in their last state. For example, a record can still show Running. This is expected. To learn how to change these records, see [Update Batch Run Status Records After an Abort](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/cgtpm_abort_job_chain_update_status.htm "Change the state of Batch Run Status records that stay in the Running state after an abort."). ## Scheduling After an Abort To resume work, schedule a job in a new job chain. This starts a new job chain worker. The new worker runs the newly scheduled jobs as usual. # Abort Endpoint Configuration Review the endpoint records that route the abort requests. Two Off\_Platform\_Endpoint\_Map\_\_mdt records route the abort requests. The managed package includes both records, so you don't need to set any URLs. Both records are protected. | Developer Name | HTTP Method | Path | Service | Target Tenant Selection Mode | | --- | --- | --- | --- | --- | | JOBCHAINWORKER\_ABORT\_GET\_JOB\_ID | GET | /jobchainworker/job | tpm | SalesOrgSubstrate | | JOBCHAINWORKER\_ABORT\_DELETE\_JOB | DELETE | /jobchainworker/job/:k8sjobid | tpm | SalesOrgSubstrate | The paths do not contain a version. The managed package adds the version when it sends the request. The SalesOrgSubstrate mode finds the target tenant from the sales org that you pass to OffPlatformCallout. For this reason, the sales org is required. The :k8sjobid variable in the delete path must match the key in the map that you pass to execute(). # Abort Export Process Sets the state of a CSV export process to Aborted. When a CSV export process is running for a longer duration than expected, it consumes resources and blocks the scheduling of new exports. The following Abort Export code snippet unblocks the scheduling by aborting the export process. ## Sample Apex Code Snippet OffPlatformCallout request = new OffPlatformCallout('ABORT\_EXPORT\_PROCESS','0001'); Map data = new Map(); data.put('csvGuid','11b19630-08f0-4f57-8e14-1778c0d3abde'); data.put('metaname', 'IntegrationExportPromotion'); OffPlatformCalloutResponse response = request.execute(TransactionHandler.getTransactionIdentifier(), data, null); System.debug(response); ## Response { "message":"Abort Export is scheduled successfully." } # Abort Export Process Uses the POST method to set the state of a CSV export process to Aborted. When a CSV export process is running for a longer duration than expected, it consumes resources and blocks the scheduling of new exports. Abort Export API unblocks the scheduling by aborting the export process. It takes csvGuid as the path parameter and IntegrationMetaName as the query parameter. ## Resource /measures/export/abort/{{csvGuid}}?integrationmetaname= - csvGuid: Enter the ID of the CSV export that needs to be aborted. ## Resource Example [https://pumpkinspice.salesforce.com/services/apexrest/cgcloud/measures/export/abort/ad95ce25-365b-43c0-8c79-e0e01ab0505a?integrationmetaname=integrationExportPromotion](https://pumpkinspice.salesforce.com/services/apexrest/cgcloud/measures/export/abort/ad95ce25-365b-43c0-8c79-e0e01ab0505a?integrationmetaname=integrationExportPromotion) ## Available Version 65.0 and later ## HTTP Method POST - **[Abort Export Process Input](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/connect_requests_abort_export.htm)** Query parameters for Abort Export Process API. - **[Abort Export Process Output](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/connect_response_abort_export.htm)** Response body for Abort Export Process API. ## Query Parameters | Parameter | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | integrationmetaname | String | Enter the name of the export configuration. | Required | 65.0 | ## Response { "message":"Abort Export is scheduled successfully." } # Abort Export Process Input Query parameters for Abort Export Process API. ## Query Parameters | Parameter | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | integrationmetaname | String | Enter the name of the export configuration. | Required | 65.0 | # Abort Export Process Output Response body for Abort Export Process API. ## Response { "message":"Abort Export is scheduled successfully." } # Account Standard and custom fields extend the standard Account object for use in Consumer Goods Cloud to represent an individual account, which is an company or person involved with your business, such as customers, competitors, and partners. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), merge(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Account number assigned to the account (not the unique, auto-generated ID assigned during creation). Can have up to 40 characters. ### AccountSource - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Source of the account record: The source is selected from an administrator-set picklist. Each picklist value can have up to 40 characters. - **Possible values**: - Other - Partner Referral - Phone Inquiry - Purchased List - Web ### AnnualRevenue - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Estimated annual revenue of the account. ### BillingAddress - **Type**: address - **Properties**: Filter, Nillable - **Description**: Compound form of the billing address. Read-only. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/compound_fields_address.htm) for details on compound address fields. ### BillingCity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Details for the billing address of the account. Can have up to 40 characters. ### BillingCountry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Details for the billing address of the account. Can have up to 80 characters. ### BillingGeocodeAccuracy - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Accuracy level of the geocode for the billing address: See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations) for details on geolocation compound fields. - **Possible values**: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip ### BillingLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with BillingLongitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –90 and 90, up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations) for details on geolocation compound fields. ### BillingLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with BillingLatitude to specify the precise geolocation of a billing address. Acceptable values are numbers between –180 and 180, up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations) for details on geolocation compound fields. ### BillingPostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Details for the billing address of the account. Can have up to 20 characters. ### BillingState - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Details for the billing address of this account. Can have up to 80 characters. ### BillingStreet - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Street name in the billing address of the account. ### CleanStatus - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the record’s clean status compared with Data.com: - **Possible values**: - Acknowledged—Reviewed - Different - Inactive - Matched—In Sync - NotFound—Not Found - Pending—Not Compared - SelectMatch—Select Match - Skipped ### DandbCompanyId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the Dun & Bradstreet® company record associated with the account. This field is a relationship field. - **Relationship Name**: DandbCompany - **Relationship Type**: Lookup - **Refers To**: DandBCompany ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Text description of the account. Limited to 32,000 KB. ### DunsNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The Data Universal Numbering System (D-U-N-S) number is a unique, nine-digit number assigned to every business location in the Dun & Bradstreet database that has a unique, separate, and distinct operation. D-U-N-S numbers are used by industries and organizations around the world as a global standard for business identification and tracking. Maximum size is nine characters. This field is available only on business accounts. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note This field is available only to companies that use Data.com Prospector or Data.com Clean. ### Fax - **Type**: phone - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Fax number of the account. ### Industry - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Industry associated with the account. Can have up to 40 characters. - **Possible values**: - Agriculture - Apparel - Banking - Biotechnology - Chemicals - Communications - Construction - Consulting - Education - Electronics - Energy - Engineering - Entertainment - Environmental - Finance - Food & Beverage - Government - Healthcare - Hospitality - Insurance - Machinery - Manufacturing - Media - Not For Profit - Other - Recreation - Retail - Shipping - Technology - Telecommunications - Transportation - Utilities ### Jigsaw - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the ID of a company in Data.com. Accounts imported from Data.com always have a value in this field, while accounts not imported from Data.com have a null value. Can have up to 20 characters. Available in API version 22.0 and later. Label is Data.com Key. This field is available only on business accounts. ### JigsawCompanyId - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: ID of a company in Data.com. Relationship field. - **Relationship Name**: JigsawCompany - **Relationship Type**: Lookup - **Refers To**: null ### LastActivityDate - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: Date when a user last modified the record. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Most recent date on which a user referenced the record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Most recent date on which a user viewed the record. ### MasterRecordId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: If this object was deleted as the result of a merge, then this field contains the ID of the record that was kept. If this object was deleted for any other reason, or hasn’t been deleted, the value is null. This field is a relationship field. - **Relationship Name**: MasterRecord - **Relationship Type**: Lookup - **Refers To**: Account ### NaicsCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The six-digit North American Industry Classification System (NAICS) code is the standard used by businesses and the government to classify business establishments into industries, according to their economic activity for the purpose of collecting, analyzing, and publishing statistical data related to the U.S. business economy. Can have up to eight characters. This field is available only on business accounts. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note This field is available only to companies that use Data.com Prospector or Data.com Clean. ### NaicsDesc - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Brief description of an company line of business based on the org’s NAICS code. Can have up to 120 characters. The field is available only on business accounts. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note The field is available only to companies that use Data.com Prospector or Data.com Clean. ### Name - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Unique identification of the account. ### NumberOfEmployees - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Number of employees working at the company that’s represented by the account. Can have up to eight digits. ### OperatingHoursId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Operating hours associated with the account. Available only if Field Service is enabled. This field is a relationship field. - **Relationship Name**: OperatingHours - **Relationship Type**: Lookup - **Refers To**: OperatingHours ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the user who currently owns the account. user logged in to the API to perform the create. If you have set up account teams in your company, the result of updating this field depends on your version of the API: - For API version 12.0 and later, sharing records are kept for all objects. - For API version before 12.0, sharing records are deleted. - For API version 16.0 and later, users must have the Transfer Record permission to update (transfer) account ownership. This field is a relationship field. - **Default value**: the - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: User ### Ownership - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Ownership type of the account: - **Possible values**: - Other - Private - Public - Subsidiary ### ParentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the parent object, if any. This field is a relationship field. - **Relationship Name**: Parent - **Relationship Type**: Lookup - **Refers To**: Account ### Phone - **Type**: phone - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Phone number of the account. Can have up to 40 characters. ### PhotoUrl - **Type**: url - **Properties**: Filter, Group, Nillable, Sort - **Description**: Path to be combined with the URL of a Salesforce instance (for example, https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the account. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the account. Returns a blank if Social Accounts and Contacts aren’t enabled for the company or are disabled for the requesting user. ### Rating - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Account’s prospect rating: - **Possible values**: - Cold - Hot - Warm ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the record type assigned to the object. This field is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### ShippingAddress - **Type**: address - **Properties**: Filter, Nillable - **Description**: Read-only. Compound form of the shipping address. See [Address Compound Fields](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/compound_fields_address.htm) for details on compound address fields. ### ShippingCity - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: City in the shipping address of the account. Can have up to 40 characters. ### ShippingCountry - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Country in the shipping address of the account. Can have up to 80 characters. ### ShippingGeocodeAccuracy - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Accuracy level of the geocode for the shipping address: See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations) for details on geolocation compound fields. - **Possible values**: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip ### ShippingLatitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with ShippingLongitude to specify the precise geolocation of a shipping address. Acceptable values are numbers between –90 and 90, up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations) for details on geolocation compound fields. ### ShippingLongitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used with ShippingLatitude to specify the precise geolocation of an address. Acceptable values are numbers between –180 and 180, up to 15 decimal places. See [Compound Field Considerations and Limitations](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/compound_fields_limitations.htm#compound_fields_limitations) for details on geolocation compound fields. ### ShippingPostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Postal code in the shipping address of the account. Can have up to 20 characters. ### ShippingState - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: State in the shipping address of the account. Can have up to 80 characters. ### ShippingStreet - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Street name in the shipping address of the account. Can have up to 255 characters. ### Sic - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Standard Industrial Classification code of the company’s main business categorization. For example, 57340 for Electronics. Can have up to 20 characters. This field is available only on business accounts. ### SicDesc - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Brief description of an company line of business, based on the SIC code. Can have up to 80 characters. This field is available only on business accounts. ### Site - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the account’s location. For example, Headquarters or London. Can have up to 80 characters. ### TickerSymbol - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stock market symbol for the account. Can have up to 20 characters. This field is available only on business accounts. ### Tradestyle - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Non-legal name that an company uses for conducting business. Similar to _Doing business as_ or _DBA_. Can have up to 255 characters. This field is available only on business accounts. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note This field is available only to companies that use Data.com Prospector or Data.com Clean. ### Type - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of account - **Possible values**: - Channel Partner / Reseller - Customer - Channel - Customer - Direct - Installation Partner - Other - Prospect - Technology Partner ### Website - **Type**: url - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Website of the account. Can have up to 255 characters. ### YearStarted - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date when an org was legally established. Can have up to four characters. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note This field is only available to organizations that use Data.com Prospector or Data.com Clean. ### cgcloud\_Account\_Email\_\_c - **Type**: email - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Email address of the account. Label is Email. ### cgcloud\_Account\_Number\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Account number assigned to the account (not the unique, auto-generated ID assigned during creation). Can have up to 40 characters. ### cgcloud\_Account\_Template\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: The account template description. This field is a calculated field. - **Formula**: cgcloud\_dev\_\_Account\_Template\_\_r.cgcloud\_dev\_\_Description\_\_c ### cgcloud\_Account\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References the account template object used for accounts. This field is a relationship field. - **Relationship Name**: cgcloud\_dev\_\_Account\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_dev\_\_Account\_Template\_\_c ### cgcloud\_\_ExternalId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique identifier of the external object record to account. ### cgcloud\_\_Name\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique identification of the account. ### cgcloud\_\_Number\_Of\_Extensions\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Number of extensions for the account. This field is a calculated field. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Sales org of the template. This field is a calculated field. - **Formula**: Text(cgcloud\_dev\_\_Account\_Template\_\_r.cgcloud\_dev\_\_Sales\_Org\_\_c) ## Associated Objects ### Associated Objects The Account object has these related objects. If the API version isn’t specified, then the APIs are available in the same versions as the object. Otherwise, the APIs are available in the specified API version and later. - **[AccountChangeEvent](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. - **[AccountFeed](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. - **[AccountHistory](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 tracked fields of the object. - **[AccountOwnerSharingRule](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. - **[AccountShare](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. # Account Dimension The account dimension for integration export must be configured for each sales org on which CSV exports is executed. The integration export fetches content of the account dimension from the Salesforce object—[Account](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_account.htm "HTML (New Window)"). After creation of RTR Report Configuration" records, provide the following information and a meta JSON: | Attribute | Description | | --- | --- | | Information Internal Name | A unique internal name of the account. | | Configuration Usage | Integration Account Dimension | | Configuration of sales org | The sales organization to which the account belongs. | ## Account dimension meta JSON example \[ { "name":"name", "fieldsf":"Name", "fieldsf$label":"Name" }, { "name":"externalid", "fieldsf":"CGCloud\_\_ExternalId\_\_c", "fieldsf$label":"CGCloud\_\_ExternalId\_\_c" }, { "name":"accountnumber", "fieldsf":"CGCloud\_\_Account\_Number\_\_c", "fieldsf$label":"CGCloud\_\_Account\_Number\_\_c" } \] # Account Plan LWC Reference The tpm-account-plan LWC is a service component that loads a TPM account plan, exposing methods to update the account plan state, and events to keep all UI components of the account plan page in sync when the account plan state changes. ![Important](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note_important.png) #### Important The content in this Consumer Goods Cloud Trade Promotion Management documentation is confidential and may be viewed only by customers or partners as authorized by Salesforce, and copying and further distribution is prohibited without prior written consent from Salesforce. The content is the highly confidential and proprietary information of Salesforce and is protected under the confidentiality obligations of your Agreement with Salesforce. Accordingly, the content may be used only as necessary in order to implement the Consumer Goods Cloud Trade Promotion Management functionality. ## Properties account-plan-id: Id. Required. The ID of the account plan record to load. ## Namespace cgcloud ## Events Here’s the event payload structure. { detail : { value: <>, property: <>, recordId: <> } } ## onstatuschange This event is triggered when the lifecycle state of the TPM account plan component changes. Status changes are triggered by lifecycle operations on the account plan record. { detail : { value: 'VALID', property: 'status', recordId: 'a2WTC0000000F772AE' } } The possible values are: - LOADING: The account plan is being loaded. - VALID: The account plan is loaded and can be interacted with. - SAVING: The account plan is being saved to the database. - ERROR: An irrecoverable error has occurred. ## oncalculationstatuschange This event is triggered when the account plan grids are calculated or recalculated. { detail : { value: 'LOADING', property: 'calculationStatus', recordId: 'a2WTC0000000F772AE' } } The possible values are: - LOADING: The calculations are being processed, or the engine is loading. - VALID: The calculations are completed, and values can be requested. - ERROR: An irrecoverable error has occurred. - DISABLED: The calculations engine is disabled for the account plan. ## oncategoryfilterchange This event is triggered when the account plan’s selected product category filter changes. The event contains the selected category product ID. { detail : { value: '01pXXXXXXXXXXXXXXX000', property: 'categoryFilter', recordId: 'a2WTC0000000F772AE' } } ## onkpisubsetsfilterchange This event is triggered when the account plan subset filter changes. The event contains the selected category product ID. { detail : { value: 'BaselineManagement', property: 'kpiSubsetFilter', recordId: 'a2WTC0000000F772AE' } } ## Example Implementation Here’s an example of how to use the tpm-account-plan component. 55.0 true lightning\_\_RecordPage cgcloud\_\_Promotion\_\_c cgcloud import { LightningElement, api } from 'lwc'; // Import the TPMManualInput class to create new instances import { TPMManualInput } from 'c/tpmGenericUtils'; export default class SampleAccountPlanTester extends LightningElement { @api recordId; // Record Id provided by the LWC framework currentCategoryId = ''; currentCalculationStatus = 'LOADING'; onCategoryFilterChange(event) { // Store currently selected category this.currentCategoryId = event.detail.value; } onCalculationStatusChange(event) { // Store current status of calculation engine this.currentCalculationStatus = event.detail.value; } // In this method, we will be adding a new manual input to the grid. // This can, for instance, be executed in the click of a button or after // some user interaction async addNewManualInputs() { const tpmAccountPlan = this.template.querySelector('cgcloud-tpm-account-plan'); // Extract the current manual inputs const currentManualInputs = tpmAccountPlan.getProperty('manualInputs'); // You can read information from the current Manual Inputs: currentManualInputs.forEach((mi) => { console.log(mi.getKPICode()); // 'ALMD' console.log(mi.getPeriodDateFrom()); // Date console.log(mi.getPeriodDateThru()); // Date console.log(mi.ProductId()); // '01qXXXXXXXXXXXXXXX' console.log(mi.getValue()); // 133 console.log(mi.isObsolete()); // false }); // Example: KPI Code to set the manual input to const kpiCode = 'ABCD'; // Example: Product Id to set the manual input to. If null, // the manual input will be applied to the "Total" for the KPI // productId can be any level on the product hierarchy that is part of // the calculation (SubCategory, Brand, etc...) const productId = '01tXXXXXXXXXXXXXXX'; // Methods used to extract data from Grid require the Grid to be in valid // status. If trying to extract data from grid when not in the correct status // an exception will be thrown if (this.currentCalculationStatus !== 'VALID') { throw new Error('Grid not in VALID status'); } // Extract the periods information from the grid const periods = await tpmAccountPlan.getPeriods(); // We find the period where we want to set the manual input. // You can find periods by name or use the periods "dateFrom, "dateThru" and "periodtype" // attributes to search for an specific period. // In this example, we will set the manual input on the "Total" period // that uses an specific label const manualInputPeriod = periods.find((p) => p.periodtype === 'Total'); // Create the new instance const newManualInput = new TPMManualInput({ kpiCode: kpiCode, period: manualInputPeriod, productId: productId, value: 123 // Value to set }); // Create a new array with our new manual input appended const newManualInputArray = \[currentManualInputs, newManualInput\]; // Set the manual inputs // If the array length is greater than the limit of // manual inputs, the "set" operation will throw an error tpmAccountPlan.setManualInputs(newManualInputArray); // After setting the new manual inputs, the Grid will be automatically // reloaded and re-rendered with the new values in place. // At this point, manual inputs are still not saved to SFDC database. // the user must save & calculate the account plan } } - **[TPM Account Plan Component Methods](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_account_plan_component_referance.htm#tpm-accountPlanComponentReference)** ## TPM Account Plan Component Methods Here are the methods supported by the tpm-account-plan LWC. - **[exportKPIs](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_account_plan_component_referance.htm#tpm_account_plan_exportKPIs)** This method returns a promise resolving to the values of the KPIs for the selected KPI subsets or names, levels, and period types. - **[getProperty](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_account_plan_component_referance.htm#tpm_account_plan_getProperty)** Imperatively retrieve the account plan state properties. - **[getLevelNames](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_account_plan_component_referance.htm#tpm_account_plan_getLevelNames)** This method returns a promise resolving to the list of levels that are currently loaded in the calculation engine. If the calculation status isn’t valid, the method returns an error. - **[getKPISubsets](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_account_plan_component_referance.htm#tpm_account_plan_getKPISubsets)** This method returns a promise resolving to the list of KPI subsets that are currently loaded in the calculation engine. If the calculation status isn’t valid, the method returns an error. - **[getKPIs](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_account_plan_component_referance.htm#tpm_account_plan_getKPIs)** This method returns a promise resolving to the list of KPIs that are currently loaded in the calculation engine. If the calculation status isn’t valid, the method returns an error. - **[getPeriods](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_account_plan_component_referance.htm#tpm_account_plan_getPeriods)** This method returns a promise resolving to the list of periods that are currently loaded in the calculation engine. If the calculation status isn’t valid, the method returns an error. - **[getPeriodTypes](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_account_plan_component_referance.htm#tpm_account_plan_getPeriodTypes)** This method returns a promise resolving to the list of period types that are currently loaded in the calculation engine. If the calculation status isn’t valid, the method returns an error. - **[setManualInputs](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_account_plan_component_referance.htm#tpm_account_plan_seManualInputs)** This method sets an array of manual inputs in the account plan service component. ### exportKPIs This method returns a promise resolving to the values of the KPIs for the selected KPI subsets or names, levels, and period types. #### API Version 58.0 #### Signature exportKPIs(options) #### Properties
Name Type Description Required or Optional
options.subsets List<String> List of loaded KPI subsets to retrieve data from.

You can get a list of loaded subsets using the getKPISubsets() method.

Provide either the KPI subsets or the KPI names.

 Optional
options.kpis List<String> List of KPI names to retrieve data from.

You can get a list of loaded KPI names using the getKPIs() method.

Provide either the KPI subsets or the KPI names.

 Optional
options.levels List<String> List of loaded levels to retrieve data from. 

You can get a list of loaded levels using the getLevelNames() method.

 Optional
options.periods List<String> List of loaded period types to retrieve data.

You can get a list of loaded period types using the getPeriodTypes() method.

 Optional
options.format List<String> Format in which the response is returned.

Possible formats are:

  • JSON: The response is an array of JavaScript objects.
  • Serialized: The response is a JSON string of JavaScript objects.
  • CSV: The response is a CSV string.

The default format is JSON.

 Optional
The returned data is a list of rows (JavaScript objects or CSV rows). Each row represents the value of the KPI for the determined level. Each row contains values for all the periods specified in the request. #### Example Implementation const api = this.template.querySelector('cgcloud-tpm-promotion'); // Export options, the possible values can be extracted using // the other described methods const exportOptions = { subsets: \["Planning"\], // Subsets to request data periods: \[ "Total", "Week" \], levels: \[ "Total", "Category", "Product" \], format: "json" }; // Correct Scenario api.getProperty('calculationStatus'); // 'VALID' api.exportKPIs(exportOptions) .then((data) => { // Example response as CSV // // kpiName,Category,Product,AP\_LBL\_TOTAL,03/2022,04/2022 // SampleKPI1,,,246,123,123 // SampleKPI1,01tTC0000000001AAA,,246,123,123 // SampleKPI1,01tTC0000000001AAA,01tTC0000000002AAA,246,123,123 // SampleKPI2,,,1974,987,987 // SampleKPI2,01tTC0000000001AAA,,1974,987,987 // SampleKPI2,01tTC0000000001AAA,01tTC0000000002AAA,1974,987,987 // Example response as JSON // // \[{ // kpiName: "SampleKPI1", // Category: null, // Product: null, // AP\_LBL\_TOTAL: 246, // "03/2022": 123, // "04/2022": 123 // }, { // kpiName: "SampleKPI1", // Category: "01tTC0000000001AAA", // Product: null, // AP\_LBL\_TOTAL: 246, // "03/2022": 123, // "04/2022": 123 // },{ // kpiName: "SampleKPI1", // Category: "01tTC0000000001AAA", // Product: "01tTC0000000002AAA", // AP\_LBL\_TOTAL: 246, // "03/2022": 123, // "04/2022": 123 // },{ // kpiName: "SampleKPI2", // Category: null, // Product: null, // AP\_LBL\_TOTAL: 1974, // "03/2022": 987, // "04/2022": 987 // },{ // kpiName: "SampleKPI2", // Category: "01tTC0000000001AAA", // Product: null, // AP\_LBL\_TOTAL: 1974, // "03/2022": 987, // "04/2022": 987 // },{ // kpiName: "SampleKPI2", // Category: "01tTC0000000001AAA", // Product: "01tTC0000000002AAA", // AP\_LBL\_TOTAL: 1974, // "03/2022": 987, // "04/2022": 987 // }\] // We can access the properties on the result: const firstRecord = data\[0\]; console.log(firstRecord\["kpiName"\]); // "SampleKPI1" // Since we request the total period, // we can read the total period value console.log(firstRecord\["AP\_LBL\_TOTAL"\]); // 246 // We can also read specific periods information console.log(firstRecord\["03/2022"\]); // 123 // We can also know which level the row references console.log(firstRecord\["Category"\]); // null console.log(firstRecord\["Product"\]); // null // Since Category is null, it means this data row // represents the total value for KPI "SampleKPI1" // For last record const lastRecord = data\[data.length - 1\]; console.log(lastRecord\["kpiName"\]); // "SampleKPI2" // Since we request the total period, // we can read the total period value console.log(lastRecord\["AP\_LBL\_TOTAL"\]); // 1974 // We can also read specific periods information console.log(lastRecord\["03/2022"\]); // 987 // We can also know which level the row references console.log(lastRecord\["Category"\]); // "01tTC0000000001AAA" console.log(lastRecord\["Product"\]); // "01tTC0000000002AAA" // Since Product is not null, it means this data row // represents the value for KPI "SampleKPI2" for that // specific product }); // Error Scenario api.getProperty('calculationStatus'); // 'LOADING' api.exportKPIs(exportOptions) .catch((error) => { console.log(error.message); // CalculationStatus is not "VALID". Current Status "LOADING" }); ### getProperty Imperatively retrieve the account plan state properties. #### API Version 59.0 #### Signature getProperty(propName) The available properties to retrieve are: - status - calculationStatus - manualInputs - kpiSubsetFilter - categoryFilter ### getLevelNames This method returns a promise resolving to the list of levels that are currently loaded in the calculation engine. If the calculation status isn’t valid, the method returns an error. #### API Version 59.0 #### Signature getLevelNames() #### Example Implementation const api = this.template.querySelector('cgcloud-tpm-account-plan'); // Correct Scenario api.getProperty('calculationStatus'); // 'VALID' api.getLevelNames() .then((levels) => { console.log(levels); // \[ "Brand", "Product"\] }); // Error Scenario api.getProperty('calculationStatus'); // 'LOADING' api.getLevelNames() .catch((error) => { console.log(error.message); // CalculationStatus is not "VALID". Current Status "LOADING" }); ### getKPISubsets This method returns a promise resolving to the list of KPI subsets that are currently loaded in the calculation engine. If the calculation status isn’t valid, the method returns an error. #### API Version 59.0 #### Signature getKPISubsets() #### Example Implementation const api = this.template.querySelector('cgcloud-tpm-account-plan'); // Correct Scenario api.getProperty('calculationStatus'); // 'VALID' api.getKPISubsets() .then((subsets) => { console.log(subsets); // \["Planning", ... }); // Error Scenario api.getProperty('calculationStatus'); // 'LOADING' api.getKPISubsets() .catch((error) => { console.log(error.message); // CalculationStatus is not "VALID". Current Status "LOADING" }); ### getKPIs This method returns a promise resolving to the list of KPIs that are currently loaded in the calculation engine. If the calculation status isn’t valid, the method returns an error. #### API Version 59.0 #### Signature getKPIs() #### Example Implementation const api = this.template.querySelector('cgcloud-tpm-account-plan'); // Correct Scenario api.getProperty('calculationStatus'); // 'VALID' api.getKPIs() .then((kpis) => { // 0 console.log(kpis\[0\].id); // "0" console.log(kpis\[0\].name); // "BasePrice" console.log(kpis\[0\].kpitype); // "account" console.log(kpis\[0\].skipped); // \["Tactic"\] console.log(kpis\[0\].type); // "read" console.log(kpis\[0\].valuetype); // "Price" }); // Error Scenario api.getProperty('calculationStatus'); // 'LOADING' api.getKPIs() .catch((error) => { console.log(error.message); // CalculationStatus is not "VALID". Current Status "LOADING" }); ### getPeriods This method returns a promise resolving to the list of periods that are currently loaded in the calculation engine. If the calculation status isn’t valid, the method returns an error. #### API Version 59.0 #### Signature getPeriods() #### Example Implementation const api = this.template.querySelector('cgcloud-tpm-account-plan'); // Correct Scenario api.getProperty('calculationStatus'); // 'VALID' api.getPeriods() .then((periods) => { // 0 console.log(periods\[0\].id); // "0" console.log(periods\[0\].name); // "AP\_LBL\_TOTAL" (label of the period) console.log(periods\[0\].periodtype); // "Total" console.log(periods\[0\].dateFrom); // null console.log(periods\[0\].dateThru); // null // 1 console.log(periods\[1\].id); // 1 console.log(periods\[1\].name); // "36/2022" // label in case of label is specified alternativly it returns the .... console.log(periods\[1\].periodtype); // "Week" console.log(periods\[1\].dateFrom); // 1661731200000 timestamp console.log(periods\[1\].dateThru); // 1662249600000 timestamp }); // Error Scenario api.getProperty('calculationStatus'); // 'LOADING' api.getPeriods() .catch((error) => { console.log(error.message); // CalculationStatus is not "VALID". Current Status "LOADING" }); ### getPeriodTypes This method returns a promise resolving to the list of period types that are currently loaded in the calculation engine. If the calculation status isn’t valid, the method returns an error. #### API Version 59.0 #### Signature getPeriodTypes() #### Example Implementation const api = this.template.querySelector('cgcloud-tpm-account-plan'); // Correct Scenario api.getProperty('calculationStatus'); // 'VALID' api.getPeriodTypes() .then((periodTypes) => { console.log(periodTypes); // \["Total", "Week"\] }); // Error Scenario api.getProperty('calculationStatus'); // 'LOADING' api.getPeriodTypes() .catch((error) => { console.log(error.message); // CalculationStatus is not "VALID". Current Status "LOADING" }); ### setManualInputs This method sets an array of manual inputs in the account plan service component. Manual grid edits are an array of TPMManualInput instances. You can add new entries or remove entries from the existing array of elements. #### API Version 60.0 #### Signature setManualInputs(manualInputs) #### Example Implementation // Import the TPMManualInput class to create new instances import { TPMManualInput } from 'cgcloud/tpmGenericUtils'; // In this method, we will be adding a new manual input to the grid. // This can, for instance, be executed in the click of a button or after // some user interaction async addNewManualInputs() { const tpmAccountPlan = this.template.querySelector('cgcloud-tpm-account-plan'); // Extract the current manual inputs const currentManualInputs = tpmAccountPlan.getProperty('manualInputs'); // You can read information from the current Manual Inputs: currentManualInputs.forEach((mi) => { console.log(mi.getKPICode()); // 'ALMN' console.log(mi.getPeriodDateFrom()); // Date console.log(mi.getPeriodDateThru()); // Date console.log(mi.ProductId()); // '03sXXXXXXXXXXXXXXX' console.log(mi.getValue()); // 133 }); // Example: KPI code to set the manual input to const kpiCode = 'ABCD'; // Example: Product Id to set the manual input to. If null, // the manual input will be applied to the "Total" for the KPI // productId can be any level on the product hierarchy that is part of // the calculation (SubCategory, Brand, etc) const productId = '01tXXXXXXXXXXXXXXX'; // Methods used to extract data from Grid require the Grid to be in valid // status. If trying to extract data from grid when not in the correct status // an exception will be thrown if (tpmAccountPlan.getProperty('calculationStatus') !== 'VALID') { throw new Error('Grid not in VALID status'); } // Extract the periods information from the grid const periods = await tpmAccountPlan.getPeriods(); // We find the period where we want to set the manual input. // You can find periods by name or use the periods "dateFrom, "dateThru" and "periodtype" // attributes to search for an specific period. // In this example, we will set the manual input on the "Total" period // that uses an specific label const manualInputPeriod = periods.find((p) => p.periodtype === 'Total'); // Create the new instance const newManualInput = new TPMManualInput({ kpiCode: kpiCode, period: manualInputPeriod, productId: productId, value: 123 // Value to set }); // Create a new array with our new manual input appended const newManualInputArray = \[currentManualInputs, newManualInput\]; // Set the manual inputs tpmAccountPlan.setManualInputs(newManualInputArray); // After setting the new manual inputs, the grids will be automatically // reloaded and re-rendered with the new values in place. // At this point, manual inputs are still not saved to SFDC database. // the user must save the account plan } # AiVisitRecommendation Represents the details of a visit recommendation. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AggregatedScore - **Type**: double - **Properties**: Create, Filter, Nillable, Sort - **Description**: Aggregate score for this visit recommendation. Based on the rule score and the model score. ### AiVisitRecommendRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: ID of the visit recommendation request associated with this record. ### IsLatest - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort - **Description**: Indicates if the recommendation is the latest recommendation. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. ### ModelScore - **Type**: textarea - **Properties**: Create, Nillable - **Description**: The score provided by the machine-learning model. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the visit recommendation. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the user associated with this record. ### RecommendationDecision - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Status of the recommendation request. - **Possible values**: - ACCEPTED—Scheduled - ACCEPTED\_FAILED—Failed to Schedule - ACCEPTED\_PENDING—Scheduling In Progress - RECOMMENDED—Recommended - REJECTED—Ignored ### RecommendationDecisionComment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Details about why a recommendation was accepted or rejected. ### RecommendationReason - **Type**: textarea - **Properties**: Create, Nillable - **Description**: Details about why this visit is recommended. ### RuleScore - **Type**: double - **Properties**: Create, Filter, Nillable, Sort - **Description**: The score provided by the recommendation strategy. ### VisitDate - **Type**: date - **Properties**: Create, Filter, Group, Sort - **Description**: Recommended date on which the site must be visited. ### VisitSiteId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: ID of the location for which visit is recommended. # AiVisitRecommendRequest Represents the details of a visit recommendation request. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AcceptedCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: Number of recommendations created by this recommendation request that are accepted. ### Description - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: Description of the visit recommendation request. ### EndDate - **Type**: date - **Properties**: Create, Filter, Group, Sort - **Description**: Date until which visit recommendations must be created. ### ErrorMessage - **Type**: textarea - **Properties**: Create, Nillable - **Description**: Details of why the visit recommendations weren't generated. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. ### Models - **Type**: textarea - **Properties**: Create, Nillable - **Description**: The machine-learning model that creates the visit recommendations. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the visit recommendation request. ### NumberOfVisitsPerDay - **Type**: int - **Properties**: Create, Filter, Group, Sort - **Description**: Number of visits that can be scheduled each day. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the user associated with this record. ### RecommendationCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: Number of recommendations created for the request. ### RecommendationResponse - **Type**: textarea - **Properties**: Create, Nillable - **Description**: JSON data containing the recommendations. ### RecommendationStrategyName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: Name of the visit recommendation strategy. ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the associated record type. ### RejectedCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: Number of recommendations created by this recommendation request that are rejected. ### StartDate - **Type**: date - **Properties**: Create, Filter, Group, Sort - **Description**: Date from which visit recommendations must be created. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort - **Description**: Status of the visit recommendation request. - **Possible values**: - COMPLETED - FAILED - IN\_PROGRESS - QUEUED ### VisitSiteList - **Type**: textarea - **Properties**: Create - **Description**: List of locations for which visit recommendations are requested. ### VisitSiteType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort - **Description**: The type of location for which visit recommendations are requested. Possible value is: RetailStore # AiVisitTaskRcmd Represents the visit task recommendations. These recommendations can be accepted or rejected by a sales manager. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AiVisitTaskRcmdRequestId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: ID of the visit task recommendation request associated with this record. ### IsLatest - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort - **Description**: Indicates if the recommendation is the latest recommendation. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last referenced a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the visit task recommendation. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the user associated with this record. ### RecommendationDecision - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort - **Description**: Status of the recommendation request. - **Possible values**: - ACCEPTED—Scheduled - ACCEPTED\_FAILED—Failed to Schedule - ACCEPTED\_PENDING—Scheduling In Progress - RECOMMENDED—Recommended - REJECTED—Ignored ### RecommendationDecisionComment - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Details about why a recommendation was accepted or rejected. ### RecommendationReason - **Type**: textarea - **Properties**: Create, Nillable - **Description**: Details about why this task or KPI is recommended. ### RuleScore - **Type**: double - **Properties**: Create, Filter, Nillable, Sort - **Description**: The score provided by the recommendation strategy. ### TargetRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The target record for which this recommendation is requested. ### TargetRecordObjectName - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: The type of targets for which activities are recommended. ### TemplateRecordId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The link to the record used as a template. ### TemplateRecordObjectName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: The object name of the template record. ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. - **[AiVisitTaskRcmdFeed](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_feed_einstein.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 are available for the object. - **[AiVisitTaskRcmdHistory](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_history_einstein.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 object. - **[AiVisitTaskRcmdOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_ownersharingrule_einstein.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 rule is available for the object. - **[AiVisitTaskRcmdShare](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_share_einstein.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. # AiVisitTaskRcmdRequest Represents the request parameters and responses of visit task recommendations. This object is available in API version 51.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AcceptedCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: Number of recommendations created by this recommendation request that are accepted. ### ErrorMessage - **Type**: textarea - **Properties**: Create, Nillable - **Description**: Details of why the visit task recommendations weren't generated. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last referenced a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the task. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the user associated with this record. ### RecommendationCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: Number of recommendations created for the request. ### RecommendationResponse - **Type**: textarea - **Properties**: Create, Nillable - **Description**: JSON data containing the recommendations. ### RecommendationStrategyName - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: Name of the visit recommendation strategy. ### RejectedCount - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort - **Description**: Number of recommendations created by this recommendation request that are rejected. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort - **Description**: Status of the visit task recommendation request. - **Default value**: QUEUED - **Possible values**: - COMPLETED - FAILED - IN\_PROGRESS - QUEUED ### TargetRecordList - **Type**: textarea - **Properties**: Create - **Description**: List of targets for which recommendations are required. ### TargetRecordObjectName - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort - **Description**: The type of targets for which activities are recommended. - **Possible values**: - AiVisitRecommendation - Visit ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. - **[AiVisitTaskRcmdRequestFeed](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_feed_einstein.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 is available for the object. - **[AiVisitTaskRcmdRequestHistory](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_history_einstein.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 object. - **[AiVisitTaskRcmdRequestOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_ownersharingrule_einstein.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 rule is available for the object. - **[AiVisitTaskRcmdRequestShare](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_share_einstein.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. # Apex Classes for Retail Order Customization Use these Apex classes to access retail order records and to run additional work after an order and its related records are committed. - **[RE\_Order Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/RE_order_class.htm)** This Apex class provides programmatic access to the retail order sObject, and its related sObjects. - **[RE\_Order.Record Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/RE_order_record_class.htm)** The RE\_Order.Record Apex class provides a wrapper for the order sObject records. - **[RE\_Order.DoWork Interface](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/RE_order_do_work_interface.htm)** The RE\_Order.DoWork Apex interface provides the capability to perform additional work after an order and the related records are committed to the database. # Apex Classes for Trade Promotion Management This section lists the Apex classes related to Trade Promotion Management. - **[Calendar Launchpad Customization](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_calendar_launchpad.htm)** Customize the hover content and the buttons for a promotion on the TPM calendar launchpad UI by creating an Apex class as a customization hook. - **[DataCloudExportScheduler Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/cg_tpm_apex_datacloudexportscheduler.htm)** This Class is used to trigger a data cloud process on the processing service. - **[JobStatusNotificationService Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/cgcloud_jobstatusnotificationservice.htm)** Processes job status notifications from external batch processing systems for Trade Promotion Management operations. - **[Promotion and Tactic Transfer Customization](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_promotion_transfer.htm)** When you save a promotion in Trade Promotion Management (TPM), it triggers a transfer of the planned promotion to Retail Execution (RE). You can modify the saved promotion and its associated tactic or tactic product details before they get transferred by creating two different callable Apex classes as customization hooks. - **[Promotion Header LWCs](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_promotion_header.htm)** The TPM Promotion header LWCs provide access to the entire TPM promotion header and specific header slots. - **[PromotionPushRemoteActionExtension Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/global_tpm_promotion_push_remote_action.htm)** This Apex class provides programmatic access to the TPM Push Promotion Process Remote Actions. - **[RTR Report Classes](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/RTR_report_execution_classes_parent.htm)** The RTR report-related APEX classes provide programmatic access to the TPM Real Time Reporting (RTR) report data. - **[ScheduleTPMAccrualProcessChain Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/global_tpm_accrual_process.htm)** This Apex class initiates TPM Accrual Process orchestrator after ensuring the accrual export configuration is successfully updated. - **[tpmGenericUtils Module](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpmGenericUtils_Module_Reference.htm)** The tpmGenericUtils module provides replacements for accessing the @salesforce modules on components that have the cgcloud runtime namespace. - **[Account Plan LWC Reference](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_account_plan_component_referance.htm#tpm_account_plan_component_referance)** The tpm-account-plan LWC is a service component that loads a TPM account plan, exposing methods to update the account plan state, and events to keep all UI components of the account plan page in sync when the account plan state changes. - **[Manual Inputs Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ManualInputs.htm#TPM_ManualInputs)** This APEX class provides programmatic access to the TPM Promotion Manual Inputs for Calculation Overrides. This class is used also for Scenario Manual Inputs on Promotion. - **[tpm-promotion Component](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_promotion_component_referance.htm#tpm_promotion_component_referance)** The tpm-promotion LWC is a service component that loads a TPM promotion, exposing methods to update the promotion state, and events to keep all UI components of the promotion page in sync when the promotion state changes. This component is provided as part of the released managed package. - **[ParticipatingCustomers Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ParticipatingCustomers.htm#TPM_ParticipatingCustomers)** This APEX class provides programmatic access to the TPM Promotion Participating Customers List used in the Promotion Push process. - **[ParticipatingCustomers.ParticipatingCustomer Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ParticipatingCustomer_2.htm#TPM_ParticipatingCustomer_2)** This APEX class provides programmatic access to a Participating Customer associated to an instance of TPM\_ParticipatingCustomers. - **[ProductFilter Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ProductFilter.htm#TPM_ProductFilter_class)** This APEX class provides programmatic access to the TPM Promotion Product Filter used in the Promotion. This Product Filter defines the Products that are included in the Promotion. - **[ProductFilter.ManualProduct Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ProductFilter.ManualProduct.htm#TPM_ProductFilter)** This APEX class provides programmatic access to a Manual Products associated to an instance of TPM\_ProductFilter. - **[Promotion Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#TPM_Promotion_class)** This APEX class provides programmatic access to the TPM Promotion SObject and it’s related SObjects. - **[Promotion.DoWork Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_promotion.do.work.htm#tpm_promotion_do_work)** This APEX interface provides the capability to perform additional work once a promotion is completed and the related records are committed to the database. The transaction will be rolled back if there any any errors reported during the doWork execution. - **[Promotion.Record](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_promotion.record.htm#tpm_promotion_record)** This APEX class provides a wrapper to Promotion SObject Records. Each instance wraps an SObject Record related to the parent TPM\_Promotion and provide methods to manipulate them in order to flag them for insertion or deletion. It also provides methods to extract the underlying SObject records so updates can be made. - **[Promotion.TacticRecord](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_PromotionTacticRecord.htm#TPM_PromotionTacticRecord)** This APEX class provides a wrapper to Promotion Tactic SObject Records. Each instance wraps an SObject Record related to the parent TPM\_Promotion and provide methods to manipulate them in order to flag them for insertion or deletion. It also provides methods to extract the underlying SObject records so updates can be made. - **[SubAccounts](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_SubAccounts.htm#TPM_SubAccounts)** Creates an empty sub accounts structure. - **[SubAccounts.SubAccount](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_SubAccountsSubAccount.htm#TPM_SubAccountsSubAccount)** This APEX class provides programmatic access to a single Sub Account information contained in a TPM\_SubAccounts instance. - **[Scenarios Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Scenarios.htm#TPM_Scenarios_class)** This APEX class provides programmatic access to the TPM Promotion Scenario information used in the Promotion. Scenarios define selectable sets of Promotion Level Manual Inputs overrides to simulate different combinations of active/inactive tactics and KPI overrides in a TPM Promotion. A TPM\_Scenarios structure can contain up to five scenarios information. - **[Scenarios.ScenarioParameter Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Scenarios.ScenarioParameter.htm#TPM_Scenarios)** This APEX class provides programmatic access to a single scenario parameter information contained in a TPM\_Scenarios instance. - **[User Interface Customization](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_ui_customization.htm)** This section provides information on how to customize the TPM user interface. - **[UI Edit Access Rights Customization](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_ui_edit_access.htm)** Edit Access Rights (EARights) is a mechanism used by the TPM UI application to selectively enable or disable certain functionality, or UI elements, depending on the business logic. - **[Trade Promotion Management Service APIs](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/cgcloud_tpm_service_introduction.htm)** Trade Promotion Management (TPM) is the process of planning, budgeting, presenting, and running incentive programs between consumer goods manufacturers and retailers. - **[Trade Promotion Management Transformation Engine Workflows](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/SP9-Workflow_Steps_Design.htm)** The workflow comprises APEX callable class to apply the transformations from the input JSON into the output structure. - **[Promotion Creation Workflow](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/promotion_creation_workflow.htm)** This section describes the list of workflow step rules that must be provided from core. - **[Promotion Copy Workflow](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/promotion_copy_workflow.htm)** This section describes the list of workflow step rules that must be provided from core. - **[Scheduling Jobs](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/cgtpm_scheduling_jobs.htm)** Most of the scheduling job endpoints use the Job Chain Process Flow. # APEX Configuration In order to customize the Promotion Save process in APEX layer, you must introduce a callable APEX class as a customization hook. In order to setup the hook, go to Setup → Custom Metadata Types → CGCloud Process Customization , and add the following records: - Label: TPM\_Promotion\_Save - DeveloperName: TPM\_Promotion\_Save - Class: - Enabled: checked - Method: save **APEX class structure** global class implements System.Callable { global Object call(String action, Map args) { // Get the TPM\_Promotion instance from the arguments TPM\_Promotion promotion = (TPM\_Promotion) args.get('promotion'); // Retrieve your custom state sent to UI String payload = (String) args.get('customState'); // Read Transaction Id String txId = (String) args.get('txId'); // Your custom logic goes here } } The call method is called during the Promotion Save Process. At this method, you can add your customizations to the process: - Create additional records - Modify TPM records ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note The TPM\_Promotion instance contains an object with all the Managed Package Promotion data. # Apex Save Process Customization This section provides information on the different workflow process to customize the save process using APEX calls. 1. Change a Managed Package SObject field value. // Get the TPM\_Promotion instance TPM\_Promotion promotion = (TPM\_Promotion) args.get('promotion'); // Update the Promotion\_\_c SObject field Promotion\_\_c myPromo = (Promotion\_\_c) promotion.getPromotion().getRecord(); myPromo.Slogan\_Language\_1\_\_c = 'My New Slogan'; // Update the First Tactic\_\_c Group Text Tactic\_\_c myTactic = (Tactic\_\_c) promotion.getTactics()\[0\].getRecord(); myTactic.Group\_Text\_\_c = 'My New group text'; 2. Delete a Managed Package SObject record. // Get the TPM\_Promotion instance TPM\_Promotion promotion = (TPM\_Promotion) args.get('promotion'); // Delete the first Tactic\_\_c SObject TPM\_Promotion.Record tacticRecordWrapper = promotion.getTactics()\[0\]; if (!tacticRecordWrapper.isDeleted()) { // We can also check if the record is new with isNew() tacticRecordWrapper.setIsDeleted(true); } 3. Add custom SObject to Promotion Save. You can add additional SObjects to be saved during the promotion SObjects database commit. // Get the TPM\_Promotion instance TPM\_Promotion promotion = (TPM\_Promotion) args.get('Promotion'); // Append a new SObject to be saved MyCustomSObject\_\_c mySObject = new MyCustomSObject\_\_c(); TPM\_Promotion.Record myRecordWrapper = promotion.append(mySObject); The TPM\_Promotion class ensures all promotion related SObjects are committed on an all or none fashion while encapsulating all operations in a transaction. Since the hook will be called from multiple places in multiple TPM processes, the best practice is to use the provided methods for handling custom records and relationships to ensure no incomplete or invalid data is committed. The SObject write order for your custom sobject records are determined by the order of the append calls. 4. Add custom SObject to Save with Relationship. // Get the TPM\_Promotion instance TPM\_Promotion promotion = (TPM\_Promotion) args.get('Promotion'); // Append a new SObject to be saved MyCustomSObject\_\_c mySObject = new MyCustomSObject\_\_c(); TPM\_Promotion.Record myRecordWrapper = promotion.append(mySObject); // Add relationship to the Promotion\_\_c record promotion.addRelationship( myRecordWrapper, MyCustomSObject\_\_c.Promotion\_\_c, promotion.getPromotion() ); // Append an additional Child SObject MyChildSObject\_\_c myChildSObject = new MyChildSObject\_\_c(); TPM\_Promotion.Record myChildRecordWrapper = promotion.append(myChildSObject); // Relate the child object to our custom object promotion.addRelationship( myChildRecordWrapper, MyChildSObject\_\_c.MyCustomSObject\_\_c, myRecordWrapper ); 5. Save Custom Data in TPM UI. Save the custom data that was sent for save along with the Promotion data.In your callable class, you can access the custom state that was set as part of the promotion state. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note This state is serialized. Deserialize it before being able to access the data. // Get the TPM\_Promotion instance TPM\_Promotion promotion = (TPM\_Promotion) args.get('promotion'); // Get the custom data serialized data String payloadString = (String) args.get('customState'); // Deserialize it to be able to access the data MyCustomStructure payload = (MyCustomStructure) JSON.deserialize(payloadString, MyCustomStructure.class); // Add the retrieved records to be saved on the promotion transaction if (payload.myRecords != null) { for (MyRecord\_\_c mr: payload.myRecords) { // Add the sobject record to the list of objects to insert or update TPM\_Promotion.Record = wrapper = promotion.append(mr); // Relate it to the promotion (if needed) promotion.addRelationship( wrapper, MyRecord\_\_c.Promotion\_\_c, promotion.getPromotion() ); } } # API End-of-Life Policy Salesforce is committed to supporting each API version for a minimum of 3 years from the date of first release. To improve the quality and performance of the API, versions that are over 3 years old sometimes are no longer supported. Salesforce notifies customers who use an API version scheduled for deprecation at least 1 year before support for the version ends. # AssessmentIndDefinedValue Stores the list of acceptable values which are defined as part of assessment indicator definition for a single and multi select question. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssessmentIndicatorDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the associated assessment indicator definition. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the record. ### SequenceNumber - **Type**: int - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The sequence in which the assessment indicator value is displayed in the UI. ### Value - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Values for the assessment indicator definition. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. - **[AssessmentIndValueFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_associated_objects_feed.htm "HTML (New Window)")**: Feed is available for the object. # AssessmentIndicatorDefinition Define parameters that act as markers of compliance for retail tasks to compare target and actual values. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### DataType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort - **Description**: Type of data the assessment Indicator definition can hold. - **Default value**: Number - **Possible values**: - Boolean - DateTime - Decimal - Number - Percentage - String - Picklist - Multi-Select Picklist ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Description of the assessment indicator definition. ### 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**: Create, Filter, Group, idLookup, Sort, Update - **Description**: The name of the assessment indicator definition that indicates the parameter to audit. Values can include: Inventory, Facings, Competitor Facings, Share of Shelf. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the assessment Indicator definition record owner. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. - **[AssessmentIndicatorDefinitionHistory](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 object. - **[AssessmentIndicatorDefinitionOwnerSharingRule](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. - **[AssessmentIndicatorDefinitionShare](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. # AssessmentIndValue Stores the list of target or captured values which are defined as part of assessment indicator definition for a single and multi select question. This object is available in API version 49.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssessmentIndDefinedValueId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Id of the associated assessment indicator definition value. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the assessment indicator definition value record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this record. ### SourceObjectId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The associated assessment indicator definition. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. - **[AssessmentIndValueFeed](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_associated_objects_feed.htm "HTML (New Window)")**: Feed is available for the object. # AssessmentTask Perform activities such as planogram check, inventory check, promotion check, in-store survey, or custom task in stores to capture information. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssessmentTaskDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The assessment task definition that is referenced for the task. This field is available in API version 48.0 and later. ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Description of task that has to be performed at the store. ### EndTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Time when the task is completed by a field rep. This field is available in API version 49.0 and later. ### IsRequired - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicate whether a task must be completed to complete a visit. This field is available in API version 48.0 and later. - **Default value**: False ### 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**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Unique identification of the task. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the assessment task record owner. ### ParentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The visit associated with an assessment task.This field is available in API version 48.0 and later. ### SequenceNumber - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The sequence in which the tasks must be performed. This field is available in API version 48.0 and later. ### StartTime - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Time when the task is started by a field rep. This field is available in API version 49.0 and later. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: View the status of a task. This field is available in API version 48.0 and later. - **Possible values**: - Completed - InProgress—In Progress - NotStarted—Not Started ### TaskDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to related records such as signature task, delivery task, other Component task, flow, and SFDC task. This field is a polymorphic relationship field. This field is available in API version 48.0 and later. - **Relationship Name**: TaskDefinition - **Refers To**: DeliveryTask, OtherComponentTask, RecordAction, SignatureTask, Task ### TaskType - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort - **Description**: Type of a task that the sales rep can perform during the visit. The task type must match the task type of the assessment task definition. - **Possible values**: - ConductInStoreSurveys - InventoryCheck - Other - PlaceOrder - PlanogramCheck - PromotionCheck ## Associated Objects This object has these associated objects. Unless noted, they’re available in the same API version as this object. - **[AssessmentTaskHistory](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 object. - **[AssessmentTaskShare](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. - **[AssessmentTaskFeed](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 is available for the object. # AssessmentTaskContentDocument Associate content documents to visits, tasks, promotions, or planograms. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssessmentTaskId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the assessment task. ### ContentContextId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the attachment or file used as the content document for a custom object that is associated with a task. The IDs are validated against ActionPlanTemplateType. ### ContentDocumentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: ID of the attachment or file used as the content document. ### 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 identifier of the content document. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. - **[AssessmentTaskContentDocumentHistory](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 object. # AssessmentTaskDefinition Associate an assessment task with an assessment indicator definition. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Description of the assessment task definition. ### 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**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Unique identification of the task. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the assessment Indicator definition record owner. ### TaskType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Type of a task that the sales rep can perform during the visit. - **Possible values**: - ConductInStoreSurveys - InventoryCheck - Other - PlaceOrder - PlanogramCheck - PromotionCheck ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. - **[AssessmentTaskDefinitionHistory](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 object. - **[AssessmentTaskDefinitionShare](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. - **[AssessmentTaskDefinitionFeed](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 is available for the object. # AssessmentTaskIndDefinition Associate an assessment indicator definition with an assessment task definition.This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssessmentIndDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The assessment indicator definition that is associated with the assessment task. ### AssessmentTaskDefinitionId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: The assessment task that is associated with the assessment indicator definition. ### DisplayOrder - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Sequence of the assessment task definitions. ### 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 assessment task indicator definition. ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. - **[AssessmentTaskIndDefinitionHistory](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 object. - **[AssessmentTaskIndDefinitionFeed](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 is available for the object. # AssessmentTaskOrder Define an order activity that the sales rep can perform during a visit to the stores. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### AssessmentTaskId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the assessment task. ### 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 identifier for the assessment Indicator definition for the order creation task. ### OrderId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the order ### RetailStoreId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the retail store. ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. - **[AssessmentTaskOrderFeed](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 are available for the object. - **[AssessmentTaskOrderHistory](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 object. # Asset Standard and custom fields extend the standard Asset object in Consumer Goods Cloud to represent an item of commercial value, such as a product sold by your company or a competitor, that a customer has purchased. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AccountId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Required. ID of the Account related to the asset. Must be a valid account ID. This field is a relationship field. - **Relationship Name**: Account - **Relationship Type**: Lookup - **Refers To**: Account ### Address - **Type**: address - **Properties**: Filter, Nillable - **Description**: The compound form of the Asset address ### AssetLevel - **Type**: int - **Properties**: Filter, Group, Nillable, Sort - **Description**: Asset’s position in the asset hierarchy: Assets that have no parent or child assets, or that belong to a hierarchy have a level of 1 for the root asset. Child assets of the root asset have a level of 2, the children of level 2 assets have a level of 3, and so on. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note The asset level of assets created before the introduction of this field defaults to –1. After the asset record is updated, the asset level is calculated and automatically updated. ### AssetProvidedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Account that provided the asset, typically a manufacturer. This field is a relationship field. - **Relationship Name**: AssetProvidedBy - **Relationship Type**: Lookup - **Refers To**: Account ### AssetServicedById - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Account in charge of servicing the asset. This field is a relationship field. - **Relationship Name**: AssetServicedBy - **Relationship Type**: Lookup - **Refers To**: Account ### City - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: City in the address. ### ContactId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the related contact record. This field is a relationship field. - **Relationship Name**: Contact - **Relationship Type**: Lookup - **Refers To**: Contact ### Country - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Country in the address. ### CurrentAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Reserved for future use. Available when CPQ Plus, Salesforce Billing, or Subscription Management is enabled. ### CurrentLifecycleEndDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: End of the period shown as current. Auto-populated field inherited from the end date of the current asset state period. If the field is empty, as with an evergreen subscription, the Current Lifecycle End Date field is empty. ### CurrentMrr - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Asset’s monthly recurring revenue during the current asset state period. Auto-populated field inherited from the monthly recurring revenue on the current asset state period. If no asset state period is current, the value is 0. Label is Current Monthly Recurring Revenue. ### CurrentQuantity - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Asset’s quantity during the current asset state period. Auto-populated field inherited from the quantity on the current asset state period. If no asset state period is current, the value is 0. ### Description - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Description of the asset. ### GeocodeAccuracy - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Shipping geocode accuracy: - **Possible values**: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip ### HasLifecycleManagement - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Indicates whether this asset is lifecycle-managed (true) or not (false). After setting this value, the value can’t be changed. Auto-populated field. - **Default value**: false ### InstallDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date when the asset was installed. ### IsCompetitorProduct - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the asset represents a product sold by a competitor (true) or not (false). - **Default value**: false ### IsInternal - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the asset is produced or used internally (true) or not (false). - **Default value**: false ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date and time that the asset was last modified. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date and time that the asset was last viewed. ### Latitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Latitude of the asset. ### LifecycleEndDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: End of the asset’s lifecycle. Auto-populated field inherited from the end date of the final asset state period. If the field is empty, as with an evergreen subscription, the lifecycle has no end date. This field is available when CPQ Plus, Salesforce Billing, or Subscription Management is enabled. ### LifecycleStartDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Beginning of the asset’s lifecycle. Auto-populated field inherited from the start date of the earliest asset state period. This field can’t be edited. When a new asset action affects the start date of an asset state period, a new period is generated. This field is available when CPQ Plus, Salesforce Billing, or Subscription Management is enabled. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the GPS coordinates of the asset. Relationship field. - **Relationship Name**: Location - **Relationship Type**: Lookup - **Refers To**: Location ### Longitude - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Asset’s location. Typically, this location is the place where the asset is stored, such as a warehouse or van. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Required. Name of the asset. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Asset’s owner. By default, the asset owner is the user who created the asset record. This field is a relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: User ### ParentId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Asset’s parent asset. This field is a relationship field. - **Relationship Name**: Parent - **Relationship Type**: Lookup - **Refers To**: Asset ### PostalCode - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Postal code in the asset address. ### Price - **Type**: currency - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Pricing information for an asset. ### Product2Id - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Optional. ID of Product2 related to this asset. Must be a valid Product2 ID. This field is a relationship field. - **Relationship Name**: Product2 - **Relationship Type**: Lookup - **Refers To**: Product2 ### ProductCode - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Product code of the related product. ### PurchaseDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date on which this asset was purchased. ### Quantity - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Asset quantity purchased or installed. ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the record type. This field is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### RootAssetId - **Type**: reference - **Properties**: Filter, Group, Nillable, Sort - **Description**: Read-only. The top-level asset in an asset hierarchy. Depending on where an asset lies in the hierarchy, the asset’s root can be the same as the parent. This field is a relationship field. - **Relationship Name**: RootAsset - **Relationship Type**: Lookup - **Refers To**: Asset ### SerialNumber - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Serial number of the asset. ### State - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: State in the asset address. ### Status - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates asset’s status: Customizable picklist. - **Possible values**: - Active - Damaged - Inactive ### StockKeepingUnit - **Type**: string - **Properties**: Filter, Group, Nillable, Sort - **Description**: Stock keeping unit assigned to the related product. ### Street - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Street name in the asset address. ### TotalLifecycleAmount - **Type**: currency - **Properties**: Filter, Nillable, Sort - **Description**: Total amount of revenue for the asset, including revenue from each stage in the asset lifecycle. The field is available when CPQ Plus, Salesforce Billing, or Subscription Management is enabled. ### UsageEndDate - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: End date or expiry date for asset use. ### cgcloud\_Asset\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References to the asset template. This field is a relationship field. - **Relationship Name**: cgcloud\_dev\_\_Asset\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_dev\_\_Asset\_Template\_\_c ### cgcloud\_Asset\_Type\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of asset. This field is a relationship field. - **Relationship Name**: cgcloud\_dev\_\_Asset\_Type\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_Brand\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References to the brand of the child product. ### 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\_dev\_\_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 field is a calculated field. - **Formula**: CASE($User.cgcloud\_dev\_\_Language\_Postfix\_\_c, "Language1", cgcloud\_dev\_\_Description\_Language\_1\_\_c, "Language2", BLANKVALUE(cgcloud\_dev\_\_Description\_Language\_2\_\_c,cgcloud\_dev\_\_Description\_Language\_1\_\_c), "Language3", BLANKVALUE(cgcloud\_dev\_\_Description\_Language\_3\_\_c,cgcloud\_dev\_\_Description\_Language\_1\_\_c), "Language4", BLANKVALUE(cgcloud\_dev\_\_Description\_Language\_4\_\_c,cgcloud\_dev\_\_Description\_Language\_1\_\_c), cgcloud\_dev\_\_Description\_Language\_1\_\_c) ### cgcloud\_ERP\_Asset\_Number\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Holds the asset number assigned by the ERP. ### cgcloud\_Manufacturer\_Serial\_Number\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Serial number given by the manufacturer. ### cgcloud\_Note\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: General note about the asset. ### cgcloud\_Ownership\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the ownership type of the asset: - **Possible values**: - Leased - Owned ### cgcloud\_POS\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References to Point of Sale(POS). This field is a relationship field. - **Relationship Name**: cgcloud\_dev\_\_POS\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_dev\_\_POS\_\_c ### cgcloud\_Production\_Year\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Holds the production year of the asset. ### cgcloud\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org of the template: - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_Service\_Phone\_Number\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Phone number from the service support of the asset. ### cgcloud\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date from which the asset is valid. ### cgcloud\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the asset is valid. ## Associated Objects ### Associated Objects The Asset object has these related objects. If the API version isn’t specified, then the APIs are available in the same versions as the object. Otherwise, the APIs are available in the specified API version and later. - **[AssetChangeEvent](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. - **[AssetFeed](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. - **[AssetHistory](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 tracked fields of the object. - **[AssetOwnerSharingRule](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. - **[AssetShare](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. # Associated Objects for Retail Execution This section provides a list of objects associated to Retail Execution standard objects with their standard fields. Some fields may not be listed for some objects. To see the system fields for each object, see [System Fields](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/system_fields.htm) in the Object Reference for Salesforce and Lightning Platform. To verify the complete list of fields for an object, use a describe call from the API or inspect with an appropriate tool. For example, inspect the WSDL or use a schema viewer. - **[StandardObjectNameChangeEvent](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. - **[StandardObjectNameFeed](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. - **[StandardObjectNameHistory](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. - **[StandardObjectNameOwnerSharingRule](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. - **[StandardObjectNameShare](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. # Assortment Represents a list of products that are eligible for sale in a store. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: User-defined description of an assortment of products. ### 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**: Create, Filter, Group, idLookup, Sort, Update - **Description**: User-defined name of an assortment of products. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the assortment owner. ### cgcloud\_\_Description\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of language 1. This field is available in API version 55.0 and later. ### cgcloud\_\_Description\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of language 2. This field is available in API version 55.0 and later. ### cgcloud\_\_Description\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of language 3. This field is available in API version 55.0 and later. ### cgcloud\_\_Description\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The description of language 4. This field is available in API version 55.0 and later. ### cgcloud\_\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description based on the user specific language. This field 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\_\_Distribution\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This field is not used in Consumer Goods Cloud. ### cgcloud\_\_Facings\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: This field is not used in Consumer Goods Cloud. ### cgcloud\_\_Listing\_Module\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Value of the Listing Module. This field is available in API version 55.0 and later. - **Default value**: Base Module - **Possible values**: - Base Module ### cgcloud\_\_Obligatory\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Denotes whether this is a closed listing. Used by the system. This field is available in API version 55.0 and later. - **Default value**: false ### cgcloud\_\_Price\_Survey\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: This field is not used in Consumer Goods Cloud. ### cgcloud\_\_Product\_Assortment\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References to the name of product assortment template. This field is available in API version 55.0 and later. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_Assortment\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Product\_Assortment\_Template\_\_c ### cgcloud\_\_Sales\_Org\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Describes the sales org which the product assortment belongs to. This field is available in API version 55.0 and later. This field is a calculated field. - **Formula**: TEXT(cgcloud\_\_Product\_Assortment\_Template\_\_r.cgcloud\_\_Sales\_Org\_\_c) ### cgcloud\_\_Sync\_Pending\_\_c - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Flagged to be relevant for this sync process. This field is available in API version 55.0 and later. This field is a calculated field. - **Formula**: IF( cgcloud\_\_Version\_\_c <> cgcloud\_\_Version\_Off\_Platform\_APL\_\_c , cgcloud\_\_Product\_Assortment\_Template\_\_r.cgcloud\_\_Consider\_For\_APL\_Generation\_\_c, false ) ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The starting date of the valid period for the Assortment. This field is available in API version 55.0 and later. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The end date of the valid period for the Assortment. This field is available in API version 55.0 and later. ### cgcloud\_\_Version\_Off\_Platform\_APL\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Stores the off platform version number of Account product list. This field is available in API version 55.0 and later. ### cgcloud\_\_Version\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the version number of Authorization list. This field is available in API version 55.0 and later. ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. - **[AssortmentFeed](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 are available for the object. - **[AssortmentHistory](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 object. - **[AssortmentShare](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. # AssortmentProduct Associate products to an assortment. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssortmentId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the related assortment. ### DefaultOrderQuantity - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Default quantity to order. ### IsFavorite - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Top-selling items of a store. ### 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**: User-defined name for the assortment. ### ProductId - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: ID of each product within the assortment. ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. - **[AssortmentProductFeed](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 are available for the object. - **[AssortmentProductHistory](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 object. # Begin Job Scheduling Transaction Begin a scheduling transaction for a job in a job chain. The job either starts an open transaction (if the number of job items is not announced) that must be explicitly committed to, or communicates the expected number of job items to the off-platform system. Optionally, a scheduling timeout between 30 seconds and 15 minutes can be specified. The default is 5 minutes. This is the time when the scheduling processes must provide the job items. Timeout is calculated from the last time job items were added to the transaction. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note The JobThreads parameter is not effective for this endpoint — worker parallelism is controlled by the individual scheduling endpoints (e.g., Schedule Promotion Calculation, Schedule Account Plan Calculation V2). ## Resource BEGIN\_JOB\_SCHEDULING\_TRANSACTION ## Available version 55.0 ## Request Parameters | Name | Type | Description | Required or Optional | | --- | --- | --- | --- | | jobChain | String | ID of the job chain record. | Required | | jobId | String | ID of the job record for which scheduling transaction is to be started. | Required | ## Apex Request Example PromotionImport is used when you schedule a top promotion by grouping the imported promotions. .BeginPromotionImportCallout callout = new .BeginPromotionImportCallout(); // Import Id, the promotion import is grouped under this ID String importId = '12345678-1234-1234-1234-123456789012'; // Number of promotions to be imported Integer nrOfItems = 100; // Timeout in seconds: number of seconds between two schedule promotion callouts // for this import Integer timeout = 400; .OffplatformCalloutResponse response = callout.execute(importId, nrOfItems, timeout); if (response.status != 200) { // Handle error } Generic is used in the calculation chain flow. // name of the salesorg for which the job must be scheduled String salesOrg = '0001'; .JobSchedulingBeginCallout callout = new .JobSchedulingBeginCallout(salesOrg); // Log Transaction Id String txId = .TransactionHandler.getTransactionIdentifier(); // Job object .Job job = new .Job(); job.JobChainName = 'TPM\_Calculation\_Chain\_'; job.JobName = 'PromotionCalculation'; // Timeout in seconds: number of seconds between two schedule promotion callouts // for this import Integer timeout = 350; .OffplatformCalloutResponse response = callout.execute(txId, job, timeout); if (response.status != 200) { // Handle error } # Begin Promotion Import This endpoint initializes a promotion import from an external system. You can group a set of promotions using the import ID, retrieved by thie end point. This endpoint announces that the import contains a specified number of promotions to be processed. The system can import the promotions, create, and update them, and trigger a promotion calculation for the given promotions. The status of the import can be monitored with the GET\_PROMOTION\_IMPORT\_STATUS endpoint. ## Resource promotions/initialize ## Available Version 55 ## Requires Chatter No ## HTTP Methods POST ## Request Body for POST ### JSON Example { "nrOfItems": 500, "salesOrg": "0001" } ### Properties
Name Type Description Required or Optional Available Version
nrOfItems Integer Number of items that are imported under the given handle.
  • Minimum Value : 1
  • Maximum Value: 10000
 Required 55
timeout Integer Indicates the timeout in seconds. In the event of a time out, no further messages will be accepted for the import IDs.

The default value is 300 seconds.

 Optional 55
salesOrg SalesOrgName Indicates the name of the sales organization. Required 55
## Response Body for POST [Begin Promotion Import Output Representation](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/connect_begin_promotion_imports_output.htm "Output representation of the promotion import request.") # Begin Promotion Import Input Input representation of the promotion import object. ## JSON Example { "nrOfItems": 500, "salesOrg": "0001" } ## Properties
Name Type Description Required or Optional Available Version
nrOfItems Integer Number of items that are imported under the given handle.
  • Minimum Value : 1
  • Maximum Value: 10000
 Required 55
timeout Integer Indicates the timeout in seconds. In the event of a time out, no further messages will be accepted for the import IDs.

The default value is 300 seconds.

 Optional 55
salesOrg SalesOrgName Indicates the name of the sales organization. Required 55
# Begin Promotion Import Output Output representation of the promotion import request. ## JSON Example { "importId" : "3121b14e-f370-4c1b-8b09-b9323ea38216" } ## Properties | Property Name | Type | Description | Available Version | | --- | --- | --- | --- | | importID | String | The ID of the promotion import. | 55 | # Best Practices for PromotionPushRemoteActionExtension This topic focuses on different types of Apex implementations to push multiple parent promotions. For more information, see [PromotionPushRemoteActionExtension Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/global_tpm_promotion_push_remote_action.htm "This Apex class provides programmatic access to the TPM Push Promotion Process Remote Actions."). The type of Apex implementations are: - Sync Apex Snippet (legacy mode only) - Queueable (both new and legacy modes) - Future Method (new mode only) - Apex Batch Class (new mode only) An Apex code snippet is provided for each Apex class. ## Legacy Mode In Summer ‘25 or earlier releases, [PromotionPushRemoteActionExtension Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/global_tpm_promotion_push_remote_action.htm "This Apex class provides programmatic access to the TPM Push Promotion Process Remote Actions.") used only Apex Flex Queue to push promotions. This method of using Apex Flex Queue is referred to as Legacy Mode in this topic. This method continues to be available in future releases. ## New Mode In Winter ‘26 or later releases, a new method to push promotions using the PromotionPushRemoteActionExtension Apex class is introduced. To enable the new method, the PushPromotionExecutionMode system setting must be set to OffPlatform. ## Sync Apex Snippet This approach of Apex implementation uses the legacy mode to push promotions using the PromotionPushRemoteActionExtension Apex class. It demonstrates how to push multiple parent promotions from one synchronous Apex execution context. List promotionIds = new List{ ' promotionIds = new List{ ' promotionIds { get; set; } public void execute() { for (String promotionId : this.promotionIds) { SchedulePromotionPushFuture.schedulePushPromotion(promotionId.trim()); } } @future(callout=true) static public void schedulePushPromotion(String promotionId) { String readParams = '{"promotionId":"' + promotionId + '"}'; String txid = cgcloud\_dev.TransactionHandler.getTransactionIdentifier(); cgcloud\_dev.PromotionPushRemoteActionExtension.pushBOPromotion(txid, readParams); } } **Scheduling Apex Snippet** SchedulePromotionPushFuture futureClass = new SchedulePromotionPushFuture(); futureClass.promotionIds = new List{ ', Database.AllowsCallouts, Database.Stateful { public List promotionIds { get; set; } public Iterable start(Database.BatchableContext bc ) { return this.promotionIds; } public void execute(Database.BatchableContext bc, List scope) { String readParams = '{"promotionId":"' + scope.get(0).trim() + '"}'; String txid = cgcloud\_dev.TransactionHandler.getTransactionIdentifier(); cgcloud\_dev.PromotionPushRemoteActionExtension.pushBOPromotion(txid, readParams); } public void finish(Database.BatchableContext bc) { } } **Scheduling Apex Snippet** SchedulePromotionPushBatch batchClass = new SchedulePromotionPushBatch(); batchClass.promotionIds = new List{ ' # Best Practices: Claim Processing Through Apex Batch Claim processes in Consumer Goods Cloud Trade Promotion Management (TPM) is done through user interface. However, if there are a large number of claims, then it is necessary to process claims in batches. In TPM, Apex batches are used to process a large number of claims. ## Considerations for Apex Batch Processing An Apex Batch class implements three methods: - start - Defines the scope of the apex batch. This method returns every record that the Apex Batch processes. - The result is partitioned into lists of up to records. - The object cgcloud\_\_Payment\_\_c records are selected and returned. - execute - Processes one of the lists of items provided by the start method. - Here the main logic of the Apex Batch is executed. - This method is called for each partition. - finish - Used to finalize monitoring and cleanup resources, if any, that are not automatically closed. ## Define Batch Scope Method: List/QueryLocator start(BatchableContext) - Avoid adding system internal fields to the list of selected fields for the claims to select. For example, fields used for Version Handling. Fields that should be excluded are: - cgcloud\_\_Version\_\_c - cgcloud\_\_Offplatform\_Version\_\_c - cgcloud\_\_Skip\_Version\_Update\_\_c - This hint is not only relevant for claim processing, but also for the processing of other versioned objects. - cgcloud\_\_Promotion\_\_c - cgcloud\_\_Account\_Plan\_\_c (a.k.a. CBP) - Assortment ## Manipulating Claims Method: execute(BatchableContext, List) - If payments are updated with the batch, avoid using the scoped record instance. Instead, create a new object instance where only the fields are set that identify the record (id field) and needs to be updated. - This prevents an accidental overwrite of fields that are outdated. For example, if the field is managed and set by a trigger such as version fields. ## Calculating Claims Method: execute(BatchableContext, List), finish(BatchableContext) - The automatic claim calculation through trigger is not considered when payments are updated in a Batch Context. The payments must be scheduled directly through a callout. - If claims should be calculated within a batch that also manipulates the claim, the claim calculation must not rely on a version that was previously loaded. For example, by the start method. - The Scheduling of the Calculation must be executed in a queueable or future method and not in the same transaction because callout after DML statements are not allowed. - Before a payment calculation is scheduled, reload the version to get the current value. - If the batch only schedules payments for calculation and does not update the claim, then load the version field into the scope. # Business Object API Entity The following entities are created as part of the default configuration to support Promotion use cases. | **Entity Name** | **Location** | **Path** | **Description** | | --- | --- | --- | --- | | Promotion | Input | | Represents the input Promotion. The attributes for the object are defined in the Workflow Rules that use this Entity. | | Tactic | Input | .Tactics\[\*\] | Represents an input Tactic. The attributes for the object are defined in the Workflow Rules that use this Entity. | | ManualInputs | Input | .ManualInputs,.Tactics\[\*\].ManualInputs | Represents a Manual Inputs Array. The attributes for the object are defined in the Workflow Rules that use this Entity. | | ProductFilter | Input | .ProductFilter,.Tactics\[\*\].ProductFilter | Represents a Product Filter Structure. The attributes for the object are defined in the Workflow Rules that use this Entity. | | TPM\_Promotion | Output | | Represents the TPM\_Promotion Instance with all the promotion data. | | TPM\_Promotion.Promotion | Output | | Represents a TPM\_Promotion.Record instance with all the Promotion SObject Data. SObject fields can be used with dot notation. | | TPM\_Promotion.Tactic | Output | | Represents a TPM\_Promotion.TacticRecord instance with all the Tactic SObject Data. SObject fields can be used with dot notation. | | TPM\_Promotion.Attachment | Output | | Represents a TPM\_Promotion.Record instance with all the Promotion Attachment SObject Data. SObject fields can be used with dot notation. | | TPM\_Promotion.AttachmentLink | Output | | Represents a TPM\_Promotion.Record instance with all the Promotion Attachment Link SObject Data. SObject fields can be used with dot notation. | | TPM\_Promotion.ProductFilter | Output | | Represents a TPM\_ProductFilter instance with all the Promotion Product filter information. | | TPM\_Promotion.ProductShare | Output | | Represents a TPM\_Promotion.Record instance with all the Promotion Product Share SObject Data. SObject fields can be used with dot notation. | | TPM\_Promotion.TacticConditionCreationDefinition | Output | | Represents a TPM\_Promotion.Record instance with all the Tactic Condition Creation Definition SObject Data. SObject fields can be used with dot notation. | | TPM\_Promotion.TacticFund | Output | | Represents a TPM\_Promotion.Record instance with all the Tactic Fund SObject Data. SObject fields can be used with dot notation. | | TPM\_Promotion.TacticProductFilter | Output | | Represents a TPM\_ProductFilter instance with all the Tactic Product filter information. | | CustomState | Output | | Represents a generic Object that will be passed to the Promotion Saving Process while saving. | # Business Object API Output Entities The following entities are provided for Promotion Business Objects API. | **BO API Name** | **Output Entity Name** | | --- | --- | | Promotion | TPM\_Promotion.Promotion | | Promotion | TPM\_Promotion.Tactic | | Promotion | TPM\_Promotion | | Promotion | CustomState | | Promotion | TPM\_Promotion.TacticConditionCreationDefinition | # Business Object API Workflow Step Input Structures The following table provides technical details related to each workflow step. | **Workflow Step Name** | **Record Type** | **Path** | **Required?** | **Description** | **Maximum Length (String)** | | --- | --- | --- | --- | --- | --- | | handleAttachmentsForDerive2 | Boolean | .DeriveAttachments | FALSE | Boolean flag. If enabled, attachments will be derived, if false, attachments won’t be derived | NA | | handleManualInputs | String | \[\*\].KPI | TRUE | The name of the KPI for which the value must be set. | 80 | | handleManualInputs | String | \[\*\].Product | FALSE | Product ID(SFID or external ID) to set the KPI Value to. If not set, the KPI value is set as total for the promotion/tactic. | 260 | | handleManualInputs | Number | \[\*\].Value | TRUE | Numeric value. Value to set to the KPI. | NA | | handleManualInputs2 | String | \[\*\].KPI | TRUE | The name of the KPI for which the value must be set. | 80 | | handleManualInputs2 | Number | \[\*\].Value | TRUE | Numeric value. Value to set to the KPI. | NA | | handleManualInputs2 | String | \[\*\].Product | FALSE | Product ID(SFID or external ID) to set the KPI Value to. If not set, the KPI value is set as total for the promotion/tactic. | 260 | | loadCategoryShareLO | String | .Id | TRUE | SFDC Id or External Id of the source promotion to be copied. | 40 | | loadPromotionAttachmentsForCopy | String | .Id | TRUE | SFDC Id or External Id of the source promotion to be copied. | 40 | | loadPromotionAttachmentsForCopy | Boolean | .CopyAttachments | FALSE | Boolean flag. If enabled, attachments will be loaded, if false, attachments won’t be loaded | NA | | loadPromotionAttachmentsForCopy2 | String | .Id | TRUE | SFDC Id or External Id of the source promotion to be copied. | 40 | | loadPromotionAttachmentsForCopy2 | Boolean | .CopyAttachments | FALSE | Boolean flag. If enabled, attachments will be loaded, if false, attachments won’t be loaded | NA | | loadPromotionBOForCopy | String | .Id | TRUE | SFDC Id or External Id of the source promotion to be copied. | 40 | | loadPromotionBOForCopy2 | String | .Id | TRUE | SFDC Id or External Id of the source promotion to be copied. | 40 | | loadPromotionDefaults | String | .Id | FALSE | SFID or External Id of the promotion. | 40 | | loadPromotionDefaults | String | .PromotionTemplate | TRUE | Name or SFID of the Promotion Template. | 40 | | loadPromotionDefaults(update) | String | .PromotionTemplate | FALSE | Name or SID of the Promotion Template | 40 | | loadPromotionDefaults(update) | String | .Id | TRUE | SFID or External Id of the promotion to be updated. | 40 | | loadPromotionDefaults(update)2 | String | .PromotionTemplate | FALSE | Name or SID of the Promotion Template | 40 | | loadPromotionDefaults(update)2 | String | .Id | TRUE | SFID or External Id of the promotion to be updated. | 40 | | loadPromotionDefaults2 | String | .PromotionTemplate | TRUE | Name or SFID of the Promotion Template. | 40 | | loadPromotionDefaults2 | String | .Id | FALSE | SFID or External Id of the promotion. | 40 | | loadPromotionForDerive2 | String | .Id | TRUE | SFID or External Id of the promotion to be derived. | 40 | | loadPromotionForDerive2 | String | .PromotionTemplate | TRUE | Name or SID of the Promotion Template to use for derivation. | 40 | | loadTacticDefaults | String | .TacticTemplate | TRUE | Name or SFID of the tactic template. | 40 | | loadTacticDefaults | String | .Id | FALSE | SFID or External Id of the tactic. | 40 | | loadTacticDefaults(update) | String | .Id | TRUE | SFID or ExternalId of the tactic | 40 | | loadTacticDefaults(update) | String | .TacticTemplate | FALSE | Name or SFID of the tactic template. | 40 | | loadTacticDefaults(update)2 | String | .Id | TRUE | SFID or ExternalId of the tactic | 40 | | loadTacticDefaults(update)2 | String | .TacticTemplate | FALSE | Name or SFID of the tactic template. | 40 | | loadTacticDefaults2 | String | .TacticTemplate | TRUE | Name or SFID of the tactic template. | 50 | | loadTacticDefaults2 | String | .Id | FALSE | SFID or External Id of the tactic. | 40 | | loadTacticsLOForCopy | String | .Id | TRUE | SFDC Id or External Id of the source promotion to be copied. | 40 | | loadTacticsLOForCopy2 | String | .Id | TRUE | SFDC Id or External Id of the source promotion to be copied. | 40 | | mapPromotionValues | String | .Comment | FALSE | Comment | 255 | | mapPromotionValues | String | .Slogan | TRUE | Slogan | 80 | | mapPromotionValues(Update) | String | .Slogan | FALSE | Slogan | 80 | | mapPromotionValues(Update) | String | .Comment | FALSE | Comment | 255 | | mapPromotionValues(Update)2 | String | .Slogan | FALSE | Slogan | 80 | | mapPromotionValues(Update)2 | String | .Comment | FALSE | Comment | 255 | | mapPromotionValues2 | String | .Slogan | TRUE | Slogan | 80 | | mapPromotionValues2 | String | .Comment | FALSE | Comment | 255 | | mapPromotionValuesForCopy2 | String | .Slogan | FALSE | Slogan | 80 | | mapTacticValues | String | .CompensationModel | FALSE | Compensation Model | 255 | | mapTacticValues | Number | .Amount | FALSE | Tactic Amount | NA | | mapTacticValues2 | String | .CompensationModel | FALSE | Compensation Model | 255 | | mapTacticValues2 | Number | .Amount | FALSE | Tactic Amount | NA | | movePromotionTimeframe | Number | .AddYears | FALSE | Amount of years to move the promotion timeframe. If not set, a default value of 1 will be used. | NA | | movePromotionTimeframe2 | String | .InStoreDateFrom | FALSE | Promotion's new In Store Date From. If specified, all promotion dates will be shifted by the difference in days between the input Date and the Promotion current Date From date. | 10 | | movePromotionTimeframe2 | Number | .AddYears | FALSE | Amount of years to move the promotion timeframe. If not set, a default value of 1 will be used. | NA | | setProductFilter | String | .Criteria.Brand\[\*\] | FALSE | The External Ids of manual brands that must be included in the promotion. | 255 | | setProductFilter | String | .IncludedProducts\[\*\] | FALSE | The External Ids of manual products that must be included. | 255 | | setProductFilter | String | .Criteria.Subcategory\[\*\] | FALSE | The External Ids of manual sub categories that must be included in the promotion. | 255 | | setProductFilter | String | .Criteria.Category\[\*\] | FALSE | The External Ids of manual categories that must be included in the promotion. | 255 | | setProductFilter | String | .ExcludedProducts\[\*\] | FALSE | The External Ids of manual products to be excluded. | 255 | | setProductFilter | String | .Criteria.Flavor\[\*\] | FALSE | The External Ids of manual flavors that must be included in the promotion. | 255 | | setProductFilter | String | .Criteria.Package\[\*\] | FALSE | The External Ids of manual packages that must be included in the promotion. | 255 | | setProductFilter2 | String | .Criteria.Flavor\[\*\] | FALSE | The External Ids of manual flavors that must be included in the promotion. | 255 | | setProductFilter2 | String | .Criteria.Package\[\*\] | FALSE | The External Ids of manual packages that must be included in the promotion. | 255 | | setProductFilter2 | String | .IncludedProducts\[\*\] | FALSE | The External Ids of manual products that must be included. | 255 | | setProductFilter2 | String | .Criteria.Subcategory\[\*\] | FALSE | The External Ids of manual sub categories that must be included in the promotion. | 255 | | setProductFilter2 | String | .Criteria.Brand\[\*\] | FALSE | The External Ids of manual brands that must be included in the promotion. | 255 | | setProductFilter2 | String | .Criteria.Category\[\*\] | FALSE | The External Ids of manual categories that must be included in the promotion. | 255 | | setProductFilter2 | String | .ExcludedProducts\[\*\] | FALSE | The External Ids of manual products to be excluded. | 255 | | setPromotionAnchor | String | .PromotionTemplate | TRUE | Name or SFID of the Promotion Template. | 40 | | setPromotionAnchor | String | .AnchorAccountSet | FALSE | Name or SFID of the customer set. | 40 | | setPromotionAnchor | String | .Id | FALSE | SFDC Id or External Id of the source promotion to be copied. | 40 | | setPromotionAnchor | String | .AnchorAccount | FALSE | SFID or External Id of the customer. | 40 | | setPromotionAnchor(Update) | String | .Id | FALSE | SFDC Id or External Id of the source promotion to be copied. | 40 | | setPromotionAnchor(Update) | String | .AnchorAccount | FALSE | SFID or External Id of the customer. | 40 | | setPromotionAnchor(Update) | String | .AnchorAccountSet | FALSE | Name or SFID of the customer set. | 40 | | setPromotionAnchor(Update) | String | .PromotionTemplate | FALSE | Name or SID of the Promotion Template | 40 | | setPromotionAnchor(Update)2 | String | .Id | FALSE | SFDC Id or External Id of the source promotion to be copied. | 40 | | setPromotionAnchor(Update)2 | String | .AnchorAccountSet | FALSE | Name or SFID of the customer set. | 40 | | setPromotionAnchor(Update)2 | String | .PromotionTemplate | FALSE | Name or SID of the Promotion Template | 40 | | setPromotionAnchor(Update)2 | String | .AnchorAccount | FALSE | SFID or External Id of the customer. | 40 | | setPromotionAnchor2 | String | .AnchorAccount | FALSE | SFID or External Id of the customer. | 40 | | setPromotionAnchor2 | String | .PromotionTemplate | TRUE | Name or SFID of the Promotion Template. | 40 | | setPromotionAnchor2 | String | .AnchorAccountSet | FALSE | Name or SFID of the customer set. | 40 | | setPromotionAnchor2 | String | .Id | FALSE | SFDC Id or External Id of the source promotion to be copied. | 40 | | setPromotionAnchorForCopy2 | String | .AnchorAccount | FALSE | SFID or External Id of the customer. | 40 | | setPromotionAnchorForCopy2 | String | .AnchorAccountSet | FALSE | Name or SFID of the customer set. | 40 | | setPromotionAnchorForDerive2 | String | .AnchorAccount | TRUE | SFID or External Id of the customer. | 40 | | setPromotionDates | String | .OrderDateThru | FALSE | Order Date Thru | 10 | | setPromotionDates | String | .DateFrom | TRUE | Date | 10 | | setPromotionDates | String | .DeliveryDateFrom | FALSE | Shipment Date From | 10 | | setPromotionDates | String | .OrderDateFrom | FALSE | Order Date From | 10 | | setPromotionDates | String | .CommitDate | FALSE | Commit Date | 10 | | setPromotionDates | String | .PlacementDateFrom | FALSE | In-store Date From | 10 | | setPromotionDates | String | .DeliveryDateThru | FALSE | Shipment Date Thru | 10 | | setPromotionDates | String | .PlacementDateThru | FALSE | In-store Date Thru | 10 | | setPromotionDates | String | .DateThru | TRUE | Date | 10 | | setPromotionDates(update) | String | .OrderDateThru | FALSE | Promotion Order Date Thru | 10 | | setPromotionDates(update) | String | .CommitDate | FALSE | Promotion Commit Date | 10 | | setPromotionDates(update) | String | .PlacementDateFrom | FALSE | Promotion In-store Date From | 10 | | setPromotionDates(update) | String | .DeliveryDateThru | FALSE | Promotion Shipment Date Thru | 10 | | setPromotionDates(update) | String | .DeliveryDateFrom | FALSE | Promotion Shipment Date From | 10 | | setPromotionDates(update) | String | .OrderDateFrom | FALSE | Promotion Order Date From | 10 | | setPromotionDates(update) | String | .PlacementDateThru | FALSE | Promotion In-store Date Thru | 10 | | setPromotionDates(update) | String | .DateFrom | FALSE | Promotion Date From | 10 | | setPromotionDates(update) | String | .DateThru | FALSE | Promotion Date Thru | 10 | | setPromotionDates(update)2 | String | .OrderDateFrom | FALSE | Promotion Order Date From | 10 | | setPromotionDates(update)2 | String | .PlacementDateFrom | FALSE | Promotion In-store Date From | 10 | | setPromotionDates(update)2 | String | .DeliveryDateThru | FALSE | Promotion Shipment Date Thru | 10 | | setPromotionDates(update)2 | String | .CommitDate | FALSE | Promotion Commit Date | 10 | | setPromotionDates(update)2 | String | .OrderDateThru | FALSE | Promotion Order Date Thru | 10 | | setPromotionDates(update)2 | String | .DeliveryDateFrom | FALSE | Promotion Shipment Date From | 10 | | setPromotionDates(update)2 | String | .PlacementDateThru | FALSE | Promotion In-store Date Thru | 10 | | setPromotionDates(update)2 | String | .DateFrom | FALSE | Promotion Date From | 10 | | setPromotionDates(update)2 | String | .DateThru | FALSE | Promotion Date Thru | 10 | | setPromotionDates2 | String | .OrderDateThru | FALSE | Order Date Thru | 10 | | setPromotionDates2 | String | .OrderDateFrom | FALSE | Order Date From | 10 | | setPromotionDates2 | String | .PlacementDateThru | FALSE | In-store Date Thru | 10 | | setPromotionDates2 | String | .DeliveryDateThru | FALSE | Shipment Date Thru | 10 | | setPromotionDates2 | String | .DateThru | TRUE | Date | 10 | | setPromotionDates2 | String | .DateFrom | TRUE | Date | 10 | | setPromotionDates2 | String | .PlacementDateFrom | FALSE | In-store Date From | 10 | | setPromotionDates2 | String | .CommitDate | FALSE | Commit Date | 10 | | setPromotionDates2 | String | .DeliveryDateFrom | FALSE | Shipment Date From | 10 | | setPromotionTemplateForDerive2 | String | .PromotionTemplate | TRUE | Name or SID of the Promotion Template to use for derivation. | 40 | | setTacticConditionCreationDefinitions | String | \[\*\].AdditionalKPI2 | FALSE | KPI definition used to provide additional information for the condition. | 80 | | setTacticConditionCreationDefinitions | String | \[\*\].AdditionalKPI3 | FALSE | KPI definition used to provide additional information for the condition. | 80 | | setTacticConditionCreationDefinitions | String | \[\*\].AdditionalKPI1 | FALSE | KPI definition used to provide additional information for the condition. | 80 | | setTacticConditionCreationDefinitions | Boolean | \[\*\].DuplicateCheck | FALSE | Determines whether the system should check for duplicate internal conditions. | NA | | setTacticConditionCreationDefinitions | String | \[\*\].Maintenance | FALSE | Defines the action on the conditions generated by the tactic. | 255 | | setTacticConditionCreationDefinitions | String | \[\*\].MeasureCode | FALSE | Defines the override measure code used to generate the condition. | 4 | | setTacticConditionCreationDefinitions | String | \[\*\].ChangeRule | FALSE | Determines the rule to handle past conditions. | 255 | | setTacticConditionCreationDefinitions | String | \[\*\].ProductLevel | FALSE | Defines the product level at which condition is generated. | 255 | | setTacticConditionCreationDefinitions | String | \[\*\].SourceKPI | TRUE | KPI Definition used for generating conditions. | 80 | | setTacticConditionCreationDefinitions | String | \[\*\].AllowedProductLevels | FALSE | When product level is empty in the input, the system considers only the levels allowed by this field while automatically determining the product level at which conditions are generated. When empty, the system considers all product levels as valid product levels for condition generation. | 160 | | setTacticConditionCreationDefinitions | String | \[\*\].Targets | FALSE | Defines the targets to which the conditions are written. | 40 | | setTacticConditionCreationDefinitions(update) | String | \[\*\].SourceKPI | FALSE | KPI Definition used for generating conditions. | 80 | | setTacticConditionCreationDefinitions(update) | String | \[\*\].AdditionalKPI1 | FALSE | KPI definition used to provide additional information for the condition. | 80 | | setTacticConditionCreationDefinitions(update) | String | \[\*\].AdditionalKPI3 | FALSE | KPI definition used to provide additional information for the condition. | 80 | | setTacticConditionCreationDefinitions(update) | String | \[\*\].Targets | FALSE | Defines the targets to which the conditions are written. | 40 | | setTacticConditionCreationDefinitions(update) | String | \[\*\].AdditionalKPI2 | FALSE | KPI definition used to provide additional information for the condition. | 80 | | setTacticConditionCreationDefinitions(update) | String | \[\*\].AllowedProductLevels | FALSE | When product level is empty in the input, the system considers only the levels allowed by this field while automatically determining the product level at which conditions are generated. When empty, the system considers all product levels as valid product levels for condition generation. | 160 | | setTacticConditionCreationDefinitions(update) | String | \[\*\].ProductLevel | FALSE | Defines the product level at which condition is generated. | 255 | | setTacticConditionCreationDefinitions(update) | String | \[\*\].ChangeRule | FALSE | Determines the rule to handle past conditions. | 255 | | setTacticConditionCreationDefinitions(update) | String | \[\*\].MeasureCode | FALSE | Defines the override measure code used to generate the condition. | 4 | | setTacticConditionCreationDefinitions(update) | String | \[\*\].Maintenance | FALSE | Defines the action on the conditions generated by the tactic. | 255 | | setTacticConditionCreationDefinitions(update) | Boolean | \[\*\].DuplicateCheck | FALSE | Determines whether the system should check for duplicate internal conditions. | NA | | setTacticConditionCreationDefinitions(update) | String | \[\*\].UniqueMeasureCode | FALSE | Concatenation of Tactic Id and Editable code of Source KPI Definition. Alternatively, this field may hold SFID of TCCD. | 22 | | setTacticConditionCreationDefinitions(update)2 | String | \[\*\].Maintenance | FALSE | Defines the action on the conditions generated by the tactic. | 255 | | setTacticConditionCreationDefinitions(update)2 | Boolean | \[\*\].DuplicateCheck | FALSE | Determines whether the system should check for duplicate internal conditions. | NA | | setTacticConditionCreationDefinitions(update)2 | String | \[\*\].UniqueMeasureCode | FALSE | Concatenation of Tactic Id and Editable code of Source KPI Definition. Alternatively, this field may hold SFID of TCCD. | 22 | | setTacticConditionCreationDefinitions(update)2 | String | \[\*\].AdditionalKPI1 | FALSE | KPI definition used to provide additional information for the condition. | 80 | | setTacticConditionCreationDefinitions(update)2 | String | \[\*\].AdditionalKPI3 | FALSE | KPI definition used to provide additional information for the condition. | 80 | | setTacticConditionCreationDefinitions(update)2 | String | \[\*\].Targets | FALSE | Defines the targets to which the conditions are written. | 40 | | setTacticConditionCreationDefinitions(update)2 | String | \[\*\].AdditionalKPI2 | FALSE | KPI definition used to provide additional information for the condition. | 80 | | setTacticConditionCreationDefinitions(update)2 | String | \[\*\].AllowedProductLevels | FALSE | When product level is empty in the input, the system considers only the levels allowed by this field while automatically determining the product level at which conditions are generated. When empty, the system considers all product levels as valid product levels for condition generation. | 160 | | setTacticConditionCreationDefinitions(update)2 | String | \[\*\].SourceKPI | FALSE | KPI Definition used for generating conditions. | 80 | | setTacticConditionCreationDefinitions(update)2 | String | \[\*\].ProductLevel | FALSE | Defines the product level at which condition is generated. | 255 | | setTacticConditionCreationDefinitions(update)2 | String | \[\*\].ChangeRule | FALSE | Determines the rule to handle past conditions. | 255 | | setTacticConditionCreationDefinitions(update)2 | String | \[\*\].MeasureCode | FALSE | Defines the override measure code used to generate the condition. | 4 | | setTacticConditionCreationDefinitions2 | Boolean | \[\*\].DuplicateCheck | FALSE | Determines whether the system should check for duplicate internal conditions. | NA | | setTacticConditionCreationDefinitions2 | String | \[\*\].Maintenance | FALSE | Defines the action on the conditions generated by the tactic. | 255 | | setTacticConditionCreationDefinitions2 | String | \[\*\].ChangeRule | FALSE | Determines the rule to handle past conditions. | 255 | | setTacticConditionCreationDefinitions2 | String | \[\*\].ProductLevel | FALSE | Defines the product level at which condition is generated. | 255 | | setTacticConditionCreationDefinitions2 | String | \[\*\].SourceKPI | TRUE | KPI Definition used for generating conditions. | 80 | | setTacticConditionCreationDefinitions2 | String | \[\*\].AllowedProductLevels | FALSE | When product level is empty in the input, the system considers only the levels allowed by this field while automatically determining the product level at which conditions are generated. When empty, the system considers all product levels as valid product levels for condition generation. | 160 | | setTacticConditionCreationDefinitions2 | String | \[\*\].AdditionalKPI2 | FALSE | KPI definition used to provide additional information for the condition. | 80 | | setTacticConditionCreationDefinitions2 | String | \[\*\].Targets | FALSE | Defines the targets to which the conditions are written. | 40 | | setTacticConditionCreationDefinitions2 | String | \[\*\].AdditionalKPI3 | FALSE | KPI definition used to provide additional information for the condition. | 80 | | setTacticConditionCreationDefinitions2 | String | \[\*\].AdditionalKPI1 | FALSE | KPI definition used to provide additional information for the condition. | 80 | | setTacticConditionCreationDefinitions2 | String | \[\*\].MeasureCode | FALSE | Defines the override measure code used to generate the condition. | 4 | | setTacticDates | String | .ShipmentDateThru | FALSE | Shipment Date Thru | 10 | | setTacticDates | String | .DateThru | FALSE | Date Thru | 10 | | setTacticDates | String | .DateFrom | FALSE | Date From | 10 | | setTacticDates | String | .InStoreDateThru | FALSE | In Store Date Thru | 10 | | setTacticDates | String | .InStoreDateFrom | FALSE | In Store Date From | 10 | | setTacticDates | String | .ShipmentDateFrom | FALSE | Shipment Date From | 10 | | setTacticDates2 | String | .InStoreDateFrom | FALSE | In Store Date From | 10 | | setTacticDates2 | String | .InStoreDateThru | FALSE | In Store Date Thru | 10 | | setTacticDates2 | String | .DateFrom | FALSE | Date From | 10 | | setTacticDates2 | String | .ShipmentDateThru | FALSE | Shipment Date Thru | 10 | | setTacticDates2 | String | .ShipmentDateFrom | FALSE | Shipment Date From | 10 | | setTacticDates2 | String | .DateThru | FALSE | Date Thru | 10 | | movePromotionTimeframeDerive2 | String | .InStoreDateFrom | FALSE | Promotion's new In Store Date From. If specified, all promotion dates will be shifted by the difference in days between the input Date and the Promotion current Date From date. | 10 | # Business Object API Workflow Steps The following table provides information about the BO API Workflow Steps. | **Workflow Step Name** | **Classname** | **Method** | **Entity** | **Description** | | --- | --- | --- | --- | --- | | setPromotionDates2 | Promotion2BoApiCoreWorkflowSteps | setPromotionDates | Promotion | Sets the promotion dates (Date From, Date Thru, Commit Date, Shipment Date From, Shipment Date Thru, Order Date From, Order Date Thru, In-Store Date From and In-Store Date Thru of a promotion). | | setTacticDates2 | Promotion2BoApiCoreWorkflowSteps | setTacticDates | Tactic | Sets/Updates the tactic dates (Date From, Date Thru, Shipment Date From, Shipment Date Thru, Instore Date From and Instore Date Thru of a tactic) from input. | | applyPromotionDateHandling2 | Promotion2BoApiCoreWorkflowSteps | applyPromotionDateHandling | TPM\_Promotion | Applies automatic date handling rules to the promotions to be processed. Needs to be executed after "setPromotionDates" rule. | | handleManualInputs2 | Promotion2BoApiCoreWorkflowSteps | handleManualInputs | ManualInputs | Sets the manual inputs (totals) on product, promotion and tactic level. | | setPromotionAnchor2 | Promotion2BoApiCoreWorkflowSteps | setPromotionAnchor | Promotion | Sets the Promotion Anchor (Customer, Customer Set or null) depending on the anchor type of the template. | | setPromotionCategories2 | Promotion2BoApiCoreWorkflowSteps | setPromotionCategories | TPM\_Promotion | Sets the promotion categories based on the categories the user has access to for the anchor customer or customer set. | | mapPromotionValues2 | Promotion2BoApiCoreWorkflowSteps | mapValues | Promotion | Maps promotion values to the output object. Each field is mapped into the Output Object field specified in the 'Maps To' attribute of the Input Structure. | | mapTacticValues2 | Promotion2BoApiCoreWorkflowSteps | mapValues | Tactic | Maps tactic values to the output object. Each field is mapped into the Output Object field specified in the 'Maps To' attribute of the Input Structure. | | setPromotionSubAccounts2 | Promotion2BoApiCoreWorkflowSteps | setPromotionSubAccounts | TPM\_Promotion | Sets the promotion Sub Accounts, if sub account planning are enabled in promotion template. | | setPromotionParticipatingCustomers2 | Promotion2BoApiCoreWorkflowSteps | setPromotionParticipatingCustomers | TPM\_Promotion | Sets the promotion Participating Customers for pushable promotions. | | managePromotionProductFilterCopy2 | Promotion2BoApiCopyCoreWorkflowSteps | managePromotionProductFilterCopy | TPM\_Promotion | Filters out invalid products from the promotion product filter. It removes products that are no longer valid for the promotion timeframe. Filter Criteria's are not touched. | | setPromotionDates(update)2 | Promotion2BoApiCoreWorkflowSteps | setPromotionDates | Promotion | Updates the promotion dates (Date From, Date Thru, Commit Date, Shipment Date From, Shipment Date Thru, Order Date From, Order Date Thru, In-Store Date From and In-Store Date Thru of a promotion). | | loadPromotionDefaults(update)2 | Promotion2BoApiCoreWorkflowSteps | loadPromotionDefaults | Promotion | Load promotion values. Id or externalId of the promotion must be provided to load promotion record values. Step to be used by 'update' workflow. | | loadTacticDefaults(update)2 | Promotion2BoApiCoreWorkflowSteps | loadTacticDefaults | Tactic | Load tactic values. TacticId or externalId must be provided to load tactic record values. Step to be used by 'update' workflow. | | setPromotionAnchor(Update)2 | Promotion2BoApiCoreWorkflowSteps | setPromotionAnchor | Promotion | Sets the Promotion Anchor (Customer, Customer Set or null) depending on the anchor type of the template. | | mapPromotionValues(Update)2 | Promotion2BoApiCoreWorkflowSteps | mapValues | Promotion | Maps promotion values to the output object. Each field is mapped into the Output Object field specified in the 'Maps To' attribute of the Input Structure. | | loadPromotionBOForCopy2 | Promotion2BoApiCopyCoreWorkflowSteps | loadPromotionBOForCopy | Promotion | Loads promotion values for copy. The input Id parameter must reference a valid Promotion by SFDC Id or External Id. If the Promotion template is not Copyable, it will report an error. | | loadTacticsLOForCopy2 | Promotion2BoApiCopyCoreWorkflowSteps | loadTacticsLOForCopy | Promotion | Loads Promotion Tactics.The input Id parameter must reference a valid Promotion by SFDC Id or External Id. If the Promotion Template does not have "Tactics" as the copied components, Promotion Tactics won't be loaded. | | loadPromotionAttachmentsForCopy2 | Promotion2BoApiCopyCoreWorkflowSteps | loadPromotionAttachmentsForCopy | Promotion | Loads Promotion Attachments for the referenced Promotion. The input Id parameter must reference a valid Promotion by SFDC Id or External Id. If input "CopyAttachments" flag is set to false or not defined, attachments won't be loaded. | | resetPromotion2 | Promotion2BoApiCopyCoreWorkflowSteps | resetPromotion | TPM\_Promotion | Resets the Promotion values to their initial values in order for the promotion to be inserted again. Workflow fields are set to their initial values and the Promotions SFDC Id is reset in order to be able to be inserted again. | | manageParticipatingCustomersCopy2 | Promotion2BoApiCopyCoreWorkflowSteps | manageParticipatingCustomersCopy | TPM\_Promotion | Filters out invalid Participating Customers. If the promotion is pushable, it removes Participating Customers that are no longer valid for the current promotion timeframe. | | resetTactic2 | Promotion2BoApiCopyCoreWorkflowSteps | resetTactic | TPM\_Promotion.Tactic | Resets the Tactic values to their initial values in order for the tactic to be able to be inserted. Workflow fields are set to their initial values and the Tactic SFDC Id is reset in order to be able to be inserted again. | | manageTacticProductFilterCopy2 | Promotion2BoApiCopyCoreWorkflowSteps | manageTacticProductFilterCopy | TPM\_Promotion.Tactic | Filters out invalid products from the tactic product filter. It removes products that are no longer valid for the promotion timeframe. Filter Criteria's are not touched. | | manageSubAccountsCopy2 | Promotion2BoApiCopyCoreWorkflowSteps | manageSubAccountsCopy | TPM\_Promotion | Filters out invalid Sub Accounts. If the promotion has Sub Accounts Enabled, it removes Sub Accounts that are no longer valid for the current promotion timeframe. | | manageManualInputCopy2 | Promotion2BoApiCopyCoreWorkflowSteps | manageManualInputCopy | TPM\_Promotion | Handles the manual inputs copy. If the promotion template has "ManualInput" as part of the copied components, it adjusts the Promotion Manual Inputs for the new Promotion Timeframe. It also adjusts Tactic inputs to reference the correct new tactics. | | movePromotionTimeframe2 | Promotion2BoApiCopyCoreWorkflowSteps | movePromotionTimeframe | Promotion | Moves the Promotion timeframe by the amount of specified years in the input "AddYears" property or the difference in days between the input "DateFrom" and Promotion current Date From. If the neither of the input properties is specified, a default value of 1 will be used for "AddYears". If both of them are provided, an error will be thrown. It also moves the tactic timeframes by the same offsets calculated for the parent promotion. It also checks the customer/customer set is still valid for the new Promotion Timeframe. | | setTacticConditionCreationDefinitions(update) | PromotionBoApiCoreWorkflowSteps | setTacticConditionCreationDefinitions | TacticConditionCreationDefinitions | Input for updating Tactic Condition Creation Definitions. | | setTacticConditionCreationDefinitions | PromotionBoApiCoreWorkflowSteps | setTacticConditionCreationDefinitions | TacticConditionCreationDefinitions | Input for creating Tactic Condition Creation Definitions. | | setTacticConditionCreationDefinitions2 | Promotion2BoApiCoreWorkflowSteps | setTacticConditionCreationDefinitions | TacticConditionCreationDefinitions | Input for creating Tactic Condition Creation Definitions. | | setTacticConditionCreationDefinitions(update)2 | Promotion2BoApiCoreWorkflowSteps | setTacticConditionCreationDefinitions | TacticConditionCreationDefinitions | Input for updating Tactic Condition Creation Definitions. | | manageTCCDsLOForCopy | PromotionBoApiCopyCoreWorkflowSteps | manageTCCDsLOForCopy | BOPromotion | This method copies the TCCD records from the source promotion tactics to the target promotion tactics. It reads the tactics from current output JSON and fetches the related TCCD records and updates the output JSON. The field 'Create Default Conditions' checkbox is set to false so that only the source promotion’s TCCDs are copied and the default TCCDs are not created. | | manageTCCDsLOForCopy2 | Promotion2BoApiCopyCoreWorkflowSteps | manageTCCDsLOForCopy | TPM\_Promotion | This method copies the TCCD records from the source promotion tactics to the target promotion tactics. It reads the tactics from current output JSON and fetches the related TCCD records and updates the output JSON. The field 'Create Default Conditions' checkbox is set to false so that only the source promotion’s TCCDs are copied and the default TCCDs are not created. | | loadPromotionForDerive2 | Promotion2BoApiDeriveCoreWorkflowSteps | loadPromotion | Promotion | Loads promotion values for derive. The input Id parameter must reference a valid Promotion by SFDC Id or External Id. If the Promotion template for the promotion is not Derivable, it will report an error. Promotion Template parameter must reference a valid Promotion Template by Id or Name. This Promotion Template must be a child template from the promotion one where the Usage is set to derive. | | handleAttachmentsForDerive2 | Promotion2BoApiDeriveCoreWorkflowSteps | handleAttachments | Promotion | Handles Promotion Attachments for the context Promotion. If input "DeriveAttachments" flag is set to false or not defined, attachments won't be derived. | | setPromotionTemplateForDerive2 | Promotion2BoApiDeriveCoreWorkflowSteps | setPromotionTemplate | Promotion | Assigns the target derive Promotion Template to the Promotion as it's template. | | setPromotionAnchorForDerive2 | Promotion2BoApiDeriveCoreWorkflowSteps | setPromotionAnchor | Promotion | Assigns the target derive Anchor Account to the Promotion as it's anchor. | | resetPromotionForDerive2 | Promotion2BoApiDeriveCoreWorkflowSteps | resetPromotion | TPM\_Promotion | Resets the Promotion values to their initial values in order for the promotion to be inserted again. Workflow fields are set to their initial values and the Promotions SFDC Id is reset in order to be able to be inserted again. | | resetTacticForDerive2 | Promotion2BoApiDeriveCoreWorkflowSteps | resetTactic | TPM\_Promotion.Tactic | Resets the Tactic values to their initial values in order for the tactic to be able to be inserted. Workflow fields are set to their initial values and the Tactic SFDC Id is reset in order to be able to be inserted again. | | managePromotionProductFilterForDerive2 | Promotion2BoApiDeriveCoreWorkflowSteps | managePromotionProductFilter | TPM\_Promotion | Filters out invalid products from the promotion product filter. It removes products that are no longer valid for the promotion timeframe. Filter Criteria's are not touched. | | manageTacticProductFilterForDerive2 | Promotion2BoApiDeriveCoreWorkflowSteps | manageTacticProductFilter | TPM\_Promotion.Tactic | Filters out invalid products from the tactic product filter. It removes products that are no longer valid for the promotion timeframe. Filter Criteria's are not touched. | | manageParticipatingCustomersForDerive2 | Promotion2BoApiDeriveCoreWorkflowSteps | manageParticipatingCustomers | TPM\_Promotion | Filters out invalid Participating Customers. If the promotion is pushable, it removes Participating Customers that are no longer valid for the current promotion timeframe. | | manageSubAccountsForDerive2 | Promotion2BoApiDeriveCoreWorkflowSteps | manageSubAccounts | TPM\_Promotion | Filters out invalid Sub Accounts. If the promotion has Sub Accounts Enabled, it removes Sub Accounts that are no longer valid for the current promotion timeframe. | | manageTCCDsForDerive2 | Promotion2BoApiDeriveCoreWorkflowSteps | manageTCCDs | TPM\_Promotion | This method copies the TCCD records from the source promotion tactics to the target promotion tactics. It reads the tactics from current output JSON and fetches the related TCCD records and updates the output JSON. The field 'Create Default Conditions' checkbox is set to false so that only the source promotion’s TCCDs are copied and the default TCCDs are not created. | | setPromotionAnchorForCopy2 | Promotion2BoApiCopyCoreWorkflowSteps | setPromotionAnchorForCopy | Promotion | Sets the Promotion Anchor (Customer, Customer Set or null) depending on the anchor type of the Promotion template. No value is set, no chages to the anchor are performed. | | mapPromotionValuesForCopy2 | Promotion2BoApiCoreWorkflowSteps | mapValues | Promotion | Maps promotion values to the output object. Each field is mapped into the Output Object field specified in the 'Maps To' attribute of the Input Structure. | | movePromotionTimeframeDerive2 | Promotion2BoApiDeriveCoreWorkflowSteps | movePromotionTimeframe | Promotion | Moves the Promotion timeframe by the difference in days between the input "DateFrom" and Promotion current Date From. If not provided, same dates as source promotion will be set. It also moves the tactic timeframes by the same offsets calculated for the parent promotion. It also checks the customer/customer set is still valid for the new Promotion Timeframe. | # Business Object API Workflows The following workflows are provided in the default configuration. | **Workflow Name** | **Description** | | --- | --- | | create | Creates promotions from simple promotion input. Can be also used to update promotions but all promotion required fields must be included in the promotion input. | | copy | Copies the received Promotion | | update | Updates promotion values from simple promotion input. | | derive | Derives the received promotion to the target Account and Promotion Template | # Business Objects API Business Object API is a feature designed to facilitate integrations of external systems and processes with TPM related SObjects. SObjects are complex in nature as they require specific attributes and processes to be executed when manipulating them to ensure data is consistent and correctly calculated. Business Object API acts as a middle layer transforming simplified payloads into the required SObject records. Business Object API features are: - Same behavior when used from within Salesforce LWC components and API - Supports up to 10000 records per transaction - Input payload validation through Schema validation - Extensive configurability and extension capabilities through point & click customization and APEX class plugins - Transactional integrity - Out of the box operations logging and traceability ## Installing Base Business Object API Configurations In order to install base Business Object API configurations in an org for a Sales Organization, execute the following APEX snippet: cgcloud.TPMSetupData.setupBOApi(''); You can track the install progress through the related Batch Run Status record. ## Process Overview When a Business Object API request is received, the following steps are executed in order to process the request for each input: 1. Spawn a Queueable job for each input record. 2. Input validation: Based on the workflow configuration records, the received input is validated against the expected schema. If the validation fails, an error is emitted and the process stops 3. Transformation phase: At this point, all the Workflow Steps defined for the Workflow start executing in the defined order: 1. For each Workflow Step: 1. Find entities to be sent as input to the workflow step 2. Execute the Workflow Step for each found input: The workflow step APEX class will be executed for each input 2. After all Workflow Steps are executed, the output object is completed 4. Business Logic Save: The generated output object is passed to the relevant Business Logic save function. This will generate all the required SObject DML operations 5. Database Commit: After all the Steps are executed, data is committed to the Database If the system detects any DML Row Lock exception during steps 3, 4 or 5, the operation will be retried. All Business Object API requests are logged into the Business Object API Transaction Log SObject for traceability. - **[Process Configuration Settings](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/cg_retail_process_overview.htm)** When executing BO API process, the system reads the following configuration values from System Setting Custom setting in order to define it’s behavior. - **[Configuration Entities](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/cg_retail_configuration_entities.htm)** Business Object API records contains Workflows and Output Entities. - **[Implementing Workflow Steps](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/cg_retail_implementing_workflow_steps.htm)** Workflow Steps are implemented as APEX classes that are used in implementing the System.Callable interface. - **[Promotion Business Object API](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/cg_tpm_promotion_business_object_api_wrapper.htm)** This section describes the base configuration provided for the Promotion Business Object. # Calendar Launchpad Customization Customize the hover content and the buttons for a promotion on the TPM calendar launchpad UI by creating an Apex class as a customization hook. - **[Customize the TPM Calendar Launchpad](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/calendar_launchpad_apex_setup.htm)** To customize the promotion hover content and buttons on the TPM calendar launchpad UI, create a callable Apex class as a customization hook. - **[PromotionHoverContent Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/promotion_content_hover_class.htm)** The PromotionHoverContent Apex class provides programmatic access to the promotion hover content and the buttons on the trade calendar promotion launchpad UI. # cgc\_sync\_\_Sync\_API\_Log\_\_c Stores performance information that's executed on synchronization endpoints. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the log. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner who created the log. A polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### cgc\_sync\_\_Category\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the category of Key Performace Indicators (KPIs). ### cgc\_sync\_\_Device\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the device from which the log was created. ### cgc\_sync\_\_Endpoint\_Class\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the Apex REST endpoints implementer class name. ### cgc\_sync\_\_Input\_Data\_Volume\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the size and volume of input data for the measured task. For example, if you want to measure a named query execution, you can enter the number of characters in the SOQL string here. ### cgc\_sync\_\_Measured\_At\_\_c - **Type**: dateTime - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Stores the date and time when the measurement was performed for the KPI. ### cgc\_sync\_\_Output\_Data\_Volume\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the size and volume of output data for the task that's measured (if applicable). For example, if you want to measure a named query execution, you can place in this field the number of records that the result set contains. ### cgc\_sync\_\_Request\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique identifier that's generated once for each API call. ### cgc\_sync\_\_SOQL\_Statement\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores the related SOQL statement that is measured, or set as a blank string when the KPI isn’t related to any specific SOQL statement. ### cgc\_sync\_\_Subcategory\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the subcategory of the KPI. ### cgc\_sync\_\_Sync\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the unique ID of the sync request. ### cgc\_sync\_\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the value of the KPI. ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_API\_Log\_\_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. - **[cgc\_sync\_\_Sync\_API\_Log\_\_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. - **[cgc\_sync\_\_Sync\_API\_Log\_\_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. - **[cgc\_sync\_\_Sync\_API\_Log\_\_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. # cgc\_sync\_\_Sync\_Client\_App\_Profile\_Mapping\_\_c Maps either a user, role, or profile to a specific sync configuration. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Sort, Update - **Description**: Unique identification of the profile mapping. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the setup owner. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ### cgc\_sync\_\_Client\_App\_ID\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: ID of the client application. ### cgc\_sync\_\_Client\_App\_Profile\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Profile details of the client application. ### cgc\_sync\_\_Mapped\_Record\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: ID of the record that's mapped to the sync configuration. ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Client\_App\_Profile\_Mapping\_\_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. - **[cgc\_sync\_\_Sync\_Client\_App\_Profile\_Mapping\_\_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. - **[cgc\_sync\_\_Sync\_Client\_App\_Profile\_Mapping\_\_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. - **[cgc\_sync\_\_Sync\_Client\_App\_Profile\_Mapping\_\_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. # cgc\_sync\_\_Sync\_Client\_Registration\_\_c Stores the details of the Consumer Goods Cloud offline mobile app device that a synchronization request to Salesforce is initiated from. This object is available in API version 61.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the sync client registry. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner who sets up the configuration. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### cgc\_sync\_\_Device\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique identifier of the device that initiates a synchronization request. ### cgc\_sync\_\_Get\_First\_Sync\_Request\_Queue\_Time\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the milliseconds of the first synchronization request to get a position in the sync queue. ### cgc\_sync\_\_Last\_Queue\_Status\_Request\_At\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the last synchronization request. ### cgc\_sync\_\_Sync\_Action\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Type of the last initiated synchronization process. - **Possible values**: - BACKGROUND\_SYNC—Background Sync - FSOD - INITIAL\_SYNC—Initial Sync - ON\_DEMAND\_SYNC—On Demand - REGULAR\_SYNC—Regular Sync ### cgc\_sync\_\_Sync\_Client\_Queue\_Status\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Status of the synchronization request. - **Default value**: DONE - **Possible values**: - CANCELLED—Cancelled - DONE—Done - PROCESSING—Processing - WAITING—Waiting ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the associated objects are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgcloud\_dev\_\_Sync\_Client\_Registration\_\_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\_dev\_\_Sync\_Client\_Registration\_\_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\_dev\_\_Sync\_Client\_Registration\_\_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 tracked fields of the object. - **[cgcloud\_dev\_\_Sync\_Client\_Registration\_\_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\_dev\_\_Sync\_Client\_Registration\_\_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. # cgc\_sync\_\_Sync\_Config\_\_c Represents the settings for synchronization engine client and its backend. For example, background sync, sync on startup, and Apex endpoint thresholds. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the sync configuration file. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the owner who set up the configuration. It’s a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ### cgc\_sync\_\_Analyze\_Threshold\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Threshold value for DB analyze. Range: 100-100000. ### cgc\_sync\_\_Back\_End\_KPIs\_Enabled\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the system allocates additional computational resources to gather performance statistics at run time (true) or not (false).. - **Default value**: false ### cgc\_sync\_\_Batch\_Soql\_Heap\_Size\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Stores the batch SOQL heap size limit in milliseconds. ### cgc\_sync\_\_Batch\_Soql\_Page\_Size\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Stores the batch SOQL page size limit in bytes. ### cgc\_sync\_\_Batch\_Soql\_Response\_Time\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Batch SOQL response time in milliseconds. Recommended value: 4000. Range: 2000-4000. ### cgc\_sync\_\_Business\_Area\_Mapping\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Maps a field from the User entity to segregate data downloaded to a mobile device based on business area. ### cgc\_sync\_\_CPU\_Time\_Calculation\_Buffer\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Buffer time in milliseconds that system includes when calculating CPU time limit to protect the system from Apex CPU time limit exceptions during sync processes. Recommended value: 6500. ### cgc\_sync\_\_ClientApp\_ID\_\_c - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Installation ID or Client App ID of the device. ### cgc\_sync\_\_Download\_Heap\_Size\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Stores the download heap size limit in bytes. ### cgc\_sync\_\_Download\_Page\_Size\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Number of records to be processed inside an Apex endpoint until paging starts. ### cgc\_sync\_\_Download\_Response\_Time\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Download response time in milliseconds. Recommended value: 2000. Range: 2000-4000. ### cgc\_sync\_\_Encryption\_Platforms\_\_c - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Comma-separated list of operating systems. For example, iOS and Android. These systems activate encryption. ### cgc\_sync\_\_Event\_Period\_Length\_Hours\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Time period in hours for controlling the event's maximum quantity limitations. ### cgc\_sync\_\_Ignore\_Client\_Overrides\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether ignores client overrides is active (true) or not (false). - **Default value**: true ### cgc\_sync\_\_Last\_Generated\_LU\_Name\_\_c - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Last generated Logical Unit (LU) value generated in the back end. ### cgc\_sync\_\_Max\_Error\_Events\_Per\_Period\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Maximum number of error events that a device can send in a specified duration when you set the value of the log level field as Error. ### cgc\_sync\_\_Max\_Other\_Events\_Per\_Period\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Maximum number of events that a device can send in a specified duration when you set the log level field as Debug, Info, or Log. ### cgc\_sync\_\_NFT\_Heap\_Size\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Named Fetch Tree heap size in bytes. Range: 1048576 (1MB) - 6291456 (6MB). Recommended value: 5242500 (5MB). ### cgc\_sync\_\_NFT\_Page\_Size\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Maximum allowed page size for Named Fetch Tree (in bytes). Range: 1000 - 50000. ### cgc\_sync\_\_NFT\_Response\_Time\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: NFT response time limit in milliseconds. Recommended value: 4000. ### cgc\_sync\_\_Named\_Query\_Heap\_Size\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Named query heap size limit in bytes. ### cgc\_sync\_\_Named\_Query\_Page\_Size\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Named query page size limit in bytes. ### cgc\_sync\_\_Named\_Query\_Response\_Time\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Named query response time limit in bytes. ### cgc\_sync\_\_Namespace\_Macro\_\_c - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Contains the replacement key to the settings for the SOQL macro in the CG Cloud Synchronization namespace.For example, if this method returns the MY\_NAMESPACE string, then every SOQL query that the system executes is replaced as shown here. SELECT $MY\_NAMESPACE.MyCustomField\_\_c FROM $MY\_NAMESPACE.MyCustomObject\_\_c is replaced with SELECT cgcloud\_\_.MyCustomField\_\_c FROM cgcloud\_\_.MyCustomObject\_\_c where, the cgcloud\_\_ string is the prefix that's obtained from {@link SYNCConstants.NAMESPACEPREFIX}. ### cgc\_sync\_\_SObject\_Describe\_Heap\_Size\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Heap size limit of sObject Describe in bytes. ### cgc\_sync\_\_SObject\_Describe\_Response\_Time\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Response time limit of sObject Describe in milliseconds. ### cgc\_sync\_\_Sync\_At\_App\_Start\_\_c - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Determines how often the data sync is performed when the mobile app starts. Possible values are: - ALWAYS\- Perform a data sync each time the mobile app starts. - TIME\_THRESHOLD\- Skip sync if threshold is not reached at the start of the mobile app - NO\_SYNC\- Ignore data sync at the start of the mobile app. ### cgc\_sync\_\_Sync\_Background\_SyncType\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of background sync.Available options are: - Upload only - Upload & download (complete sync) - Deactivated ### cgc\_sync\_\_Sync\_Concurrent\_Users\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Maximum number of users that can simultaneously perform synchronization when the Queue sync users at maximum limit setting is enabled. Recommended value: 200 Range: 2-600. ### cgc\_sync\_\_Sync\_Interval\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Background sync interval in minutes. ### cgc\_sync\_\_Sync\_On\_Online\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Executes the last incomplete sync attempt and is triggered when an online connection is available. It mainly synchronizes the tracked objects. Stores the value as true when the sync is performed online. ### cgc\_sync\_\_Sync\_On\_Resume\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Executes the last incomplete sync and gets executed when the device resumes from the background. It mainly synchronizes the tracked objects. Stores the value as true when the sync resumes. ### cgc\_sync\_\_Sync\_On\_Startup\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: This synchronization option is triggered every time the application is launched. Tracked objects and NFTs are optional for this synchronization method. It mainly synchronizes the schema and runtime artifacts (RTAs). Stores the value as true when the sync is on start. ### cgc\_sync\_\_Sync\_Upload\_Chunk\_Weight\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Sort, Update - **Description**: Defines the total size of the records that an upload request contains. The record weight is directly proportional to the required computational resources. ### cgc\_sync\_\_Time\_Interval\_For\_Sync\_At\_App\_Start\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Indicates the duration after which the data sync is performed when the offline mobile app starts. Range 10-1440 minutes. minutes. - **Default value**: 30 ### cgc\_sync\_\_Upload\_Heap\_Size\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Heap size upload in bytes. ### cgc\_sync\_\_Upload\_Page\_Size\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Upload page size limit in bytes. ### cgc\_sync\_\_Upload\_Response\_Time\_Limit\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Upload response time limit in milliseconds. ### cgc\_sync\_\_Vertical\_Namespace\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Namespace of the vertical package that's used with this sync configuration. ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Config\_\_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. - **[cgc\_sync\_\_Sync\_Config\_\_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. - **[cgc\_sync\_\_Sync\_Config\_\_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. - **[cgc\_sync\_\_Sync\_Config\_\_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. # cgc\_sync\_\_Sync\_History\_\_c Stores information about every sync that's performed on the mobile app along with its status information and associated Key Performance Indicators (KPIs). This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### 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 owner. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### cgc\_sync\_\_Connection\_Type\_At\_Start\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Connection type at the start of the sync. ### cgc\_sync\_\_Device\_ID\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Installation ID of the device. ### cgc\_sync\_\_Duration\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Total time taken for the synchronization process to complete. This is a calculated field. - **Formula**: ( cgc\_sync\_\_End\_Date\_Time\_\_c - cgc\_sync\_\_Start\_Date\_Time\_\_c ) \* 24\*60\*60 ### cgc\_sync\_\_End\_Date\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp when the synchronization is completed. ### cgc\_sync\_\_KPIData\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Collects and stores sync KPI data in a compressed format when a sync operation is run. The KPI data includes metrics such as duration and record count for named fetch trees, named queries, and tracked objects. ### cgcloud\_dev\_\_KPISbmsStatus\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: No longer in use. Indicated the status of KPIs that were submitted for analysis. Possible values were: - Complete - InProgress - Ready ### cgc\_sync\_\_Number\_Of\_Detailed\_Logs\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Number of detailed log messages. This is a calculated field. ### cgc\_sync\_\_Number\_Of\_Download\_Records\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Number of downloaded records. ### cgc\_sync\_\_Number\_Of\_Upload\_Records\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Number of uploaded records. ### cgc\_sync\_\_Start\_Date\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp when the sync started. ### cgcloud\_dev\_\_Sync\_Completion\_Time\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Time taken in seconds to complete a sync process, excluding the queue waiting time. If the Queue sync users at maximum limit setting is disabled, the field takes the Duration value. This field is a calculated field. - **Formula**: (cgcloud\_dev\_\_End\_Date\_Time\_\_c - cgcloud\_dev\_\_Start\_Date\_Time\_\_c) \* 24\*60\*60 - cgcloud\_dev\_\_Time\_In\_Queue\_\_c ### cgc\_sync\_\_Sync\_History\_Log\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: History of the logs created during synchronization. This is a calculated field. - **Formula**: HYPERLINK(LEFT($Api.Partner\_Server\_URL\_260, FIND( '/services', $Api.Partner\_Server\_URL\_260)) + '/one/one.app#/alohaRedirect/apex/SyncHistory?deviceid='+ cgc\_sync\_\_Device\_ID\_\_c + '&datestart=' + TEXT(cgc\_sync\_\_Start\_Date\_Time\_\_c) + '&dateend=' + TEXT(cgc\_sync\_\_End\_Date\_Time\_\_c), Name , '\_blank') ### cgc\_sync\_\_Sync\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the unique id of the sync request. ### cgc\_sync\_\_Sync\_State\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The system's current synchronization state. - **Possible values**: - Cancelled - Connection Issue - Download Issue - Error - Synchronized - Up and Download Issues - Upload Issue ### cgc\_sync\_\_Sync\_Success\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the sync completed successfully (true) or not (false). - **Default value**: false ### cgc\_sync\_\_Sync\_Triggered\_By\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Source that triggered the sync. - **Possible values**: - Scheduler - SyncOnOnline - SyncOnResume - SyncOnStartup - User Action ### cgc\_sync\_\_Sync\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the type of the sync. - **Possible values**: - Background Sync - FSOD - Initial Sync - On Demand - Regular Sync ### cgcloud\_dev\_\_Time\_In\_Queue\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Queue waiting time of a sync request in seconds. Value is zero if the Queue Sync User feature is disabled. ### cgc\_sync\_\_Total\_Api\_Calls\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total number of all API calls made during the sync. ## Associated Objects ### Associated Objects This object has the following associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_History\_\_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. - **[cgc\_sync\_\_Sync\_History\_\_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. - **[cgc\_sync\_\_Sync\_History\_\_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. - **[cgc\_sync\_\_Sync\_History\_\_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. # cgc\_sync\_\_Sync\_History\_Detail\_\_c Contains detailed information about all sync history records. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgc\_sync\_\_Api\_Calls\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Number of API calls made during the synchronization process. ### cgc\_sync\_\_Duration\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Time taken to complete the synchronization process. This is a calculated field. - **Formula**: ( cgc\_sync\_\_End\_Date\_Time\_\_c - cgc\_sync\_\_Start\_Date\_Time\_\_c ) \* 24\*60\*60 ### cgc\_sync\_\_End\_Date\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp when the synchronization process is completed. ### cgc\_sync\_\_Processed\_Records\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Number of records processed during the synchronization process. ### cgc\_sync\_\_Start\_Date\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp when the synchronization process started. ### cgc\_sync\_\_Sync\_History\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Refers to the related sync history. This is a relationship field. - **Relationship Name**: cgc\_sync\_\_Sync\_History\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgc\_sync\_\_Sync\_History\_\_c (the master object) ### cgc\_sync\_\_Sync\_Step\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sync step used when the sync history was uploaded. - **Possible values**: - Download - Download\_App\_Content - Download\_Attachment - Download\_NFT - Execute\_FSOD - Purging\_Data - Upload ### cgc\_sync\_\_Sync\_Success\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the sync completed successfully (true) or not (false). - **Default value**: false ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_History\_Detail\_\_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. - **[cgc\_sync\_\_Sync\_History\_Detail\_\_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. - **[cgc\_sync\_\_Sync\_History\_Detail\_\_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. - **[cgc\_sync\_\_Sync\_History\_Detail\_\_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. # cgc\_sync\_\_Sync\_ID\_Mapping\_\_c Contains information about the mappings of the local mobile application IDs to Salesforce IDs. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### 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 ### cgc\_sync\_\_Device\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Installation ID of the device. ### cgc\_sync\_\_Local\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Primary key ID of the device ### cgc\_sync\_\_Salesforce\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Mapped Salesforce ID of the device. ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_ID\_Mapping\_\_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. - **[cgc\_sync\_\_Sync\_ID\_Mapping\_\_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. - **[cgc\_sync\_\_Sync\_ID\_Mapping\_\_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. - **[cgc\_sync\_\_Sync\_ID\_Mapping\_\_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. # cgc\_sync\_\_Sync\_Message\_\_c Represents the messages that are exposed to a mobile app user during the sync process. This object is available in API version 53.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**: Date when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date when the record was last viewed. ### 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**: ID of the record type. This is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### cgc\_sync\_\_Category\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Category of the sync message. - **Possible values**: - Core sync message - Static sync message - Dynamic sync message ### cgc\_sync\_\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the message code. ### cgc\_sync\_\_IsCore\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the sync message is a core system message (true) or not (false).These are the possible values: - True - False - **Default value**: false ### cgc\_sync\_\_MappingType\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the mapping type of the sync message.These are the possible values: - CategoryBased - CodeBased - ObjectBased ### cgc\_sync\_\_Nr\_of\_Translations\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Count of the translations. This is a calculated field. ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Message\_\_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. - **[cgc\_sync\_\_Sync\_Message\_\_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. - **[cgc\_sync\_\_Sync\_Message\_\_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. - **[cgc\_sync\_\_Sync\_Message\_\_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. # cgc\_sync\_\_Sync\_Message\_Translation\_\_c Contains translated sync messages. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the translation file. ### cgc\_sync\_\_LanguageCode\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Language code of the translation file, such as en\_US. ### cgc\_sync\_\_Language\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the language. ### cgc\_sync\_\_Sync\_Message\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Refers to the sync message record. This is a relationship field. - **Relationship Name**: cgc\_sync\_\_Sync\_Message\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgc\_sync\_\_Sync\_Message\_\_c (the master object) ### cgc\_sync\_\_Text\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Translated text. ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Message\_Translation\_\_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. - **[cgc\_sync\_\_Sync\_Message\_Translation\_\_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. - **[cgc\_sync\_\_Sync\_Message\_Translation\_\_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. - **[cgc\_sync\_\_Sync\_Message\_Translation\_\_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. # cgc\_sync\_\_Sync\_Metadata\_Changes\_\_c Stores the timestamps for the changes that are made in the metadata. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### 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 ### cgc\_sync\_\_DeploymentTimeStamp\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the latest changes in the deployment package. ### cgc\_sync\_\_Device\_Health\_Status\_Requires\_Alert\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether there’s one or more external devices that have an error or warning status (true) or not (false). - **Default value**: false ### cgc\_sync\_\_Identifier\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Internal identifier of the client. ### cgc\_sync\_\_MobilityThemesTimeStamp\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the latest changes in the theme configuration. ### cgc\_sync\_\_NamedQueriesTimeStamp\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the latest changes in the named query configuration. ### cgc\_sync\_\_NftsTimeStamp\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the latest changes in the NFT configuration. ### cgc\_sync\_\_SyncConfigurationTimeStamp\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the latest changes in the sync configuration. ### cgc\_sync\_\_TrackedObjectDescribeTimeStamp\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the client metadata for configured tracked objects. ### cgc\_sync\_\_TrackedObjectSettingsTimeStamp\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the latest changes in the tracked object configuration. ### cgc\_sync\_\_TranslationTimeStamp\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the latest changes in sync messages. ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Metadata\_Changes\_\_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. - **[cgc\_sync\_\_Sync\_Metadata\_Changes\_\_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. - **[cgc\_sync\_\_Sync\_Metadata\_Changes\_\_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. - **[cgc\_sync\_\_Sync\_Metadata\_Changes\_\_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. # cgc\_sync\_\_Sync\_Mobile\_App\_Component\_\_c Contains the settings for different customizable UI components in the theme. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique identification of the theme. ### cgc\_sync\_\_Color\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Refers to the color code that's used in the mobile app. This can be a color code macro or an RGBA code. ### cgc\_sync\_\_Description\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Describes the \_\_property\_name\_\_c property. ### cgc\_sync\_\_Property\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique names of the mobile app framework control to adjust the color based on themes. ### cgc\_sync\_\_Property\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Property type of the UI component. - **Default value**: Color - **Possible values**: - Button - Color ### cgc\_sync\_\_Sync\_Mobile\_App\_Theme\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Refers to the mobile app theme. This is a relationship field. - **Relationship Name**: cgc\_sync\_\_Sync\_Mobile\_App\_Theme\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgc\_sync\_\_Sync\_Mobile\_App\_Theme\_\_c (the master object) ## Additional information Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Component\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Component\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Component\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Component\_\_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. # cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_\_c Deployment packages that contain application runtime artifacts of the mobile app. This object is available in API version 53.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 ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the record type. This is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### cgc\_sync\_\_AggregatedState\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Deployment package state. This is a calculated field. - **Possible values**: - Initial - Revoked - Scheduled - Published - Published (partially) - **Formula**: IF(cgc\_sync\_\_Revoked\_\_c = True, "Revoked", IF(cgc\_sync\_\_Assignment\_to\_All\_\_c + cgc\_sync\_\_Assignment\_to\_User\_\_c == 0, 'Initial', IF(cgc\_sync\_\_MinPublishingDate\_\_c > NOW() && cgc\_sync\_\_MaxPublishingDate\_\_c > NOW(), 'Scheduled', IF(cgc\_sync\_\_MinPublishingDate\_\_c <= NOW() && cgc\_sync\_\_MaxPublishingDate\_\_c <= NOW(), 'Published', 'Published (partially)') ) ) ) ### cgc\_sync\_\_Assignment\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Display assignment type and number of assignments per assignment type in .csv format. This is a calculated field. - **Formula**: If( cgc\_sync\_\_Assignment\_to\_All\_\_c = 0 && cgc\_sync\_\_Assignment\_to\_User\_\_c = 0, 'Not assigned', If( cgc\_sync\_\_Assignment\_to\_All\_\_c > 0, 'All', '') & If( cgc\_sync\_\_Assignment\_to\_All\_\_c > 0 && cgc\_sync\_\_Assignment\_to\_User\_\_c > 0, ', ', '') & If( cgc\_sync\_\_Assignment\_to\_User\_\_c > 0, 'User(' & Text(cgc\_sync\_\_Assignment\_to\_User\_\_c) & ')', '')) ### cgc\_sync\_\_Assignment\_to\_All\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Deployment package that users can download. This is a calculated field. ### cgc\_sync\_\_Assignment\_to\_User\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Deployment package that a specific user can download. This is a calculated field. ### cgc\_sync\_\_Deployment\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Deployment type of the mobile app package. - **Default value**: Complete RTA - **Possible values**: - Complete RTA - Delta RTA - Full - Pictures ### cgc\_sync\_\_Description\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the mobile deployment package. ### cgc\_sync\_\_Installation\_Deadline\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time by when this package must be installed. ### cgc\_sync\_\_MaxPublishingDate\_\_c - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date and time by when this package must be published. This is a calculated field. ### cgc\_sync\_\_MinPublishingDate\_\_c - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date from which this package can be published. This is a calculated field. ### cgc\_sync\_\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the deployment mobile package. ### cgc\_sync\_\_Publish\_Date\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time when this package is made available to a user's devices. ### cgc\_sync\_\_Registration\_Date\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp when the deployment package record was created. ### cgc\_sync\_\_Registration\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: User who registered the package. This is a relationship field. - **Relationship Name**: cgc\_sync\_\_Registration\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgc\_sync\_\_Revoked\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the deployment mobile package is revoked (true) or not (false). A revoked deployment mobile package isn’t available for download. - **Default value**: false ### cgc\_sync\_\_Version\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Version of the deployment package. ## Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_\_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. # cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_As\_\_c Contains information about the recipient of the deployment package. This object is available in API version 53.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. ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the record type. This is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### cgc\_sync\_\_Assignment\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Information about to whom the deployment package is assigned. - **Default value**: All - **Possible values**: - All - User ### cgc\_sync\_\_Installation\_Deadline\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Last date by which the deployment package must be installed on the device. ### cgc\_sync\_\_Publishing\_Date\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date from which the deployment package is available for download. ### cgc\_sync\_\_State\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: State of the deployment package. This is a calculated field. - **Formula**: If( cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_\_r.cgc\_sync\_\_Revoked\_\_c, "Revoked", If(cgc\_sync\_\_Publishing\_Date\_\_c > NOW() , "Scheduled","Published")) ### cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Deployment package to which the assignment belongs. - **Relationship Name**: cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_\_c (the master object) ### cgc\_sync\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: User to whom the deployment package is assigned. - **Relationship Name**: cgc\_sync\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_As\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_As\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_As\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_As\_\_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. # cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_Inst\_\_c Maintains a record of the installed deployment packages, their installation timestamps, and devices on which those packages are deployed. This object is available in API version 53.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 owner. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### cgc\_sync\_\_AppInstallationID\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the application. This is a relationship field. - **Relationship Name**: cgc\_sync\_\_AppInstallationID\_\_r - **Relationship Type**: Lookup - **Refers To**: cgc\_sync\_\_Sync\_Mobile\_App\_Installation\_\_c ### cgc\_sync\_\_Deployment\_Date\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp when the deployment package was deployed. ### cgc\_sync\_\_Device\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the device. ### cgc\_sync\_\_Is\_Current\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is related to the latest installed deployment package (true) or not (false). The value is set by an event trigger. - **Default value**: false ### cgc\_sync\_\_Recipient\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Device user ID. This is a relationship field. - **Relationship Name**: cgc\_sync\_\_Recipient\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgc\_sync\_\_State\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Status of the deployment package installation. - **Possible values**: - Downloaded - Error - Installed ### cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_As\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Relation to the deployment package assignment. - **Relationship Name**: cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_As\_\_r - **Relationship Type**: Lookup - **Refers To**: cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_As\_\_c ### cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Relation to the deployment package. This is a relationship field. - **Relationship Name**: cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_\_r - **Relationship Type**: Lookup - **Refers To**: cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_\_c ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_Inst\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_Inst\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_Inst\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_Inst\_\_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. # cgc\_sync\_\_Sync\_Mobile\_App\_Domain\_\_c Stores information about domains that are available as dropdown boxes in the mobile app. This object is available in API version 53.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**: 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. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_Sync\_Mobile\_App\_Domain\_\_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. - **[cgc\_sync\_Sync\_Mobile\_App\_Domain\_\_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. - **[cgc\_sync\_Sync\_Mobile\_App\_Domain\_\_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. - **[cgc\_sync\_Sync\_Mobile\_App\_Domain\_\_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. # cgc\_sync\_\_Sync\_Mobile\_App\_Installation\_\_c Contains information about the user to whom the deployment package is to be distributed. This object is available in API version 53.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 ### cgc\_sync\_\_API\_Calls\_Down\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Number of API calls that are grouped by downloads since either the first installation or the last reset. ### cgc\_sync\_\_API\_Calls\_Everything\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total number of API calls made during installation. ### cgc\_sync\_\_API\_Calls\_Misc\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total number of API calls not considered during upload, download, and NFT (Named Fetch Tree) syncs since either the first installation or the last reset. ### cgc\_sync\_\_API\_Calls\_NFT\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total number of all API calls that are grouped by NFT synchronizations since either the first installation or the last reset. ### cgc\_sync\_\_API\_Calls\_Up\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total number of API calls that are grouped by upload synchronizations since either the first installation or the last reset. ### cgc\_sync\_\_Avg\_API\_Calls\_Down\_Per\_Day\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Weighted average of the API calls that are down per day. ### cgc\_sync\_\_Avg\_API\_Calls\_Everything\_Per\_Day\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Weighted average of API calls per day. ### cgc\_sync\_\_Avg\_API\_Calls\_Misc\_Per\_Day\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Weighted average of all API calls that aren't considered during upload, download, or NFT syncs. ### cgc\_sync\_\_Avg\_API\_Calls\_NFT\_Per\_Day\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Weighted average of API calls for NFT syncs. ### cgc\_sync\_\_Avg\_API\_Calls\_Up\_Per\_Day\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Weighted average of API calls for upload. It's calculated only on the view, and not on the persistent fields. ### cgc\_sync\_\_Client\_App\_ID\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Client app ID that the device uses and the user combination for a specific sync App\_Installation\_\_c record. ### cgc\_sync\_\_Deployment\_Package\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the deployment package that's installed on the device. ### cgc\_sync\_\_DeviceId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Installation ID of the device. ### cgc\_sync\_\_Device\_Model\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Model number of the client device. ### cgc\_sync\_\_Device\_OS\_Version\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Operating system that runs on the client device. ### cgc\_sync\_\_Encryption\_Key\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Encryption key of the client device. ### cgc\_sync\_\_Event\_Period\_Length\_Hours\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Time duration (in hours) for controlling maximum event quantity limitations. ### cgc\_sync\_\_Free\_Persistent\_Storage\_Space\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Available storage space (in bytes) of the device. ### cgc\_sync\_\_Installation\_Date\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp when the package was installed. ### cgc\_sync\_\_Installed\_App\_Version\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Version of the application installed on the client device. ### cgc\_sync\_\_IsEncrypted\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the database on the client device is encrypted (true) or not (false). - **Default value**: false ### cgc\_sync\_\_Last\_Connection\_At\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the last attempted upload or download. ### cgc\_sync\_\_Last\_Failed\_Sync\_At\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the last failed sync. ### cgc\_sync\_\_Last\_Reset\_At\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp when the last reset was performed. ### cgc\_sync\_\_Last\_Successful\_Download\_At\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the last successful download. ### cgc\_sync\_\_Last\_Successful\_FSOD\_At\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the last successfully executed First Sync of Day. ### cgc\_sync\_\_Last\_Successful\_Upload\_At\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp of the last successful upload. ### cgc\_sync\_\_Link\_to\_Device\_Details\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the device details record. This is a calculated field. - **Formula**: HYPERLINK(LEFT($Api.Partner\_Server\_URL\_260, FIND( '/services', $Api.Partner\_Server\_URL\_260)) + '/'+ Id + '/e?retURL=/one/one.app#/alohaRedirect/apex/AppInstallations', 'Device Details', '\_blank') ### cgc\_sync\_\_Link\_to\_Device\_Logs\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the device logs. This is a calculated field. - **Formula**: HYPERLINK(LEFT($Api.Partner\_Server\_URL\_260, FIND( '/services', $Api.Partner\_Server\_URL\_260)) + '/lightning/r/Report/'+$Setup.cgc\_sync\_Sync\_Report\_Links\_\_c.cgc\_sync\_Device\_Event\_Logs\_Id\_\_c+'/view?fv0=' + cgc\_sync\_DeviceId\_\_c, "Logs", "\_blank") & " | " & HYPERLINK(LEFT($Api.Partner\_Server\_URL\_260, FIND( '/services', $Api.Partner\_Server\_URL\_260)) + '/lightning/r/Report/'+ $Setup.cgc\_sync\_Sync\_Report\_Links\_\_c.cgc\_sync\_Sync\_History\_Id\_\_c +'/view?fv1=' + cgc\_sync\_DeviceId\_\_c, "Sync History", "\_blank") & " | " & HYPERLINK(LEFT($Api.Partner\_Server\_URL\_260, FIND( '/services', $Api.Partner\_Server\_URL\_260)) + '/lightning/r/Report/'+ $Setup.cgc\_sync\_Sync\_Report\_Links\_\_c.cgc\_sync\_KPI\_Id\_\_c +'/view?fv0=' + cgc\_sync\_DeviceId\_\_c, "KPIs", "\_blank") ### cgc\_sync\_\_Link\_to\_the\_Record\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the sync record. This is a calculated field. - **Formula**: LEFT($Api.Partner\_Server\_URL\_260, FIND( '/services', $Api.Partner\_Server\_URL\_260)) + Id ### cgc\_sync\_\_Local\_Database\_Record\_Count\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Number of records on the local database of the device. ### cgc\_sync\_\_Max\_Error\_Events\_Per\_Period\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Maximum number of error events that a device can send over a period of time (set in Events Period field), when Log Level field is set as Error. ### cgc\_sync\_Max\_Other\_Events\_Per\_Period\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Maximum number of events that a device can send over a period of time (set in Events Period field), when Log Level field is set as either Debug, Info, or Log. ### cgc\_sync\_Number\_Of\_Resets\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total number of resets performed. ### cgc\_sync\_Pending\_Record\_Count\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Number of records that are yet to be synced. ### cgc\_sync\_Permission\_Set\_Assigned\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a permission set is assigned (true) or not (false). - **Default value**: false ### cgc\_sync\_Platform\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Platform of the device. ### cgc\_sync\_Record\_Error\_Count\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Number of errors detected. ### cgc\_sync\_Remote\_Procedure\_Call\_Log\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: List of command instances executed by the client. . ### cgc\_sync\_Remote\_Procedure\_Call\_Queue\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A semicolon-separated list of command instances (in order of insertion). Clients can use this list to determine the remote procedures that are called from the back end. ### cgc\_sync\_Remote\_Procedure\_Call\_Supported\_Commands\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: A semicolon-separated list of command code names. Clients can populate this list to determine the remote procedures that can be called from the back end. ### cgc\_sync\_Schemaless\_Extension\_JSON\_\_c - **Type**: textarea - **Properties**: Create, Defaulted on create, Nillable, Update - **Description**: User or project-specific data that's associated to a specific application without a schema. ### cgc\_sync\_Status\_BL\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the functional state of the business logic. - **Default value**: G - **Possible values**: - G—OK - R—Error - Y—Warning ### cgc\_sync\_Status\_FW\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the function state of the Consumer Goods Cloud offline mobile app framework using a traffic light indicator. This field derives values from the Device Status picklist. - **Default value**: G - **Possible values**: - G— OK - R— Error - Y— Warning ### cgc\_sync\_Status\_Sync\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the function state of the Sync engine using a traffic light indicator. This field derives values from the Device Status picklist. - **Default value**: G - **Possible values**: - G—OK - R—Error - Y—Warning ### cgc\_sync\_Sync\_Error\_Message\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Message to display when an error occurs during sync. ### cgc\_sync\_Sync\_Status\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Status of the latest sync process. - **Possible values**: - SyncError - Synchronized - Synchronizing - AwaitingSynchronization ### cgc\_sync\_TechPanel\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Toggle to enable (true) or disable (false) the tech panel on the mobile device. '\\. - **Default value**: false ### cgc\_sync\_Total\_API\_Calls\_Down\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total number of API calls made during sync between Salesforce back-end and the mobile device since the first installation. This value is not affected by a reset. ### cgc\_sync\_Total\_API\_Calls\_Everything\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total number of API calls since the first installation. This value is not affected by a reset. ### cgc\_sync\_Total\_API\_Calls\_Misc\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total numer of API calls since the first installation, not considered in upload, download, or NFT syncs. This value is not affected by a reset. ### cgc\_sync\_Total\_API\_Calls\_NFT\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total number of API calls used to sync NFT (Named Fetch Tree) data since the first installation. This value is not affected by a reset. ### cgc\_sync\_Total\_API\_Calls\_Up\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total number of API calls grouped by upload syncs since the first installation. This value is not affected by a reset. ### cgc\_sync\_TraceModeTill\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the trace mode will be active on the mobile device. ### cgc\_sync\_Trace\_Mode\_Area\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Area on which trace mode is active. - **Default value**: Application - **Possible values**: - All - Application - Synchronization ### cgc\_sync\_Trace\_Mode\_Duration\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total number of hours for which trace mode logging can remain active on the mobile device. ### cgc\_sync\_Trace\_Mode\_On\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Enable (true) or disable (false) trace mode. - **Default value**: false ### cgc\_sync\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Information about the app user. This is a relationship field. - **Relationship Name**: cgc\_sync\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgc\_sync\_minCacheLogLevel\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Minimum cache log level. ### cgc\_sync\_minPrintLogLevel\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Minimum print log level. ### cgc\_sync\_minSubmitLogLevel\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Minimum submit log level. ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_Sync\_Mobile\_App\_Installation\_\_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. - **[cgc\_sync\_Sync\_Mobile\_App\_Installation\_\_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. - **[cgc\_sync\_Sync\_Mobile\_App\_Installation\_\_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. - **[cgc\_sync\_Sync\_Mobile\_App\_Installation\_\_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. # cgc\_sync\_\_Sync\_Mobile\_App\_Log\_\_c Stores the error messages and warnings that occurred in the mobile app. Such error messages and warnings are uploaded every time a user runs the upload to Salesforce action in the mobile app. This object is available in API version 53.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 mobile app log. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### cgc\_sync\_\_Details\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Link to the sync details record. ### cgc\_sync\_\_DeviceId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Unique identification of the client device that was used to submit the event. ### cgc\_sync\_\_Device\_Model\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Model number of the device. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note This field is for internal use. ### cgc\_sync\_\_Device\_OS\_Version\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Version of the operating system on the mobile device. ### cgc\_sync\_\_Device\_Platform\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Operating system of the mobile device, including Android, iOS, or web browser. ### cgc\_sync\_\_Event\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Event error code. ### cgc\_sync\_\_Generated\_At\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the date and time when the event is generated. ### cgc\_sync\_\_Length\_In\_Millis\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the time taken (in milliseconds) to generate the event. ### cgc\_sync\_\_Log\_Level\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Level of the generated log. - **Possible values**: - 1200 - 1400 - 500 - 800 - 900 ### cgc\_sync\_\_Message\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Error log message that's used as the error description. ### cgc\_sync\_\_Namespace\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Namespace used for the mobile app. Possible values: - FW UI - FW ENGINE - SYNC ### cgc\_sync\_\_SubmittedBy\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: User who uploaded the log. This is a relationship field. - **Relationship Name**: cgc\_sync\_\_SubmittedBy\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgc\_sync\_\_Sync\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the unique ID of the sync request. ### cgc\_sync\_\_Sync\_Version\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: User who's logged in on the client while the record was submitted to the back end. ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Log\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Log\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Log\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Log\_\_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. # cgc\_sync\_\_Sync\_Mobile\_App\_Macro\_\_c Contains the color macros that are used for themes. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique identification of the record. ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the record type. This is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### cgc\_sync\_\_Color\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Color code of the mobile device. This can be a color macro or an RGBA code. ### cgc\_sync\_\_Description\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Describes where this color code is used in the mobile device. ### cgc\_sync\_\_Macro\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Color code of the mobile device. This can be a color macro or an RGBA code. - **Possible values**: - Button - Color - Image ### cgc\_sync\_\_Sync\_Mobile\_App\_Theme\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Refers to the mobile app theme. This is a relationship field. - **Relationship Name**: cgc\_sync\_\_Sync\_Mobile\_App\_Theme\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgc\_sync\_\_Sync\_Mobile\_App\_Theme\_\_c (the master object) ## Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Macro\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Macro\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Macro\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Macro\_\_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. # cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Config\_\_c Contains the mapping information of picklists for dropdown boxes in the mobile app. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Sort, Update - **Description**: Unique identification of the record. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the setup owner. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_Sync\_Mobile\_App\_PL\_Config\_\_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. - **[cgc\_sync\_Sync\_Mobile\_App\_PL\_Config\_\_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. - **[cgc\_sync\_Sync\_Mobile\_App\_PL\_Config\_\_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. - **[cgc\_sync\_Sync\_Mobile\_App\_PL\_Config\_\_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. # cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Map\_\_c Contains the mapping information of picklists and dropdown boxes in the mobile application. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### 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 ### cgc\_sync\_\_Field\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Salesforce field name of the picklist. ### cgc\_sync\_\_HasChildren\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether there’s an extension record (true) or not (false). The default value is false. ### cgc\_sync\_\_Has\_Empty\_Item\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the picklist contains an empty item (true) or not (false). The default value is false. ### cgc\_sync\_\_Mobile\_App\_Domain\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Toggle ID of the mobile app domain. ### cgc\_sync\_\_Object\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the Salesforce object that contains the picklist. ## Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Map\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Map\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Map\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Map\_\_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. # cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Map\_Ext\_\_c Contains the mapping information of picklists and dropdown boxes in the mobile app. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgc\_sync\_\_Business\_Area\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Key used to segregate business areas. - **Default value**: 0000 ### cgc\_sync\_\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Picklist code. ### cgc\_sync\_\_Ignore\_On\_Mobile\_App\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether to ignore elements in the mobile app (true) or not (false). - **Default value**: false ### cgc\_sync\_\_ImageId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Image ID of the icon of the corresponding picklist value. ### cgc\_sync\_\_ParentPicklist\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Refers to the picklist-mapping record. This is a relationship field. - **Relationship Name**: cgc\_sync\_\_ParentPicklist\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Map\_\_c (the master object) ### cgc\_sync\_\_Picklist\_Value\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Picklist value. ### cgc\_sync\_\_ShortText\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Short text for language 1 to display for this sales org. ### cgc\_sync\_\_ShortText\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Short text for language 2 to display for this sales org. ### cgc\_sync\_\_ShortText\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Short text for language 3 to display for this sales org. ### cgc\_sync\_\_ShortText\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Short text for language 4 to display for this sales org. ### cgc\_sync\_\_Sort\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Order of values in the picklist. ### cgc\_sync\_\_Text\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text for language 1 to display for this sales org. ### cgc\_sync\_\_Text\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text for language 2 to display for this sales org. ### cgc\_sync\_\_Text\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text for language 3 to display for this sales org. ### cgc\_sync\_\_Text\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text for language 4 to display for this sales org. ### cgc\_sync\_\_ValidationCode\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Value to filter picklist items. ## Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Map\_Ext\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Map\_Ext\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Map\_Ext\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Map\_Ext\_\_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. # cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Repo\_\_c Represents the repository of dropdown boxes in a mobile app. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### 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 ### cgc\_sync\_\_Business\_Area\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Key used to segregate business areas. Possible value is 0000. ### cgc\_sync\_\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Code for the picklist. ### cgc\_sync\_\_Field\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Salesforce field name of the picklist. ### cgc\_sync\_\_Has\_Empty\_Item\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the picklist contains an empty item (true) or not (false). - **Default value**: false ### cgc\_sync\_\_ImageId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Image ID of the icon of the corresponding picklist value. ### cgc\_sync\_\_Mobile\_App\_Domain\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Mapping to the domain name of the mobile runtime artifact. ### cgc\_sync\_\_Object\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Refers to the object name. ### cgc\_sync\_\_Picklist\_Value\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Picklist value. ### cgc\_sync\_\_ShortText\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Short text for language 1 to display for this sales org. ### cgc\_sync\_\_ShortText\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Short text for language 2 to display for this sales org. ### cgc\_sync\_\_ShortText\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Short text for language 3 to display for this sales org. ### cgc\_sync\_\_ShortText\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Short text for language 4 to display for this sales org. ### cgc\_sync\_\_Sort\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Order of values in the picklist. ### cgc\_sync\_\_Text\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text for language 1 to display for this sales org. ### cgc\_sync\_\_Text\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text for language 2 to display for this sales org. ### cgc\_sync\_\_Text\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text for language 3 to display for this sales org. ### cgc\_sync\_\_Text\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Text for language 4 to display for this sales org. ### cgc\_sync\_\_ValidationCode\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Value to filter the picklist. ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Repo\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Repo\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Repo\_\_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. - **[cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Repo\_\_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. # cgc\_sync\_\_Sync\_Mobile\_App\_Theme\_\_c Represents the themes of a mobile app. This object is available in API version 53.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**: Date when the record was last referenced. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Date when the record was last viewed. ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique identification of the mobile app theme. ### 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 ### cgc\_sync\_Attachment\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Refers to the theme icon or image file. ### cgc\_sync\_Attachment\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the attached .zip file. ### cgc\_sync\_Description\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the theme. ### cgc\_sync\_Label\_Languages\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: The key-value pair of language codes and related translated label text for the theme name. For example, {"en": "Dark Theme", "de" : "dunkles theme"} ### cgc\_sync\_isActive\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the theme is active (true) or not (false). Only active themes are available on the mobile device. - **Default value**: false ### cgc\_sync\_isCore\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the theme is editable (false) or not (true). If set as true, the client or project cannot edit the theme. - **Default value**: false ### cgc\_sync\_isDefault\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the theme is a default theme (true) or not (false). - **Default value**: false ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_Sync\_Mobile\_App\_Theme\_\_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. - **[cgc\_sync\_Sync\_Mobile\_App\_Theme\_\_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. - **[cgc\_sync\_Sync\_Mobile\_App\_Theme\_\_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. - **[cgc\_sync\_Sync\_Mobile\_App\_Theme\_\_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. # cgc\_sync\_\_Sync\_Named\_Fetch\_Tree\_Nodes\_\_c Contains information about the nodes that are used to construct the tree structure of sync objects. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Sort, Update - **Description**: Unique identification of the record. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the setup owner. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ### cgc\_sync\_\_Child\_Join\_Field\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the relation between two objects. When the NFT is evaluated, it returns details of the products and tactics that are related to the contract IDs and to the retrieved contracts. ### cgc\_sync\_\_Display\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Display name of the NFT. This field is unique to your organization. ### cgc\_sync\_\_Fetch\_Tree\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of the fetch tree. This is used to look up nodes (records) in the same tree. ### cgc\_sync\_\_Join\_Field\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the join field. ### cgc\_sync\_\_Object\_Api\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of the object from which the data is retrieved. ### cgc\_sync\_\_Parent\_Join\_Field\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: List of returned contracts for a given set of account IDs. At the parent level, the join field acts as the lookup field. ### cgc\_sync\_\_Parent\_Node\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Parent object of this node. ### cgc\_sync\_\_SF\_Rest\_Enabled\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a client can use (true) standard Salesforce REST APIs for synchronization to evaluate an NFT or not (false). - **Default value**: false ### cgc\_sync\_\_Where\_2\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Second part of the where clause. ### cgc\_sync\_\_Where\_3\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Third part of the where clause. ### cgc\_sync\_\_Where\_4\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Fourth part of the where clause. ### cgc\_sync\_\_Where\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Conditional statements of the where clause to filter and retrieve data from the back end. ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Named\_Fetch\_Tree\_Nodes\_\_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. - **[cgc\_sync\_\_Sync\_Named\_Fetch\_Tree\_Nodes\_\_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. - **[cgc\_sync\_\_Sync\_Named\_Fetch\_Tree\_Nodes\_\_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. - **[cgc\_sync\_\_Sync\_Named\_Fetch\_Tree\_Nodes\_\_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. # cgc\_sync\_\_Sync\_Named\_Query\_\_c Contains details and SOQL (Salesforce Object Query Language) statements for a named query. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Sort, Update - **Description**: Unique identification of the record. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the setup owner. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ### cgc\_sync\_Bindable\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of the named query. ### cgc\_sync\_SOQL\_Statement2\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Second part of the SOQL statement. ### cgc\_sync\_SOQL\_Statement3\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Third part of the SOQL statement. ### cgc\_sync\_SOQL\_Statement4\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Fourth part of the SOQL statement. ### cgc\_sync\_SOQL\_Statement\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Sort, Update - **Description**: SOQL statement that's used to retrieve data from the back end of the mobile device ### cgc\_sync\_Type\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of named query that's used. ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_Sync\_Named\_Query\_\_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. - **[cgc\_sync\_Sync\_Named\_Query\_\_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. - **[cgc\_sync\_Sync\_Named\_Query\_\_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. - **[cgc\_sync\_Sync\_Named\_Query\_\_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. # cgc\_sync\_\_Sync\_Remote\_Request\_\_c Stores requests to trigger technical activities on the mobile app. For example, data resupply and clean-up upload queue. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identifier of the remote request. ### cgc\_sync\_\_App\_Installation\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Relationship field to app installation. This is a relationship field. - **Relationship Name**: cgc\_sync\_\_App\_Installation\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgc\_sync\_\_Sync\_Mobile\_App\_Installation\_\_c (the master object) ### cgc\_sync\_\_Is\_Processed\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the remote request is processed by the mobile device (true) or not (false). - **Default value**: false ### cgc\_sync\_\_Processed\_At\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp when the remote request was processed by the mobile device. ### cgc\_sync\_\_Request\_Data\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Requested data or log collected from the mobile device. ### cgc\_sync\_\_Request\_Name\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the remote request. - **Possible values**: - CLEAN\_FAILURE\_QUEUE—Clear Upload Failures - REQUEST\_DB\_CONTENT—Request Data - REQUEST\_STATS—Request Statistics - RESET\_STATS—Reset API Stats - RESUPPLY—Resupply - TECH\_PANEL—Activate Debug Window - TRACE\_MODE—Activate Trace Mode - UPLOAD\_LOG\_DUMP—Request Logs ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Remote\_Request\_\_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. - **[cgc\_sync\_\_Sync\_Remote\_Request\_\_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. - **[cgc\_sync\_\_Sync\_Remote\_Request\_\_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. - **[cgc\_sync\_\_Sync\_Remote\_Request\_\_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. # cgc\_sync\_\_Sync\_Report\_Links\_\_c Contains information about the conjunction object for reports and related logs. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique identification of the record. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the setup owner. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ### cgc\_sync\_\_Device\_Event\_Logs\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Report ID of the device event logs. ### cgc\_sync\_\_KPI\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Report ID of the API's Key Performance Indicators (KPIs). ### cgc\_sync\_\_Sync\_History\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Report ID of the sync history. ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Report\_Links\_\_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. - **[cgc\_sync\_\_Sync\_Report\_Links\_\_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. - **[cgc\_sync\_\_Sync\_Report\_Links\_\_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. - **[cgc\_sync\_\_Sync\_Report\_Links\_\_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. # cgc\_sync\_\_Sync\_Tracked\_Object\_Config\_\_c Contains configurations for tracked objects including data distribution, sync settings, and client schema. This object is available in API version 53.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Sort, Update - **Description**: Unique identification of the record. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the setup owner. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ### cgc\_sync\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the tracked object is active (true) or not (false). - **Default value**: true ### cgc\_sync\_\_Allow\_Null\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether null values instead of default datatype values in the offline database are allowed (true) or not (false). - **Default value**: false ### cgc\_sync\_\_Batch\_SOQL\_Param\_Chunk\_Size\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Batch SOQL parameter chunk size in bytes. ### cgc\_sync\_\_Clear\_Upload\_Failures\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether to clear upload failures for this tracked object (true) or not (false). - **Default value**: false ### cgc\_sync\_\_ClientApp\_ID\_\_c - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Installation ID of the device. ### cgc\_sync\_\_Custom\_Index\_List2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Custom set of indexes named List2 for the current object. ### cgc\_sync\_\_Custom\_Index\_List3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Custom set of indexes named List3 for the current object. ### cgc\_sync\_\_Custom\_Index\_List4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Custom set of indexes named List4 for the current object. ### cgc\_sync\_\_Custom\_Index\_List\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Custom set of indexes named List for the current object. ### cgc\_sync\_\_Dependent\_Lookups\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Details of the dependent lookups. ### cgc\_sync\_\_Displayable\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether to display this object in the mobile app (true) or not (false). - **Default value**: true ### cgc\_sync\_\_Enable\_Enhanced\_Delta\_Sync\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the delta sync is active (true) or not (false). - **Default value**: true ### cgc\_sync\_\_Fieldset\_Name\_List\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Comma-separated list of field set names for the object. ### cgc\_sync\_\_Layout\_Needed\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this layout is required in the mobile app (true) or not (false). - **Default value**: false ### cgc\_sync\_\_List\_Header\_Fieldset\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: List header of the field set. ### cgc\_sync\_\_Max\_Records\_Before\_Full\_Sync\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Maximum number of single records that the device can sync before switching to full sync mode. ### cgc\_sync\_\_Object\_Api\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: API name of the tracked object. ### cgc\_sync\_\_On\_the\_Road\_Sync\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Enable (true) or disable (false) synchronizing only tracked objects marked as On The Road Sync. - **Default value**: false ### cgc\_sync\_\_Only\_Metadata\_Needed\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether only metadata is allowed and no data is downloaded for this tracked object (true) or not (false). - **Default value**: false ### cgc\_sync\_\_Order\_By\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The value for ORDER BY. ### cgc\_sync\_\_SF\_Rest\_Enabled\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the client must use standard Salesforce REST API to synchronize tracked objects (true) or not (false). - **Default value**: false ### cgc\_sync\_\_Sync\_Overview\_Condition\_Field\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Condition to display this record on the Sync Overview screen as a pending upload. ### cgc\_sync\_\_Sync\_Overview\_Condition\_Operator\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Conditional operators (IN, >, <, =, !=) for sync overview. ### cgc\_sync\_\_Sync\_Overview\_Condition\_Value\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Condition for sync overview. ### cgc\_sync\_\_Sync\_Overview\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether to display this record in sync overview (true) or not (false). - **Default value**: false ### cgc\_sync\_\_Sync\_Record\_Weight\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Sort, Update - **Description**: Weight of this record. Weight of a record is directly proportional to the computational resources that are required for processing. ### cgc\_sync\_\_Tracked\_Relationship\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the dependency on another tracked object. Clients can evaluate this field to propagate sync states from child to parent records. ### cgc\_sync\_\_Tracking\_enabled\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a tracked object relationship must be considered (true) or ignored (false). - **Default value**: false ### cgc\_sync\_\_Where\_2\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Second part of the where clause. ### cgc\_sync\_\_Where\_3\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Third part of the where clause. ### cgc\_sync\_\_Where\_4\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Fourth part of the where clause. ### cgc\_sync\_\_Where\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Conditions of the where clause. ## Associated Objects This object has these associated objects. If the API version isn’t specified, the version details are available in the same API versions as this object. Otherwise, they’re available in the specified API version and later. - **[cgc\_sync\_\_Sync\_Tracked\_Object\_Config\_\_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. - **[cgc\_sync\_\_Sync\_Tracked\_Object\_Config\_\_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. - **[cgc\_sync\_\_Sync\_Tracked\_Object\_Config\_\_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. - **[cgc\_sync\_\_Sync\_Tracked\_Object\_Config\_\_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. # CGCloud Namespace The CGCloud namespace provides classes that allow you to customise Real Time Reporting (RTR) data extraction from Apex.
Available in: Lightning Experience in Enterprise and Unlimited Editions that have Consumer Goods Cloud Trade Promotion Management enabled.
The following are the classes in the CGCloud namespace. - **[RTRReportResult Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult.htm#apex_class_CGReporting_RTRReportResult)** Use this class to execute the Trade Promotion Management Real Time Reporting (RTR) report and access the report data. - **[ReportComponent Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_ReportComponent.htm#apex_class_CGReporting_RTRReportResult_ReportComponent)** Represents a Real Time Reporting (RTR) report UI component. This is an abstract class and can’t be instantiated. - **[FlatList Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_FlatList.htm#apex_class_CGReporting_RTRReportResult_FlatList)** Represents a Real Time Reporting (RTR) report UI Flatlist component. This class extends the ReportComponent class. - **[FlatListRowIterable Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_FlatListRowIterable.htm#apex_class_CGReporting_RTRReportResult_FlatListRowIterable)** Represents a Real Time Reporting (RTR) report UI Flatlist component set of rows. This class implements the [Iterable](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_classes_iterable.htm "HTML (New Window)") interface that allows it to be used in batch processes. - **[FlatListRow Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_FlatListRow.htm#apex_class_CGReporting_RTRReportResult_FlatListRow)** Represents a Real Time Reporting (RTR) report UI Flatlist component single rows. - **[ScoreCard Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_ScoreCard.htm#apex_class_CGReporting_RTRReportResult_ScoreCard)** Represents a Real Time Reporting (RTR) report scorecard component. This class extends the ReportComponent class. # cgcloud\_\_Account\_Condition\_\_c Contains the details of the relationship between customer and the customer conditions. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ### cgcloud\_\_Condition\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to condition template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Condition\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Condition\_Template\_\_c ### cgcloud\_\_Max\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The maximum header discount available to the customer in question. ### cgcloud\_\_Quantity\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used for quantity discounts. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the Customer Condition record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The date from when the entry is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The date until when the entry is valid. ### cgcloud\_\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Holds the value of a condition. ## 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\_Condition\_\_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\_\_Account\_Condition\_\_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\_\_Account\_Condition\_\_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 tracked fields of the object. - **[cgcloud\_\_Account\_Condition\_\_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\_\_Account\_Condition\_\_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. # cgcloud\_\_Account\_Extension\_\_c This object records account roles and further product-related attributes. 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() ## Special Access Rules ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### cgcloud\_\_Account\_Plan\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the level of the customer in trade org hierarchies, which is used to aggregate KPIs. - **Possible values**: - Plan ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the customer to whom the Extension record is assigned. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ### cgcloud\_\_Bill\_To\_Role\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date from which the Bill To Role is valid. ### cgcloud\_\_Bill\_To\_Role\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the Bill To Role is valid. ### cgcloud\_\_Broker\_Role\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date from which the Broker Role is valid. ### cgcloud\_\_Broker\_Role\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the Broker Role is valid. ### cgcloud\_\_Class\_Of\_Trade\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to which the account the company segment belongs. - **Possible values**: - CC—C&C Markets - CategorySpecialist - ConvenienceStores - Department - DiscountStores - DrugStores - GasStation - Grocery - Hotel - Hypermarket - Kiosk - Restaurants - SM—Supermarket ### cgcloud\_\_Company\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the type of customer. - **Possible values**: - Consumer - Independent - OnTrade - Payee - Payer - Retailer - ThirdParty - Wholesaler ### cgcloud\_\_Consider\_Modules\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the account can be used to list module classification. - **Default value**: false ### cgcloud\_\_Customer\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the customer to whom the Extension record is assigned. ### cgcloud\_\_Customer\_Role\_Number\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines the role number of the customer. ### cgcloud\_\_Customer\_Role\_Price\_List\_type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the Role Price List type of the customer. - **Possible values**: - Direct Customer - NotRelevant - Wholesaler ### cgcloud\_\_Customer\_Role\_Price\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the customer's Role Price type. - **Possible values**: - NotRelevant - consumer - factory ### cgcloud\_\_Customer\_Role\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date from which the customer role is valid. ### cgcloud\_\_Customer\_Role\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the customer role is valid. ### cgcloud\_\_Date\_Closure\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date on which the company closed. ### cgcloud\_\_Decreasing\_PSI\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the previously calculated PSI is higher than the last one. - **Default value**: false ### cgcloud\_\_Decreasing\_Revenue\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines whether a customer is classified as a decrease revenue customer. - **Possible values**: - No - Yes ### cgcloud\_\_Delivery\_Role\_Modify\_Preset\_Quantity\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the way quantity modifications of preset quantities of delivery documents can be modified. - **Possible values**: - No - Only Decrease - Only Increase - Yes ### cgcloud\_\_Delivery\_Role\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date from which the Delivery Role is valid. ### cgcloud\_\_Delivery\_Role\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the Delivery Role is valid. ### cgcloud\_\_Distribution\_Issue\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the last relevant call (and then the customer) has distribution issues. - **Default value**: false ### cgcloud\_\_ExternalId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique external ID. ### cgcloud\_\_Fixed\_Overdraw\_\_c - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Fixed-based overdraw allowance percentage. ### cgcloud\_\_Fund\_Role\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date from which the Fund Role is valid. ### cgcloud\_\_Invoice\_Document\_Transaction\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies how to handle invoice documents regarding payments. This field is available in API version 55.0 and later. - **Possible values**: - CreditMemo - InvoiceCashInvoice - InvoiceCreditInvoice - NoPayment ### cgcloud\_\_Fund\_Role\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the Fund Role is valid. ### cgcloud\_\_Last\_PSI\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Last relevant calculated PSI. ### cgcloud\_\_Last\_Visit\_Date\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date on which the last customer call was referenced to calculate the KPI. ### cgcloud\_\_Match\_Code\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Matchcode of the business partner. It is usually a concatenation of several encoded account attributes, such as name, state, and city. For example, KROGER.GA.ATL. ### cgcloud\_\_OOS\_Issue\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the last relevant call (and then the customer) has Out Of Stock (OOS) issues. - **Default value**: false ### cgcloud\_\_Order\_Document\_Transaction\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Mode to handle orders. Specifies payment type and defines detailed behavior of a delivery document. This field is available in API version 55.0 and later. - **Possible values**: - CashOrder - CreditOrder - NoPaymentOrder - VanSalesCashInvoice - VanSalesNoPaymentInvoice ### cgcloud\_\_Order\_Role\_Order\_Template\_Blocked\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Set a value to control the customer's use of the temporary order template. - **Possible values**: - 0—No - 1—Yes - 2—Warning ### cgcloud\_\_Order\_Role\_Orderer\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of the ordering business partner. - **Possible values**: - Direct - Indirect - Replenishment ### cgcloud\_\_Order\_Role\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date from which the Order Role is valid. ### cgcloud\_\_Order\_Role\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the Order Role is valid. ### cgcloud\_\_Org\_Level\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Classification of the customer organization level. - **Possible values**: - CustLevel01—Customer Level 1 - CustLevel02—Customer Level 2 - CustLevel03—Customer Level 3 - CustLevel04—Customer Level 4 - CustLevel05—Customer Level 5 - CustLevel06—Customer Level 6 - CustLevel07—Customer Level 7 ### cgcloud\_\_Payer\_Role\_Credit\_Block\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the customer is credit blocked. - **Default value**: false ### cgcloud\_\_Payer\_Role\_Credit\_Rating\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the credit rating of the customer. - **Possible values**: - A - B - C ### cgcloud\_\_Payer\_Role\_Document\_Transaction\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Mode to handle orders. Specifies payment type and defines detailed behavior of a delivery document. - **Possible values**: - CashInvoice—Delivery Cash Invoice - CreditInvoice—Delivery Credit Invoice - NonValuatedDeliveryNote—Non Valuated Delivery Note - ValuatedDeliveryNote—Valuated Delivery Note ### cgcloud\_\_Payer\_Role\_Overall\_Credit\_Limit\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the overall credit limit of the customer. ### cgcloud\_\_Payer\_Role\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date from which the Payer Role is valid. ### cgcloud\_\_Payer\_Role\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The date until when the Payer Role is valid. ### cgcloud\_\_Payment\_Mode\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Preferred payment mode used when taking a payment during order taking. This field is available in API version 55.0 and later. - **Possible values**: - Cash - Check - CreditCard - DebitCard - MoneyOrder ### cgcloud\_\_Phase\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: System in which the record is stored. - **Possible values**: - 1—Priority ERP - 2—Priority CRM - 3—Only CRM ### cgcloud\_\_Pricing\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Determines the pricing type of the customer. - **Default value**: 1 - **Possible values**: - 1—Standard - 2—Standard incl. Sales Tax - C—Sample/Donation ### cgcloud\_\_Priority\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Classification of a company. - **Possible values**: - A - Priority - B - Priority - C - Priority ### cgcloud\_\_Promotion\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date from which the Promotion Role is valid. ### cgcloud\_\_Promotion\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the Promotion Role is valid. ### cgcloud\_\_RBF\_Overdraw\_\_c - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Rate Based Funding overdraw allowance percentage. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the CustomerExtension record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sales\_Org\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Sales organization to which the customer extension belongs. This is a calculated field. - **Formula**: cgcloud\_\_Account\_\_r.cgcloud\_\_Sales\_Org\_\_c ### cgcloud\_\_Sales\_Organization\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Optimize the reading process of account filters in the Trade Calendar and Account Plan. This is a relationship field. - **Relationship Name**: cgcloud\_\_Sales\_Organization\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Sales\_Organization\_\_c ### cgcloud\_\_Sales\_Relevant\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the account can be used for sales activities. - **Default value**: false ### cgcloud\_\_State\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Status of the account. Business partner roles can be used to control the status of the account. - **Possible values**: - 010—Active - 090—Prepared for Deletion ### cgcloud\_\_Store\_Role\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date from which the Store Role is valid. ### cgcloud\_\_Store\_Role\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the Store Role is valid. ### cgcloud\_\_Tax\_Jurisdiction\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Jurisdiction code of location at which taxes are to be paid. ### cgcloud\_\_Transfer\_Record\_Identifier\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifies the anchor customer for the promotion transfer process. ### cgcloud\_\_Transfer\_Record\_Identifier\_Unique\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: A unique identifier that contains a combination of transfer record identifier and sales org values. ### cgcloud\_\_Week\_Day\_Share\_Profile\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to the Week Day Share Profile that's utilized for calculations for the referenced account. This is a relationship field. - **Relationship Name**: cgcloud\_\_Week\_Day\_Share\_Profile\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Week\_Day\_Share\_Profile\_\_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\_\_Account\_Extension\_\_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\_\_Account\_Extension\_\_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\_\_Account\_Extension\_\_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\_\_Account\_Extension\_\_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\_\_Account\_Extension\_\_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. # cgcloud\_\_Account\_Manager\_\_c This object stores the details of users who manage specific accounts in a particular function (ManagementType). 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to a customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the customer-manager relationship is active (true) or not (false). - **Default value**: true ### cgcloud\_\_Main\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Main flag. Marks a user as the main manager of an account. - **Default value**: false ### cgcloud\_\_Management\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Type of management relation. - **Default value**: Sales - **Possible values**: - CallCenter - Consultant - Sales - Service ### cgcloud\_\_Org\_Unit\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the org unit. This is a relationship field. - **Relationship Name**: cgcloud\_\_Org\_Unit\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Org\_Unit\_\_c ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the Customer Manager record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Substitution\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to a substitution customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Substitution\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Substitution\_\_c ### cgcloud\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to a user. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Date from which the entry is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Date until which the entry is valid. ## 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\_\_Account\_Manager\_\_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\_\_Account\_Manager\_\_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\_\_Account\_Manager\_\_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\_\_Account\_Manager\_\_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\_\_Account\_Manager\_\_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. # cgcloud\_\_Account\_Org\_Unit\_\_c Contains the details of the relationship between customer and the org unit. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to customer. 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**: Indicates if the relationship is active (true) or not (false). - **Default value**: 'true' ### cgcloud\_\_Org\_Unit\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the Org Unit. This is a relationship field. - **Relationship Name**: cgcloud\_\_Org\_Unit\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Org\_Unit\_\_c (the master object) ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the Customer Org Unit record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The date from when the entry is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The date until when the entry is valid. ## Associated Objects ### 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\_Org\_Unit\_\_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\_\_Account\_Org\_Unit\_\_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\_\_Account\_Org\_Unit\_\_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 tracked fields of the object. - **[cgcloud\_\_Account\_Org\_Unit\_\_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\_\_Account\_Org\_Unit\_\_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. # 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 ### 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. - **Default value**: 'Category' - **Possible values**: - Brand - Category - Flavor—Sub Brand - Package—Product Price Group - Product - SubCategory ### 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 ### 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](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\_\_Account\_Plan\_\_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\_\_Account\_Plan\_\_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 tracked fields of the object. - **[cgcloud\_\_Account\_Plan\_\_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\_\_Account\_Plan\_\_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. # cgcloud\_\_Account\_Plan\_Category\_\_c Categories of the account plan including the manual inputs. Categories can be assigned to an account plan. A category can only be assigned to one account/business year combination. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### cgcloud\_\_Account\_Plan\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the account plan. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Plan\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Account\_Plan\_\_c (the master object) ### cgcloud\_\_Category\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the category. This is a relationship field. - **Relationship Name**: cgcloud\_\_Category\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Manual\_Calculation\_Input\_2\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Contains the manual inputs for the account and categories in the JSON format. ### cgcloud\_\_Manual\_Calculation\_Input\_3\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Contains the manual inputs for the account and categories in the JSON format. ### cgcloud\_\_Manual\_Calculation\_Input\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Contains the manual inputs for the account and categories in the JSON format. ### cgcloud\_\_Uniqueness\_Check\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Combination of AccountPlan.Account, AccountPlan.BusinessYear, and Category to check for uniqueness. ### cgcloud\_\_Version\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Refers to the version number, which is updated every time the record is edited. ## Associated Objects ### 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\_Category\_\_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\_\_Account\_Plan\_Category\_\_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\_\_Account\_Plan\_Category\_\_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 tracked fields of the object. - **[cgcloud\_\_Account\_Plan\_Category\_\_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\_\_Account\_Plan\_Category\_\_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. # cgcloud\_\_Account\_Plan\_User\_Filter\_\_c Contains the filter selections of a user for a planning account. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Name of this 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\_Plan\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the customer business plan. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Plan\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Account\_Plan\_\_c ### cgcloud\_\_Filter\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Contains the filter selection in the JSON format. ### cgcloud\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ## Associated Objects ### 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\_User\_Filter\_\_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\_\_Account\_Plan\_User\_Filter\_\_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\_\_Account\_Plan\_User\_Filter\_\_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 tracked fields of the object. - **[cgcloud\_\_Account\_Plan\_User\_Filter\_\_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\_\_Account\_Plan\_User\_Filter\_\_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. # cgcloud\_\_Account\_Product\_Profile\_\_c This object stores statistical profiles that indicate the distribution of weekly data between a customer and category. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to a customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ### cgcloud\_\_Check\_is\_Product\_Unique\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Helper field (not in the UI): used to check that there's a maximum of one account product profile for an Account-Product2 combination. ### cgcloud\_\_Friday\_Percentage\_\_c - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Utilized share value for Fridays. This is a calculated field. - **Formula**: cgcloud\_\_Friday\_\_c / cgcloud\_\_Total\_\_c ### cgcloud\_\_Friday\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Input value for the share that's valid for Fridays. ### cgcloud\_\_Monday\_Percentage\_\_c - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Utilized share value for Mondays. This is a calculated field. - **Formula**: cgcloud\_\_Monday\_\_c / cgcloud\_\_Total\_\_c ### cgcloud\_\_Monday\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Input value for the share that's valid for Mondays. ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the product. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the Week Day Distribution Profile. This is a calculated field. - **Formula**: (HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top")) ### cgcloud\_\_Sales\_Org\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Sales organization to which the weekday distribution profile belongs. This is a calculated field. - **Formula**: cgcloud\_\_Account\_\_r.cgcloud\_\_Sales\_Org\_\_c ### cgcloud\_\_Saturday\_Percentage\_\_c - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Utilized share value for Saturdays. This is a calculated field. - **Formula**: cgcloud\_\_Saturday\_\_c / cgcloud\_\_Total\_\_c ### cgcloud\_\_Saturday\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Input value for the share that's valid for Saturdays. ### cgcloud\_\_Sunday\_Percentage\_\_c - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Utilized share value for Sundays. This is a calculated field. - **Formula**: cgcloud\_\_Sunday\_\_c / cgcloud\_\_Total\_\_c ### cgcloud\_\_Sunday\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Input value for the share that's valid for Sundays. ### cgcloud\_\_Thursday\_Percentage\_\_c - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Utilized share value for Thursdays. This is a calculated field. - **Formula**: cgcloud\_\_Thursday\_\_c / cgcloud\_\_Total\_\_c ### cgcloud\_\_Thursday\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Input value for the share that's valid for Thursdays. ### cgcloud\_\_Total\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of all the input weekday values in the current profile. This is a calculated field. - **Formula**: cgcloud\_\_Monday\_\_c + cgcloud\_\_Tuesday\_\_c + cgcloud\_\_Wednesday\_\_c + cgcloud\_\_Thursday\_\_c + cgcloud\_\_Friday\_\_c + cgcloud\_\_Saturday\_\_c + cgcloud\_\_Sunday\_\_c ### cgcloud\_\_Tuesday\_Percentage\_\_c - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Utilized share value for Tuesdays. This is a calculated field. - **Formula**: cgcloud\_\_Tuesday\_\_c / cgcloud\_\_Total\_\_c ### cgcloud\_\_Tuesday\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Input value for the share that's valid for Tuesdays. ### cgcloud\_\_Wednesday\_Percentage\_\_c - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Utilized share value for Wednesdays. This is a calculated field. - **Formula**: cgcloud\_\_Wednesday\_\_c / cgcloud\_\_Total\_\_c ### cgcloud\_\_Wednesday\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Input value for the share that's valid for Wednesdays. ## 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\_\_Account\_Product\_Profile\_\_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\_\_Account\_Product\_Profile\_\_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\_\_Account\_Product\_Profile\_\_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\_\_Account\_Product\_Profile\_\_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\_\_Account\_Product\_Profile\_\_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. # cgcloud\_\_Account\_Receivable\_\_c Holds the customer related information regarding invoices to be paid and debit and credit notes. This object is available in API version 55.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**: Required. Default name of this record. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: A reference to the account for which the invoice information is stored. Required. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ### cgcloud\_\_Amount\_Open\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Latest amount to be paid (calculated in ERP system based on payment transactions). Not applicable for credit notes. ### cgcloud\_\_Amount\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Original amount with which invoice, credit, or debit note was raised. ### cgcloud\_\_Document\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Invoice, credit, or debit note raised against an account. - **Possible values**: - CreditNote - DebitNote - Invoice ### cgcloud\_\_Due\_Date\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Due date of invoice. Not applicable for credit notes. ### cgcloud\_\_External\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique reference number to track the invoice, debit note, or credit note that is generated. ### cgcloud\_\_Invoice\_Status\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Consolidated status set in ERP system based on account receivable transactions. Not applicable for credit notes. - **Possible values**: - PartiallyPaid - UnPaid ### cgcloud\_\_Receipt\_Date\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date on which the invoice, credit, or debit note was generated. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the account receivables record. This field is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_RECORD\_LINK, "\_top") ## Associated Objects ### 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\_Receivable\_\_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\_\_Account\_Receivable\_\_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\_\_Account\_Receivable\_\_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 tracked fields of the object. - **[cgcloud\_\_Account\_Receivable\_\_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\_\_Account\_Receivable\_\_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. # cgcloud\_\_Account\_Relationship\_\_c This object represents the relationship between two customer accounts. 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 activity on this record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Specifies the main customer in the relationship. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (Master object) ### cgcloud\_\_End\_Date\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the relationship is active. ### cgcloud\_\_Is\_Primary\_Relationship\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the relationship is a primary relationship (true) or not (false). - **Default value**: false ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the Customer Relationship record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Related\_Account\_Name\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Name of the customer who is related to the main customer of the relationship. This field is a calculated field. This field is available in API version 55.0 and later. - **Formula**: cgcloud\_\_Related\_Account\_\_r.Name ### cgcloud\_\_Related\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Customer who is related to the main customer in the relationship. This is a relationship field. - **Relationship Name**: cgcloud\_\_Related\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Relationship\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Defines the relationship that's defined by this account-to-account relation record (Payer, Payee, Wholesaler, Delivery Recipient, Bill To, and so on.). - **Possible values**: - BillTo - DeliveryRecipient - Payee - Payer - Wholesaler ### cgcloud\_\_Self\_Relationship\_\_c - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Formula that’s used to indicate that the relationship is a self relationship. This is a calculated field. - **Formula**: cgcloud\_\_Account\_\_c = cgcloud\_\_Related\_Account\_\_c ### cgcloud\_\_Start\_Date\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Date from which the relationship is active. ## 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\_\_Account\_Relationship\_\_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\_\_Account\_Relationship\_\_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\_\_Account\_Relationship\_\_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\_\_Account\_Relationship\_\_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\_\_Account\_Relationship\_\_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. # cgcloud\_\_Account\_Sales\_Data\_\_c Contains the information of the sales of a customer for two consecutive years. Access of the object provided to the System Admin. 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**: 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**: Name of this record. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ### cgcloud\_\_Month\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the month for which the sales data is for. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the customer sales data record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sales\_Volume\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sales Volume. ### cgcloud\_\_Year\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the year for which the sales data is for. ## Associated Objects ### 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\_Sales\_Data\_\_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\_\_Account\_Sales\_Data\_\_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\_\_Account\_Sales\_Data\_\_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 tracked fields of the object. - **[cgcloud\_\_Account\_Sales\_Data\_\_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\_\_Account\_Sales\_Data\_\_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. # cgcloud\_\_Account\_Set\_\_c Represents the object for the creation of Customer Sets. 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**: 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\_\_Description\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies description of Language 1. ### cgcloud\_\_Description\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies description of Language 2. ### cgcloud\_\_Description\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies description of Language 3. ### cgcloud\_\_Description\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies 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\_\_Group\_Similar\_Stores\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Enables the customer set to group similar stores. - **Default value**: false ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the customer set record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the customer set belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Segmentation\_Rule\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Segmentation Rule. This is a relationship field. - **Relationship Name**: cgcloud\_\_Segmentation\_Rule\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Segmentation\_Rule\_\_c ## Associated Objects ### 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\_Set\_\_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\_\_Account\_Set\_\_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\_\_Account\_Set\_\_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 tracked fields of the object. - **[cgcloud\_\_Account\_Set\_\_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\_\_Account\_Set\_\_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. # cgcloud\_\_Account\_Set\_Account\_\_c Junction object between Customer and Customer Set. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Account\_Set\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to Customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Set\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Account\_Set\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to Customer Set. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Set\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Account\_Set\_\_c (the master object) ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the Customer set Customer record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ## Associated Objects ### 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\_Set\_Account\_\_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\_\_Account\_Set\_Account\_\_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\_\_Account\_Set\_Account\_\_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 tracked fields of the object. - **[cgcloud\_\_Account\_Set\_Account\_\_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\_\_Account\_Set\_Account\_\_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. # cgcloud\_\_Account\_Set\_Manager\_\_c Custom object to store the relation between Customer Set and User. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### cgcloud\_\_Account\_Set\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to Customer Set. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Set\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Account\_Set\_\_c (the master object) ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the Customer Set manager record is active (true) or not (false). - **Default value**: 'true' ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the Customer Set Manager record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to user. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The date from when the record is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The date until when the record is valid. ## Associated Objects ### 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\_Set\_Manager\_\_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\_\_Account\_Set\_Manager\_\_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\_\_Account\_Set\_Manager\_\_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 tracked fields of the object. - **[cgcloud\_\_Account\_Set\_Manager\_\_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\_\_Account\_Set\_Manager\_\_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. # cgcloud\_\_Account\_Specific\_Product\_Condition\_\_c Holds the relation between a customer and the condition template. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ### cgcloud\_\_Condition\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the condition template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Condition\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Condition\_Template\_\_c ### cgcloud\_\_Price\_List\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of a price list. - **Possible values**: - NotRelevant—Not Relevant - WS1999—WS1999 - Wholesaler - WS2000—WS2000 - Direct Customer ### cgcloud\_\_Price\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type or usage of a price. - **Possible values**: - NotRelevant—Not Relevant - consumer—Consumer - factory—Factory ### cgcloud\_\_Product\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description of the product. This is a calculated field. - **Formula**: cgcloud\_\_Product\_\_r.cgcloud\_\_Description\_1\_\_c ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the product. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Quantity\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used for quantity discounts. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the account-specific product conditions record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The date from when the entry is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The date until when the entry is valid. ### cgcloud\_\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the value of a condition. ## Associated Objects ### 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\_Specific\_Product\_Condition\_\_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\_\_Account\_Specific\_Product\_Condition\_\_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\_\_Account\_Specific\_Product\_Condition\_\_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 tracked fields of the object. - **[cgcloud\_\_Account\_Specific\_Product\_Condition\_\_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\_\_Account\_Specific\_Product\_Condition\_\_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. # cgcloud\_\_Account\_Sub\_Account\_\_c Defines the account to sub-account relationship. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Parent customer for this sub-account relationship. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the Sub Account. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sub\_Account\_External\_Id\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Specifies the external ID of the sub-account external in the formula field to ensure access. This is a calculated field. - **Formula**: cgcloud\_\_Sub\_Account\_\_r.cgcloud\_\_ExternalId\_\_c ### cgcloud\_\_Sub\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Sub Account lookup. This is a relationship field. - **Relationship Name**: cgcloud\_\_Sub\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The date from when the record is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: The date until when the record is valid. ### cgcloud\_\_Volume\_Percent\_\_c - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies how much the specific sub-account contributes in percent to the overall volume of the account. ## Associated Objects ### 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\_Sub\_Account\_\_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\_\_Account\_Sub\_Account\_\_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\_\_Account\_Sub\_Account\_\_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 tracked fields of the object. - **[cgcloud\_\_Account\_Sub\_Account\_\_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\_\_Account\_Sub\_Account\_\_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. # cgcloud\_\_Account\_Task\_\_c This object represents the details of the customer task (customer issue). 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**: Name of this record. ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Record type of the record. This is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### cgcloud\_\_Account\_Task\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Task\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Account\_Task\_Template\_\_c ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (Master object) ### cgcloud\_\_Accountable\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the owner of the task. This is a relationship field. - **Relationship Name**: cgcloud\_\_Accountable\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Asset\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the asset. This is a relationship field. - **Relationship Name**: cgcloud\_\_Asset\_\_r - **Relationship Type**: Lookup - **Refers To**: Asset ### cgcloud\_\_Classification\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the area that causes the issue. - **Default value**: Inquiry - **Possible values**: - Asset Maintenance - Asset Replacement - Asset Retirement - Company - Complaint - Inquiry - Order - Placement - Private - Repair Asset - Service - TimeEntry—Time Entry - Training - Vehicle ### cgcloud\_\_Creation\_Date\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date on which the customer task was created. ### 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\_\_Due\_Date\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date by which the action is to be done. ### cgcloud\_\_Note\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies a note for the customer task. ### cgcloud\_\_Phase\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Phase of the customer task. - **Default value**: Initial - **Possible values**: - Cancelled—Canceled - Closed—Completed - Initial - Released ### cgcloud\_\_Priority\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Priority of the customer task. - **Possible values**: - A - B - C ### cgcloud\_\_Responsible\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the responsible user. This is a relationship field. - **Relationship Name**: cgcloud\_\_Responsible\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org to which the account task belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Workflow\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Reference to the workflow. This is a calculated field. - **Formula**: cgcloud\_\_Account\_Task\_Template\_\_r.cgcloud\_\_Workflow\_\_r.Name ## 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\_\_Account\_Task\_\_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\_\_Account\_Task\_\_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\_\_Account\_Task\_\_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\_\_Account\_Task\_\_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\_\_Account\_Task\_\_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. # cgcloud\_\_Account\_Task\_Template\_\_c Represents the details of the customer task template to be used for customer tasks. 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**: 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**: 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**: The customer task template is active and can be used for customer task creation. - **Default value**: true ### 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\_\_Management\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Describes the kind of management relationship. - **Possible values**: - CallCenter—Call Center - Consultant—Merchandizer - Sales - Service ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The customer task template that is available for the sales org specified. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sorting order of the customer task template in the overviews. ### cgcloud\_\_User\_Roles\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: User roles that are required for the user when creating calls based on this template. - **Possible values**: - CGCloud\_FA—FA - CGCloud\_FM—FM - CGCloud\_HQ\_Sales\_Manager—Sales Support - CGCloud\_Inventory\_Manager—Inventory Manager - CGCloud\_KAM—KAM - CGCloud\_Master\_Data\_Admin—Business Admin - CGCloud\_Sales\_User—Sales User - CGCloud\_Supervisor—Supervisor ### cgcloud\_\_Workflow\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the workflow. This is a relationship field. - **Relationship Name**: cgcloud\_\_Workflow\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Workflow\_\_c ## Associated Objects ### 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\_Task\_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\_\_Account\_Task\_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\_\_Account\_Task\_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 tracked fields of the object. - **[cgcloud\_\_Account\_Task\_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\_\_Account\_Task\_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. # cgcloud\_\_Account\_Template\_\_c Stores the details of the account template object that's to be used for accounts. 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**: 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 ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Record type of the record. This is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the Customer Template record is active (true) or not (false). - **Default value**: true ### cgcloud\_\_Available\_Product\_Level\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the multiple sets of values that the user can choose, which are further used to aggregate the calculation grid for the account plan. - **Possible values**: - Brand - Category - Flavor—Sub Brand - Package—Product Price Group - SubCategory—Sub Category ### 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\_\_Initial\_Roles\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Set of roles that a new account receives when it's created on the CGCloud Mobility App. - **Possible values**: - customer - deliveryrecipient - order - payer - store ### cgcloud\_\_KPI\_Set\_Plan\_Dependent\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the KPI Set, which has Plan usage and is child object dependent. This is a relationship field. - **Relationship Name**: cgcloud\_\_KPI\_Set\_Plan\_Dependent\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Set\_\_c ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the customer template belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## 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\_\_Account\_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\_\_Account\_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\_\_Account\_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\_\_Account\_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\_\_Account\_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. # cgcloud\_\_Account\_Trade\_Org\_Hierarchy\_\_c This object represents the details of the account hierarchy. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### cgcloud\_\_Child\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Represents the child account. This is a relationship field. - **Relationship Name**: cgcloud\_\_Child\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (Master object) ### cgcloud\_\_Parent\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the parent account. This is a relationship field. - **Relationship Name**: cgcloud\_\_Parent\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the Customer Trade Org Hierarchy record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Date from which the entry is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Date until which the entry is valid. ## 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\_\_Account\_Trade\_Org\_Hierarchy\_\_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\_\_Account\_Trade\_Org\_Hierarchy\_\_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\_\_Account\_Trade\_Org\_Hierarchy\_\_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\_\_Account\_Trade\_Org\_Hierarchy\_\_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\_\_Account\_Trade\_Org\_Hierarchy\_\_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. # cgcloud\_\_Account\_Visit\_Setting\_\_c This object stores the settings for the calls of a user based on a customer. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the entry is active (true) or not (false). - **Default value**: true ### cgcloud\_\_Day\_Of\_Week\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Contains the day of the week that's to be used by the automatic planning algorithm to schedule the call. - **Possible values**: - fri—Friday - mon—Monday - sat—Saturday - sun—Sunday - thu—Thursday - tue—Tuesday - wed—Wednesday ### cgcloud\_\_Duration\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Numeric value that's used to describe the length that a call of the specified category typically takes with the related account. ### cgcloud\_\_Frequency\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Sort, Update - **Description**: Number of weeks between two visits. ### cgcloud\_\_Initial\_Year\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Initial year of the planning. - **Default value**: 2015 - **Possible values**: - 2015 - 2016 - 2017 - 2018 ### cgcloud\_\_Management\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of the management relationship between a user and an account. - **Possible values**: - CallCenter - Consultant - Sales - Service ### cgcloud\_\_Overdue\_Check\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a customer with a particular visit template can be marked as overdue (true) or not (false). - **Default value**: false ### cgcloud\_\_Overdue\_Date\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the date on which the call for a particular visit template is completed. Until this date, the customer is referred to as an overdue customer. ### cgcloud\_\_Planning\_Mode\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Mode of automatic call planning. - **Default value**: StartWeek - **Possible values**: - LastCall—Last Call & Frequency - StartWeek—Start Week - StartWeekYear—Start Week Year ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the Customer Visit Setting record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Start\_Week\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Sort, Update - **Description**: Week of the year to start with automatic call planning. ### cgcloud\_\_Time\_Of\_Day\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Stores the time of day that the automatic planning algorithm uses to schedule the call. ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Date from which the entry is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Date until which the entry is valid. ### cgcloud\_\_Visit\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the visit template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Visit\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Visit\_Template\_\_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\_\_Account\_Visit\_Setting\_\_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\_\_Account\_Visit\_Setting\_\_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\_\_Account\_Visit\_Setting\_\_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\_\_Account\_Visit\_Setting\_\_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\_\_Account\_Visit\_Setting\_\_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. # cgcloud\_\_Approval\_Code\_\_c Represents the attributes for approval code of users. 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**: 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\_\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Approval code of the user. ### cgcloud\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ## Associated Objects ### 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\_\_Approval\_Code\_\_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\_\_Approval\_Code\_\_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\_\_Approval\_Code\_\_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 tracked fields of the object. - **[cgcloud\_\_Approval\_Code\_\_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\_\_Approval\_Code\_\_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. # cgcloud\_\_Asset\_Audit\_\_c Represents the details of an asset survey. 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**: 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. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the customer for whom the survey was conducted. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ### cgcloud\_\_Asset\_Tag\_Number\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Serial number of the asset. ### cgcloud\_\_Asset\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the asset for which the survey was conducted. This is a relationship field. - **Relationship Name**: cgcloud\_\_Asset\_\_r - **Relationship Type**: Lookup - **Refers To**: Asset ### cgcloud\_\_Condition\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the status of the asset at the moment of the survey execution. - **Possible values**: - C—Destroyed - D—Damaged - T—Techn. Defect - W—Working ### cgcloud\_\_Creation\_Date\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date of creation. ### cgcloud\_\_Distribution\_Relevant\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether data correlated with the call needs to be distributed to mobility devices (true) or not (false). - **Default value**: 'true' ### cgcloud\_\_Location\_Rating\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies a rating for the determined location. - **Possible values**: - B—Bad - G—Good - I—Could Be Better ### cgcloud\_\_Location\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the position of the asset with the customer. - **Possible values**: - B—Bar - F—Foyer - M—Main Course - N—See Note - O—Open Air - R—Cash Register ### cgcloud\_\_Method\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies if the audit data record was initiated manually or via barcode scanner. - **Possible values**: - M—Manual - S—Scanner ### cgcloud\_\_Note\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Short note for the survey. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the asset audit detail page. This is a calculated field. - **Formula**: (HYPERLINK('/'&Id, $Label.cgcloud\_\_record\_link, '\_top')) ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Sales Org. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Sighted\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the asset is present (true) or not (false). - **Default value**: 'false' ### cgcloud\_\_Usage\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies how the customer uses the asset. - **Possible values**: - AA—Against Agreement - MA—Misapplication - RI—Correct ### cgcloud\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user who executed the survey. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Visit\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the call on which the survey was conducted. This is a relationship field. - **Relationship Name**: cgcloud\_\_Visit\_\_r - **Relationship Type**: Lookup - **Refers To**: Visit ## Associated Objects ### 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\_\_Asset\_Audit\_\_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\_\_Asset\_Audit\_\_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\_\_Asset\_Audit\_\_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 tracked fields of the object. - **[cgcloud\_\_Asset\_Audit\_\_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\_\_Asset\_Audit\_\_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. # cgcloud\_\_Asset\_Template\_\_c An asset is a physical element that has a certain value which a manufacturer can place at a customer's location (retailer, bar, hotel, shop, and so on), and it can be associated to a POS (such as a shelf, cooler, fridge, and more). 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**: 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**: Active flag. - **Default value**: true ### cgcloud\_\_Blind\_Mode\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the customer’s assets are initially shown. This setting is applicable for mobility devices. - **Default value**: false ### 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\_\_Location\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the location at which the asset is to be used. - **Default value**: INT - **Possible values**: - BAR—Bar - INT—Internal - STR—Street ### cgcloud\_\_Meta\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Type of asset template. - **Default value**: Cooler - **Possible values**: - Cooler - DispensingEquipment—Dispensing Equipment - Freezer - Furniture - IntangibleAssets—Intangible Assets - OutdoorEquipment—Out Door ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org to which the asset template belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Scanner\_Policy\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the asset audit is to be run via a scanner. This setting is applicable for mobility devices. - **Default value**: false ### cgcloud\_\_Scanning\_Required\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the asset audit is to be run via a scanner. This setting is applicable for mobility devices. - **Default value**: false ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sort number. ## 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\_\_Asset\_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\_\_Asset\_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\_\_Asset\_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\_\_Asset\_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\_\_Asset\_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. # cgcloud\_\_Auto\_Number\_Sequence\_\_c Stores information about the numbered index of the next transaction log record. 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 ### 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\_\_Next\_Number\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Contains the numbered index of the next log record. ## 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\_\_Auto\_Number\_Sequence\_\_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\_\_Auto\_Number\_Sequence\_\_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\_\_Auto\_Number\_Sequence\_\_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\_\_Auto\_Number\_Sequence\_\_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\_\_Auto\_Number\_Sequence\_\_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. # cgcloud\_\_Batch\_Last\_Successful\_Run\_\_c Keeps track of the last successful runs. This object is available in API version 55.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**: Unique ID of the user This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### cgcloud\_\_Last\_Run\_Mode\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The mode for which the batch process ran. ### cgcloud\_\_Last\_Successful\_Run\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The time of the last successful run of the batch process. ### cgcloud\_\_Process\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: The process reference ID of the batch. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: The sales org on which the batch process ran. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Unique\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique concatenation of process and sales org. ## Associated Objects ### 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\_\_Batch\_Last\_Successful\_Run\_\_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\_\_Batch\_Last\_Successful\_Run\_\_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\_\_Batch\_Last\_Successful\_Run\_\_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 tracked fields of the object. - **[cgcloud\_\_Batch\_Last\_Successful\_Run\_\_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\_\_Batch\_Last\_Successful\_Run\_\_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. # cgcloud\_\_Batch\_Process\_Configuration\_\_c Custom setting that captures the configuration of the batch process. 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 ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Sort, Update - **Description**: Unique identification of the record. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the setup owner. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ### cgcloud\_\_Apex\_Class\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Batch process class that's to be executed. ### cgcloud\_\_Batch\_Size\_\_c - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: Size of the batch. ### cgcloud\_\_Execute\_Nightly\_Calculation\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Configuration indicating that the TPM Calculation Chain should be initiated once per night. - **Default value**: false ### cgcloud\_\_Friday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Configuration flag, indicating that the Batch Process in context should run on Fridays. - **Default value**: false ### cgcloud\_\_Job\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the Batch Job to be executed. ### cgcloud\_\_Last\_Run\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Time at which the server for this sales org was last started. ### cgcloud\_\_Monday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Configuration flag, indicating that the Batch Process in context should run on Mondays. - **Default value**: false ### cgcloud\_\_Promotion\_Template\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Promotion Template filter, in case of promotion calculations only promotions of this type are calculated. ### cgcloud\_\_Refresh\_Account\_Product\_List\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates the mode of Account Product List. - **Default value**: false ### cgcloud\_\_Run\_Mode\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Determines whether the complex pricing processes run in Delta or Full mode. This field is available in API version 55.0 and later. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Sales Org for which this setting is defined. ### cgcloud\_\_Saturday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Configuration flag, indicating that the Batch Process in context should run on Saturdays. - **Default value**: false ### cgcloud\_\_Start\_Time\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Time at which the server is to be started. Restricted to full hours. It's stored in GMT+0 (UTC) in a 24-hour format. ### cgcloud\_\_Sunday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Configuration flag, indicating that the Batch Process in context should run on Sundays. - **Default value**: false ### cgcloud\_\_Thursday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Configuration flag, indicating that the Batch Process in context should run on Thursdays. - **Default value**: false ### cgcloud\_\_Tuesday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Configuration flag, indicating that the Batch Process in context should run on Tuesdays. - **Default value**: false ### cgcloud\_\_Wednesday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Configuration flag, indicating that the Batch Process in context should run on Wednesdays. - **Default value**: false ## 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\_\_Batch\_Process\_Configuration\_\_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\_\_Batch\_Process\_Configuration\_\_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\_\_Batch\_Process\_Configuration\_\_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\_\_Batch\_Process\_Configuration\_\_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\_\_Batch\_Process\_Configuration\_\_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. # cgcloud\_\_Batch\_Run\_Status\_\_c Keeps track of batch processes. 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\_\_Batch\_Chain\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifies processes that are running in one process chain. ### cgcloud\_\_Batch\_ID\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Identifier of the batch process instance. ### cgcloud\_\_Batch\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Name of the batch process. ### cgcloud\_\_Batch\_State\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: State of the batch process. - **Possible values**: - Done - Error - Fatal - Running ### cgcloud\_\_Batch\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Type of the batch process. - **Possible values**: - APEX - Managed - Web - Worker ### cgcloud\_\_Duration\_Time\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Run time of the batch process in milliseconds. ### cgcloud\_\_End\_Date\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: End date and time of the batch process. ### cgcloud\_\_Items\_Done\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Number of job items that were successfully processed. ### cgcloud\_\_Items\_Error\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Number of job items that were processed with an error. ### cgcloud\_\_Items\_Scheduled\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Number of job items that were scheduled for a job. ### cgcloud\_\_Job\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Job Name under which the process is scheduled. ### cgcloud\_\_Last\_Update\_Date\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Last update date and time of the batch process. ### cgcloud\_\_Process\_Count\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Count of process instances that were involved in the job processing. ### cgcloud\_\_Progress\_Current\_Value\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Last progress update of the batch process. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: SalesOrg context on which the batch process is running. ### cgcloud\_\_Start\_Date\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Start date and time of the batch process. ### cgcloud\_\_Transaction\_ID\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Log transaction ID that's assigned to the batch process. ## 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\_\_Batch\_Run\_Status\_\_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\_\_Batch\_Run\_Status\_\_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\_\_Batch\_Run\_Status\_\_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\_\_Batch\_Run\_Status\_\_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\_\_Batch\_Run\_Status\_\_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. # cgcloud\_\_Batch\_Run\_Status\_Detail\_\_c Collects further batch monitoring details. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### cgcloud\_\_Batch\_Run\_Status\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the main Batch Monitoring record. This is a relationship field. - **Relationship Name**: cgcloud\_\_Batch\_Run\_Status\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Batch\_Run\_Status\_\_c (the master object) ### cgcloud\_\_Detail\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Type of the detail record. - **Possible values**: - Error - KPI - Progress ### cgcloud\_\_Entry\_Date\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: Time stamp of the API call that created this entry. ### cgcloud\_\_Error\_Value\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Error summary that contains information about the issue that a batch process encountered. ### cgcloud\_\_KPI\_Value\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Summary that contains relevant KPIs of the batch process execution. ### cgcloud\_\_Progress\_Value\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Value that indicates the progress of the batch process. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Links to the detail record page. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ## 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\_\_Batch\_Run\_Status\_Detail\_\_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\_\_Batch\_Run\_Status\_Detail\_\_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\_\_Batch\_Run\_Status\_Detail\_\_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\_\_Batch\_Run\_Status\_Detail\_\_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\_\_Batch\_Run\_Status\_Detail\_\_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. # cgcloud\_\_BO\_API\_\_c This table stores the header record of Business Object APIs. 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**: 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\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the Business Object API belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Unique\_Key\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Stores schema constraints. This is a technical field that the workflow updates, and it's unique (case-insensitive). ExternalId. Value: Name+Sales\_Org ## 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\_\_BO\_API\_\_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\_\_BO\_API\_\_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\_\_BO\_API\_\_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\_\_BO\_API\_\_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\_\_BO\_API\_\_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. # cgcloud\_\_BO\_API\_Entity\_\_c This table stores the entity definitions of Business Object APIs. 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**: 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\_\_Description\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Description of the entity. ### cgcloud\_\_Location\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Location of the entity. Input .json file or Output .json file. - **Possible values**: - Input - Output ### cgcloud\_\_Path\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Path of the entity. ### cgcloud\_\_Unique\_Key\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Stores schema constraints. ## 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\_\_BO\_API\_Entity\_\_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\_\_BO\_API\_Entity\_\_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\_\_BO\_API\_Entity\_\_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\_\_BO\_API\_Entity\_\_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\_\_BO\_API\_Entity\_\_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. # cgcloud\_\_BO\_API\_Output\_Entity\_\_c This table stores the output entities of the Business Object API. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### cgcloud\_\_BO\_API\_Entity\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the Business Object API Entity. This is a relationship field. - **Relationship Name**: cgcloud\_\_BO\_API\_Entity\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_BO\_API\_Entity\_\_c (Detail object) ### cgcloud\_\_BO\_API\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the Business Object API record. This is a relationship field. - **Relationship Name**: cgcloud\_\_BO\_API\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_BO\_API\_\_c (Master object) ### cgcloud\_\_Unique\_Key\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Stores schema constraints. ## 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\_\_BO\_API\_Output\_Entity\_\_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\_\_BO\_API\_Output\_Entity\_\_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\_\_BO\_API\_Output\_Entity\_\_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\_\_BO\_API\_Output\_Entity\_\_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\_\_BO\_API\_Output\_Entity\_\_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. # cgcloud\_\_BO\_API\_Step\_Input\_Structure\_\_c This table stores the input structure configuration that the business object API workflow step expects. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: RecordType of the Business Object API Step Input Structure. This is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### cgcloud\_\_BO\_API\_Workflow\_Step\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the business object API workflow step. This is a relationship field. - **Relationship Name**: cgcloud\_\_BO\_API\_Workflow\_Step\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_BO\_API\_Workflow\_Step\_\_c (Master object) ### cgcloud\_\_Description\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores the purpose of the mapped data. ### cgcloud\_\_Maps\_To\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Used for the mapValues rule. Defines the field in the output in which the value is to be mapped. You can specify a list of fields by separating them with commas. Use the <> token to replace it with the required namespace. ### cgcloud\_\_Maximum\_Items\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines the maximum number of items. Shown for RecordType Array. ### cgcloud\_\_Maximum\_Length\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines the maximum length of the String. Shown for RecordType String. ### cgcloud\_\_Maximum\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines the maximum value of the Number. Shown for RecordType Number. ### cgcloud\_\_Minimum\_Items\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines the minimum number of items. Shown for RecordType Array. ### cgcloud\_\_Minimum\_Length\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines the minimum length of the String. Shown for RecordType String. ### cgcloud\_\_Minimum\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines the minimum value of the Number. Shown for RecordType Number. ### cgcloud\_\_Path\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Defines the path of the Input .json file in which the attribute is available. ### cgcloud\_\_Pattern\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Defines the pattern that the String must match. The input must compile to a APEX RegExp. APEX uses the Java RegExp engine. Shown for RecordType String. ### cgcloud\_\_Required\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the property is required. - **Default value**: true ## 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\_\_BO\_API\_Step\_Input\_Structure\_\_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\_\_BO\_API\_Step\_Input\_Structure\_\_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\_\_BO\_API\_Step\_Input\_Structure\_\_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\_\_BO\_API\_Step\_Input\_Structure\_\_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\_\_BO\_API\_Step\_Input\_Structure\_\_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. # cgcloud\_\_BO\_API\_Transaction\_Log\_\_c This object stores information about Business Object API Transaction Log, which is a collection of one or more promotions that should be created or updated under the same name via the Promotion BO Creation API. 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**: Name of this 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\_\_Calculation\_End\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp when off-platform signaled that the calculation was finished (the same timestamp for all promotions of the transaction). ### cgcloud\_\_Calculation\_Schedule\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp when the promotion calculation was scheduled. ### cgcloud\_\_Error\_Information\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Error information. ### cgcloud\_\_Error\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Shows the error type or phase when an error occurred. - **Possible values**: - CalculationError—Calculation Error - EnqueueCalculationError—Enqueue Calculation Error - TransformationError—Transformation Error - ValidationError—Validation Error - WriteError—Write Error ### cgcloud\_\_Input\_Json\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Input .json file that's to be transformed to the promo .json file. ### cgcloud\_\_Number\_of\_Retries\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Stores the number of retries that the system took to properly run the writing of a promotion. ### cgcloud\_\_Output\_Json\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Promo .json file that's to be passed to writeBoPromotion. ### cgcloud\_\_Promotion\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: SFID of the promotion that was either created or updated. The value of this field is set when the promotion is created. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_\_c ### cgcloud\_\_Sales\_Org\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the sales organization. ### cgcloud\_\_Status\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the status of the process. - **Default value**: Initial - **Possible values**: - Calculated - Error - Initial - ToBeCalculated—To be calculated - Written ### cgcloud\_\_Transaction\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents one transaction. For mass-copy or mass-edit, the integration multiple Business Object API Transaction Logs can be executed under the same transaction. ### cgcloud\_\_Workflow\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Explains the various workflows that can be run via the process. This is a relationship field. - **Relationship Name**: cgcloud\_\_Workflow\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_BO\_API\_Workflow\_\_c ### cgcloud\_\_Write\_End\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp when the promotion save process was completed. ### cgcloud\_\_Write\_Start\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp when the promotion save process was started. ## 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\_\_BO\_API\_Transaction\_Log\_\_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\_\_BO\_API\_Transaction\_Log\_\_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\_\_BO\_API\_Transaction\_Log\_\_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\_\_BO\_API\_Transaction\_Log\_\_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\_\_BO\_API\_Transaction\_Log\_\_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. # cgcloud\_\_BO\_API\_Workflow\_\_c This table stores the workflows that are defined for the Business Object. 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**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Name of this record. ### cgcloud\_\_BO\_API\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the Business Object API record. This is a relationship field. - **Relationship Name**: cgcloud\_\_BO\_API\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_BO\_API\_\_c (the master object) ### cgcloud\_\_Description\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: High-level description of the workflow. ### cgcloud\_\_Unique\_Key\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Stores schema constraints. ## 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\_\_BO\_API\_Workflow\_\_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\_\_BO\_API\_Workflow\_\_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\_\_BO\_API\_Workflow\_\_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\_\_BO\_API\_Workflow\_\_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\_\_BO\_API\_Workflow\_\_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. # cgcloud\_\_BO\_API\_Workflow\_Entity\_\_c This object stores the entities that Business Object API Workflows use. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### cgcloud\_\_BO\_API\_Entity\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the business object API entity. This is a relationship field. - **Relationship Name**: cgcloud\_\_BO\_API\_Entity\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_BO\_API\_Entity\_\_c (the master object) ### cgcloud\_\_BO\_API\_Workflow\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the business object API workflow. This is a relationship field. - **Relationship Name**: cgcloud\_\_BO\_API\_Workflow\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_BO\_API\_Workflow\_\_c (the detail object) ### cgcloud\_\_Input\_Mapping\_Field\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the input mapping field. If Output Entity has been set, then this field must also be set. ### cgcloud\_\_Output\_Entity\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the business object API entity. This is a relationship field. - **Relationship Name**: cgcloud\_\_Output\_Entity\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_BO\_API\_Entity\_\_c ### cgcloud\_\_Output\_Mapping\_Field\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the output mapping field. If Output Entity has been set, then this field must also be set. ### cgcloud\_\_Unique\_Key\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Stores schema constraints. This is a technical field that the workflow updates. ## 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\_\_BO\_API\_Workflow\_Entity\_\_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\_\_BO\_API\_Workflow\_Entity\_\_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\_\_BO\_API\_Workflow\_Entity\_\_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\_\_BO\_API\_Workflow\_Entity\_\_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\_\_BO\_API\_Workflow\_Entity\_\_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. # cgcloud\_\_BO\_API\_Workflow\_Step\_\_c This table stores the definitions of the workflow step. 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**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique identification of the record. ### cgcloud\_\_Classname\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Callable class that implements the Workflow Step. ### cgcloud\_\_Description\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: High-level description of the Workflow Step features. ### cgcloud\_\_Entity\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Input or output .json file that this step targets. This is a relationship field. - **Relationship Name**: cgcloud\_\_Entity\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_BO\_API\_Entity\_\_c (Master object) ### cgcloud\_\_Method\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Method that's to be passed to the Workflow Step. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the business object API workflow step applies. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Unique\_Key\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Field stores schema constraints. This is a technical field that the workflow updates. ## 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\_\_BO\_API\_Workflow\_Step\_\_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\_\_BO\_API\_Workflow\_Step\_\_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\_\_BO\_API\_Workflow\_Step\_\_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\_\_BO\_API\_Workflow\_Step\_\_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\_\_BO\_API\_Workflow\_Step\_\_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. # cgcloud\_\_BO\_API\_Workflow\_Workflow\_Step\_\_c This table stores the junction object to identify the workflow steps that apply for each workflow. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### cgcloud\_\_BO\_API\_Workflow\_Step\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the business object API workflow step. This is a relationship field. - **Relationship Name**: cgcloud\_\_BO\_API\_Workflow\_Step\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_BO\_API\_Workflow\_Step\_\_c (Detail object) ### cgcloud\_\_BO\_API\_Workflow\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the business object API workflow. This is a relationship field. - **Relationship Name**: cgcloud\_\_BO\_API\_Workflow\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_BO\_API\_Workflow\_\_c (Master object) ### cgcloud\_\_Enabled\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the Step is enabled to be applied. - **Default value**: true ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines the order in which the Step is to be applied. Steps are run in ascending order. ### cgcloud\_\_Unique\_Key\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Stores schema constraints. This is a technical field that the workflow updates. ### cgcloud\_\_Unique\_Sort\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Technical field that the workflow updates. ## 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\_\_BO\_API\_Workflow\_Workflow\_Step\_\_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\_\_BO\_API\_Workflow\_Workflow\_Step\_\_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\_\_BO\_API\_Workflow\_Workflow\_Step\_\_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\_\_BO\_API\_Workflow\_Workflow\_Step\_\_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\_\_BO\_API\_Workflow\_Workflow\_Step\_\_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. # cgcloud\_\_Business\_Year\_\_c This object stores the attributes of the Business Year. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this 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\_\_Date\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Start date of the Business Year. ### cgcloud\_\_Date\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: End date of the Business Year. ### 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\_\_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\_\_Year\_Number\_\_c ) ### cgcloud\_\_Sales\_Organization\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Describes the Sales Organization to which the Business Year belongs. This is a relationship field. - **Relationship Name**: cgcloud\_\_Sales\_Organization\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Sales\_Organization\_\_c ### cgcloud\_\_Year\_Number\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Year Number that's used for the Business Year. ## 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\_\_Business\_Year\_\_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\_\_Business\_Year\_\_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\_\_Business\_Year\_\_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\_\_Business\_Year\_\_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\_\_Business\_Year\_\_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. # cgcloud\_\_CGCPS\_Service\_Settings\_\_c Use this custom setting to either enable or disable CGCPS service data mocking. With this setting, you can develop non-CGCPS service-enabled orgs. 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 ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Name of this record. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the setup owner. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ### cgcloud\_\_CGCPS\_Service\_Mocking\_Enabled\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: When selected, this setting delivers mock data instead of data from CGCPS service endpoints. Use this setting if your org isn't configured to pull data from CGCPS services. - **Default value**: false ## 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\_\_CGCPS\_Service\_Settings\_\_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\_\_CGCPS\_Service\_Settings\_\_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\_\_CGCPS\_Service\_Settings\_\_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\_\_CGCPS\_Service\_Settings\_\_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\_\_CGCPS\_Service\_Settings\_\_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. # cgcloud\_\_Color\_Schema\_\_c Defines various Sales Organization-dependent property-based color schemes for the Trade Calendar. 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 ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Sort, Update - **Description**: Unique identification of the record. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the setup owner. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ### cgcloud\_\_Color\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Value for which the defined color is used. ### cgcloud\_\_Field\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the promotion field which is used to determine if this color schema should be applied for a promotion bar in the Trade Calendar. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This record will be considered only for Promos of the given Sales\_Organization\_\_c. ### cgcloud\_\_Schema\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the Color Schema to which this record belongs. Groups multiple records together (for example, a phase based color schema TradeCalendar\_Phase will have different color definitions for different promotion phases (planning vs. approved vs. canceled). ### cgcloud\_\_Transparency\_\_c - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Transparency of the Bar in the Trade Calendar of this Schema record is applied to the promotion bar in the trade calendar. ### cgcloud\_\_Value\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Field value of the promotion (in the field 'Field\_Name\_\_c'). If the field value equals this one, this schema record gets applied. ## 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\_\_Color\_Schema\_\_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\_\_Color\_Schema\_\_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\_\_Color\_Schema\_\_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\_\_Color\_Schema\_\_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\_\_Color\_Schema\_\_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. # cgcloud\_\_Condition\_Search\_Group\_\_c Holds the attributes of Condition Search Group. This object is available in API version 55.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**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Required. Default name of this record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Unique ID of the user. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### cgcloud\_\_Aggregation\_Rule\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines how the individual rules of the search group must be aggregated. - **Default value**: Sum - **Possible values**: - Max - Min - Sum ### cgcloud\_\_Description\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Holds the description of language 1. ### cgcloud\_\_Description\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Holds the description of language 2. ### cgcloud\_\_Description\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Holds the description of language 3. ### cgcloud\_\_Description\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Holds the description of language 4. ### cgcloud\_\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description based on the user specific language. This field 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\_\_Group\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the code used in KPI Definition. ## 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\_\_Condition\_Search\_Group\_\_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\_\_Condition\_Search\_Group\_\_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\_\_Condition\_Search\_Group\_\_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 tracked fields of the object. - **[cgcloud\_\_Condition\_Search\_Group\_\_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\_\_Condition\_Search\_Group\_\_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. # cgcloud\_\_Condition\_Search\_Rule\_\_c Holds the attributes of Condition Search Rule. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Account\_Dimension\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the account hierarchical node to start condition search from. - **Default value**: Exact - **Possible values**: - Bottom\_Up - Exact - Not\_Relevant ### cgcloud\_\_Condition\_Anchor\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The source table from which the conditions need to be searched from. - **Default value**: Account\_Product - **Possible values**: - Account - Account\_Product - Product ### cgcloud\_\_Condition\_Search\_Group\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the Condition Search Group object. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Condition\_Search\_Group\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Condition\_Search\_Group\_\_c (the master object) ### cgcloud\_\_Description\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Holds the description of language 1. ### cgcloud\_\_Description\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Holds the description of language 2. ### cgcloud\_\_Description\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Holds the description of language 3. ### cgcloud\_\_Description\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Holds the description of language 4. ### cgcloud\_\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description based on the user specific language. This field 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\_\_Dimension\_Priority\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the search order of the different dimensions. - **Possible values**: - Account\_Product - Product\_Account ### cgcloud\_\_Measure\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Holds the code for the condition type of the conditions records to be retrieved. ### cgcloud\_\_Product\_Dimension\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the product hierarchical node to start condition search from. - **Default value**: Exact - **Possible values**: - Bottom\_Up - Exact - Not\_Relevant ### cgcloud\_\_Search\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the strategy to be used for search conditions across product and account hierarchies. - **Default value**: First\_Hit - **Possible values**: - Collection - First\_Hit ## 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\_\_Condition\_Search\_Rule\_\_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\_\_Condition\_Search\_Rule\_\_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\_\_Condition\_Search\_Rule\_\_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 tracked fields of the object. - **[cgcloud\_\_Condition\_Search\_Rule\_\_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\_\_Condition\_Search\_Rule\_\_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. # cgcloud\_\_Condition\_Template\_\_c Stores the details of the condition template object. 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**: 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**: Active flag. - **Default value**: false ### cgcloud\_\_Customer\_Reference\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Describes whether an account reference exists for the conditions of this template. - **Default value**: false ### 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\_\_Price\_Finding\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID that's used in the code. For example, Product Price or Consumer Price. ### cgcloud\_\_Product\_Reference\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Describes whether a product reference exists for the conditions of this template. - **Default value**: false ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org to which the condition template belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Template\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Used to group conditions. - **Possible values**: - Discount - Factor - Price ### cgcloud\_\_Value\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of the condition value. - **Possible values**: - Amount - Percentage ## 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\_\_Condition\_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\_\_Condition\_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\_\_Condition\_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\_\_Condition\_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\_\_Condition\_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. # cgcloud\_\_Consider\_Default\_SalesOrg\_\_c Use this object to assign Global Sales Org. 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 ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique identification of the record. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the setup owner. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ## 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\_\_Consider\_Default\_SalesOrg\_\_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\_\_Consider\_Default\_SalesOrg\_\_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\_\_Consider\_Default\_SalesOrg\_\_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\_\_Consider\_Default\_SalesOrg\_\_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\_\_Consider\_Default\_SalesOrg\_\_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. # cgcloud\_\_Contract\_\_c Stores the details of the customer contract object, which is used to track various types of customer agreements. 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. ### 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\_\_Account\_Contract\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the contract template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Contract\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Contract\_Template\_\_c ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (Master object) ### cgcloud\_\_Accountable\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: User who's accountable for the customer contract. This is a relationship field. - **Relationship Name**: cgcloud\_\_Accountable\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Commit\_Date\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date on which the contract was committed. ### 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**: Reference to the 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\_\_Initiation\_Date\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date of the entry of the claim. ### cgcloud\_\_Note\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: General notes about the contract. ### cgcloud\_\_Phase\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the current phase of the customer contract process. - **Default value**: Planning - **Possible values**: - Cancelled—Canceled - Committed—Approved - ForApproval—Released - Planning—Initial - Rejected ### cgcloud\_\_Responsible\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: User who's responsible for the customer contract. This is a relationship field. - **Relationship Name**: cgcloud\_\_Responsible\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org to which the contract belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Submitted\_for\_Approval\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Describes whether the contract is submitted for approval. The mobility system (Sync. Purposes) uses this attribute. - **Default value**: false ### cgcloud\_\_Tactics\_Date\_From\_\_c - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: This field is necessary to validate that the dates of tactics are in the correct range. This is a calculated field. ### cgcloud\_\_Tactics\_Date\_Thru\_\_c - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: Calculates the max "Valid\_Thru" date for all the contract tactics related to the contract. This is a calculated field. ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: First date of validity period of the customer contract. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Last date of validity period of the customer contract. ### cgcloud\_\_Workflow\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Name of the workflow that's specified in the contract template. This is a calculated field. - **Formula**: cgcloud\_\_Account\_Contract\_Template\_\_r.cgcloud\_\_Workflow\_\_r.Name ## 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\_\_Contract\_\_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\_\_Contract\_\_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\_\_Contract\_\_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\_\_Contract\_\_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\_\_Contract\_\_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. # cgcloud\_\_Contract\_Payment\_\_c Stores the details of the contract payment object. With this object, you can track the types of customer payment requests that are agreed via a contract. 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. ### 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\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (Master object) ### cgcloud\_\_Accountable\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: User who's accountable for the contract payment. This is a relationship field. - **Relationship Name**: cgcloud\_\_Accountable\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Contract\_Payment\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the contract payment template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Contract\_Payment\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Contract\_Payment\_Template\_\_c ### cgcloud\_\_Currency\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the currency of the order based on the sales org currency of the order template object. This attribute must have the same picklist values as the sales org currency field. - **Possible values**: - CAD - CHF - EUR - GBP - JPY - NOK - RUB - USD ### 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**: Reference to the 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\_\_Initiation\_Date\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date of the entry of the claim. ### cgcloud\_\_Paid\_Amount\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Stores the final paid requested amount. This is a calculated field. ### cgcloud\_\_Phase\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the current phase of the contract payment. - **Default value**: Planning - **Possible values**: - Canceled - Committed—Approved - ForApproval—Released - Planning—Initial - Rejected ### cgcloud\_\_Reference\_Date\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Reference date of the contract payment. ### cgcloud\_\_Requested\_Amount\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Stores the requested total amount. This is a calculated field. ### cgcloud\_\_Responsible\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: User who's responsible for the contract payment. This is a relationship field. - **Relationship Name**: cgcloud\_\_Responsible\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org to which the contract payment belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Submitted\_for\_Approval\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Describes whether the contract is submitted for approval. The mobility system (Sync. Purposes) uses this attribute. - **Default value**: false ### cgcloud\_\_Text\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores the text of a payment request. ### cgcloud\_\_Workflow\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Name of the workflow that's specified in the contract payment template. This is a calculated field. - **Formula**: cgcloud\_\_Contract\_Payment\_Template\_\_r.cgcloud\_\_Workflow\_\_r.Name ## 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\_\_Contract\_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\_\_Contract\_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\_\_Contract\_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\_\_Contract\_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\_\_Contract\_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. # cgcloud\_\_Contract\_Payment\_Tactic\_\_c Stores the details of the relationship between a contract payment and contract tactics. By using this object, you can check the contract tactics for which the payment is applicable after the customer has fulfilled the agreement. 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. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the technical field. This attribute isn't shown in the user interface. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Actual\_Costs\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Describes the proportion of the payment request that's allotted to the tactic. ### cgcloud\_\_Contract\_Payment\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the contract payment. This is a relationship field. - **Relationship Name**: cgcloud\_\_Contract\_Payment\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Contract\_Payment\_\_c (Master object) ### cgcloud\_\_Contract\_Tactic\_Template\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Describes the contract tactic template of the contract tactic. This is a calculated field. - **Formula**: cgcloud\_\_Contract\_Tactic\_\_r.cgcloud\_\_Contract\_Tactic\_Template\_\_r.Name ### cgcloud\_\_Contract\_Tactic\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the contract tactic. This is a relationship field. - **Relationship Name**: cgcloud\_\_Contract\_Tactic\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Contract\_Tactic\_\_c ### cgcloud\_\_Contract\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the contract. This is a relationship field. - **Relationship Name**: cgcloud\_\_Contract\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Contract\_\_c ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the record detail. This is a calculated field. - **Formula**: (HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top")) ### cgcloud\_\_Rejected\_Amount\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Describes the proportion of the payment request that's rejected for the tactic. This is a calculated field. - **Formula**: IF(ISPICKVAL(cgcloud\_\_Status\_\_c , 'FullRejection'), cgcloud\_\_Actual\_Costs\_\_c, 0) ### cgcloud\_\_Status\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates whether the table entry is either new, deleted, or modified. This attribute is used for the replication process. - **Default value**: Approved - **Possible values**: - Approved - FullRejection—Rejected ## 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\_\_Contract\_Payment\_Tactic\_\_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\_\_Contract\_Payment\_Tactic\_\_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\_\_Contract\_Payment\_Tactic\_\_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\_\_Contract\_Payment\_Tactic\_\_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\_\_Contract\_Payment\_Tactic\_\_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. # cgcloud\_\_Contract\_Payment\_Template\_\_c Stores the details of the contract payment template, which is used for contract 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 ### 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**: Active flag. - **Default value**: true ### 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\_\_Meta\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Type of the Payment Template. - **Default value**: ContractPayment - **Possible values**: - ContractPayment—Contract Payment - Payment ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org to which the contract template belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sort number. ### cgcloud\_\_Workflow\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Workflow. This is a relationship field. - **Relationship Name**: cgcloud\_\_Workflow\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Workflow\_\_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\_\_Contract\_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\_\_Contract\_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\_\_Contract\_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\_\_Contract\_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\_\_Contract\_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. # cgcloud\_\_Contract\_Product\_\_c Stores the details of the relationship between a customer contract and a product. With this object, you can capture product-specific agreements that are included in a customer contract. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Amount\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Discount on the promoted product. ### cgcloud\_\_Consumer\_Price\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Promoted price of the product. ### cgcloud\_\_Contract\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Relation to the customer contract. This is a relationship field. - **Relationship Name**: cgcloud\_\_Contract\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Contract\_\_c (Master object) ### cgcloud\_\_Planned\_Quantity\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Incremental quantity that the tactic causes. ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the product. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the customer contract product. This is a calculated field. - **Formula**: (HYPERLINK('/'&Id, $Label.cgcloud\_\_record\_link, '\_top')) ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Reference to the sales org. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## 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\_\_Contract\_Product\_\_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\_\_Contract\_Product\_\_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\_\_Contract\_Product\_\_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\_\_Contract\_Product\_\_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\_\_Contract\_Product\_\_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. # cgcloud\_\_Contract\_Tactic\_\_c Relation between a Contract and a Tactic template. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Active flag. - **Default value**: true ### cgcloud\_\_Contract\_Tactic\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the contract tactic template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Contract\_Tactic\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Contract\_Template\_\_c ### cgcloud\_\_Contract\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the customer contract object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Contract\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Contract\_\_c (Master object) ### cgcloud\_\_Cost\_Amount\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The amount agreed with the customer as a compensation for fulfilling this tactic. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the contract tactic. This is a calculated field. - **Formula**: (HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top")) ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: First date of validity period of the contract tactic. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Last date of validity period of the contract tactic. ## 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\_\_Contract\_Tactic\_\_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\_\_Contract\_Tactic\_\_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\_\_Contract\_Tactic\_\_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\_\_Contract\_Tactic\_\_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\_\_Contract\_Tactic\_\_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. # cgcloud\_\_Contract\_Template\_\_c Contract and Tactic Templates object. 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**: 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 ### 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\_\_Account\_Contract\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the contract template with which the tactic template record is related. Mandatory for the tactic template record type. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Contract\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Contract\_Template\_\_c ### cgcloud\_\_Active\_Policy\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether a contract tactic of this type is initially preset as included in the contract (not considered if the contract tactic is manually added to the promotion). - **Default value**: true ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the template is active. Only active templates can be used for creating customer contracts. - **Default value**: true ### cgcloud\_\_Automatic\_Creation\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Describes whether the customer contract created that's approved with this template leverages the creation of a contract payment. - **Default value**: true ### cgcloud\_\_Copy\_Tactics\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Describes whether the tactics that are created after this tactic template are to be included in the copy of the contract. - **Default value**: false ### 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**: Reference to the 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\_\_Job\_Definition\_List\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the job definition list. This is a relationship field. - **Relationship Name**: cgcloud\_\_Job\_Definition\_List\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Job\_Definition\_List\_\_c ### cgcloud\_\_Max\_Days\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Maximum duration of the contract in days. ### cgcloud\_\_Meta\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Metatype for the integration with the mobile device. - **Possible values**: - CustomerContract—Customer Contract - Tactic ### cgcloud\_\_Min\_Days\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Minimum duration of the contract in days. ### cgcloud\_\_Preset\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Describes whether the Tactic Template is to be preset when creating the contract. If this checkbox is deselected, Tactics are available to manually add after creation. - **Default value**: false ### cgcloud\_\_Product\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the cardinality of the products that are related to the contracts based on this template. - **Default value**: ZeroOrMore - **Possible values**: - No - OneOrMore—One or more - ZeroOrMore—Zero or more ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org to which the contract template belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Sort\_Count\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the sort value. ### cgcloud\_\_Workflow\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Workflow. Mandatory for the contract template record type. This is a relationship field. - **Relationship Name**: cgcloud\_\_Workflow\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Workflow\_\_c ## Associated Objects ### Associated Objects This object has these following 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\_\_Contract\_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\_\_Contract\_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\_\_Contract\_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\_\_Contract\_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\_\_Contract\_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. # cgcloud\_\_CP\_Calculation\_Schema\_\_c The calculation schema object is used for complex pricing. 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**: 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**: Active flag. - **Default value**: false ### 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\_\_Mobility\_Relevant\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the calculation schema is relevant for the handled edition. - **Default value**: false ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the calculation schema record belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sort number. ## 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\_\_CP\_Calculation\_Schema\_\_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\_\_CP\_Calculation\_Schema\_\_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\_\_CP\_Calculation\_Schema\_\_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\_\_CP\_Calculation\_Schema\_\_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\_\_CP\_Calculation\_Schema\_\_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. # cgcloud\_\_CP\_Calculation\_Schema\_Determination\_\_c The calculation schema determination object is used to determine the rule based on order template pricing type and customer pricing type. 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\_Price\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the pricing type of the customer. - **Default value**: 1 - **Possible values**: - 1—Standard - 2—Standard incl. Sales Tax - C—Sample/Donation ### cgcloud\_\_Calculation\_Schema\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the calculation schema. This is a relationship field. - **Relationship Name**: cgcloud\_\_Calculation\_Schema\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Calculation\_Schema\_\_c ### cgcloud\_\_Order\_Price\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the pricing type of the sales document template. - **Default value**: A - **Possible values**: - A—Standard - C—Free of Charge - F—Sample/Donate - Q—Return - T—Refusal - V—Contract ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the calculation schema determination record belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## 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\_\_CP\_Calculation\_Schema\_Determination\_\_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\_\_CP\_Calculation\_Schema\_Determination\_\_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\_\_CP\_Calculation\_Schema\_Determination\_\_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\_\_CP\_Calculation\_Schema\_Determination\_\_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\_\_CP\_Calculation\_Schema\_Determination\_\_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. # cgcloud\_\_CP\_Calculation\_Schema\_Step\_\_c This object stores the details of the relationship between calculation schema and pricing condition template that's used for the calculation steps that belong to a calculation schema. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this record. ### cgcloud\_\_Accrual\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the calculation step is an accrual step. - **Default value**: false ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Active flag. - **Default value**: false ### cgcloud\_\_Base\_User\_Exit\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique identifier for the user exit that modifies the basis value of the calculation. ### cgcloud\_\_Calculation\_Groups\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies all calculation groups that are relevant for the calculation step. - **Possible values**: - A—Delivery - B—Return - C—Return Resale - FreeItem—Free Item ### cgcloud\_\_Calculation\_Schema\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the calculation schema record. This is a relationship field. - **Relationship Name**: cgcloud\_\_Calculation\_Schema\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_CP\_Calculation\_Schema\_\_c (Master object) ### cgcloud\_\_Constraint\_User\_Exit\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique identifier for a user exit that represents a constraint for the required calculation step. ### cgcloud\_\_Interim\_Value\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Auxiliary variable that can be used to either store the result of the step (Copy) or sum up the current item value (carry over) as interim value. - **Possible values**: - CarryOver(1)—Carry Over (1) - CarryOver(2)—Carry Over (2) - CarryOver(3)—Carry Over (3) - CarryOver(4)—Carry Over (4) - CarryOver(5)—Carry Over (5) - CarryOver(6)—Carry Over (6) - Copy1—Copy (D) - Copy2—Copy (E) - Copy3—Copy (F) - Copy4—Copy (G) - Copy5—Copy (H) - Copy6—Copy (I) ### cgcloud\_\_Item\_Meta\_Rule\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies how the rules apply to the order item template. - **Possible values**: - According to Price Effect - All Items (Total) - Delivery (excl. Free Item) - Delivery (incl. Free Item) - Returns Only ### cgcloud\_\_Mandatory\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether a calculation step is mandatory. If no matching condition records are found, the calculation stops with an error message. - **Default value**: false ### cgcloud\_\_Position\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Position of the calculation step within the calculation schema. ### cgcloud\_\_Pricing\_Condition\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the pricing condition template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Pricing\_Condition\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Pricing\_Condition\_Template\_\_c ### cgcloud\_\_Print\_Relevant\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the calculation step is print relevant. - **Default value**: false ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the calculation schema step record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Selectable\_Promotion\_Skip\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Skip the calculation step for an item that originates from a selectable promotion. - **Default value**: false ### cgcloud\_\_Statistical\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the calculation step is a statistical step. - **Default value**: false ### cgcloud\_\_Step\_Constraint\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Defines a constraint for the calculation step. If the constraint isn't fulfilled, the calculation step is skipped. ### cgcloud\_\_Step\_Reference\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the calculation steps that are used as a basis of the current calculation step. ### cgcloud\_\_Step\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Position of the calculation step within the calculation schema. ### cgcloud\_\_Target\_Condition\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specification of either the line item attribute or sales document attribute that receives the value of the found condition. - **Possible values**: - BasePriceReceipt—Base Price (Receipt) - GrossTotalValueReceipt—Gross Total Value (Receipt) - GrossValueReceipt—Gross Value (Receipt) - MerchandiseValueReceipt—Merchandise Value (Receipt) - PriceReceipt—Price (Receipt) - PricingInfo1—Pricing Info 1 - PricingInfo2—Pricing Info 2 - PricingInfo3—Pricing Info 3 - PricingInfo4—Pricing Info 4 - TotalValueReceipt—Total Value (Receipt) - ValueReceipt—Value (Receipt) ### cgcloud\_\_Target\_Result\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specification of either the line item attribute or sales document attribute that receives the result of the current calculation step. - **Possible values**: - BasePriceReceipt—Base Price (Receipt) - GrossTotalValueReceipt—Gross Total Value (Receipt) - GrossValueReceipt—Gross Value (Receipt) - MerchandiseValueReceipt—Merchandise Value (Receipt) - PriceReceipt—Price (Receipt) - PricingInfo1—Pricing Info 1 - PricingInfo2—Pricing Info 2 - PricingInfo3—Pricing Info 3 - PricingInfo4—Pricing Info 4 - TotalValueReceipt—Total Value (Receipt) - ValueReceipt—Value (Receipt) ### cgcloud\_\_User\_Exit\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique identifier for the user exit of the calculation step. ## 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\_\_CP\_Calculation\_Schema\_Step\_\_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\_\_CP\_Calculation\_Schema\_Step\_\_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\_\_CP\_Calculation\_Schema\_Step\_\_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\_\_CP\_Calculation\_Schema\_Step\_\_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\_\_CP\_Calculation\_Schema\_Step\_\_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. # cgcloud\_\_CP\_Key\_Attribute\_\_c The key attribute object is used to determine the complex pricing condition. 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**: 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\_\_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\_\_Mobility\_Attribute\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Textual specification of the attribute name that's taken from the mobility data source used for data determination. ### cgcloud\_\_Mobility\_Entity\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Textual specification of the mobility data source that's used for data determination. ### cgcloud\_\_Object\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specification of the object (module) to which the key attribute mapping belongs. - **Possible values**: - Custom—Auxiliary - Customer - Order - Product ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the key attribute belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## 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\_\_CP\_Key\_Attribute\_\_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\_\_CP\_Key\_Attribute\_\_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\_\_CP\_Key\_Attribute\_\_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\_\_CP\_Key\_Attribute\_\_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\_\_CP\_Key\_Attribute\_\_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. # cgcloud\_\_CP\_Key\_Type\_\_c The key type object is used in the complex pricing search strategy. 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**: 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\_\_Consider\_Account\_Hierarchy\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the condition is to be searched only in the trade org hierarchy of the orderer. - **Default value**: false ### cgcloud\_\_Consider\_Account\_Set\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the business partner set is to be used as a key for condition finding. - **Default value**: false ### cgcloud\_\_Consider\_Account\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the business partner to be be used as a key for condition finding. - **Default value**: false ### cgcloud\_\_Consider\_Product\_Hierarchy\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the condition is to be searched only in the product hierarchy. - **Default value**: false ### cgcloud\_\_Consider\_Product\_Set\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the product set is to be used as a key for condition finding. - **Default value**: false ### cgcloud\_\_Consider\_Promotion\_Rewards\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the reward is to be used as a key for condition finding. - **Default value**: false ### cgcloud\_\_Consider\_Promotion\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether a valid promotion is to be used as a key for condition finding. - **Default value**: false ### cgcloud\_\_Consider\_Sales\_Org\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the sales org is to be used as a key for condition finding. - **Default value**: false ### 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\_\_Distribution\_Category\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the distribution category that's used to replicate the current key type. - **Possible values**: - Customer - To All ### cgcloud\_\_Key\_10\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the mapping of key 10 with the attribute of an object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Key\_10\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Key\_Attribute\_\_c ### cgcloud\_\_Key\_1\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the mapping of key 1 with the attribute of an object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Key\_1\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Key\_Attribute\_\_c ### cgcloud\_\_Key\_2\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the mapping of key 2 with the attribute of an object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Key\_2\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Key\_Attribute\_\_c ### cgcloud\_\_Key\_3\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the mapping of key 3 with the attribute of an object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Key\_3\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Key\_Attribute\_\_c ### cgcloud\_\_Key\_4\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the mapping of key 4 with the attribute of an object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Key\_4\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Key\_Attribute\_\_c ### cgcloud\_\_Key\_5\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the mapping of key 5 with the attribute of an object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Key\_5\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Key\_Attribute\_\_c ### cgcloud\_\_Key\_6\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the mapping of key 6 with the attribute of an object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Key\_6\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Key\_Attribute\_\_c ### cgcloud\_\_Key\_7\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the mapping of key 7 with the attribute of an object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Key\_7\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Key\_Attribute\_\_c ### cgcloud\_\_Key\_8\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the mapping of key 8 with the attribute of an object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Key\_8\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Key\_Attribute\_\_c ### cgcloud\_\_Key\_9\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the mapping of key 9 with the attribute of an object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Key\_9\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Key\_Attribute\_\_c ### cgcloud\_\_Product\_Hierarchy\_Only\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the condition is to be searched only in the product hierarchy. - **Default value**: false ### cgcloud\_\_Replication\_Key\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the part of the merged key that's used to replicate the condition record. - **Default value**: NoReplKey - **Possible values**: - CustHier—Customer Hierarchy - CustSet—Customer Set - Customer - Key1—Key 1 - Key10—Key 10 - Key2—Key 2 - Key3—Key 3 - Key4—Key 4 - Key5—Key 5 - Key6—Key 6 - Key7—Key 7 - Key8—Key 8 - Key9—Key 9 - NoReplKey—No Replication Key - ProdHier—Product Hierarchy - ProdSet—Product Set - Product ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the key type belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Controls the position of condition key types in overviews. ## 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\_\_CP\_Key\_Type\_\_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\_\_CP\_Key\_Type\_\_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\_\_CP\_Key\_Type\_\_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\_\_CP\_Key\_Type\_\_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\_\_CP\_Key\_Type\_\_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. # cgcloud\_\_CP\_Pricing\_Condition\_\_c This object holds the details of the pricing condition object that the Penny Perfect Pricing functionality uses. 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\_Set\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the customer set object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Set\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Account\_Set\_\_c ### cgcloud\_\_Content\_Hash\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The Content Hash to identify the changes made to the Content field. ### cgcloud\_\_Content\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: XML structure with aggregated condition information. ### cgcloud\_\_Deleted\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether a pricing condition has been deleted by the complex pricing batch. This field is available in API version 55.0 and later. - **Default value**: false ### cgcloud\_\_Distribution\_Category\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Advanced pricing condition distribution category. - **Possible values**: - Customer - Product - To All - User ### cgcloud\_\_Key\_Type\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the key type object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Key\_Type\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Key\_Type\_\_c ### cgcloud\_\_Merged\_Key\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Merged key of all key attributes that the key type defines. ### cgcloud\_\_Pricing\_Condition\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the pricing condition template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Pricing\_Condition\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Pricing\_Condition\_Template\_\_c ### cgcloud\_\_Product\_Assortment\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the product assortment object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_Assortment\_\_r - **Relationship Type**: Lookup - **Refers To**: Assortment ### cgcloud\_\_Promotion\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the promotion object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_\_c ### cgcloud\_\_Replication\_Key\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID or value of the record that the staging replication key defines. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org to which the pricing condition belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Unique\_Key\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Key that's used for the upsert process. ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Start period of all conditions that are merged into this condition (earliest one). ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: End period of all conditions that are merged into this condition (oldest one). ## 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\_\_CP\_Pricing\_Condition\_\_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\_\_CP\_Pricing\_Condition\_\_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\_\_CP\_Pricing\_Condition\_\_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\_\_CP\_Pricing\_Condition\_\_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\_\_CP\_Pricing\_Condition\_\_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. # cgcloud\_\_CP\_Pricing\_Condition\_Scale\_Stage\_\_c Staging table for condition scales that complex pricing uses. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this 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\_\_Logistic\_Unit\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Logistic Unit of the free item. - **Possible values**: - ConsumerUnit—Consumer Unit - Layer - Pallet - SalesUnit—Sales Unit ### cgcloud\_\_Position\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Position number that the ERP provides. ### cgcloud\_\_Pricing\_Condition\_Stage\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to Pricing Condition Stage. This is a relationship field. - **Relationship Name**: cgcloud\_\_Pricing\_Condition\_Stage\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Pricing\_Condition\_Stage\_\_c ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to Product. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Rate\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Condition value of the scale range. ### cgcloud\_\_Scale\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines the levels of the scale condition. ### cgcloud\_\_Status\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: State of the pricing condition scale stage. - **Possible values**: - d - n - u ## 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\_\_CP\_Pricing\_Condition\_Scale\_Stage\_\_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\_\_CP\_Pricing\_Condition\_Scale\_Stage\_\_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\_\_CP\_Pricing\_Condition\_Scale\_Stage\_\_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\_\_CP\_Pricing\_Condition\_Scale\_Stage\_\_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\_\_CP\_Pricing\_Condition\_Scale\_Stage\_\_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. # cgcloud\_\_CP\_Pricing\_Condition\_Stage\_\_c Staging table for conditions that complex pricing uses. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of this 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\_Set\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to Customer Set. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Set\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Account\_Set\_\_c ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to Account. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Currency\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Currency of agreement. - **Possible values**: - CAD—Canadian Dollar - CHF—Swiss Franc - EUR—Euro - GBP—Pound Sterling - JPY—Yen - NOK—Norwegian Krone - RUB—Russian Currency - USD—US Dollar ### cgcloud\_\_Denominator\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines a denominator for the condition. ### cgcloud\_\_External\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: SAP or ERP Condition record number. ### cgcloud\_\_Key\_10\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Key of the used Key Type. ### cgcloud\_\_Key\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Key of the used Key Type. ### cgcloud\_\_Key\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Key of the used Key Type. ### cgcloud\_\_Key\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Key of the used Key Type. ### cgcloud\_\_Key\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Key of the used Key Type. ### cgcloud\_\_Key\_5\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Key of the used Key Type. ### cgcloud\_\_Key\_6\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Key of the used Key Type. ### cgcloud\_\_Key\_7\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Key of the used Key Type. ### cgcloud\_\_Key\_8\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Key of the used Key Type. ### cgcloud\_\_Key\_9\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Key of the used Key Type. ### cgcloud\_\_Key\_Type\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to Key Type. This is a relationship field. - **Relationship Name**: cgcloud\_\_Key\_Type\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Key\_Type\_\_c ### cgcloud\_\_Keys\_Hash\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Hash code of all columns that can be used to build the merge key in the target table. ### cgcloud\_\_Logistic\_Unit\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Condition unit. - **Possible values**: - ConsumerUnit—Consumer Unit - Layer - Pallet - SalesUnit—Sales Unit ### cgcloud\_\_Pricing\_Condition\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to Pricing Condition Template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Pricing\_Condition\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Pricing\_Condition\_Template\_\_c ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to Product. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Promotion\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to Promotion. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_\_c ### cgcloud\_\_Reward\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to Reward. This is a relationship field. - **Relationship Name**: cgcloud\_\_Reward\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_Reward\_\_c ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the key condition belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Sort\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Controls the sequence of complex pricing conditions. ### cgcloud\_\_Status\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: State of the pricing condition stage. - **Possible values**: - d - n - u ### cgcloud\_\_Threshold\_Unit\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Unit for which thresholds (scales) are defined. - **Possible values**: - ConsumerUnit—Consumer Unit - Layer - Pallet - SalesUnit—Sales Unit ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date from which the entry is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the entry is valid. ### cgcloud\_\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Condition value (amount or percentage). ## Associated Objects ### Associated Objects This object has these following 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\_\_CP\_Pricing\_Condition\_Stage\_\_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\_\_CP\_Pricing\_Condition\_Stage\_\_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\_\_CP\_Pricing\_Condition\_Stage\_\_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\_\_CP\_Pricing\_Condition\_Stage\_\_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\_\_CP\_Pricing\_Condition\_Stage\_\_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. # cgcloud\_\_CP\_Pricing\_Condition\_Template\_\_c The pricing condition template object is used to define what is to be calculated in a step of a calculation schema. 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**: 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 ### 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\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Active Flag. - **Default value**: false ### cgcloud\_\_Base\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the item or product attribute that is to be used as the base for several pricing functionalities such as scale determination or condition value distribution to items. - **Possible values**: - Quantity - Value - Volume - Weight ### cgcloud\_\_Condition\_Level\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines whether the complex pricing condition type describes header-level or item-level conditions. - **Possible values**: - OrderHeader—Order Header - OrderItem—Order Item ### cgcloud\_\_Decimal\_Places\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the number of remaining decimal places, if rounding applies. - **Possible values**: - 0—None - 1—One - 2—Two - 3—Three - 4—Four - 5—Five - 6—Six ### 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\_\_Distribute\_To\_Item\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the found or calculated condition value is to be distributed among the sales document items. - **Default value**: false ### cgcloud\_\_Item\_Grouping\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies that the condition applies to a group of items (group condition). - **Default value**: false ### cgcloud\_\_Mandatory\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Mandatory flag. - **Default value**: false ### cgcloud\_\_Manual\_Source\_Attribute\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the field from which the manual condition is taken. - **Possible values**: - PricingInfo1—Pricing Info 1 - PricingInfo2—Pricing Info 2 - PricingInfo3—Pricing Info 3 - PricingInfo4—Pricing Info 4 ### cgcloud\_\_Manual\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the condition type requires manual editing of the condition. - **Default value**: false ### cgcloud\_\_Meta\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the meta type of the complex pricing condition template. - **Possible values**: - AddFreeItm—Add Free Item - FixAmount—Amount - FlatRate—Flat Rate - FreeGood—Free Good - LastVldVal—Last Valid Value - Maximum - Minimum - MultiBuy—Multi Buy - Percentage - Price - Summation - UserExit—User Exit Only ### cgcloud\_\_Rounding\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines whether the system rounds the calculation result after the calculation step has been applied. - **Possible values**: - 0—No Rounding - 1—Commercial Rounding - 2—Always Round Up - 3—Always Round Down ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the pricing condition template belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Scale\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether scale conditions apply and, if Scale Type is not empty, how to interpret the scale. - **Possible values**: - From - Graduated - To ### cgcloud\_\_Search\_Strategy\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the search strategy of the calculation schema step. This is a relationship field. - **Relationship Name**: cgcloud\_\_Search\_Strategy\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Search\_Strategy\_\_c ### cgcloud\_\_Sign\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the leading sign of condition values. - **Possible values**: - +—P (Plus) - \-—M (Minus) - N—Not Specified ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Controls the position of templates in overviews and wizards. ### cgcloud\_\_Subtotal\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies the pricing templates that are used to define subtotal condition templates. - **Default value**: false ## 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\_\_CP\_Pricing\_Condition\_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\_\_CP\_Pricing\_Condition\_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\_\_CP\_Pricing\_Condition\_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\_\_CP\_Pricing\_Condition\_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\_\_CP\_Pricing\_Condition\_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. # cgcloud\_\_CP\_Search\_Strategy\_\_c The search strategy object is used to search for complex pricing conditions. 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**: 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**: Active flag. - **Default value**: false ### 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\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the search strategy record belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sort number. ## 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\_\_CP\_Search\_Strategy\_\_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\_\_CP\_Search\_Strategy\_\_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\_\_CP\_Search\_Strategy\_\_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\_\_CP\_Search\_Strategy\_\_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\_\_CP\_Search\_Strategy\_\_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. # cgcloud\_\_CP\_Search\_Strategy\_Step\_\_c This object stores the details of the relationship between search strategy and key type, which is used to search for complex pricing strategy steps. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Account\_Hierarchy\_Search\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies if and how the customer hierarchy is to be considered for condition finding. - **Possible values**: - Complete - CustLevel1—Customer Level 1 - CustLevel2—Customer Level 2 - CustLevel3—Customer Level 3 - CustLevel4—Customer Level 4 - CustLevel5—Customer Level 5 - CustLevel6—Customer Level 6 - CustLevel7—Customer Level 7 - No ### cgcloud\_\_Consider\_Account\_Hierarchy\_\_c - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Specifies if condition will be searched only in the trade org hierarchy of the orderer. This is a calculated field. - **Formula**: cgcloud\_\_Key\_Type\_\_r.cgcloud\_\_Consider\_Account\_Hierarchy\_\_c ### cgcloud\_\_Consider\_Account\_\_c - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Specifies if business partner will be used as key for condition finding. This is a calculated field. - **Formula**: cgcloud\_\_Key\_Type\_\_r.cgcloud\_\_Consider\_Account\_\_c ### cgcloud\_\_Consider\_Product\_Hierarchy\_\_c - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Specifies if condition will be searched only in the product hierarchy. This is a calculated field. - **Formula**: cgcloud\_\_Key\_Type\_\_r.cgcloud\_\_Consider\_Product\_Hierarchy\_\_c ### cgcloud\_\_Constraint\_User\_Exit\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique identifier for a user exit that represents a constraint for the search strategy step in question: Step will be skipped if user exit confirms the fulfilled constraint. ### cgcloud\_\_Customer\_Role\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the role of the customer that's relevant for condition finding. - **Possible values**: - BillTo—Bill To - DeliveryRecipient—Delivery Recipient - Orderer - Payer ### cgcloud\_\_Exclusive\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether condition search stops after having found a condition. - **Default value**: false ### cgcloud\_\_Key\_Type\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description of the reference Key Type. This is a calculated field. - **Formula**: cgcloud\_\_Key\_Type\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Key\_Type\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the key type. This is a relationship field. - **Relationship Name**: cgcloud\_\_Key\_Type\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Key\_Type\_\_c ### cgcloud\_\_Product\_Hierarchy\_Only\_\_c - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Specifies if condition will be searched only in the product hierarchy. This is a calculated field. - **Formula**: cgcloud\_\_Key\_Type\_\_r.cgcloud\_\_Product\_Hierarchy\_Only\_\_c ### cgcloud\_\_Product\_Hierarchy\_Search\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies if and how the product hierarchy is to be considered for condition finding. - **Possible values**: - Complete - No - ProdLevel1—Product Level 1 - ProdLevel2—Product Level 2 - ProdLevel3—Product Level 3 - ProdLevel4—Product Level 4 - ProdLevel5—Product Level 5 ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the search strategy step record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Search\_Strategy\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the search strategy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Search\_Strategy\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_CP\_Search\_Strategy\_\_c (Master object) ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Position of the search strategy step in the search strategy. ## Associated Objects ### Associated Objects This object has these following 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\_\_CP\_Search\_Strategy\_Step\_\_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\_\_CP\_Search\_Strategy\_Step\_\_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\_\_CP\_Search\_Strategy\_Step\_\_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\_\_CP\_Search\_Strategy\_Step\_\_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\_\_CP\_Search\_Strategy\_Step\_\_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. # cgcloud\_\_Custom\_Calendar\_\_c This object stores the attributes of the custom calendar. 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**: The 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\_\_Activated\_By\_Id\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user who activated the custom calendar. This is a relationship field. - **Relationship Name**: cgcloud\_\_Activated\_By\_Id\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Activated\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the timestamp when the custom calendar is activated. ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Reference to the custom calendar that's activated for the sales org. - **Default value**: false ### 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\_\_ExternalId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Stores the unique case-sensitive external ID. ### cgcloud\_\_Last\_Extended\_By\_Id\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user who extended the custom calendar. This is a relationship field. - **Relationship Name**: cgcloud\_\_Last\_Extended\_By\_Id\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Last\_Extended\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the timestamp when the custom calendar was extended. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the custom calendar belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## 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\_\_Custom\_Calendar\_\_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\_\_Custom\_Calendar\_\_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\_\_Custom\_Calendar\_\_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\_\_Custom\_Calendar\_\_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\_\_Custom\_Calendar\_\_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. # cgcloud\_\_Custom\_Period\_\_c This object stores the attributes of the custom period. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Business\_Year\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Business year of the period. ### cgcloud\_\_Custom\_Calendar\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Custom calendar to which the period belongs. This is a relationship field. - **Relationship Name**: cgcloud\_\_Custom\_Calendar\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Custom\_Calendar\_\_c (Master object) ### cgcloud\_\_Date\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Start date of the period. ### cgcloud\_\_Date\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: End date of the period. ### 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\_\_ExternalId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Stores the unique case-sensitive external ID. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Describes the sales organization to which the custom period belongs. This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Custom\_Calendar\_\_r.cgcloud\_\_Sales\_Org\_\_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\_\_Custom\_Period\_\_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\_\_Custom\_Period\_\_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\_\_Custom\_Period\_\_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\_\_Custom\_Period\_\_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\_\_Custom\_Period\_\_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. # cgcloud\_\_Custom\_Permission\_User\_Role\_Mapping\_\_c This object assigns (Mapping) mobility user roles to permission sets. 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\_\_Custom\_Permission\_Name\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the Permission Set. ### cgcloud\_\_Custom\_Permission\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Permission Set. ### cgcloud\_\_User\_Role\_Name\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the Mobility User Role. ## 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\_\_Custom\_Permission\_User\_Role\_Mapping\_\_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\_\_Custom\_Permission\_User\_Role\_Mapping\_\_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\_\_Custom\_Permission\_User\_Role\_Mapping\_\_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\_\_Custom\_Permission\_User\_Role\_Mapping\_\_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\_\_Custom\_Permission\_User\_Role\_Mapping\_\_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. # cgcloud\_\_Data\_Type\_\_c Stores the flexible data type. 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**: 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 ### 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\_\_Append\_Empty\_Item\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the empty item is appended. - **Default value**: false ### cgcloud\_\_Customizable\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: If deselected, data type is used only on Mobility. - **Default value**: true ### cgcloud\_\_Data\_Length\_Decimal\_Places\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Represents the allowed number of decimal places ### cgcloud\_\_Data\_Length\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The length of data that can be entered for the data type. ### cgcloud\_\_Data\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the length of the datatype. - **Possible values**: - Date - Decimal - String - Toggle ### cgcloud\_\_Default\_Value\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Default Value. ### cgcloud\_\_Long\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Speaking name of the datatype. ### cgcloud\_\_Manual\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicator for manual datatypes. - **Default value**: true ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the data type belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## 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\_\_Data\_Type\_\_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\_\_Data\_Type\_\_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\_\_Data\_Type\_\_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\_\_Data\_Type\_\_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\_\_Data\_Type\_\_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. # cgcloud\_\_Data\_Type\_Option\_\_c Stores the item (picklist item) of a flexible data type. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Code\_Uniqueness\_Check\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This field is used internally to ensure that one code (field) is unique within a data type record. The value is set via workflow. It shouldn't be shown to the user. ### cgcloud\_\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Code or value of the data type option. ### cgcloud\_\_Data\_Type\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the Data Type. This is a relationship field. - **Relationship Name**: cgcloud\_\_Data\_Type\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Data\_Type\_\_c (Master object) ### cgcloud\_\_Default\_Item\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the item is a default item. - **Default value**: false ### cgcloud\_\_Description\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description for Language 1. ### cgcloud\_\_Description\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description for Language 2. ### cgcloud\_\_Description\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description for Language 3. ### cgcloud\_\_Description\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description for 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\_\_ImageId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the picture on the mobility device. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Stores the hyperlink of the record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Short\_Description\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Short description for Language 1. ### cgcloud\_\_Short\_Description\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Short description for Language 2. ### cgcloud\_\_Short\_Description\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Short description for Language 3. ### cgcloud\_\_Short\_Description\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Short description for Language 4 ### cgcloud\_\_Short\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Stores the short description. This is a calculated field. - **Formula**: CASE($User.cgcloud\_\_Language\_Postfix\_\_c, "Language1", cgcloud\_\_Short\_Description\_Language\_1\_\_c, "Language2", BLANKVALUE(cgcloud\_\_Short\_Description\_Language\_2\_\_c,cgcloud\_\_Short\_Description\_Language\_1\_\_c), "Language3", BLANKVALUE(cgcloud\_\_Short\_Description\_Language\_3\_\_c,cgcloud\_\_Short\_Description\_Language\_1\_\_c), "Language4", BLANKVALUE(cgcloud\_\_Short\_Description\_Language\_4\_\_c,cgcloud\_\_Short\_Description\_Language\_1\_\_c), cgcloud\_\_Short\_Description\_Language\_1\_\_c) ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sort order ### cgcloud\_\_Unique\_Default\_Option\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This field is used internal to ensure that only one option can be set as default within a data type record. The value would be set via workflow. It should not be shown to the user. ### cgcloud\_\_Validation\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Validation Code. ## Associated Objects ### Associated Objects This object has these following 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\_\_Data\_Type\_Option\_\_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\_\_Data\_Type\_Option\_\_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\_\_Data\_Type\_Option\_\_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\_\_Data\_Type\_Option\_\_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\_\_Data\_Type\_Option\_\_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. # cgcloud\_\_Field\_Sales\_Activity\_\_c Stores the details of the field sales activity object. Field Sales Activity (FSA) covers a set of job definition lists. 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\_\_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\_\_Note\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Note text. ### cgcloud\_\_Phase\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Phase of the field sales activity. - **Default value**: Planning - **Possible values**: - Canceled - Committed - Planning ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org of the template. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date from which the Field Sales Activity is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the Field Sales Activity is valid. ## 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\_\_Field\_Sales\_Activity\_\_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\_\_Field\_Sales\_Activity\_\_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\_\_Field\_Sales\_Activity\_\_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\_\_Field\_Sales\_Activity\_\_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\_\_Field\_Sales\_Activity\_\_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. # cgcloud\_\_Flatten\_Account\_Hierarchy\_\_c This object stores node hierarchy information for the Customer Segmentation functionality. 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. ### cgcloud\_\_Account\_Level\_01\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Account level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Level\_01\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Account\_Level\_02\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Account level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Level\_02\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Account\_Level\_03\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Account level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Level\_03\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Account\_Level\_04\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Account level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Level\_04\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Account\_Level\_05\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Account level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Level\_05\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Account\_Level\_06\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Account level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Level\_06\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Account\_Level\_07\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Account level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Level\_07\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Account\_Level\_08\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Account level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Level\_08\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Account\_Level\_09\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Account level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Level\_09\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Account\_Level\_10\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Account level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Level\_10\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Account\_Level\_11\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Account level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Level\_11\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Account\_Level\_12\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Account level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Level\_12\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Account\_Level\_13\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Account level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Level\_13\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Account\_Level\_14\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Account level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Level\_14\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Account\_Level\_15\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Account level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Level\_15\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the Account of the hierarchy node. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ### cgcloud\_\_Node\_Level\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Reference to the level of the node in the hierarchy. ### cgcloud\_\_Result\_Level\_\_c - **Type**: multipicklist - **Properties**: Create, Defaulted on create, Filter, Nillable, Restricted picklist, Update - **Description**: Defines the level from which to retrieve customers. - **Default value**: Store - **Possible values**: - Store - Trade Org ### cgcloud\_\_UpsertID\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique ID to upsert records from CGCloud Processing Service. ## 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\_\_Flatten\_Account\_Hierarchy\_\_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\_\_Flatten\_Account\_Hierarchy\_\_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\_\_Flatten\_Account\_Hierarchy\_\_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\_\_Flatten\_Account\_Hierarchy\_\_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\_\_Flatten\_Account\_Hierarchy\_\_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. # cgcloud\_\_Flatten\_Org\_Unit\_Hierarchy\_\_c This object stores node org unit hierarchy information for the Customer Segmentation functionality. 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. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Account that's assigned to the org unit of the hierarchy node. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Node\_Level\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Reference to the level of the node in the hierarchy. ### cgcloud\_\_Org\_Unit\_Level\_01\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Org Unit level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Org\_Unit\_Level\_01\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Org\_Unit\_\_c ### cgcloud\_\_Org\_Unit\_Level\_02\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Org Unit level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Org\_Unit\_Level\_02\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Org\_Unit\_\_c ### cgcloud\_\_Org\_Unit\_Level\_03\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Org Unit level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Org\_Unit\_Level\_03\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Org\_Unit\_\_c ### cgcloud\_\_Org\_Unit\_Level\_04\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Org Unit level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Org\_Unit\_Level\_04\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Org\_Unit\_\_c ### cgcloud\_\_Org\_Unit\_Level\_05\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Org Unit level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Org\_Unit\_Level\_05\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Org\_Unit\_\_c ### cgcloud\_\_Org\_Unit\_Level\_06\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Org Unit level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Org\_Unit\_Level\_06\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Org\_Unit\_\_c ### cgcloud\_\_Org\_Unit\_Level\_07\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Org Unit level hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Org\_Unit\_Level\_07\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Org\_Unit\_\_c ### cgcloud\_\_Org\_Unit\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the Org Unit of the hierarchy node. This is a relationship field. - **Relationship Name**: cgcloud\_\_Org\_Unit\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Org\_Unit\_\_c (the master object) ### cgcloud\_\_Result\_Level\_\_c - **Type**: multipicklist - **Properties**: Create, Defaulted on create, Filter, Nillable, Restricted picklist, Update - **Description**: Defines the level from which to retrieve customers. - **Default value**: Store - **Possible values**: - Store - Trade Org ### cgcloud\_\_UpsertID\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique ID to upsert records from CGCloud Processing Service. ## 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\_\_Flatten\_Org\_Unit\_Hierarchy\_\_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\_\_Flatten\_Org\_Unit\_Hierarchy\_\_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\_\_Flatten\_Org\_Unit\_Hierarchy\_\_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\_\_Flatten\_Org\_Unit\_Hierarchy\_\_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\_\_Flatten\_Org\_Unit\_Hierarchy\_\_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. # cgcloud\_\_Fund\_\_c A fund is the amount of money that's given to an employee for a special reason during a specific business period. This money is used to pay special activities such as promotion campaigns. 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 ### 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\_\_Actual\_RBF\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total Actual Rate Based Funding (RBF) that's calculated from Fund Grid. ### cgcloud\_\_Amount\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Fund Amount - Sum of all Transaction.Amount from Transaction\_Row (where Transaction\_Row.Target\_Fund = #Fund#). This is a calculated field. ### cgcloud\_\_Anchor\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to an account. This is a relationship field. - **Relationship Name**: cgcloud\_\_Anchor\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Anchor\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to Product. This is a relationship field. - **Relationship Name**: cgcloud\_\_Anchor\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Available\_to\_Plan\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Represents the sum of the Pending Budget amount minus the Spending (Pending) amount. This is a calculated field. - **Formula**: cgcloud\_\_Pending\_Budget\_\_c + cgcloud\_\_Current\_Budget\_\_c ### cgcloud\_\_Commitments\_Total\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of Spending Committed and LE Spend Pending. This is a calculated field. - **Formula**: cgcloud\_\_Spending\_Committed\_\_c + cgcloud\_\_LE\_Spend\_Pending\_\_c ### cgcloud\_\_Currency\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Fund currency. - **Possible values**: - CAD - CHF - EUR - GBP - JPY - NOK - RUB - USD ### cgcloud\_\_Current\_Balance\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Represents the sum of the Credit/Debit Balance (Approved) amount and the Actual RBF amount This is a calculated field. - **Formula**: cgcloud\_\_Total\_Credits\_Approved\_Earned\_\_c - cgcloud\_\_Total\_Debits\_Approved\_\_c ### cgcloud\_\_Current\_Budget\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Represents the sum of the Current Balance amount and the Actual RBF amount. This is a calculated field. - **Formula**: cgcloud\_\_Current\_Balance\_\_c - cgcloud\_\_Spending\_Committed\_\_c ### cgcloud\_\_Deposits\_Approved\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: This field rolls up Fund transaction Rows in which the transaction type is Deposit. This is a calculated field. ### cgcloud\_\_Deposits\_Pending\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: This field rolls up pending fund transactions (in which Target funds are credited) and sums up the approved amount of Deposits. ### cgcloud\_\_Deposits\_Total\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of Approved Deposits and Pending Deposits. This is a calculated field. - **Formula**: cgcloud\_\_Deposits\_Approved\_\_c + cgcloud\_\_Deposits\_Pending\_\_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. 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\_\_External\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: External ID that's used to maintain unique fund records during data loads. ### cgcloud\_\_Fixed\_Based\_Overdraw\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: This field is used to make this calculation: Deposits (Approved) \* (Fixed-Based Overdraw Allowance/100). ### cgcloud\_\_Fund\_Template\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Stores the description of the selected fund template. 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\_\_Invoice\_Based\_Costs\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of Tactic\_Fund.OI\_Costs\_c of records whose Phase is Committed. This is a calculated field. ### cgcloud\_\_LE\_RBF\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total LE RBF that's calculated from Fund Grid. ### cgcloud\_\_LE\_Revenue\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total LE Revenue that's calculated from Fund Grid. ### cgcloud\_\_LE\_Spend\_Approved\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of Tactic\_Fund.LE\_Spend\_\_c of records whose Phase is Committed. This is a calculated field. ### cgcloud\_\_LE\_Spend\_Pending\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of Tactic\_Fund.LE\_Spend\_\_c of records whose Phase isn't Committed or Cancelled. This is a calculated field. ### cgcloud\_\_LE\_Spend\_Total\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of spend approved and spend pending. This is a calculated field. - **Formula**: cgcloud\_\_LE\_Spend\_Approved\_\_c + cgcloud\_\_LE\_Spend\_Pending\_\_c ### cgcloud\_\_LE\_Volume\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total LE Volume that's calculated from Fund Grid. ### cgcloud\_\_Liabilities\_Accrued\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of Tactic\_Fund.Liabilities\_\_c of records whose Phase is Committed. This is a calculated field. ### cgcloud\_\_Liabilities\_Unpaid\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Liabilities\_Accrued\_\_c minus Payments\_Approved\_\_c. This is a calculated field. - **Formula**: cgcloud\_\_Liabilities\_Accrued\_\_c - cgcloud\_\_Payments\_Approved\_\_c ### cgcloud\_\_Payments\_Approved\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of all Payment\_Tactic\_Fund.Amount from Payment\_Tactic\_Fund (where Payment\_Tactic\_Fund.Payment\_Status = Closed). This is a calculated field. ### cgcloud\_\_Payments\_Pending\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of all Payment\_Tactic\_Fund.Amount from Payment\_Tactic\_Fund (where Payment\_Tactic\_Fund.Payment\_Status <> Closed). This is a calculated field. ### cgcloud\_\_Payments\_Total\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of approved payments and pending payments. This is a calculated field. - **Formula**: cgcloud\_\_Payments\_Approved\_\_c + cgcloud\_\_Payments\_Pending\_\_c ### cgcloud\_\_Payouts\_Approved\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of the Payments (Approved) amount and the Invoice Based Costs amount. This is a calculated field. - **Formula**: cgcloud\_\_Payments\_Approved\_\_c + cgcloud\_\_Invoice\_Based\_Costs\_\_c ### cgcloud\_\_Pending\_Balance\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Represents the sum of the Credit/Debit Balance (Pending) amount and the LE RBF amount. This is a calculated field. - **Formula**: cgcloud\_\_Total\_Credits\_Pending\_Estimated\_\_c - cgcloud\_\_Total\_Debits\_Pending\_\_c ### cgcloud\_\_Pending\_Budget\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Represents the sum of the Pending Balance amount and the Remaining RBF amount. This is a calculated field. - **Formula**: cgcloud\_\_Pending\_Balance\_\_c - cgcloud\_\_LE\_Spend\_Pending\_\_c ### cgcloud\_\_Product\_Count\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Usage in validation rule for one or more products in the related list when locking the fund. This is a calculated field. ### cgcloud\_\_RBF\_Based\_Overdraw\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: This field is to calculate: RBF (Remaining) \* (RBF-Based Overdraw Allowance/ 100). ### cgcloud\_\_Remaining\_RBF\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Difference of LE RBF and Actual RBF. This is a calculated field. - **Formula**: cgcloud\_\_LE\_RBF\_\_c - cgcloud\_\_Actual\_RBF\_\_c ### cgcloud\_\_Sales\_Org\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Sales org of the fund. This is a calculated field. - **Formula**: TEXT( cgcloud\_\_Fund\_Template\_\_r.cgcloud\_\_Sales\_Org\_\_c ) ### cgcloud\_\_Spending\_Committed\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of Tactic\_Fund.LE\_Spend\_\_c of records whose Phase is Committed minus the sum of Payment\_Tactic\_Funds.Payment\_Status\_\_c of records whose Payments\_Status\_\_c is Closed. This is a calculated field. - **Formula**: cgcloud\_\_LE\_Spend\_Approved\_\_c - cgcloud\_\_Payouts\_Approved\_\_c ### cgcloud\_\_Status\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Determines the status of the fund. - **Default value**: Active - **Possible values**: - Active - Closed - Initial - On Hold ### cgcloud\_\_Total\_Available\_Overdraw\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: This field is calculate: Fixed-Based Overdraw + RBF-Based Overdraw. This is a calculated field. - **Formula**: cgcloud\_\_Fixed\_Based\_Overdraw\_\_c + cgcloud\_\_RBF\_Based\_Overdraw\_\_c ### cgcloud\_\_Total\_Balance\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of the current balance and pending balance. This is a calculated field. - **Formula**: cgcloud\_\_Current\_Balance\_\_c + cgcloud\_\_Pending\_Balance\_\_c ### cgcloud\_\_Total\_Budget\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of the current budget and pending budget. This is a calculated field. - **Formula**: cgcloud\_\_Current\_Budget\_\_c + cgcloud\_\_Pending\_Budget\_\_c ### cgcloud\_\_Total\_Credits\_Approved\_Earned\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Represents the sum of the Deposits (Approved) amount and the Actual RBF amount. This is a calculated field. - **Formula**: cgcloud\_\_Deposits\_Approved\_\_c + cgcloud\_\_Actual\_RBF\_\_c ### cgcloud\_\_Total\_Credits\_Pending\_Estimated\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Represents the sum of the Deposits (Pending) amount and the LE RBF amount. This is a calculated field. - **Formula**: cgcloud\_\_Deposits\_Pending\_\_c + cgcloud\_\_Remaining\_RBF\_\_c ### cgcloud\_\_Total\_Debits\_Approved\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Represents the sum of the Withdraws/Payments (Approved) amount and the Invoice Based Costs amount. This is a calculated field. - **Formula**: cgcloud\_\_Withdraws\_Payments\_Approved\_\_c + cgcloud\_\_Invoice\_Based\_Costs\_\_c ### cgcloud\_\_Total\_Debits\_Pending\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Represents the sum of the Withdraws/Payments (Pending) amount and the Invoice-Based Costs amount. This is a calculated field. - **Formula**: cgcloud\_\_Withdraws\_Pending\_\_c + cgcloud\_\_Payments\_Pending\_\_c ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date from which the fund is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the fund is valid. ### cgcloud\_\_Withdraws\_Approved\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: This field rolls up Fund transaction Rows for which transaction type is Withdraws. This is a calculated field. ### cgcloud\_\_Withdraws\_Payments\_Approved\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Represents the sum of the Withdraws (Approved) amount and the Payments (Approved) amount. This is a calculated field. - **Formula**: cgcloud\_\_Withdraws\_Approved\_\_c + cgcloud\_\_Payments\_Approved\_\_c ### cgcloud\_\_Withdraws\_Pending\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: This field rolls up pending fund transactions (in which Target funds are debited) and sums up the approved Withdraws amount. ### cgcloud\_\_Withdraws\_Total\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of the Withdraws (Approved) amount and the Payments (Approved) amount. This is a calculated field. - **Formula**: cgcloud\_\_Withdraws\_Approved\_\_c + cgcloud\_\_Withdraws\_Pending\_\_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\_\_Fund\_\_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\_\_Fund\_\_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\_\_Fund\_\_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\_\_Fund\_\_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\_\_Fund\_\_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. # cgcloud\_\_Fund\_Product\_\_c A Fund object can be linked to multiple brands or categories based on the fund template settings. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Fund\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Fund record associated with the Product record. This is a relationship field. - **Relationship Name**: cgcloud\_\_Fund\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Fund\_\_c (master object) ### cgcloud\_\_Product\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Associated product description. This is a calculated field. - **Formula**: HYPERLINK("/one/one.app#/sObject/" & cgcloud\_\_Product\_\_c & "/view", cgcloud\_\_Product\_\_r.cgcloud\_\_Description\_1\_\_c ) ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Product record associated with the Fund record. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ## Associated Objects ### 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\_\_Fund\_Product\_\_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\_\_Fund\_Product\_\_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\_\_Fund\_Product\_\_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 tracked fields of the object. - **[cgcloud\_\_Fund\_Product\_\_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\_\_Fund\_Product\_\_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. # cgcloud\_\_Fund\_Template\_\_c Template for the creation of a Fund. 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**: 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**: Determines whether the template is active. - **Default value**: true ### cgcloud\_\_Actual\_RBF\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: KPI definition that's used for the Actual RBF Total KPI. This is a relationship field. - **Relationship Name**: cgcloud\_\_Actual\_RBF\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Anchor\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the anchor type of the fund. - **Default value**: Customer - **Possible values**: - Customer - Customer Product ### cgcloud\_\_Currency\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Currency of the sales organization that's linked to this Fund Template. - **Possible values**: - CAD—Canadian Dollar - CHF—Swiss Franc - EUR—Euro - GBP—Pound Sterling - JPY—Yen - NOK—Norwegian Krone - RUB—Russian Currency - USD—US Dollar ### 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**: Stores the description of the template. 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\_\_Fund\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Controls the Level of the Product Anchor (if any) of the Fund. - **Possible values**: - Brand - Category ### cgcloud\_\_KPI\_Set\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: KPI Set that's associated with the Fund Template. The KPI sets that are associated with Fund Templates can't be deleted. 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**: This subset helps filter KPI Definitions in the GridHierarchyView component. If you don't select a filter, no subset filter is applied. - **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\_\_LE\_RBF\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: KPI definition that's used for the LE RBF Total KPI. This is a relationship field. - **Relationship Name**: cgcloud\_\_LE\_RBF\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_LE\_Revenue\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: KPI definition that's used for the LE Revenue Total KPI. This is a relationship field. - **Relationship Name**: cgcloud\_\_LE\_Revenue\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_LE\_Volume\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: KPI definition that's used for the LE Volume Total KPI. This is a relationship field. - **Relationship Name**: cgcloud\_\_LE\_Volume\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Product\_Anchor\_Level\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Controls the Level of the Product Anchor (if any) of the Fund. - **Possible values**: - Brand - Category ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org of the template. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the Sort number. ## 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\_\_Fund\_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\_\_Fund\_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\_\_Fund\_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\_\_Fund\_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\_\_Fund\_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. # cgcloud\_\_Fund\_Transaction\_\_c Holds the fund transaction details. 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. ### cgcloud\_\_Amount\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Transaction amount. ### cgcloud\_\_Anchor\_Customer\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Shows the anchor customer from the Fund object. This is a calculated field. - **Formula**: CASE( cgcloud\_\_Transaction\_Type\_\_c , 'Drawback', cgcloud\_\_Source\_Fund\_\_r.cgcloud\_\_Anchor\_Account\_\_r.Name, cgcloud\_\_Target\_Fund\_\_r.cgcloud\_\_Anchor\_Account\_\_r.Name) ### cgcloud\_\_Currency\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Holds the currency set by the template selected based on the sales org. - **Possible values**: - CAD - CHF - EUR - GBP - JPY - NOK - RUB - USD ### cgcloud\_\_Date\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Transaction date. ### cgcloud\_\_Fund\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Shows the fund description. This is a calculated field. - **Formula**: CASE( cgcloud\_\_Transaction\_Type\_\_c , 'Drawback', HYPERLINK("/one/one.app#/sObject/" & cgcloud\_\_Source\_Fund\_\_c & "/view", cgcloud\_\_Source\_Fund\_\_r.cgcloud\_\_Description\_\_c ), HYPERLINK("/one/one.app#/sObject/" & cgcloud\_\_Target\_Fund\_\_c & "/view", cgcloud\_\_Target\_Fund\_\_r.cgcloud\_\_Description\_\_c )) ### cgcloud\_\_Fund\_Transaction\_Header\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to the fund transaction header that dictates the behavior of the fund transaction rows to be created. This is a relationship field. - **Relationship Name**: cgcloud\_\_Fund\_Transaction\_Header\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Fund\_Transaction\_Header\_\_c ### cgcloud\_\_Fund\_Transaction\_Template\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description of the Transaction template. This is a calculated field. - **Formula**: cgcloud\_\_Fund\_Transaction\_Template\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Fund\_Transaction\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Transaction template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Fund\_Transaction\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Fund\_Transaction\_Template\_\_c ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Record link. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Source\_Fund\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Source fund for the transaction. This is a relationship field. - **Relationship Name**: cgcloud\_\_Source\_Fund\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Fund\_\_c ### cgcloud\_\_Status\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Approval status of the fund transactions. - **Default value**: Pending - **Possible values**: - Approved - Cancelled - Pending ### cgcloud\_\_Target\_Fund\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Target fund for the transaction. This is a relationship field. - **Relationship Name**: cgcloud\_\_Target\_Fund\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Fund\_\_c (master object) ### cgcloud\_\_Transaction\_Type\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Holds the transaction type of the selected fund transaction template. This is a calculated field. - **Formula**: Text(cgcloud\_\_Fund\_Transaction\_Template\_\_r.cgcloud\_\_Transaction\_Type\_\_c) ## Associated Objects ### 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\_\_Fund\_Transaction\_\_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\_\_Fund\_Transaction\_\_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\_\_Fund\_Transaction\_\_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 tracked fields of the object. - **[cgcloud\_\_Fund\_Transaction\_\_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\_\_Fund\_Transaction\_\_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. # cgcloud\_\_Fund\_Transaction\_Header\_\_c Fund Transaction Header object facilitates the creation of multiple fund transactions in either a multiple source or target fund business scenario. This object dictates key fields such as the fund transaction template. The source or target funds for the fund transaction records to be created are based on transaction types such as Transfer, drawback, and more. 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 ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of the multi-fund transaction. This is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### cgcloud\_\_Amount\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Sum of the amount of all related transactions. ### cgcloud\_\_Currency\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Stores the Currency set by the selected template based on Sales Org. - **Possible values**: - CAD—Canadian Dollar - CHF—Swiss Franc - EUR—Euro - GBP—Pound Sterling - JPY—Yen - NOK—Norwegian Krone - RUB—Russian Currency - USD—US Dollar ### cgcloud\_\_Fund\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Stores the description of the selected source or target fund, where applicable,. This is a calculated field. - **Formula**: CASE( cgcloud\_\_Transaction\_Type\_\_c , 'Drawback', cgcloud\_\_Target\_Fund\_\_r.cgcloud\_\_Description\_\_c , cgcloud\_\_Source\_Fund\_\_r.cgcloud\_\_Description\_\_c) ### cgcloud\_\_Fund\_Transaction\_Template\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description value of the transaction's related Fund Transaction Template. This is a calculated field. - **Formula**: cgcloud\_\_Fund\_Transaction\_Template\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Fund\_Transaction\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Fund Transaction Template that dictates the behavior of related transactions based on the template's Transaction Type. This is a relationship field. - **Relationship Name**: cgcloud\_\_Fund\_Transaction\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Fund\_Transaction\_Template\_\_c ### cgcloud\_\_Source\_Fund\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Source Fund to be selected for transactions based on Template Transaction Type. This is a relationship field. - **Relationship Name**: cgcloud\_\_Source\_Fund\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Fund\_\_c ### cgcloud\_\_Status\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Status field for the fund transaction header. - **Default value**: Pending - **Possible values**: - Approved - Cancelled - Pending ### cgcloud\_\_Target\_Fund\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Source Fund to be selected for transactions based on Template Transaction Type. This is a relationship field. - **Relationship Name**: cgcloud\_\_Target\_Fund\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Fund\_\_c ### cgcloud\_\_Transaction\_Date\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date of the transaction. ### cgcloud\_\_Transaction\_Type\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Stores the transaction type of the selected fund transaction template. This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Fund\_Transaction\_Template\_\_r.cgcloud\_\_Transaction\_Type\_\_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\_\_Fund\_Transaction\_Header\_\_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\_\_Fund\_Transaction\_Header\_\_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\_\_Fund\_Transaction\_Header\_\_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\_\_Fund\_Transaction\_Header\_\_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\_\_Fund\_Transaction\_Header\_\_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. # cgcloud\_\_Fund\_Transaction\_Row\_\_c Transaction rows for the funds. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Amount\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Transaction amount. ### cgcloud\_\_Currency\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Transaction currency. This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Fund\_Transaction\_\_r.cgcloud\_\_Currency\_\_c) ### cgcloud\_\_Fund\_Transaction\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the custom field that stores the transaction name for which transaction rows are created. This is a relationship field. - **Relationship Name**: cgcloud\_\_Fund\_Transaction\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Fund\_Transaction\_\_c (master object) ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link of the record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Source\_Fund\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the source fund of the transaction. This is a relationship field. - **Relationship Name**: cgcloud\_\_Source\_Fund\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Fund\_\_c ### cgcloud\_\_Target\_Fund\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the target fund of the transaction. This is a relationship field. - **Relationship Name**: cgcloud\_\_Target\_Fund\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Fund\_\_c (the detail object) ### cgcloud\_\_Transaction\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: This field identifies a transaction row of type Deposit or Withdraw based on either the credit or debit transaction on the target fund of the record. For example, a negative transaction on the target fund identifies a transaction row as a Withdraw type of transaction. - **Possible values**: - Deposit - Withdraw ## 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\_\_Fund\_Transaction\_Row\_\_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\_\_Fund\_Transaction\_Row\_\_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\_\_Fund\_Transaction\_Row\_\_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\_\_Fund\_Transaction\_Row\_\_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\_\_Fund\_Transaction\_Row\_\_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. # cgcloud\_\_Fund\_Transaction\_Template\_\_c Template for the creation of a transaction for the Fund. 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**: 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**: Determines whether the template is active. - **Default value**: true ### cgcloud\_\_Currency\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Currency of the sales organization that's linked to this Fund Transaction Template. - **Possible values**: - CAD—Canadian Dollar - CHF—Swiss Franc - EUR—Euro - GBP—Pound Sterling - JPY—Yen - NOK—Norwegian Krone - RUB—Russian Currency - USD—US Dollar ### 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**: Stores the description. 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\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org of the Transaction template. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sort number. ### cgcloud\_\_Transaction\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the transaction type of the selected fund transaction template. - **Default value**: Initial - **Possible values**: - Adjustment - Drawback - Initial - Transfer ## 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\_\_Fund\_Transaction\_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\_\_Fund\_Transaction\_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\_\_Fund\_Transaction\_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\_\_Fund\_Transaction\_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\_\_Fund\_Transaction\_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. # cgcloud\_\_Historic\_Product\_\_c Junction object between the Customer (Account) and Product (Product\_\_c) objects. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (Master object) ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the product. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the Detail page of the historic product record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, /\*IMAGE("/img/func\_icons/util/lookup20.gif", "View")\*/"View", "\_top") ### cgcloud\_\_Visit\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the visit template-specific surveyed product (optional). This is a relationship field. - **Relationship Name**: cgcloud\_\_Visit\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Visit\_Template\_\_c ## Associated Objects ### 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\_\_Historic\_Product\_\_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\_\_Historic\_Product\_\_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\_\_Historic\_Product\_\_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 tracked fields of the object. - **[cgcloud\_\_Historic\_Product\_\_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\_\_Historic\_Product\_\_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. # cgcloud\_\_Inventory\_\_c Stores the details of the inventory object. 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 ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the Record Type. This is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the account. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Balance\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Balance of the inventory. This is a calculated field. ### cgcloud\_\_Currency\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Relevant currency of the inventory. - **Possible values**: - CAD - CHF - EUR - GBP - JPY - NOK - RUB - USD ### 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\_\_Initial\_Inventory\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Attribute that controls whether the system automatically creates an initial transaction for this inventory. ### cgcloud\_\_Invalid\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the Inventory is valid. - **Default value**: false ### cgcloud\_\_Inventory\_Control\_Measure\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Inventory control measure of the inventory control template. This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Inventory\_Template\_\_r.cgcloud\_\_Inventory\_Control\_Measure\_\_c) ### cgcloud\_\_Inventory\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the inventory control template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Inventory\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Inventory\_Control\_Template\_\_c ### cgcloud\_\_Phase\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the phase of the inventory. - **Default value**: Active - **Possible values**: - Active - Closed ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the product. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Quota\_Type\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Quote type of the inventory control template. This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Inventory\_Template\_\_r.cgcloud\_\_Quota\_Type\_\_c) ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org of the template. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Tour\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the tour. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tour\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Tour\_\_c ### cgcloud\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Inventory valid from date. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Inventory valid thru date. ### cgcloud\_\_Vehicle\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the vehicle. This is a relationship field. - **Relationship Name**: cgcloud\_\_Vehicle\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Vehicle\_\_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\_\_Inventory\_\_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\_\_Inventory\_\_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\_\_Inventory\_\_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\_\_Inventory\_\_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\_\_Inventory\_\_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. # cgcloud\_\_Inventory\_Control\_Template\_\_c Stores the details of the inventory control template that's to be used for inventories. 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**: 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 ### 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\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the template is active. - **Default value**: true ### cgcloud\_\_Customer\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines whether inventories based on this template are associated to a customer. - **Default value**: None - **Possible values**: - None - One ### 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\_\_Inventory\_Control\_Measure\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Unit of measure that's defined for the inventory control. - **Default value**: Qty/Consumer Unit - **Possible values**: - Qty/Consumer Unit - Qty/Order Unit - Value/Domestic Currency ### cgcloud\_\_Period\_Policy\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a period assignment for the inventory control is required. - **Default value**: false ### cgcloud\_\_Period\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Applicable period for the inventory control record. - **Default value**: Year - **Possible values**: - Month - Period - Quarter - Sales Cycle - Segment - Week - Year ### cgcloud\_\_Product\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines whether inventories based on this template are associated to a product. - **Default value**: None - **Possible values**: - None - One ### cgcloud\_\_Quota\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Applicable quota type for the inventory control. - **Default value**: Transfer Quota - **Possible values**: - Reception Quota - Transfer Quota ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the Sales Organization in which the template can be used. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Tour\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines whether inventories based on this template are associated to a tour. - **Default value**: None - **Possible values**: - None - One ### cgcloud\_\_Use\_Description\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether the language dependent description can be filled. If the description isn't allowed, the system doesn't create a text record for the inventory transaction. - **Default value**: false ### cgcloud\_\_User\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines whether inventories based on this template are associated to a user. - **Default value**: None - **Possible values**: - None - One ### cgcloud\_\_Vehicle\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines whether inventories based on this template are associated to a vehicle. - **Default value**: None - **Possible values**: - None - One ## 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\_\_Inventory\_Control\_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\_\_Inventory\_Control\_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\_\_Inventory\_Control\_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\_\_Inventory\_Control\_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\_\_Inventory\_Control\_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. # cgcloud\_\_Inventory\_Transaction\_\_c Captures Inventory Transaction records. 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. ### cgcloud\_\_Accounted\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is already considered for updating the Balance record. - **Default value**: false ### cgcloud\_\_Allow\_Manual\_Creation\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether it's possible to manually create the initial inventory and Balance record. - **Default value**: false ### cgcloud\_\_Amount\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Amount of the transaction. ### cgcloud\_\_Balance\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: This technical field is created to update the Total balance value in Inventory (Roll-up Summary field). The checkbox value is updated by updating the workflow field. - **Default value**: false ### cgcloud\_\_Charge\_Date\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date on which the inventory is to be physically charged by this transaction. ### cgcloud\_\_Creation\_Date\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date on which the inventory is created. ### cgcloud\_\_Currency\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the currency of the cash inventory. - **Possible values**: - CAD - CHF - EUR - GBP - JPY - NOK - RUB - USD ### cgcloud\_\_Inventory\_Transaction\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the inventory transaction template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Inventory\_Transaction\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Inventory\_Transaction\_Template\_\_c ### cgcloud\_\_Inventory\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the inventory. This is a relationship field. - **Relationship Name**: cgcloud\_\_Inventory\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Inventory\_\_c (the master object) ### cgcloud\_\_Order\_Document\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the order document. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_Document\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Order\_\_c ### cgcloud\_\_Order\_Item\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the order item for a product-related transaction. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_Item\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Order\_Item\_\_c ### cgcloud\_\_Order\_Payment\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References to the ID of the order payment related to the inventory transaction. This field is a relationship field. This field is available in API version 55.0 and later. - **Relationship Name**: cgcloud\_\_Order\_Payment\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Order\_Payment\_\_c ### cgcloud\_\_Payment\_Method\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the payment method for the cash transaction. - **Possible values**: - Cash - Check - CreditCard - DebitCard - Deduction - Expense - MoneyOrder - Multiple ## 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\_\_Inventory\_Transaction\_\_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\_\_Inventory\_Transaction\_\_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\_\_Inventory\_Transaction\_\_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\_\_Inventory\_Transaction\_\_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\_\_Inventory\_Transaction\_\_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. # cgcloud\_\_Inventory\_Transaction\_Template\_\_c Stores the details of the inventory control template that's to be used for inventory control transactions. 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**: 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**: Determines whether the template is active. - **Default value**: true ### 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**: Reference to the 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\_\_Initial\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the transaction is an initial transaction. - **Default value**: false ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the Sales Organization in which the template can be used. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Transaction\_Control\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the transaction behavior. - **Default value**: add - **Possible values**: - Add - Audit - Current - Current to Orderer - Neutral - Orderer to Current - Withdraw ### cgcloud\_\_Transaction\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the transaction type. - **Default value**: Addition - **Possible values**: - Addition - Balance - Void - Withdrawal ### cgcloud\_\_Use\_Inventory\_Reference\_1\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Use Inventory Reference 1. - **Default value**: false ### cgcloud\_\_Use\_Inventory\_Reference\_2\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Use Inventory Reference 2. - **Default value**: false ### cgcloud\_\_Use\_Inventory\_Reference\_3\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Use Inventory Reference 3. - **Default value**: false ### cgcloud\_\_Use\_Inventory\_Reference\_4\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Use Inventory Reference 4. - **Default value**: false ### cgcloud\_\_Use\_Inventory\_Reference\_5\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Use Inventory Reference 5. - **Default value**: false ## 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\_\_Inventory\_Transaction\_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\_\_Inventory\_Transaction\_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\_\_Inventory\_Transaction\_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\_\_Inventory\_Transaction\_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\_\_Inventory\_Transaction\_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. # cgcloud\_\_Job\_Definition\_List\_\_c Stores the set of questions or surveys that are to be carried out in the respective call and contains further relevant configurations. 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**: 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 ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the record type.Available record types: - FSA.JDL - JDL This is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates that the activity is available for use. - **Default value**: true ### cgcloud\_\_Activity\_Question\_Score\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of scores of the questions in the activity. This is a calculated field. ### cgcloud\_\_Activity\_Score\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Activity Score that's to be considered for activity performance evaluation on Mobility. ### cgcloud\_\_Approval\_State\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether the activity is created by a field sales activity. The activity can be either valid (Approved), canceled via field sales activity (Canceled), or independent of a field sales activity (NotRelevant). - **Default value**: Not Relevant - **Possible values**: - Approved - Canceled - Not Relevant ### cgcloud\_\_Consider\_Account\_\_c - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Relevant for Standard activity: Restricted to Customers. This is a calculated field. - **Formula**: cgcloud\_\_Job\_Definition\_List\_Template\_\_r.cgcloud\_\_Consider\_Account\_\_c ### cgcloud\_\_Consider\_History\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: If yes, the system determines historic products for product surveys. - **Default value**: false ### cgcloud\_\_Consider\_Listing\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: If yes, the system determines listed products for product surveys. - **Default value**: false ### cgcloud\_\_Consider\_Products\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: If yes, the system determines products that are directly assigned to the activity for product surveys. - **Default value**: false ### cgcloud\_\_Consider\_Score\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates whether the activity is score relevant. - **Default value**: No - **Possible values**: - No - Yes ### cgcloud\_\_Default\_Management\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the default management type that's to be considered during the user determination process while creating job lists out of non-standard activity. - **Possible values**: - Consultant - Sales - Service ### 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**: Formula field for description. 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\_\_Field\_Sales\_Activity\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to a field sales activity. Empty for a stand alone activity. This is a relationship field. - **Relationship Name**: cgcloud\_\_Field\_Sales\_Activity\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Field\_Sales\_Activity\_\_c ### cgcloud\_\_Job\_Definition\_List\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the activity template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Job\_Definition\_List\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Job\_Definition\_List\_Template\_\_c ### cgcloud\_\_Mark\_for\_Deletion\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Deletion flag. Users who maintain job definition lists can mark the job definition list for deletion. The system administrator have the permissions to delete the activity. - **Default value**: false ### cgcloud\_\_Promotion\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the promotion name. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_\_c ### cgcloud\_\_Restrict\_Org\_Unit\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Controls the determination of valid users that are restricted to the org unit assigned to the customer when creating job list out of a non-standard activity. - **Possible values**: - All - Main ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales organization to which the activity belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Standard\_Jobs\_\_c - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: If yes, specifies a Standard activity. This is a calculated field. - **Formula**: cgcloud\_\_Job\_Definition\_List\_Template\_\_r.cgcloud\_\_Standard\_Jobs\_\_c ### cgcloud\_\_Threshold\_Fulfilled\_\_c - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines the upper threshold limit for the activity score. ### cgcloud\_\_Threshold\_Partially\_Fulfilled\_\_c - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines the lower threshold limit for the activity score. ### cgcloud\_\_User\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Controls the determination of valid users when the activity is activated. The attribute controls the valid users by interpreting main management relation between users and Customers. - **Default value**: All - **Possible values**: - All - First - OnlyMain ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date from which the validity period begins. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date on which the validity period ends. ### cgcloud\_\_Visit\_Template\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description of the linked visit template. This is a calculated field. - **Formula**: cgcloud\_\_Visit\_Template\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Visit\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the visit template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Visit\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Visit\_Template\_\_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\_\_Job\_Definition\_List\_\_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\_\_Job\_Definition\_List\_\_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\_\_Job\_Definition\_List\_\_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\_\_Job\_Definition\_List\_\_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\_\_Job\_Definition\_List\_\_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. # cgcloud\_\_Job\_Definition\_List\_Account\_\_c Stores the details of the relationship between job definition list and customer. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (master object) ### cgcloud\_\_Excluded\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Excludes the customer temporarily from the list of customers of the activity. - **Default value**: false ### cgcloud\_\_Job\_Definition\_List\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Reference to the activity template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Job\_Definition\_List\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Job\_Definition\_List\_\_c ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: URL to view the record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales organization to which the account assignment of the activity (and the activity itself) belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## 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\_\_Job\_Definition\_List\_Account\_\_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\_\_Job\_Definition\_List\_Account\_\_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\_\_Job\_Definition\_List\_Account\_\_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\_\_Job\_Definition\_List\_Account\_\_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\_\_Job\_Definition\_List\_Account\_\_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. # cgcloud\_\_Job\_Definition\_List\_Account\_Set\_\_c Junction object between Job Definition List and Customer Set. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Account\_Set\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Transfers Account\_Set.Description. This is a calculated field. - **Formula**: cgcloud\_\_Account\_Set\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Account\_Set\_Name\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Transfers Account\_Set.Name. This is a calculated field. - **Formula**: cgcloud\_\_Account\_Set\_\_r.Name ### cgcloud\_\_Account\_Set\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Reference to the Customer set. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_Set\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Account\_Set\_\_c (the detail object) ### cgcloud\_\_Composite\_Key\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Contains concatenation of the related records' Job definition List and Customer Set. The field is set by workflow. This prevents a Customer Set from being added twice to a Job Definition List. ### cgcloud\_\_Job\_Definition\_List\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to Activity. This is a relationship field. - **Relationship Name**: cgcloud\_\_Job\_Definition\_List\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Job\_Definition\_List\_\_c (the master object) ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Replaces Name by Hyperlink View. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, /\*IMAGE("/img/func\_icons/util/lookup20.gif", "View")\*/"View", "\_top") ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales Organization to which the account set assignment of the activity (and the activity itself) belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## 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\_\_Job\_Definition\_List\_Account\_Set\_\_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\_\_Job\_Definition\_List\_Account\_Set\_\_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\_\_Job\_Definition\_List\_Account\_Set\_\_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\_\_Job\_Definition\_List\_Account\_Set\_\_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\_\_Job\_Definition\_List\_Account\_Set\_\_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. # cgcloud\_\_Job\_Definition\_List\_Product\_\_c Stores the details of the relationship between the Job Definition List and Product related lists. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Composite\_Key\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Contains concatenation of the Job Definition List and Product related records. The field is set by workflow. This field prevents a Product from being added twice to a Job Definition List. ### cgcloud\_\_Excluded\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The product can be temporarily excluded from the product list. - **Default value**: false ### cgcloud\_\_Job\_Definition\_List\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the activity. This is a relationship field. - **Relationship Name**: cgcloud\_\_Job\_Definition\_List\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Job\_Definition\_List\_\_c (master object) ### cgcloud\_\_Manually\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Added products are marked as Manually True. Products that are added via FSA are marked as Manually False. - **Default value**: true ### cgcloud\_\_Product\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Shows the description of the product. This is a calculated field. - **Formula**: cgcloud\_\_Product\_\_r.cgcloud\_\_Description\_1\_\_c ### cgcloud\_\_Product\_Number\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Shows the number of the product. This is a calculated field. - **Formula**: cgcloud\_\_Product\_\_r.cgcloud\_\_Consumer\_Goods\_Product\_Code\_\_c ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to a product. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Replaces Name by Hyperlink View. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales organization to which the product assignment of the activity (and the activity itself) belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## 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\_\_Job\_Definition\_List\_Product\_\_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\_\_Job\_Definition\_List\_Product\_\_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\_\_Job\_Definition\_List\_Product\_\_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\_\_Job\_Definition\_List\_Product\_\_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\_\_Job\_Definition\_List\_Product\_\_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. # cgcloud\_\_Job\_Definition\_List\_Template\_\_c Template that controls the behavior of Job definition lists. 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**: 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**: Indicates whether the activity template is available for use. - **Default value**: true ### cgcloud\_\_Classification\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the type of activity template that's used to show the cockpit card of mobility device. - **Possible values**: - Non\_Standard—Non Standard - Standard - Standard\_with\_Customer—Standard with Customer ### cgcloud\_\_Consider\_Account\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The attribute is used in activities with standard jobs. If yes, the system considers the Customer of the call when determining the relevant standard activity. If no, the standard activity is valid for all Customers. - **Default value**: false ### cgcloud\_\_Consider\_History\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines the default configuration for considering historical products during activity creation. - **Default value**: false ### cgcloud\_\_Consider\_Listing\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines the default configuration for considering listed products during activity creation. - **Default value**: false ### cgcloud\_\_Consider\_Products\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines the default configuration for individual addition of products to the activity. - **Default value**: false ### cgcloud\_\_Default\_Management\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the default management type that's considered in the user determination when creating job lists from non-standard activity. - **Default value**: Sales - **Possible values**: - Consultant - Sales - Service ### 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\_\_Display\_In\_Cockpit\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the activity template is to be shown in the cockpit (mobility). - **Default value**: false ### cgcloud\_\_Duration\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines the default duration when creating an activity (measured in weeks). ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org to which the activity template belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies the sort value of the activity template record. ### cgcloud\_\_Standard\_Jobs\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether standard jobs are to be considered. - **Default value**: false ### cgcloud\_\_User\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Controls the determination of valid users when the activity is activated. The attribute controls valid users by interpreting the main management relation between the user and the Customer. - **Default value**: All - **Possible values**: - All - First - OnlyMain ## Associated Objects This object has these following 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\_\_Job\_Definition\_List\_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\_\_Job\_Definition\_List\_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\_\_Job\_Definition\_List\_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\_\_Job\_Definition\_List\_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\_\_Job\_Definition\_List\_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. # cgcloud\_\_Job\_Definition\_Template\_\_c Stores the definition of the questions or product surveys that are available in the system. 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**: 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**: Specifies whether the template is active. - **Default value**: true ### cgcloud\_\_Consider\_Max\_Value\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether the maximum value of the current job definition template is to be considered. - **Default value**: false ### cgcloud\_\_Consider\_Min\_Value\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether the minimum value of the current job definition template is to be considered. - **Default value**: false ### cgcloud\_\_Data\_Type\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Reference to the data type that's used as an answer in the respective job. This is a relationship field. - **Relationship Name**: cgcloud\_\_Data\_Type\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Data\_Type\_\_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\_\_Job\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Reference to the job template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Job\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Job\_Template\_\_c ### cgcloud\_\_Max\_Date\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Controls the validation of date fields when answering questions or surveys on CAS OnPremise mobile devices. - **Possible values**: - MaxDate - MinDate - NextYear - Today ### cgcloud\_\_Max\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Maximum value for the answer of the current job definition template. ### cgcloud\_\_Measure\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Measure Type of the referenced Job Definition Template. - **Default value**: Store - **Possible values**: - POS - Store ### cgcloud\_\_Min\_Date\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Controls the validation of date fields when answering questions or surveys on CGCloud OnPremise mobile devices. - **Possible values**: - MaxDate - MinDate - NextYear - Today ### cgcloud\_\_Min\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Minimum value for the answer of the current job definition template. ### cgcloud\_\_Perfect\_Store\_Question\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether a question is to be considered relevant to determine the perfect store index of a call. - **Default value**: false ### cgcloud\_\_Picture\_Taking\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether a picture can be taken for this question during call execution on mobility devices. **Note**: This is relevant only for Question. - **Default value**: false ### cgcloud\_\_Presetting\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the prepopulation of the corresponding attribute in the activity job defintion template (Job\_DL\_Job\_Definition\_Template) that's used to control the activity specific to the presetting of the answer in the call. - **Default value**: None - **Possible values**: - LastValue - None - TargetValue ### cgcloud\_\_Primary\_Survey\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Allows specification of three primary product survey questions that's used for discrepancy survey in a matrix-type display on the CAS OnPremise mobility devices. - **Possible values**: - Distribution - Facings - PriceSurvey - PromotionParticipation - PlacementOfDisplay - QualityOfDisplay - AssetPlacement ### cgcloud\_\_Competitor\_Relevant\_\_c - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Response to collate competitor information related to (placement or price) of products or promotions. ### cgcloud\_\_Product\_Reference\_\_c - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Controls whether the survey is about products. If there's no product reference, then dynamic is true. The string (length 1) options are 0 and 1. This is a calculated field. - **Formula**: cgcloud\_\_Job\_Template\_\_r.cgcloud\_\_Product\_Reference\_\_c ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org to which the job definition template belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Save\_Presetting\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether preset answers are to be automatically stored when completing the call. Note regarding restrictions of save presetting: In the back end, the save presetting is currently restricted to the Last Value presetting in questions and surveys. On mobility devices, the save presetting is currently restricted to surveys only (considering the Last Value and Target Value presetting). - **Default value**: false ### cgcloud\_\_Short\_Description\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the description of language 1. ### cgcloud\_\_Short\_Description\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the description of language 2. ### cgcloud\_\_Short\_Description\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the description of language 3. ### cgcloud\_\_Short\_Description\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the description of language 4. ### cgcloud\_\_Short\_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\_\_Short\_Description\_Language\_1\_\_c, "Language2", BLANKVALUE(cgcloud\_\_Short\_Description\_Language\_2\_\_c,cgcloud\_\_Short\_Description\_Language\_1\_\_c), "Language3", BLANKVALUE(cgcloud\_\_Short\_Description\_Language\_3\_\_c,cgcloud\_\_Short\_Description\_Language\_1\_\_c), "Language4", BLANKVALUE(cgcloud\_\_Short\_Description\_Language\_4\_\_c,cgcloud\_\_Short\_Description\_Language\_1\_\_c), cgcloud\_\_Short\_Description\_Language\_1\_\_c) ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Used for sorting. For example, when manually adding questions during call execution on the CAS OnPremise mobile solution. ### cgcloud\_\_Step\_Size\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Controls the stepper for numeric fields when answering questions or surveys on CAS OnPremise mobile devices. ### cgcloud\_\_Survey\_Identification\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Used by mobility to store survey identification values. - **Possible values**: - Distribution - Facings - POS Distribution - POS Facings - POS Price - Price ### cgcloud\_\_Target\_Value\_Column\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the target value column of primary surveys (configured via Primary\_Survey\_Policy). - **Possible values**: - 0—None - 1—Facing - 2—PriceSurvey - 3—Distribution ### cgcloud\_\_Use\_Stepper\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the stepper is used. - **Default value**: false ## 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\_\_Job\_Definition\_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\_\_Job\_Definition\_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\_\_Job\_Definition\_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\_\_Job\_Definition\_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\_\_Job\_Definition\_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. # cgcloud\_\_Job\_DL\_Job\_Definition\_Template\_\_c This object stores the questions or surveys that are used in the job definition list. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Composite\_Key\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique identifier of the record. ### cgcloud\_\_Condition\_Answers\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: List of relevant answers for the parent condition. ### cgcloud\_\_Condition\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description of Activity Job Definition Template of the parent condition. This is a calculated field. - **Formula**: cgcloud\_\_Condition\_\_r.cgcloud\_\_Job\_Definition\_Template\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Condition\_Operator\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Operator that's applied to the Conditional answer. - **Possible values**: - In - Not In ### cgcloud\_\_Condition\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Activity Job Definition Template that represents the parent condition. This is a relationship field. - **Relationship Name**: cgcloud\_\_Condition\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Job\_DL\_Job\_Definition\_Template\_\_c ### cgcloud\_\_Consider\_Score\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates whether the question is score relevant. - **Default value**: No - **Possible values**: - No - Yes ### cgcloud\_\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description of the referenced Job Definition Template. This is a calculated field. - **Formula**: cgcloud\_\_Job\_Definition\_Template\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Excluded\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Used to exclude the activity job definition template from the call execution. - **Default value**: false ### cgcloud\_\_Job\_Action\_Success\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Controls detachment behavior and validation (mandatory) when completing the call. - **Possible values**: - Detach - None - Validation ### cgcloud\_\_Job\_Definition\_List\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the activity. This is a relationship field. - **Relationship Name**: cgcloud\_\_Job\_Definition\_List\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Job\_Definition\_List\_\_c (the master object) ### cgcloud\_\_Job\_Definition\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Reference to the job definition template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Job\_Definition\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Job\_Definition\_Template\_\_c ### cgcloud\_\_Job\_Template\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Job template of the job definition template. This is a calculated field. - **Formula**: cgcloud\_\_Job\_Definition\_Template\_\_r.cgcloud\_\_Job\_Template\_\_r.Name ### cgcloud\_\_Mandatory\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Respective question or survey that must be answered during the call execution. - **Default value**: false ### cgcloud\_\_Measure\_Type\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Measure Type of the referenced Job Definition Template. This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Job\_Definition\_Template\_\_r.cgcloud\_\_Measure\_Type\_\_c) ### cgcloud\_\_POS\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the POS template. This is a relationship field. - **Relationship Name**: cgcloud\_\_POS\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_POS\_Template\_\_c ### cgcloud\_\_POS\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Type of POS. - **Possible values**: - ct—Cigarette Carrier - dairycase—Dairy Case - freezer—Freezer - refrigerator—Refrigerator - sc—Sales Counter - shelf—Shelf - smt—Cigarette Sales Panel - vm—Vending Machine ### cgcloud\_\_Presetting\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Controls the presetting of the corresponding answer in the call. - **Possible values**: - LastValue - None - TargetValue ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales organization to which the job definition template assignment of the activity (and the activity itself) belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Save\_Presetting\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Used only in the back end in validations and to control whether preset answers are to be automatically stored when completing the call. Represents the save presetting configuration of the referenced job definition template. As a result, the attribute is pre-populated when adding the job definition template to the activity. On mobility devices, the corresponding job definition template is evaluated directly. - **Default value**: false ### cgcloud\_\_Score\_Relevant\_Answers\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: List of relevant answers for the question. ### cgcloud\_\_Score\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Score of the question. ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sorts Job definitions, and is auto-populated from Job\_Definition\_Template.Sort ## 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\_\_Job\_DL\_Job\_Definition\_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\_\_Job\_DL\_Job\_Definition\_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\_\_Job\_DL\_Job\_Definition\_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\_\_Job\_DL\_Job\_Definition\_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\_\_Job\_DL\_Job\_Definition\_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. # cgcloud\_\_Job\_DL\_Template\_Def\_Template\_\_c Stores the list of job definition templates in the Job definition list template. When creating a job definition list based on this template, the assigned job definition templates are used to preset job definitions. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the template is active. - **Default value**: true ### cgcloud\_\_Composite\_Key\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Contains concatenation of the related records' Job definition List Template and Job Definition Template. The field is set by workflow. This prevents a Job Definition Template from being added twice to a Job Definition List. ### cgcloud\_\_Job\_Definition\_List\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the activity template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Job\_Definition\_List\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Job\_Definition\_List\_Template\_\_c (the master object) ### cgcloud\_\_Job\_Definition\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Reference to the job definition template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Job\_Definition\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Job\_Definition\_Template\_\_c ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Replaces Name by Hyperlink View. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ## 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\_\_Job\_DL\_Template\_Def\_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\_\_Job\_DL\_Template\_Def\_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\_\_Job\_DL\_Template\_Def\_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\_\_Job\_DL\_Template\_Def\_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\_\_Job\_DL\_Template\_Def\_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. # cgcloud\_\_Job\_List\_\_c Stores the job lists that are generated from non-standard job definition lists. 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, Nillable, Sort, Update - **Description**: Reference to the customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Description\_JDL\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description of the job definition list. This is a calculated field. - **Formula**: cgcloud\_\_Job\_Definition\_List\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Done\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Status of the job list. - **Default value**: 0 - **Possible values**: - 0—Not Done - 1—Done - 2—Canceled ### cgcloud\_\_Job\_Definition\_List\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the activity. This is a relationship field. - **Relationship Name**: cgcloud\_\_Job\_Definition\_List\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Job\_Definition\_List\_\_c ### cgcloud\_\_Manager\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the manager. This is a relationship field. - **Relationship Name**: cgcloud\_\_Manager\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Replaces Name by Hyperlink View. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date from which the entry is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the entry is valid. ### cgcloud\_\_Visit\_Date\_\_c - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: Visit of the call to which the job list is magnetized. This is a calculated field. - **Formula**: cgcloud\_\_Visit\_\_r.cgcloud\_\_Start\_Date\_\_c ### cgcloud\_\_Visit\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Visit template that's assigned to the activity. This is a relationship field. - **Relationship Name**: cgcloud\_\_Visit\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Visit\_Template\_\_c ### cgcloud\_\_Visit\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Visit to which the job list is magnetized. This is a relationship field. - **Relationship Name**: cgcloud\_\_Visit\_\_r - **Relationship Type**: Lookup - **Refers To**: Visit ## 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\_\_Job\_List\_\_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\_\_Job\_List\_\_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\_\_Job\_List\_\_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\_\_Job\_List\_\_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\_\_Job\_List\_\_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. # cgcloud\_\_Job\_Template\_\_c Stores whether a job is to be considered as either a task, a question, a product related question (survey), or any other object related job like capturing orders. 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**: 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\_\_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**: Reference to the 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\_\_Product\_Reference\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether the survey is about products. If there's no product reference, then the dynamic must be true. - **Default value**: false ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org to which the job template belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## 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\_\_Job\_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\_\_Job\_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\_\_Job\_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\_\_Job\_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\_\_Job\_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. # cgcloud\_\_KPI\_Definition\_\_c Contains the description of a single measure. The fields of the table can be derived from the current KPI\_Set .json file. 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**: 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 ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of the KPI, defines how the KPI is handled by the system. This is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### cgcloud\_\_Aggregation\_Merge\_Rule\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Determines how subperiods are merged into either full weeks or months. - **Default value**: sum - **Possible values**: - avg—Avg - sum—Sum ### cgcloud\_\_Aggregation\_Rule\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines how the data in lower level nodes are aggregated to higher levels. - **Possible values**: - avg—Avg - formula—Formula - max—Max - min—Min - sum—Sum ### cgcloud\_\_Aggregation\_Time\_Rule\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the monthly calculation rule. - **Possible values**: - aggregate—Aggregate - formula—Formula - read—Read ### cgcloud\_\_BoM\_Scope\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Defines the levels for which the calculation engine determines values. This field is available in API version 55.0 and later. - **Possible values**: - Component - Header - Product ### cgcloud\_\_Comment\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores extra information about the KPI Definition. ### cgcloud\_\_Compound\_Main\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether this KPI is main compound KPI. - **Default value**: false ### cgcloud\_\_Data\_Source\_Aggregation\_Mode\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines whether a core aggregation is to be used or a custom aggregation is to be used - **Default value**: standard - **Possible values**: - custom—Custom - standard—Standard ### cgcloud\_\_Data\_Source\_BoM\_Component\_Source\_Level\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines from which level the values are determined. This field is available in API version 55.0 and later. - **Possible values**: - Component - Product ### cgcloud\_\_Data\_Source\_Condition\_Search\_Group\_Code\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Stores the group code of the condition search group. This field is a calculated field. This field is available in API version 55.0 and later. - **Formula**: cgcloud\_\_Data\_Source\_Condition\_Search\_Group\_\_r.cgcloud\_\_Group\_Code\_\_c ### cgcloud\_\_Data\_Source\_Condition\_Search\_Group\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References to the condition search group. This field is a relationship field. This field is available in API version 55.0 and later. - **Relationship Name**: cgcloud\_\_Data\_Source\_Condition\_Search\_Group\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Condition\_Search\_Group\_\_c ### cgcloud\_\_Data\_Source\_Consider\_Product\_Hierarchy\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product hierarchy is considered for the condition search. - **Default value**: false ### cgcloud\_\_Data\_Source\_Load\_For\_Sub\_Accounts\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the loaded data is anchored to the planning account or to a list of accounts (Sub accounts). This field is applicable only for Read type. - **Default value**: false ### cgcloud\_\_Data\_Source\_Measure\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique code of a data source measure. ### cgcloud\_\_Data\_Source\_Monthly\_Table\_Name\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Name of the source table for Monthly data that's to be read. - **Possible values**: - accountmeasure—Account Measure - accountproductmeasure—Account Product Measure - dailymeasureint—Daily Measure Int - dailymeasurereal—Daily Measure Real - monthlyaccountmeasureresult—Monthly Account Measure Result - monthlypaymenttacticmeasureresult—Monthly Payment Tactic Measure Result - monthlypromotionmeasureresult—Monthly Promotion Measure Result - productmeasure—Product Measure - promotiontacticdailymeasurereal—Promotion Tactic Daily Measure Real ### cgcloud\_\_Data\_Source\_Table\_Name\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Name of the source table from which the measure data is drawn. - **Possible values**: - accountmeasure—Account Measure - accountproductmeasure—Account Product Measure - dailymeasureint—Daily Measure Int - dailymeasurereal—Daily Measure Real - productmeasure—Product Measure - promotiontacticdailymeasurereal—Promotion Tactic Daily Measure Real - promotiontacticweeklymeasurereal—Promotion Tactic Weekly Measure Real - weeklyaccountmeasureresult—Weekly Account Measure Result - weeklymeasureint—Weekly Measure Int - weeklymeasurereal—Weekly Measure Real - weeklypaymenttacticmeasureresult—Weekly Payment Tactic Measure Result - weeklypromotionmeasureresult—Weekly Promotion Measure Result ### cgcloud\_\_Data\_Source\_Week\_Offset\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Data is fetched from the database for the timeframe that lies within this number of weeks before the promotion. This field is supported only for volume data. ### cgcloud\_\_Data\_Source\_Year\_Offset\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Number of years to go back in time. The data is fetched from the database for the timeframe that lies within this number of years that can be either one or two years before the promotion. This field is applicable only for Read type. It can't be used in combination with week offset for one KPI at the same time. ### 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\_\_Display\_Enabled\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Only the measures whose display is enabled are to be displayed on the UI. - **Default value**: true ### cgcloud\_\_Display\_Round\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: UI Rounding determines the number of decimal places that are to be shown in the cell. ### cgcloud\_\_Distribution\_Acc\_Hierarchy\_Dist\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Measure code defines the code that's used to distributevalues down the account hierarchy. - **Possible values**: - copy—Copy - equal—Equal - metric—Metric (KPI) ### cgcloud\_\_Distribution\_Acc\_Hierarchy\_Metric\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The measure code defines the code that is used for distribution of values down the account hierarchy. ### cgcloud\_\_Distribution\_Order\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the order in which hierarchies are traversed. - **Default value**: PlanThenTime - **Possible values**: - PlanThenTime—Planning Hierarchy -> Time - TimeThenPlan—Time -> Planning Hierarchy ### cgcloud\_\_Distribution\_Plan\_Hierarchy\_Dist\_Metric\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the KPI definition when distribution is of plan hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Distribution\_Plan\_Hierarchy\_Dist\_Metric\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Distribution\_Plan\_Hierarchy\_Dist\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the distribution type that's to be used to distribute values down the planning hierarchy. - **Default value**: metric - **Possible values**: - copy—Copy - equal—Equal - metric—Metric (KPI) - proportional—Proportional ### cgcloud\_\_Distribution\_Time\_Hierarchy\_Dist\_Metric\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the KPI definition when distribution is of time hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Distribution\_Time\_Hierarchy\_Dist\_Metric\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Distribution\_Time\_Hierarchy\_Dist\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the distribution type that's to be used to distribute values down the time hierarchy. - **Default value**: metric - **Possible values**: - copy—Copy - equal—Equal - metric—Metric (KPI) - proportional—Proportional ### cgcloud\_\_Editable\_Edit\_Mode\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: This field is for lump sum. After this field is enabled and when a user introduces a total, the totals don't change even if other items change (KPI, products, and so on). - **Default value**: week - **Possible values**: - all—All - none—None - total—Total - week—Week ### cgcloud\_\_Editable\_Enable\_Past\_Weeks\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: If true, the cells of past weeks remain editable. - **Default value**: false ### cgcloud\_\_Editable\_Fixed\_Totals\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the non-obsolete last edited or calculated total value of the KPI is saved for use in the Promotion Calculation. - **Default value**: false ### cgcloud\_\_Editable\_Measure\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique code of the editable measure that's used when saving the edit history. ### cgcloud\_\_Formula\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Function that executes the calculation. ### cgcloud\_\_Is\_Storage\_Level\_Bom\_Component\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Flag that indicates whether the KPI Definition Storage Levels is BOM Component. This field is available in API version 55.0 and later. - **Default value**: false ### cgcloud\_\_Parent\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Compound KPI to which this KPI belongs. This is a relationship field. - **Relationship Name**: cgcloud\_\_Parent\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Reporting\_Formula\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Defines the calculation rule for calculated reporting KPIs as a JavaScript formula. ### cgcloud\_\_Reporting\_Relevant\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the KPI is relevant for reporting. - **Default value**: false ### cgcloud\_\_Reporting\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Controls whether the KPI is either directly read from the Writeback measure or calculated. - **Default value**: read - **Possible values**: - calculated—Calculated - external—External - read—Read ### cgcloud\_\_Rounding\_Order\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Period Then Sub Periods method rounds period values first, and then rounds the buckets. This ensures that their merged value matches the period value. Sub Periods Then Period rounds subperiods first, and then merges them into periods. - **Possible values**: - default—Default - periodfirst—Period Then Sub Periods - subperiodfirst—Sub Periods Then Period ### cgcloud\_\_Rounding\_Precision\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the precision to which the calculation engine rounds the calculated values of the KPI at product level such that these values aggregate up to the correct weekly, monthly, and total values without losing precision. - **Possible values**: - 0 - 1 - 2 - 3 - 4 - 5 - 6 ### cgcloud\_\_Rounding\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Rounding With Carry Over is a special configuration that uses a carryover from one cell to another to ensure that aggregations and totals match with the rounded number. Rounding Enabled performs a simple rounding to the nearest number. - **Possible values**: - nocarryover—Rounding Enabled - withcarryover—Rounding With Carry Over ### cgcloud\_\_Scope\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the object scope of the KPI. The KPI can be added to the relevant KPI Set based on the defined scope. - **Default value**: account - **Possible values**: - account—Account - fund—Funding - paymenttactic—Payment Tactic - promotion—Promotion - promotiontactic—Promotion Tactic ### cgcloud\_\_Storage\_Options\_Measure\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique code of the writeback measure that's used when writing back KPIs. The last character may be a # for KPIs with the object scope as Payment Tactic. ### cgcloud\_\_Storage\_Options\_Storage\_Levels\_\_c - **Type**: multipicklist - **Properties**: Create, Defaulted on create, Filter, Nillable, Restricted picklist, Update - **Description**: Levels on which the data is written back. More than one level can be defined. - **Default value**: Product - **Possible values**: - Brand - Category - Flavor—Sub Brand - Package—Product Price Group - Product - SubCategory—Sub Category - Tactic - measures—Measures ### cgcloud\_\_Storage\_Options\_Subperiod\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: If active, writeback has to generate daily accurate values for the subperiods that belong to different months. - **Possible values**: - weeksplits—Week Splits By Month ### cgcloud\_\_Storage\_Options\_Writeback\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Rows with writeback as true are saved back to the database for further use by external tools. - **Default value**: false ### cgcloud\_\_Time\_Granularity\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: If granularity is Subperiod, the formula is applied at the subperiod level and then merged by using merge rule. In Period granularity, the formula is applied over already merged values. - **Default value**: subperiod - **Possible values**: - period—Period - subperiod—Sub Period ### cgcloud\_\_Time\_Scope\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Consideration of time ranges within the calculation. - **Default value**: complete - **Possible values**: - complete—Complete - custom1—Custom 1 - custom2—Custom 2 - order—Order - placement—Instore - shipment—Shipment ### cgcloud\_\_Total\_Calculation\_Cumulative\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies whether the KPI is a cumulative KPI. - **Default value**: off - **Possible values**: - off—Off - on—On ### cgcloud\_\_Total\_Calculation\_Rule\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines how the total column is aggregated along the x-axis. - **Possible values**: - avg—Avg - formula—Formula - max—Max - min—Min - sum—Sum ### cgcloud\_\_Validation\_Error\_Message\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Label ID of the error string. ### cgcloud\_\_Validation\_Level\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Determines the level at which the validation is to be executed. This field is applicable only for the Validation record type. - **Possible values**: - promotion—Promotion - promotionproduct—Promotion Product - promotionproductgroup1—Promotion Product Group1 - promotionproductgroup2—Promotion Product Group2 - tactic—Tactic - tacticproduct—Tactic Product - tacticproductgroup1—Tactic Product Group1 - tacticproductgroup2—Tactic Product Group2 ### cgcloud\_\_Validation\_Value\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Determines the granular level at which the validation is run. - **Possible values**: - total—Total - week—Week ### cgcloud\_\_Value\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Determines the granular level at which the validation is executed. This field is applicable only for the Validation record type. - **Default value**: None - **Possible values**: - Money - None - Percentage - Price - Volume ## 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\_\_KPI\_Definition\_\_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\_\_KPI\_Definition\_\_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\_\_KPI\_Definition\_\_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\_\_KPI\_Definition\_\_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\_\_KPI\_Definition\_\_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. # cgcloud\_\_KPI\_Map\_\_c Holds the information about the KPI Map configuration. 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**: 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\_\_Description\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: KPI map description. ### cgcloud\_\_Field\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the field that belongs to sObject Type and is used for KPI mapping. ### cgcloud\_\_Fund\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the fund template. If the fund template isn't specified, then this is the default mapping for all fund records. If the fund template is specified, then the mapping is specific to the related fund records. This is a relationship field. - **Relationship Name**: cgcloud\_\_Fund\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Fund\_Template\_\_c ### cgcloud\_\_KPI\_Definition\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Measure code from the KPI Definition lookup. ### cgcloud\_\_KPI\_Definition\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the KPI definition to be used in the mapping. This is a relationship field. - **Relationship Name**: cgcloud\_\_KPI\_Definition\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Precision\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Holds the total number of digits allowed for the target field. ### cgcloud\_\_Promotion\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the promotion template. If the promotion template isn't specified, then this is the default mapping for all promotion records. If the promotion template is specified, then the mapping is specific to the related promotion records. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_Template\_\_c ### cgcloud\_\_RBF\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the rate-based funding (RBF) template. If the RBF template isn't specified, then this is the default mapping for all RBF records. If the RBF template is specified, then the mapping is specific to the related RBF records. This is a relationship field. - **Relationship Name**: cgcloud\_\_RBF\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_RBF\_Template\_\_c ### cgcloud\_\_SObject\_Type\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the type of sObject supported for KPI mapping. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org that the KPI map belongs to. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Scale\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Holds the number of decimal places allowed for the target field. ### cgcloud\_\_Tactic\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Tactic template. If the tactic template isn't specified, then this is the default mapping for all tactic records. If the tactic template is specified, then the mapping is specific to the related tactic records. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tactic\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Tactic\_Template\_\_c ## Associated Objects ### 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\_\_KPI\_Map\_\_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\_\_KPI\_Map\_\_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\_\_KPI\_Map\_\_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 tracked fields of the object. - **[cgcloud\_\_KPI\_Map\_\_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\_\_KPI\_Map\_\_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. # cgcloud\_\_KPI\_Set\_\_c This table contains information about KPI Set Configuration. 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**: 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\_\_Child\_Object\_Dependency\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the KPI Set is dependent on child objects. - **Default value**: false ### cgcloud\_\_Configuration\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Describes the configuration in JSON format. ### cgcloud\_\_Description\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the KPI set in language 1. ### cgcloud\_\_Description\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the KPI set in language 2. ### cgcloud\_\_Description\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the KPI set in language 3. ### cgcloud\_\_Description\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description of the KPI set in language 4. ### cgcloud\_\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description of the KPI set. 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\_\_Manual\_Change\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the offplatform configuration update is to be triggered in a async process. - **Default value**: false ### cgcloud\_\_Statistics\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Contains statistics for the complete KPI set and the related subsets. ### cgcloud\_\_Usage\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the usage of the KPI set. - **Possible values**: - Funding - Payment - Plan - Promotion - Rate Based Funding - Reporting ## 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\_\_KPI\_Set\_\_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\_\_KPI\_Set\_\_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\_\_KPI\_Set\_\_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\_\_KPI\_Set\_\_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\_\_KPI\_Set\_\_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. # cgcloud\_\_KPI\_Set\_KPI\_Definition\_\_c Junction object between KPI Definition and KPI Definition Set. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: ID of the record owner. ### cgcloud\_\_KPI\_Definition\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Parent object (KPI Definition). This is a relationship field. - **Relationship Name**: cgcloud\_\_KPI\_Definition\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c (Detail object) ### cgcloud\_\_KPI\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description of the KPI definition that's shown when selecting the Adjustment KPI from lookup. This is a calculated field. - **Formula**: cgcloud\_\_KPI\_Definition\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_KPI\_Set\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Parent object (Calculation Configuration). This is a relationship field. - **Relationship Name**: cgcloud\_\_KPI\_Set\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_KPI\_Set\_\_c (Master object) ### cgcloud\_\_KPI\_Subsets\_\_c - **Type**: multipicklist - **Properties**: Create, Defaulted on create, Filter, Nillable, Restricted picklist, Update - **Description**: ID of the KPI subset. - **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\_\_KPI\_Tactic\_Dependent\_\_c - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Field value that's updated based on KPI\_Definition.Aggregation\_Skipped\_Dimesnions. This is a calculated field. - **Formula**: OR(ISPICKVAL(cgcloud\_\_KPI\_Definition\_\_r.cgcloud\_\_Scope\_\_c , "promotiontactic"),ISPICKVAL(cgcloud\_\_KPI\_Definition\_\_r.cgcloud\_\_Scope\_\_c , "paymenttactic")) ### cgcloud\_\_Manual\_Input\_Copy\_Mode\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines whether manual input is copied over to the target promotion. - **Possible values**: - No - Yes ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the KpiSetKpiDefinition Record for related custom lists. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sort\_Subset\_PSP\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sorts KPI subsets with the Promotion scenario. ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: Sorts the KPI definition in the KPI set. ### cgcloud\_\_Storage\_Options\_Subset\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Define subsets of KPIs that can be calculated in various writeback steps. - **Possible values**: - basic—Basic - businessplan—Business Plan ### cgcloud\_\_Unique\_Editable\_Measure\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Ensures that the editable measure codes per KPI set are unique. This means that no two editable KPIs create manual entries for the same measure code. ### cgcloud\_\_Unique\_KPI\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Ensures that a KPI is assigned only once to a KPI set. ### cgcloud\_\_Unique\_KPI\_Id\_for\_Sort\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Ensures that the KPI sort order is total (for two KPIs k1 within the set, either k1 < k2 or k2 < k1 is true; otherwise k1 = k2). ### cgcloud\_\_Unique\_Storage\_Options\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Ensures that the storage measure codes per KPI set are unique. This means that no two writeback KPIs create writebacks for the same measure code. ## 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\_\_KPI\_Set\_KPI\_Definition\_\_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\_\_KPI\_Set\_KPI\_Definition\_\_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\_\_KPI\_Set\_KPI\_Definition\_\_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\_\_KPI\_Set\_KPI\_Definition\_\_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\_\_KPI\_Set\_KPI\_Definition\_\_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. # cgcloud\_\_Listing\_Classification\_\_c Holds the information about the listing modules and the product category for a customer. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the account the listing classification is assigned to. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (master object) ### cgcloud\_\_Listing\_Module\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the listing module. ### cgcloud\_\_Product\_Category\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Product category to which the product belongs. - **Possible values**: - Beverages - Chips - Detergent - Frozen - Hygiene - Snacks ## Associated Objects ### 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\_\_Listing\_Classification\_\_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\_\_Listing\_Classification\_\_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\_\_Listing\_Classification\_\_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 tracked fields of the object. - **[cgcloud\_\_Listing\_Classification\_\_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\_\_Listing\_Classification\_\_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. # cgcloud\_\_Listing\_Module\_\_c This object stores information about listing modules for a product assortment. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique identification of the record. ### cgcloud\_\_Product\_Assortment\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: References to the product assortment to which the module is assigned. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_Assortment\_\_r - **Relationship Type**: Master-detail - **Refers To**: Assortment (the master object) ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Order of the module in the assortment. ## 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\_\_Listing\_Module\_\_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\_\_Listing\_Module\_\_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\_\_Listing\_Module\_\_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\_\_Listing\_Module\_\_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\_\_Listing\_Module\_\_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. # cgcloud\_\_Mobile\_Link\_\_c Deep Link Object. 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**: 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 ### 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\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Only Active Records that are to be relevant for display. - **Default value**: false ### cgcloud\_\_Asset\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique asset identifier. ### cgcloud\_\_Asset\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of the asset. - **Possible values**: - application - dashboard - lens ### cgcloud\_\_Dashboard\_State\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: State of the dashboard and all its datasets. The state depends on user selection, start values, global filters, and external or initial filters that are applicable for the dataset. ### cgcloud\_\_Description\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Language dependent description 1. ### cgcloud\_\_Description\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Language dependent description 2. ### cgcloud\_\_Description\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Language dependent description 3. ### cgcloud\_\_Description\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Language dependent description 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", cgcloud\_\_Description\_Language\_2\_\_c, "Language3", cgcloud\_\_Description\_Language\_3\_\_c, "Language4", cgcloud\_\_Description\_Language\_4\_\_c, cgcloud\_\_Description\_Language\_1\_\_c) ### cgcloud\_\_Display\_In\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Indicates where the mobile link is shown in the mobile device. - **Possible values**: - Store Cockpit - Your Day ### cgcloud\_\_Login\_Host\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: URL that shows the login screen when the user is not logged in to the application. ### cgcloud\_\_Org\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the organization that contains the content. ### cgcloud\_\_Record\_Type\_Name\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Developer name of the record type. This is a calculated field. - **Formula**: RecordType.DeveloperName ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org to which the Deep Links belong. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Scheme\_Name\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Scheme component of the link to which the user will navigate on a mobility device. - **Possible values**: - https - ms-onedrive - salesforce1 - sfanalytics - whatsapp ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sort Order of displayable deep links record within a call. ### cgcloud\_\_URL\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores the web address to which the user can navigate by using a quick access cockpit card on a mobility device. ## 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\_\_Mobile\_Link\_\_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\_\_Mobile\_Link\_\_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\_\_Mobile\_Link\_\_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\_\_Mobile\_Link\_\_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\_\_Mobile\_Link\_\_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. # cgcloud\_\_Order\_\_c Stores the header details of the order entry. 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\_\_ASN\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Advanced shipping notice number that the supplier provides for a special delivery. ### cgcloud\_\_ATM\_Confirmation\_Nr\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Contains the confirmation number of the receipt that an Automated Teller Machine (ATM) prints. ### cgcloud\_\_Accountable\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system shows the Initiator of the order as the initial accountable. This is a relationship field. - **Relationship Name**: cgcloud\_\_Accountable\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Actual\_Check\_Out\_Quantity\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total product checkout quantity for the tour in question as actually counted by the tour executing user. ### cgcloud\_\_Actual\_Check\_Out\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Checkout type (method) that's must be applied in the product checkout document based on the given template settings. - **Possible values**: - Counting Groups - Express - Pallets - SKU ### cgcloud\_\_Bank\_Name\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Contains the name of the bank. - **Possible values**: - Bank\_of\_Scotland—Bank of Scotland - CitiBank—Citi Bank - IngDiBa - SantanderBank—Santander Bank ### cgcloud\_\_Bill\_Recipient\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the bill to of the order entry. This is a relationship field. - **Relationship Name**: cgcloud\_\_Bill\_Recipient\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Calculation\_Schema\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Schema that's used to calculate the order with complex pricing. This is a relationship field. - **Relationship Name**: cgcloud\_\_Calculation\_Schema\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Calculation\_Schema\_\_c ### cgcloud\_\_Calculation\_Status\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Complex pricing calculation status. - **Default value**: 0 - **Possible values**: - 0—Initial - 1—Calculated - 2—Calculation Required, Resettable - 3—Calculation Required, Not Resettable - 4—Calculation Failed ### cgcloud\_\_Calculation\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Time of the last complex pricing calculation for this order. ### cgcloud\_\_Cancel\_Reason\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the reason for the cancellation of the delivery document or order. - **Possible values**: - CanceledByCall—Canceled by Call - CashierNotAvailable—Cashier Not Available - CustomerBlocked—Customer is credit blocked - DoubleDelivery—Double Delivery - Misentry - NotEnoughMoney—Not enough money - WrongDelivery—Wrong Delivery - WrongPricing—Wrong Pricing ### cgcloud\_\_Check\_Out\_Quantity\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total product checkout quantity for the tour in question as given by the HOST interface. ### cgcloud\_\_Check\_Out\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the currency of the order based on the sales org currency of the order template object. It must have the same picklist values as the sales org currency field. - **Possible values**: - Counting Groups - Express - Pallets - SKU ### cgcloud\_\_Currency\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the currency of the order based on the sales org currency of the order template object. It must have the same picklist values as the sales org currency field. - **Possible values**: - CAD - CHF - EUR - GBP - JPY - NOK - RUB - USD ### cgcloud\_\_Customer\_Order\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Customer-specific ID of the order. ### cgcloud\_\_Delivery\_Date\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: By default: next day. Delivery date calculation is customized frequently. ### cgcloud\_\_Delivery\_Note\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Delivery note. ### cgcloud\_\_Delivery\_Recipient\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the delivery recipient of the selected account. This is a relationship field. - **Relationship Name**: cgcloud\_\_Delivery\_Recipient\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Delivery\_Terms\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Terms of delivery. - **Possible values**: - ExWarehouse—Ex Warehouse - FreeOfCharge—Free Of Charge - FreeOnBoard—Free On Board - ScaleOfCharge—Scale Of Charge ### cgcloud\_\_Document\_Transaction\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies how to manage a sales document. - **Possible values**: - CashInvoice—Delivery Cash Invoice - CreditInvoice—Delivery Credit Invoice - CashOrder—Cash Order - CreditMemo—Credit Memo - CreditOrder—Credit Order - InvoiceCashInvoice—Cash Invoice - InvoiceCreditInvoice—Credit Invoice - NoPayment—No Payment - NoPaymentOrder—No Payment Order - VanSalesCashInvoice—Van Sales Cash Invoice - VanSalesNoPaymentInvoice—Van Sales No Payment Invoice - NonValuatedDeliveryNote—Non Valuated Delivery Note - ValuatedDeliveryNote—Valuated Delivery Note ### cgcloud\_\_Document\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of the order document to distinguish DSD and non-DSD order entries. - **Possible values**: - CashCheckIn—Cash Check In - CashCheckOut—Cash Check Out - Delivery - OrderEntry—Order Entry - ProductCheckIn—Product Check In - ProductCheckOut—Product Check Out - TruckAudit—Truck Audit ### cgcloud\_\_Gross\_Total\_Value\_Receipt\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Total value of the order entry in the order/receipt currency. ### cgcloud\_\_Gross\_Total\_Value\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Gross total value (domestic currency) of the sales document including relevant sales taxes. The system calculates its value based on the respective sales document item template settings. ### cgcloud\_\_Header\_Discount\_Percentage\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Percentage value of the header discount. ### cgcloud\_\_Initiation\_Date\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date of initiation of this sales document. ### cgcloud\_Invoice\_ID\_\_C - **Type**: date - **Properties**: Create, Nillable, Update - **Description**: Unique invoice identifier. ### cgcloud\_\_Inventory\_Reference\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: First reference to the inventory as defined in the order template. ### cgcloud\_\_Inventory\_Reference\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Second reference to the inventory as defined in the order template. ### cgcloud\_\_Inventory\_Reference\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Third reference to the inventory as defined in the order template. ### cgcloud\_\_Inventory\_Reference\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Fourth reference to the inventory as defined in the order template. ### cgcloud\_\_Inventory\_Reference\_5\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Fifth reference to the inventory as defined in the order template. ### cgcloud\_\_Invoice\_Note\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Invoice note. ### cgcloud\_\_Merchandise\_Value\_Receipt\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Merchandise value (value of goods) in receipt currency, not including header discount. ### cgcloud\_\_Mobility\_Release\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the order was released on Mobility. - **Default value**: false ### cgcloud\_\_Order\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup field to capture the customer for which the order is created. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Order\_Date\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Day on which the customer committed to the sales document. For order entries, this is the order date. ### cgcloud\_\_Order\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the user-readable number that's used for print-outs and customer communication. ### cgcloud\_\_Order\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Order Template for Order Entry. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Order\_Template\_\_c ### cgcloud\_\_Paid\_Amount\_Receipt\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Paid amount of the order entry in domestic currency. The paid amount is a gross value. ### cgcloud\_\_Paid\_Amount\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Paid amount of order. ### cgcloud\_\_Payer\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the payer of the order. This is a relationship field. - **Relationship Name**: cgcloud\_\_Payer\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Payment\_Method\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Describes the manner of the remuneration. - **Possible values**: - Cash - Check—Cheque - CreditCard—Credit Card - DebitCard—Debit Card - Deduction - Expense - MoneyOrder—Money Order - Multiple ### cgcloud\_\_Payment\_Reason\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies a reason that leads to modifying the document handling regarding payments. - **Possible values**: - CalculationFailed—Calculation Failed - PriceDisagreement—Price Disagreement - WrongPrice—Wrong Price ### cgcloud\_\_Payment\_Terms\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Terms of payment. - **Possible values**: - 2percent—2 % / 14 - COD—cash on delivery - net30—net 30 ### cgcloud\_\_Payment\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the sign of the absolute paid amount: either inpayment (+, debit) or outpayment (-, credit). - **Possible values**: - Credit—Out - Debit—In ### cgcloud\_\_Phase\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Workflow neutral description of the order entry status. - **Default value**: Initial - **Possible values**: - Approved - Assigned - Canceled - Closed - Feedback - ForApproval—For Approval - HoldBack—Hold Back - Initial - Ready - Released - SendFax—Send Fax - Voided - WorkCompleted—Work Completed ### cgcloud\_\_Pricing\_Date\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Enables tracking of the conditions that were used. By default: current day. It can be changed if the order was taken on paper first and was then added to the system after a price change. ### cgcloud\_\_Pricing\_Info\_1\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field that stores calculated value at the order level. ### cgcloud\_\_Pricing\_Info\_2\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field that stores calculated value at the order level. ### cgcloud\_\_Pricing\_Info\_3\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field that stores calculated value at the order level. ### cgcloud\_\_Pricing\_Info\_4\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field that stores calculated value at the order level. ### cgcloud\_\_Pricing\_Info\_5\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field that stores calculated value at the order level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Info\_6\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field that stores calculated value at the order level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Info\_7\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field that stores calculated value at the order level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Info\_8\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field that stores calculated value at the order level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Info\_9\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field that stores calculated value at the order level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Info\_10\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field that stores calculated value at the order level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Information\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores the pricing information (found conditions) that are directly related to the order. ### cgcloud\_\_Receipt\_Currency\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Receipt currency of an order. - **Possible values**: - CAD - CHF - EUR - GBP - NOK - RUB - USD - Yen—JPY ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the Detail page of the Order record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_self") ### cgcloud\_\_Release\_Geolocation\_\_Latitude\_\_s - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Geolocation (latitude) that's to be fulfilled by mobility devices, and is not displayed on the order UI. ### cgcloud\_\_Release\_Geolocation\_\_Longitude\_\_s - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Geolocation (longitude) that's to be fulfilled by mobility devices, and is not displayed on the order UI. ### cgcloud\_\_Release\_Geolocation\_\_c - **Type**: location - **Properties**: Nillable - **Description**: Geolocation (latitude and longitude) that's to be fulfilled by mobility devices, and is not displayed on the order UI. ### cgcloud\_\_Release\_Platform\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Platform that can be used to release the order. This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Order\_Template\_\_r.cgcloud\_\_Release\_Platform\_\_c) ### cgcloud\_\_Release\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date and time on which the sales document was released. ### cgcloud\_\_Responsible\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the responsible user. This is a relationship field. - **Relationship Name**: cgcloud\_\_Responsible\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Selected\_Rewards\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores mobility selected rewards and related items or products in JSON format. ### cgcloud\_\_Total\_Returned\_Quantity\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sum of all returned quantities. ### cgcloud\_\_Total\_Shipped\_Quantity\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sum of all shipped quantities. ### cgcloud\_\_Total\_Value\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Total value (domestic currency) of the order including item discounts, without sales taxes. ### cgcloud\_\_Tour\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This field looks up to Tour. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tour\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Tour\_\_c ### cgcloud\_\_Value\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Value of the order entry in the order or receipt currency. ### cgcloud\_\_Visit\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the call in which the sales document is created. This is a relationship field. - **Relationship Name**: cgcloud\_\_Visit\_\_r - **Relationship Type**: Lookup - **Refers To**: Visit ### cgcloud\_\_Warehouse\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Warehouse from which the customer is to be delivered. - **Possible values**: - 55001—North West - 55002—South West - 55003—Middle West - 55004—North East - 5505—South East - CE—Central Europe - NA—North America ### cgcloud\_\_Wholesaler\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the wholesaler of the account. This is a relationship field. - **Relationship Name**: cgcloud\_\_Wholesaler\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Workflow\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: ID of the referenced workflow. This is a calculated field. - **Formula**: cgcloud\_\_Order\_Template\_\_r.cgcloud\_\_Workflow\_\_r.Name ## 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\_\_Order\_\_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\_\_Order\_\_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\_\_Order\_\_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\_\_Order\_\_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\_\_Order\_\_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. # cgcloud\_\_Order\_Item\_\_c Stores the details of the order item object. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Base\_Price\_Receipt\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Basic product price in receipt currency. ### cgcloud\_\_Base\_Price\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Stores the Value of the item, specified in the appropriate product condition. ### cgcloud\_\_Check\_In\_Reason\_Code\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Allows the specification of a reason if the checked-in product quantity doesn't adhere to the expected product quantity that's given via product inventory. - **Possible values**: - Broken - Misc. - Miscounting—Miscounting Check Out - NoDoc—Pick up without doc. - Stolen ### cgcloud\_\_Consumer\_Quantity\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Ordered quantity expressed in consumer quantity units. ### cgcloud\_\_Discount\_\_c - **Type**: percent - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Manual discount given by the user. ### cgcloud\_\_Erp\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of this order entry for the ERP system. ### cgcloud\_\_Free\_Item\_Creation\_Step\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores a reference to the step that generates the free item. ### cgcloud\_\_Gross\_Value\_Receipt\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Gross value in receipt currency. ### cgcloud\_\_History\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The item, which has been added to the disposal list, has been ordered in a former sales document. (The item belongs to a former sales document of the same business partner and of the same sales document template.) - **Default value**: false ### cgcloud\_\_Left\_Quantity\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Item quantity that's left on the truck after product check-in. ### cgcloud\_\_Listed\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product exists in an authorization list of the order. - **Default value**: false ### cgcloud\_\_Modification\_Reason\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies a reason if preordered product quantity has been modified on the mobility device. - **Possible values**: - BadPrd—Bad Product - CpFailed—Pricing failed - DmgByDriver—Damage by driver - FGReturn—Full good return - IncOrder—Incorrect order - Less—Client wants less - Misc—Miscellaneous - MissCount—Misscounting - More—Client wants more - Nopayment—No payment - OutTrStock—Out of Truck Stock - TMStock—Too much stock - TckTransfer—Truck transfer - WrDel—Wrong delivery - WrongPrd—Wrong product ### cgcloud\_\_Order\_Item\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the order item template with which the Order Item is associated. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_Item\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Order\_Item\_Template\_\_c ### cgcloud\_\_Order\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the order with which the Order Item is associated. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Order\_\_c (Master object) ### cgcloud\_\_Out\_Of\_Stock\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the product is out of stock. - **Default value**: false ### cgcloud\_\_Parent\_Order\_Item\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to a parent Order Item. (For example, for a free item, the ordered item that caused the free item. It's used in complex pricing on mobility devices. This is a relationship field. - **Relationship Name**: cgcloud\_\_Parent\_Order\_Item\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Order\_Item\_\_c ### cgcloud\_\_Parent\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the parent to which the free item is related. It can be related to an Order Item. If the free item related to the Order header type is Order, then Parent\_Order\_Item is filled. - **Possible values**: - Item - Order - Reward ### cgcloud\_\_Price\_Receipt\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Calculated price of the item in the receipt or document currency. ### cgcloud\_\_Price\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Calculated price of the item in the domestic currency. ### cgcloud\_\_Pricing\_Info\_1\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field that stores the calculated value in the Order Item level. ### cgcloud\_\_Pricing\_Info\_2\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. ### cgcloud\_\_Pricing\_Info\_3\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. ### cgcloud\_\_Pricing\_Info\_4\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. ### cgcloud\_\_Pricing\_Info\_5\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Info\_6\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Info\_7\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Info\_8\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Info\_9\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Info\_10\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Additional pricing information field for storing calculated value in the Order Item level. This field is available in API version 55.0 and later. ### cgcloud\_\_Pricing\_Information\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores conditions that were used to calculate pricing. ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Product ID of the selected product. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Promoted\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a promotion is available in the relevant period. - **Default value**: false ### cgcloud\_\_Promotion\_Reward\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the reward that belongs to the Order Item. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_Reward\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_Reward\_\_c ### cgcloud\_\_Promotion\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the promotion if the product of the item originates from a selectable promotion. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_\_c ### cgcloud\_\_Quantity\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Quantity of this product. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Hyperlink to the detail page of the record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Special\_Price\_Receipt\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies a reduced price for an item that's used to calculate the item value, if specified. This attribute can be edited only if the Order item template allows the consideration of the special price. ### cgcloud\_\_Special\_Price\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies a reduced price for an item that's used to calculate the item value, if specified. This attribute can be edited only if the sales document item template allows the consideration of the special price. ### cgcloud\_\_Suggested\_Quantity\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Contains the suggested order quantity that's been calculated via an algorithm or that's given by a relevant promotion. ### cgcloud\_\_Target\_Quantity\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Product checkout quantity for the tour that the HOST interface specifies. ### cgcloud\_\_UoM\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unit Of Measure. - **Possible values**: - ConsumerUnit - Layer - Pallet - SalesUnit ### cgcloud\_\_Value\_Receipt\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Calculated value of the item in the receipt or document currency. ### cgcloud\_\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Calculated value of the item in the domestic currency. ### cgcloud\_\_Voided\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a disposal list item is voided. - **Default value**: false ## 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\_\_Order\_Item\_\_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\_\_Order\_Item\_\_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\_\_Order\_Item\_\_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\_\_Order\_Item\_\_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\_\_Order\_Item\_\_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. # cgcloud\_\_Order\_Item\_Inventory\_Transaction\_\_c Holds the association details for the order item template, the inventory control template, and the inventory transaction template. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Attribute used to enable or disable the current template or record. - **Default value**: true ### cgcloud\_\_Inventory\_Control\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Inventory control template ID. This is a relationship field. - **Relationship Name**: cgcloud\_\_Inventory\_Control\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Inventory\_Control\_Template\_\_c ### cgcloud\_\_Inventory\_Transaction\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Inventory transaction template ID. This is a relationship field. - **Relationship Name**: cgcloud\_\_Inventory\_Transaction\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Inventory\_Transaction\_Template\_\_c ### cgcloud\_\_Order\_Item\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the Order item template ID. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_Item\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Order\_Item\_Template\_\_c (master object) ### cgcloud\_\_Unique\_Field\_Display\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Technical field to verify that only one active record is used for display as Yes. Consists of: - Order\_Item\_Template.Id - Active (True, False) - User\_For\_Display (True, False) ### cgcloud\_\_Unique\_Inventory\_Templates\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Technical field to verify the uniqueness for the combination of order template, inventory control template, and inventory transaction template. - Inventory\_Control\_Template.Id - Inventory\_Transaction\_Template.Id ### cgcloud\_\_Used\_For\_Display\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies the inventory template that's relevant for showing the current inventory balances in the disposal list. - **Default value**: false ## Associated Objects ### 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\_\_Order\_Item\_Inventory\_Transaction\_\_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\_\_Order\_Item\_Inventory\_Transaction\_\_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\_\_Order\_Item\_Inventory\_Transaction\_\_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 tracked fields of the object. - **[cgcloud\_\_Order\_Item\_Inventory\_Transaction\_\_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\_\_Order\_Item\_Inventory\_Transaction\_\_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. # cgcloud\_\_Order\_Item\_Order\_Template\_Association\_\_c Holds the association of order item templates with order template. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Check\_Uniqueness\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the order template and the order item template association is unique. - **Default value**: false ### cgcloud\_\_Main\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Main order item template. - **Default value**: false ### cgcloud\_\_Order\_Item\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Order item template ID. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_Item\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Order\_Item\_Template\_\_c (master object) ### cgcloud\_\_Order\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Order template ID. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Order\_Template\_\_c (detail object) ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Hyperlink for the Detail page of the record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The date from which the association is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The date till which the association is valid. ## Associated Objects ### 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\_\_Order\_Item\_Order\_Template\_Association\_\_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\_\_Order\_Item\_Order\_Template\_Association\_\_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\_\_Order\_Item\_Order\_Template\_Association\_\_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 tracked fields of the object. - **[cgcloud\_\_Order\_Item\_Order\_Template\_Association\_\_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\_\_Order\_Item\_Order\_Template\_Association\_\_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. # cgcloud\_\_Order\_Item\_Rule\_\_c Defines the rules handled by the pricing engine during the complex pricing calculation. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Effect\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines how the order item template affects the reference value determination. - **Possible values**: - +—Add - \-—Subtract - n—Neutral ### cgcloud\_\_Item\_Meta\_Rule\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines how the rules apply to the order item template. - **Possible values**: - According to Price Effect - All Items (Total) - Delivery (excl. Free Item) - Delivery (incl. Free Item) - Returns Only ### cgcloud\_\_Order\_Item\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the order item template object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_Item\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Order\_Item\_Template\_\_c (master object) ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the order item rule record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ## Associated Objects ### 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\_\_Order\_Item\_Rule\_\_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\_\_Order\_Item\_Rule\_\_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\_\_Order\_Item\_Rule\_\_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 tracked fields of the object. - **[cgcloud\_\_Order\_Item\_Rule\_\_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\_\_Order\_Item\_Rule\_\_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. # cgcloud\_\_Order\_Item\_Template\_\_c This template controls the behavior of an Order Item Template. For example, OrderEntry is an important template, which allows a sales document to behave like an order entry. 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**: 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 ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Record type of the record. This is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Attribute that's used to enable or disable the current template. - **Default value**: true ### cgcloud\_\_Add\_Allowed\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the user can add or scan items for the selected item type. - **Default value**: false ### cgcloud\_\_Assortment\_Relation\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether the assignment of products to sales document item templates within the customer selling assortment has to be considered. - No: The system doesn't consider any assignment. - Yes: The system filters the disposal list subject to the assignment. Although, the validation verifies the assignment of each product to the according sales document item template. - **Default value**: false ### cgcloud\_\_Calculation\_Group\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Attribute that allows to classify order item templates in order to identify the item template in a complex pricing calculation step. - **Possible values**: - A—Delivery - B—Return - C—Return Resale - FreeItem—Free Item ### cgcloud\_\_Check\_Inventory\_Overdraft\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Controls whether and the method by which overdrawing the user inventory is verified. - **Default value**: No - **Possible values**: - No - Warning - Yes ### cgcloud\_\_Check\_Max\_Quantity\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Used to prevent adding quantities that are greater than the maximum value. - **Default value**: 0 - **Possible values**: - 0—No - 1—Yes - 2—Warning ### cgcloud\_\_Check\_Quota\_Overdraft\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Controls whether and the method by which overdrawing the quota is verified. - **Default value**: No - **Possible values**: - No - Warning - Yes ### cgcloud\_\_Closed\_Listing\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether an order quantity for a product thatthe order listing algorithm doesn't find can be entered for this sales document item template. - **Default value**: false ### cgcloud\_\_Complex\_Pricing\_Relevant\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the order item tempate can be used for complex scenarios. - **Default value**: false ### cgcloud\_\_Consider\_Delivery\_State\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the delivery of a product is to be considered. For return items, the delivery state is not to be considered. - **Default value**: true ### cgcloud\_\_Creation\_Platform\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the platform on which this template can be used to create order documents. - **Possible values**: - Both - Laptop - Mobility ### cgcloud\_\_Default\_Logistic\_Unit\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unit to preset. - **Possible values**: - Consumer—Consumer Unit - Order—Order Unit - Price—Price Unit - StockTaking—Stocktaking Unit ### 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 of the Order\_Item\_Template. 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\_\_Exclude\_Order\_Rounding\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether Quantity Rounding is to be excluded. - **Default value**: true ### cgcloud\_\_Explicit\_Default\_Unit\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Default Unit Unit to preset the Order\_Item.UoM. Used when Use\_Product\_Logistic !='Yes'. - **Possible values**: - ConsumerUnit—Consumer Unit - Layer - Pallet - SalesUnit—Sales Unit ### cgcloud\_\_Logistic\_Category\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Controls the logistical unit types that can be chosen for an item of this template. - **Possible values**: - All - Order—Order Unit - Stocktaking—Stocktaking Unit ### cgcloud\_\_Max\_Quantity\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Controls the maximum quantity that can be the orderer of any product by using this order item template. ### cgcloud\_\_Mobility\_Logistic\_Unit\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Controls the setting of the QuantitiyLogisticUnit attribute on the Mobility when ordering a product based on this order item template. - **Possible values**: - ConsumerUnit—Consumer Unit - OrderUnit—Order Unit ### cgcloud\_\_Modification\_Reason\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether the user must enter a reason if the preordered quantity has been modified. - **Possible values**: - Mand—Mandatory - NotReq—Not Required - Opt—Optional ### cgcloud\_\_Modification\_Reasons\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Reason for modification of the preordered quantity on a mobile device. - **Possible values**: - BadPrd—Bad Product - DmgByDriver—Damage by driver - FGReturn—Full good return - IncOrder—Incorrect order - Less—Client wants less - Misc—Miscellaneous - MissCount—Misscounting - More—Client wants more - Nopayment—No payment - OutTrStock—Out of Truck Stock - TMStock—Too much stock - TckTransfer—Truck transfer - WrDel—Wrong delivery - WrongPrd—Wrong product ### cgcloud\_\_Modify\_Quantity\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Quantity that's to be modified. - **Possible values**: - No - Only Decrease - Only Increase - Yes ### cgcloud\_\_Movement\_Direction\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the type of movement that's associated with the order. - **Default value**: None - **Possible values**: - In - None - Out ### cgcloud\_\_Permits\_Printing\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether the order item of this template is to be printed. - **Default value**: false ### cgcloud\_\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether a order quantity is to be suggested in the disposal list and whether the suggestion is to be based on the ordered quantity or on the delivered (invoiced) quantity of the item. - **Possible values**: - Delivered Quantity - No - Ordered Quantity ### cgcloud\_\_Position\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Determines the position of the order item template. - **Possible values**: - 1 - 10 - 11 - 12 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 ### cgcloud\_\_Price\_Effect\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the effect of the item template on the total value. - **Default value**: 1 - **Possible values**: - \-1—Subtractive - 0—Neutral - 1—Additive ### cgcloud\_\_Quantity\_Suggestion\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether a order quantity is to be suggested in the disposal list and whether the suggestion is to be based either on the ordered quantity or on the delivered (invoiced) quantity of the item. - **Possible values**: - DeliveredQuantity—Delivered Quantity - No - OrderedQuantity—Ordered Quantity ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org to which the order item template belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Save\_Zero\_Quantity\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Order item based on the respective item template that's to be saved when the item has been modified but still has 0 quantity of the order item. - **Default value**: false ### cgcloud\_\_Scanning\_Increment\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Scanning increment. ### cgcloud\_\_Short\_Text\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Short text for the item template. ### cgcloud\_\_UoM\_Scan\_Behavior\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: UoM Scan Behavior. - **Default value**: Standard - **Possible values**: - Barcode—Barcode UoM - Current—Current UoM - Standard—Standard UoM ### cgcloud\_\_UoM\_Scan\_Default\_Unit\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: UoM Scan Default Unit - **Default value**: SalesUnit - **Possible values**: - ConsumerUnit—Consumer Unit - Layer - Pallet - SalesUnit—Sales Unit ### cgcloud\_\_Use\_Inventory\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether user inventory relationships and attributes are to be considered. - **Default value**: false ### cgcloud\_\_Use\_Product\_Logistic\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Controls the manner in which logistics information for a product is to be considered. - **Possible values**: - N—No - V—Validate - Y—Yes ### cgcloud\_\_Use\_Quota\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether quota relationships and attributes are to be considered. - **Default value**: false ### cgcloud\_\_User\_Special\_Price\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: User Special Price - **Default value**: false ## 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\_\_Order\_Item\_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\_\_Order\_Item\_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\_\_Order\_Item\_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\_\_Order\_Item\_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\_\_Order\_Item\_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. # cgcloud\_\_Order\_Payment\_\_c Holds the attributes of the Order Payment object. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### 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\_\_Absolute\_Amount\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Amount of the payment without the sign. ### cgcloud\_\_Amount\_DC\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Amount in domestic currency. Payments are gross values. ### cgcloud\_\_Amount\_RC\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Amount in receipt currency. ### cgcloud\_\_Bank\_Account\_Number\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Account number at the bank. ### cgcloud\_\_Bank\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Code of the Bank. ### cgcloud\_\_CSC\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Card security code of the credit card. ### cgcloud\_\_Calc\_Amount\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Calculated value of the payment. Used in cash check-in process. ### cgcloud\_\_Currency\_RC\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Currency of the payment. - **Possible values**: - CAD - CHF - EUR - GBP - JPY - NOK - RUB - USD ### cgcloud\_\_Date\_Eff\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Effective date of the means of payment. ### cgcloud\_\_Exp\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Expiration date of the means of payment. ### cgcloud\_\_Expense\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates whether other types of expenses, such as Road Toll and Gas, are associated. - **Possible values**: - Gas - Lubricant - Misc - Parking - RoadToll ### cgcloud\_\_Holder\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Holder of the account. ### cgcloud\_\_Initiation\_Date\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date on which the payment is created within the system. ### cgcloud\_\_Institute\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the institute. ### cgcloud\_\_Number\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Number of the means of payment. ### cgcloud\_\_Order\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the order. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Order\_\_c ### 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\_\_Order\_Payment\_Template\_\_c ### cgcloud\_\_Payment\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Payment method to specify in the Payment template. - **Possible values**: - Cash - Check ## Associated Objects ### 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\_\_Order\_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\_\_Order\_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\_\_Order\_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 tracked fields of the object. - **[cgcloud\_\_Order\_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\_\_Order\_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. # cgcloud\_\_Order\_Payment\_Inventory\_Transaction\_\_c Holds the association details for the order payment template, the inventory template, and the inventory transaction template. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Active flag. - **Default value**: false ### cgcloud\_\_Inventory\_Control\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Inventory control template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Inventory\_Control\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Inventory\_Control\_Template\_\_c ### cgcloud\_\_Inventory\_Transaction\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the inventory transaction template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Inventory\_Transaction\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Inventory\_Transaction\_Template\_\_c ### cgcloud\_\_Order\_Payment\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the order payment template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_Payment\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Order\_Payment\_Template\_\_c (master object) ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the order inventory transaction record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ## Associated Objects ### 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\_\_Order\_Payment\_Inventory\_Transaction\_\_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\_\_Order\_Payment\_Inventory\_Transaction\_\_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\_\_Order\_Payment\_Inventory\_Transaction\_\_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 tracked fields of the object. - **[cgcloud\_\_Order\_Payment\_Inventory\_Transaction\_\_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\_\_Order\_Payment\_Inventory\_Transaction\_\_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. # cgcloud\_\_Order\_Payment\_Template\_\_c Holds the attributes of the order payment template. 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**: 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\_\_Account\_Required\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the necessity of an account number. - **Possible values**: - NotRequired - Optional - Required ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Active flag. - **Default value**: false ### cgcloud\_\_Bank\_Code\_Required\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the necessity of a bank code. - **Possible values**: - NotRequired - Optional - Required ### cgcloud\_\_CSC\_Required\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the necessity of a card security code. - **Possible values**: - NotRequired - Optional - Required ### cgcloud\_\_Debit\_Credit\_Payment\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates whether the template is used for incoming payments or outgoing payments. Empty item is added to the UI to configure inventory transfer documents (at tour start or end). Toggle check is disabled. - **Possible values**: - Credit - Debit ### cgcloud\_\_Description\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Holds the description of language 1. ### cgcloud\_\_Description\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Holds the description of language 2. ### cgcloud\_\_Description\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Holds the description of language 3. ### cgcloud\_\_Description\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Holds the description of language 4. ### cgcloud\_\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description based on 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\_\_Effective\_Date\_Required\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the necessity of an effective date. - **Possible values**: - NotRequired - Optional - Required ### cgcloud\_\_Expiration\_Date\_Required\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the necessity of an expiration date. - **Possible values**: - NotRequired - Optional - Required ### cgcloud\_\_Holder\_Name\_Required\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the necessity of an account holder. - **Possible values**: - NotRequired - Optional - Required ### cgcloud\_\_Institute\_Required\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the necessity of a name for the institute. - **Possible values**: - NotRequired - Optional - Required ### cgcloud\_\_Item\_Number\_Required\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the necessity of a number for the means of payment. - **Possible values**: - NotRequired - Optional - Required ### cgcloud\_\_PaymentMethod\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Method of payment. - **Possible values**: - Cash - Check - CreditCard - DebitCard - Deduction - Expense - MoneyOrder - Multiple ### cgcloud\_\_Payment\_Modification\_Reason\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Picklist values that define the need for modification of payment. - **Possible values**: - Lost - Miscounting - NoReceipt - Stolen ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org that the order template belongs to. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## Associated Objects ### 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\_\_Order\_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\_\_Order\_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\_\_Order\_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 tracked fields of the object. - **[cgcloud\_\_Order\_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\_\_Order\_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. # cgcloud\_\_Order\_Template\_\_c Template that controls the behavior of a sales document. 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**: 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 ### 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\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Attribute that's used to either enable or disable the current template. - **Default value**: true ### cgcloud\_\_Add\_Former\_Items\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Template setting controls whether items, which belong to a former sales document of the same business partner and of the same sales document template, are to be added to the disposal list. The system considers only sales documents that have reached a status of status type as Ready within the number of days specified in SdoMeta.ConsiderMaxHistoryDays. - **Default value**: false ### cgcloud\_\_Add\_Items\_Json\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: JSON to customize the Add Items page. ### cgcloud\_\_Allow\_Competitor\_Products\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether foreign products can be used in the sales document. - **Default value**: false ### cgcloud\_\_Allow\_Header\_Discount\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates if a user can provide a discount for the order. The app evaluates the discount percentage or amount from the valid pricing conditions for the order. - **Default value**: false ### cgcloud\_\_Allowed\_Orderer\_Types\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Allowed Orderer Types. - **Possible values**: - Direct - Indirect - Replenishment ### cgcloud\_\_Barcode\_Scan\_Behavior\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Controls the behavior of barcode scanning of products: Select an item, and then increase the product quantity. - **Default value**: SelectIncrease - **Possible values**: - AddBatchNumber—Add Batch Number - OnlySelect—Only Select - SelectIncrease—Select Increase - UserExit—User Exit ### cgcloud\_\_Can\_Purchase\_Number\_Update\_Allowed\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the driver is allowed to update the purchase number while reviewing the delivery document. - **Default value**: false ### cgcloud\_\_Calculation\_Schema\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the calculation schema that determines the calculation schema that's used in truck load documents. This is a relationship field. - **Relationship Name**: cgcloud\_\_Calculation\_Schema\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Calculation\_Schema\_\_c ### cgcloud\_\_Cancel\_Reason\_Required\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the user must provide a reason for order or delivery document cancellation. - **Default value**: false ### cgcloud\_\_Cancel\_Reason\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Specifies the reason for the cancellation of the delivery document or order. - **Possible values**: - CanceledByCall—Canceled By Call - CashierNotAvailable—Cashier Not Available - CustomerBlocked—Customer is credit blocked - DoubleDelivery—Double Delivery - Misentry - NotEnoughMoney—Not Enough Money - WrongDelivery—Wrong Delivery - WrongPricing—Wrong Pricing ### cgcloud\_\_Capture\_Release\_Time\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Capture Release Time. - **Default value**: false ### cgcloud\_\_Check\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether the delivery date is to be checked. - **Default value**: true ### cgcloud\_\_Check\_Out\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Order is used for the inventory check-out. - **Default value**: SKU Check-Out - **Possible values**: - Counting Group Check-Out - Express Check-Out - Pallet Check-Out - SKU Check-Out ### cgcloud\_\_Compute\_Price\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Controls whether prices are computed for the items. - **Possible values**: - 0—Save - 1—Add and Save - 2—No - 3—External - 4—Offline (Button) - 5—Offline (Edit Mode) ### cgcloud\_\_Consider\_Field\_Availability\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Template setting controls whether the field state is to be considered when adding a product to the disposal list. - **Default value**: false ### cgcloud\_\_Consider\_History\_In\_Days\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Controls the number of days that are to be used to determine a last item. ### cgcloud\_\_Consider\_Inventory\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines the products in the item list based on existing user inventories. - **Default value**: false ### cgcloud\_\_Consider\_Lead\_Time\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the lead time is taken from the delivery recipient. Otherwise, the lead time of this template is taken. The maximum lead time is defined in both cases by the template. - **Default value**: false ### cgcloud\_\_Consider\_Listing\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: All products of active listings are considered according to the specified listing finding template. - **Possible values**: - 0—No - 1—Yes - 2—User Exit ### cgcloud\_\_Consider\_Modification\_Reason\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether modification reasons can be entered for modified items. - **Default value**: false ### cgcloud\_\_Consider\_OoS\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The system adds out-of-stock products to the disposal list and/or presets their quantity. - **Possible values**: - Add - AddPreset—Add & Preset Quantity - No - Preset—Preset Quantity ### cgcloud\_\_Consider\_Promotion\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: All products whose state is active and executable are considered according to the specified promotion finding template. - **Possible values**: - 0—No - 1—Yes - 2—User Exit ### cgcloud\_\_Consider\_Quantity\_Suggestion\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Presetting of the ordered quantity via either the calculated quantity suggestion or preordered quantity. - **Possible values**: - LQtyStock—Last Quantities & Stock - Lqty—Last Quantities - No - Pqty—Preordered Quantity ### cgcloud\_\_Consider\_Saturday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: If 1 (true): deliveries on Saturdays are allowed. - **Default value**: false ### cgcloud\_\_Consider\_Selectable\_Promotion\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Enables selectable promotions on Mobility. - **Default value**: false ### cgcloud\_\_Consider\_Stock\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the current stock is to be considered for quantity suggestion in the web display of the disposal list. Currently, it's additionally used to display the current stock in the disposal list of the Mobility device. - **Default value**: false ### cgcloud\_\_Consider\_Sunday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: If 1 (true): deliveries on Sundays are allowed. - **Default value**: false ### cgcloud\_\_Creation\_Platform\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the platform on which this template can be used to create sales documents. - **Default value**: Laptop - **Possible values**: - Both - Laptop - Mobility ### cgcloud\_\_Customer\_Selling\_Assortment\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether the customer selling assortment is used to preset the disposal list. - 0/No: The system doesn't consider any customer selling assortment. - 1/Yes: The system filters the disposal list subject to the customer selling assortment. All other template attributes for the disposal list control are to be considered also. - **Default value**: false ### cgcloud\_\_Deletion\_Allowed\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether it’s allowed to delete any object of the template. - **Default value**: false ### cgcloud\_\_Delivery\_Date\_Calculation\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Controls how the delivery date is determined. - **Default value**: Built In - **Possible values**: - Built In - No - Today - User Exit ### cgcloud\_\_Description\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the description in language 1. ### cgcloud\_\_Description\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the description in language 2. ### cgcloud\_\_Description\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the description in language 3. ### cgcloud\_\_Description\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the description in language 4. ### cgcloud\_\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description based on the user-specifiied language. This is a calculated field. - **Formula**: CASE($User.cgcloud\_\_Language\_Postfix\_\_c, "Language1", cgcloud\_\_Description\_Language\_1\_\_c, "Language2", cgcloud\_\_Description\_Language\_2\_\_c, "Language3", cgcloud\_\_Description\_Language\_3\_\_c, "Language4", cgcloud\_\_Description\_Language\_4\_\_c, cgcloud\_\_Description\_Language\_1\_\_c) ### cgcloud\_\_Disposal\_List\_Proposal\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Controls whether and how the disposal list is built for this sales document template. - **Default value**: Proposal - **Possible values**: - None - Proposal - Talon - UserExit—User Exit ### cgcloud\_\_Document\_Transaction\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies how to manage a sales document regarding payments. - **Possible values**: - CashInvoice—Delivery Cash Invoice - CreditInvoice—Delivery Credit Invoice - CashOrder—Cash Order - CreditMemo—Credit Memo - CreditOrder—Credit Order - InvoiceCashInvoice—Cash Invoice - InvoiceCreditInvoice—Credit Invoice - NoPayment—No Payment - NoPaymentOrder—No Payment Order - VanSalesCashInvoice—Van Sales Cash Invoice - VanSalesNoPaymentInvoice—Van Sales No Payment Invoice - NonValuatedDeliveryNote—Non Valuated Delivery Note - ValuatedDeliveryNote—Valuated Delivery Note ### cgcloud\_\_Document\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies how to handle a sales document regarding payments. - **Possible values**: - CashCheckIn—Cash Check In - CashCheckOut—Cash Check Out - Delivery - OrderEntry—Order Entry - ProductCheckIn—Product Check In - ProductCheckOut—Product Check Out - TruckAudit—Truck Audit ### cgcloud\_\_Flat\_Item\_List\_Grouping\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: When displaying the disposal list as a flat list on the Mobility device, the items are to be grouped in accordance with the product groups of the specified level. - **Possible values**: - Brand - Category - Flavor - Package - Product - SubCategory ### cgcloud\_\_Free\_Items\_Json\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: JSON to customize the Free Items page. ### cgcloud\_\_Generate\_Pricing\_Information\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Controls the storage of pricing information in the respective order item/order object. And these pricing details are shown during printing or print preview. - **Default value**: No - **Possible values**: - No - Yes - YesOV—Yes (Optimised Version) ### cgcloud\_\_Generate\_Pricing\_Log\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Controls whether the pricing engine writes or synchronizes pricing logs. - **Possible values**: - No - Yes ### cgcloud\_\_Generate\_Rewards\_Log\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: This attribute can be used by users to switch on/off the generation of the Rewards log file when the order is saved. - **Default value**: Yes - **Possible values**: - No - Yes ### cgcloud\_\_Hide\_Wholesaler\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether the attribute Broker/Wholesaler is hidden in the UI. - **Default value**: false ### cgcloud\_\_Id\_Generation\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Controls the behavior of the document number generation. - **Possible values**: - Creation—Number generation at creation time - Default—Default behavior (Web: On Save, Mobile: On Sync) - Release—Number generation at release time ### cgcloud\_Inventory\_Filter\_\_C - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the inventory products are considered for creating and validating the disposal list. - **Default value**: false ### cgcloud\_\_Inventory\_Reference\_1\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the first inventory reference usage. - **Possible values**: - ActualUser—Actual User - ActualVehicle—Actual Vehicle - DefaultUser—Default User - DefaultVehicle—Default Vehicle - Tour ### cgcloud\_\_Inventory\_Reference\_2\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the second inventory reference usage. - **Possible values**: - ActualUser—Actual User - ActualVehicle—Actual Vehicle - DefaultUser—Default User - DefaultVehicle—Default Vehicle - Tour ### cgcloud\_\_Inventory\_Reference\_3\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the third inventory reference usage. - **Possible values**: - ActualUser—Actual User - ActualVehicle—Actual Vehicle - DefaultUser—Default User - DefaultVehicle—Default Vehicle - Tour ### cgcloud\_\_Inventory\_Reference\_4\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the fourth inventory reference usage. - **Possible values**: - ActualUser—Actual User - ActualVehicle—Actual Vehicle - DefaultUser—Default User - DefaultVehicle—Default Vehicle - Tour ### cgcloud\_\_Inventory\_Reference\_5\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the fifth inventory reference usage. - **Possible values**: - ActualUser—Actual User - ActualVehicle—Actual Vehicle - DefaultUser—Default User - DefaultVehicle—Default Vehicle - Tour ### cgcloud\_\_Invoice\_Id\_Generation\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Controls the way in which an invoice number is generated. - **Possible values**: - Creation—Number generation at creation time - Default—Default behavior (Web: On Save, Mobile: On Sync) - NoGen—No Number generation - Release—Number generation at release time ### cgcloud\_Invoice\_Number\_Definition\_\_C - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the format of the system-generated invoice ID. This is a relationship field. - **Relationship Name**: cgcloud\_\_System\_Number\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_System\_Number\_\_c ### cgcloud\_\_Is\_Partial\_Payment\_Allowed\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the driver is allowed to collect partial payment for the cash order or delivery document. - **Default value**: false ### cgcloud\_\_Item\_Input\_Required\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: All items of the sales document must have been edited (entered quantity) before releasing the document. - **Default value**: false ### cgcloud\_\_Item\_Presetting\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether the system shows the presetting of item values in the truck load and cash documents. - **Possible values**: - BlindMode—Blind Lines - NonBlindMode—Non Blind Lines - Prepopulated ### cgcloud\_\_List\_Option\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the default list option in the sales document. - **Possible values**: - Flat List - Hierarchy ### cgcloud\_\_Listing\_Finding\_Date\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Controls the date that's used for the product finding algorithms of customer authorization lists. - **Default value**: ListingDate - **Possible values**: - DeliveryDate—Delivery Date - InitiationDate—Initiation Date - ListingDate—Listing Date - OrderDate—Order Date ### cgcloud\_\_Listing\_Finding\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the authorization list finding template, which controls the behavior of the algorithm. - **Default value**: None - **Possible values**: - Hit—First Hit - None ### cgcloud\_\_Manual\_Adjustment\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether the delivery date can be edited by the user. - **Default value**: true ### cgcloud\_\_Max\_Lead\_Time\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Number of maximum days that are allowed to place an order before the planned delivery date. ### cgcloud\_\_Max\_Order\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Maximum order value that's accepted for orders of this template. ### cgcloud\_\_Min\_Lead\_Time\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Number of minimum days needed to process the order and prepare the delivery. ### cgcloud\_\_Min\_Order\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Minimum order value that's accepted for orders of this template. The system only considers the value if it's >=0.01. ### cgcloud\_\_Mobility\_Relevant\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls the validation of restrictions that are necessary for usage on mobility devices. - **Default value**: false ### cgcloud\_\_Notify\_Outdated\_Calculation\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether the system issues a warning message about an outdated complex pricing calculation when opening the order. - **Default value**: false ### cgcloud\_\_Number\_Of\_Historic\_Quantities\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Number of historical orders that are to be considered for quantity suggestion. ### cgcloud\_\_Order\_Details\_Json\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: JSON to customize the Order Details page. ### cgcloud\_\_Order\_Items\_Json\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: JSON to customize the Order Items section. ### cgcloud\_\_Order\_Page\_Header\_Json\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: JSON to customize the Order Page Header section. ### cgcloud\_\_Payment\_Modification\_Reason\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether modification reasons can be entered for the difference in payments. - **Possible values**: - Mandatory - Notrequired—Not required - Optional ### cgcloud\_\_Price\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Determines the Price Type value for every product. - **Possible values**: - NotRelevant—Not Relevant - consumer—Consumer - factory—Factory ### cgcloud\_\_Pricing\_Date\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the date that's to be used for complex price calculation. - **Possible values**: - DeliveryDate—Delivery Date - OrderDate—Order Date ### cgcloud\_\_Pricing\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the pricing type of the order template. - **Possible values**: - A—Standard - C—Free of Charge - F—Sample/Donate - Q—Return - T—Refusal - V—Contract ### cgcloud\_\_Product\_Check\_In\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines whether a complete or partial product check-in is required at the end of a tour. The truck inventory check-out document controls the way check-in is required. - **Possible values**: - Complete—Complete check-in is mandatory - Optional—Check-in is optional - Partial—Check-in is mandatory, partial check-in allowed ### cgcloud\_\_Product\_Selector\_Groups\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Used for mobility. - **Possible values**: - All - Basket - Brand - New - Out of Stock - Promotion - Sub-Category ### cgcloud\_\_Promotion\_Filter\_Selection\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Determines the presetting of promotion filter for promotional orders. The system shows the order in the disposal list with either the first valid selectable promotion or without any selectable promotion. - **Default value**: 0 - **Possible values**: - 0—No Promotion - 1—First Promotion ### cgcloud\_\_Promotion\_Finding\_Date\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Controls the date that's used for product finding algorithms of promotion tactics. - **Default value**: ListingDate - **Possible values**: - DeliveryDate—Delivery Date - InitiationDate—Initiation Date - ListingDate—Listing Date - OrderDate—Order Date ### cgcloud\_\_Promotion\_Finding\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the promotion finding template. - **Possible values**: - Collection—Collection Algorithm - None ### cgcloud\_\_Quantity\_Rounding\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Quantity Rounding. - **Default value**: Off - **Possible values**: - Off - RoundingAlwaysOn—Rounding Always On - RoundingDefaultOff—Rounding Default Off - RoundingDefaultOn—Rounding Default On ### cgcloud\_\_Recalculation\_Required\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Controls whether forced recalculation is required in complex pricing if the calculation date diverges from the current date. - **Possible values**: - AlwaysCalculate—Always Calculate - No - Yes - YesNotify—Yes (With Notification) ### cgcloud\_\_Release\_Platform\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the platform that can be used to release the order that references this template. - **Default value**: All - **Possible values**: - All - Mobility ### cgcloud\_\_Report\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Controls the type of report that's used. ### cgcloud\_\_Sales\_Document\_Assortment\_Filter\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether the sales document template assortment is to be considered when building and validating the disposal list. - **Default value**: false ### cgcloud\_\_Sales\_Document\_Assortment\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether the sales document template assortment is used to preset the disposal list. - 0/No: The system doesn't consider any sales document template assortment. - 1/Yes: The system presets the disposal list subject to the sales document template assortment. All other template attributes for the disposal list control have to be considered also. - **Default value**: false ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org to which the order template belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Selling\_Assortment\_Filter\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether the customer selling assortment is to be considered when validating the disposal list. No: The system doesn't consider any customer selling assortment. Yes: The system filters the disposal list subject to the customer selling assortment. The validation verifies the assignment of each product to the according assortment. - **Default value**: false ### cgcloud\_\_Signature\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to a signature template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Signature\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Signature\_Template\_\_c ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Position of this instance in overviews or toggles. ### cgcloud\_\_Special\_Order\_Handling\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Used for complex pricing calculations. - **Default value**: No - **Possible values**: - ExclusiveSpecialOrder—Exclusive Special Order - InclusiveSpecialOrder—Inclusive Special Order - No ### cgcloud\_\_Special\_Order\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates the ability to use the template along with talon tactics. - **Default value**: false ### cgcloud\_\_Sync\_Options\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Sync Options. - **Possible values**: - Cancel - No - Release - ReleaseCancel—Release Cancel ### cgcloud\_\_System\_Number\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to the System Number. This is a relationship field. - **Relationship Name**: cgcloud\_\_System\_Number\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_System\_Number\_\_c ### cgcloud\_\_Transaction\_Receiver\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies for whom the inventory transactions are to be written. For example, either for the initiator or for the owner of the respective sales or inventory document. - **Possible values**: - Initiator - Owner ### cgcloud\_\_Use\_Built\_In\_Pricing\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Controls whether built-in pricing is used to or the whole pricing is done by a user exit. - **Possible values**: - No - Yes ### cgcloud\_\_Use\_Customer\_Document\_TA\_Type\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the handling type of the customer is to be considered . - **Default value**: false ### cgcloud\_\_User\_Roles\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: User roles that are assigned to the order template. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note Ensure that the master picklist values exactly match the Technical Name of the permission sets. Enter the user value in Translation. For example, if CGCloud\_Master\_Data\_Admin is the master picklist value, then Master Data Admin is the translated value. - **Possible values**: - CGCloud\_KAM - CGCloud\_Master\_Data\_Admin - CGCloud\_Retail\_Admin - CGCloud\_Sales\_User - CGCloud\_Security\_Admin - CGCloud\_Supervisor - CGCloud\_Tour\_User ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date from which the entry is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the entry is valid. ### cgcloud\_\_Wholesaler\_Required\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a wholesaler or broker reference is required for sales documents of this template. - **Default value**: false ### cgcloud\_\_Workflow\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the workflow. This is a relationship field. - **Relationship Name**: cgcloud\_\_Workflow\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Workflow\_\_c ## Associated Objects ### Associated Objects This object has these 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\_\_Order\_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\_\_Order\_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\_\_Order\_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\_\_Order\_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\_\_Order\_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. # cgcloud\_\_Order\_Template\_Order\_Payment\_Template\_\_c Holds the association details for the order template and the order payment template. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Order\_Payment\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the order payment template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_Payment\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Order\_Payment\_Template\_\_c (detail object) ### cgcloud\_\_Order\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the order template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Order\_Template\_\_c (master object) ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Hyperlink to the detail page of the record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ## Associated Objects ### Associated Objects The object has these associated objects. The associated object's API version is the same as the API version of the object unless specified otherwise: - **[cgcloud\_\_Order\_Template\_Order\_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\_\_Order\_Template\_Order\_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\_\_Order\_Template\_Order\_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 tracked fields of the object. - **[cgcloud\_\_Order\_Template\_Order\_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\_\_Order\_Template\_Order\_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. # cgcloud\_\_Order\_Template\_Product\_Selector\_Group\_\_c Stores the relation between Order Template and Product selection. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Default\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Default flag. - **Default value**: false ### cgcloud\_\_Level\_1\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Product Selector Level 1. - **Possible values**: - All - Basket - Brand - Category - History - New - OutOfStock - Promotion - SubCategory ### cgcloud\_\_Level\_2\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Product Selector Level 2. - **Possible values**: - Brand - Category - Promotion - SubCategory ### cgcloud\_\_Order\_Template\_Id\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the Order template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_Template\_Id\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Order\_Template\_\_c (Master object) ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Hyperlink to the detail page of the record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ## 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\_\_Order\_Template\_Product\_Selector\_Group\_\_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\_\_Order\_Template\_Product\_Selector\_Group\_\_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\_\_Order\_Template\_Product\_Selector\_Group\_\_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\_\_Order\_Template\_Product\_Selector\_Group\_\_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\_\_Order\_Template\_Product\_Selector\_Group\_\_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. # cgcloud\_\_Org\_Unit\_\_c Stores the details of the Organization unit object that defines a manufacturer's organizational structure. 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**: 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\_\_Description\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the description for language 1. ### cgcloud\_\_Description\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the description for language 2. ### cgcloud\_\_Description\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the description for language 3. ### cgcloud\_\_Description\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the description for 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\_\_Main\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Main Org Unit. - **Default value**: false ### cgcloud\_\_Org\_Level\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Level of an organization unit regarding a organization type. - **Possible values**: - Client - SalesOffice - SalesOrganization - SalesRep ### cgcloud\_\_Org\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of a organization unit. - **Possible values**: - Marketing - Sales - Service ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org to which the org unit belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## 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\_\_Org\_Unit\_\_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\_\_Org\_Unit\_\_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\_\_Org\_Unit\_\_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\_\_Org\_Unit\_\_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\_\_Org\_Unit\_\_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. # cgcloud\_\_Org\_Unit\_Hierarchy\_\_c Stores the details of the relationship between two org units. It's typically used for the sales org unit hierarchy. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Child\_Org\_Level\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Child Org Level. This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Child\_Org\_Unit\_\_r.cgcloud\_\_Org\_Level\_\_c) ### cgcloud\_\_Child\_Org\_Type\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Child Org Type. This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Child\_Org\_Unit\_\_r.cgcloud\_\_Org\_Type\_\_c) ### cgcloud\_\_Child\_Org\_Unit\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to a child org unit in an org unit hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Child\_Org\_Unit\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Org\_Unit\_\_c (the master object) ### cgcloud\_\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description based on the user specific language. This is a calculated field. - **Formula**: cgcloud\_\_Parent\_Org\_Unit\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Parent\_Org\_Level\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Parent Org Level. This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Parent\_Org\_Unit\_\_r.cgcloud\_\_Org\_Level\_\_c) ### cgcloud\_\_Parent\_Org\_Type\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Parent Org Type. This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Parent\_Org\_Unit\_\_r.cgcloud\_\_Org\_Type\_\_c) ### cgcloud\_\_Parent\_Org\_Unit\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the parent org unit in an org unit hierachy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Parent\_Org\_Unit\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Org\_Unit\_\_c ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Hyperlink to the detail page of the record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Date from which the entry is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Date until which the entry is valid. ## 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\_\_Org\_Unit\_Hierarchy\_\_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\_\_Org\_Unit\_Hierarchy\_\_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\_\_Org\_Unit\_Hierarchy\_\_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\_\_Org\_Unit\_Hierarchy\_\_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\_\_Org\_Unit\_Hierarchy\_\_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. # cgcloud\_\_Org\_Unit\_User\_\_c Stores the details of the relationship between the organization unit and the user. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Main\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines the main user. - **Default value**: false ### cgcloud\_\_Management\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Management Type. - **Possible values**: - CallCenter - Consultant - Sales - Services ### cgcloud\_\_Org\_Unit\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to an org unit that's assigned to a user. This is a relationship field. - **Relationship Name**: cgcloud\_\_Org\_Unit\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Org\_Unit\_\_c (the master object) ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Hyperlink to the detail page of the record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to a user who is assigned to an org unit. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Date from which the entry is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Date until which the entry is valid. ## 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\_\_Org\_Unit\_User\_\_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\_\_Org\_Unit\_User\_\_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\_\_Org\_Unit\_User\_\_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\_\_Org\_Unit\_User\_\_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\_\_Org\_Unit\_User\_\_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. # cgcloud\_\_Organization\_Setting\_\_c This object enables or disables the role hierarchy in a call module. 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 ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique identification of the record. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The SetupOwnerId field on Hierarchy Custom Settings stores either the Org, Profile, or User that's associated to a custom setting record. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ### cgcloud\_\_Role\_Hierarchy\_Disabled\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Enables or disables the role hierarchy in a call module. - **Default value**: false ## 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\_\_Organization\_Setting\_\_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\_\_Organization\_Setting\_\_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\_\_Organization\_Setting\_\_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\_\_Organization\_Setting\_\_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\_\_Organization\_Setting\_\_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. # cgcloud\_\_Package\_Setting\_\_c This is a custom setting that helps you manage dynamic namespaces. 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 ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique identification of the record. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The SetupOwnerId field on Hierarchy Custom Settings stores either the Org, Profile, or User that's associated with a custom setting record. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ### cgcloud\_\_Namespace\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the namespace of the org. ## 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\_\_Package\_Setting\_\_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\_\_Package\_Setting\_\_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\_\_Package\_Setting\_\_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\_\_Package\_Setting\_\_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\_\_Package\_Setting\_\_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. # 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. # cgcloud\_\_Payment\_External\_Reference\_\_c This object contains the hyperlinks that are related to a payment record. 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 ### 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\_\_Payment\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Reference to the Payment. This is a relationship field. - **Relationship Name**: cgcloud\_\_Payment\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Payment\_\_c ### cgcloud\_\_URL\_Link\_\_c - **Type**: url - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Hyperlinks to the Payment documentation. ## 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\_External\_Reference\_\_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\_External\_Reference\_\_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\_External\_Reference\_\_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\_External\_Reference\_\_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\_External\_Reference\_\_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. # cgcloud\_\_Payment\_Tactic\_\_c This object represents the relationship between Fund and Payment Tactic junction objects. 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**: 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**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Record type of the record. This is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### cgcloud\_\_Adjustment\_Type\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: If a payment is to be adjusted, this field defines the type of adjustment. ### cgcloud\_\_Amount\_Offset\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Tactic payout that's pending after having associated payment tactic funds. This is a calculated field. - **Formula**: ABS( cgcloud\_\_Tactic\_Payout\_\_c - cgcloud\_\_Payment\_Tactic\_Fund\_Summary\_\_c ) ### cgcloud\_\_Anchor\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Anchor of the tactic. This is a calculated field. - **Formula**: cgcloud\_\_Tactic\_\_r.cgcloud\_\_Anchor\_\_c ### cgcloud\_\_Calculation\_Date\_From\_\_c - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: Start date of the calculation timeframe for the payment tactic. This is a calculated field. - **Formula**: IF(ISBLANK(cgcloud\_\_Custom\_Calculation\_Date\_From\_\_c), cgcloud\_\_Tactic\_\_r.cgcloud\_\_Date\_From\_\_c,cgcloud\_\_Custom\_Calculation\_Date\_From\_\_c) ### cgcloud\_\_Calculation\_Date\_Thru\_\_c - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: End date of the calculation timeframe for the payment tactic. This is a calculated field. - **Formula**: IF(ISBLANK(cgcloud\_\_Custom\_Calculation\_Date\_Thru\_\_c), cgcloud\_\_Tactic\_\_r.cgcloud\_\_Date\_Thru\_\_c,cgcloud\_\_Custom\_Calculation\_Date\_Thru\_\_c) ### cgcloud\_\_Custom\_Calculation\_Date\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Start date of the custom calculation timeframe for the payment tactic. ### cgcloud\_\_Custom\_Calculation\_Date\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: End date of the custom calculation timeframe for the payment tactic. ### cgcloud\_\_End\_Date\_\_c - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: End date of the tactic. This is a calculated field. - **Formula**: cgcloud\_\_Tactic\_\_r.cgcloud\_\_Date\_Thru\_\_c ### cgcloud\_\_Fund\_Distribution\_Metric\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Distribution metric that a user can choose to calculate funding percentage and payout amount. - **Default value**: LE\_Volume\_\_c - **Possible values**: - LE\_Revenue\_\_c—LE Revenue - LE\_Volume\_\_c—LE Volume ### cgcloud\_\_Has\_Calculated\_Amount\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates when a payment is updated and saved so that the recalculation of the tactic payout amount can be triggered. - **Default value**: false ### cgcloud\_\_KPI\_Subset\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: KPI Subset defines the KPIs that are shown in the Payment Tactic KPI Grid of this payment tactic. This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Payment\_\_r.cgcloud\_\_Payment\_Template\_\_r.cgcloud\_\_KPI\_Subset\_\_c) ### cgcloud\_\_Payment\_Method\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Payment method of the tactic. This is a calculated field. - **Formula**: Text(cgcloud\_\_Tactic\_\_r.cgcloud\_\_Payment\_Method\_\_c) ### cgcloud\_\_Payment\_Status\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Status of the payment. ### cgcloud\_\_Payment\_Tactic\_Fund\_Summary\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Summary of the Payment Tactic Funds that's associated to the payment. ### cgcloud\_\_Payment\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: User-friendly payment tactic identifier. This is a relationship field. - **Relationship Name**: cgcloud\_\_Payment\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Payment\_\_c (Master object) ### cgcloud\_\_Pending\_Amount\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Pending amount that's to be paid. This is a calculated field. - **Formula**: cgcloud\_\_Tactic\_\_r.cgcloud\_\_Pending\_Amount\_\_c ### cgcloud\_\_Promotion\_Slogan\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Promotion slogan of the source promotion to which the tactic is related. This is a calculated field. - **Formula**: cgcloud\_\_Tactic\_\_r.cgcloud\_\_Promotion\_\_r.cgcloud\_\_Slogan\_\_c ### cgcloud\_\_Promotion\_Tactic\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Combination of the source promotion and tactic name that's used in the payment. This is a calculated field. - **Formula**: HYPERLINK("/one/one.app#/sObject/" & Id & "/view", cgcloud\_\_Tactic\_\_r.cgcloud\_\_Promotion\_\_r.cgcloud\_\_Slogan\_\_c &' - '& cgcloud\_\_Tactic\_\_r.cgcloud\_\_Tactic\_Template\_\_r.cgcloud\_\_Description\_\_c ) ### cgcloud\_\_Requires\_Fund\_\_c - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Defines whether the payment requires funds to be approved. This is a calculated field. - **Formula**: cgcloud\_\_Payment\_\_r.cgcloud\_\_Payment\_Template\_\_r.cgcloud\_\_Requires\_Funds\_\_c ### cgcloud\_\_Start\_Date\_\_c - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: Start date of the tactic. This is a calculated field. - **Formula**: cgcloud\_\_Tactic\_\_r.cgcloud\_\_Date\_From\_\_c ### cgcloud\_\_Tactic\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description of the tactic. This is a calculated field. - **Formula**: HYPERLINK("/one/one.app#/sObject/" & Id & "/view", cgcloud\_\_Tactic\_\_r.cgcloud\_\_Tactic\_Template\_\_r.cgcloud\_\_Description\_\_c) ### cgcloud\_\_Tactic\_Payout\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Payment amount that's allocated for the specified tactic. Depending on the orientation of the payment, you can enter either negative or positive values in this field. For positive payments, only positive values are allowed and for negative payments, only negative values are allowed. ### cgcloud\_\_Tactic\_Template\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Reference to the tactic template of the tactic. This is a calculated field. - **Formula**: cgcloud\_\_Tactic\_\_r.cgcloud\_\_Tactic\_Template\_\_r.Name ### cgcloud\_\_Tactic\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the tactic. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tactic\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Tactic\_\_c (Detail object) ### cgcloud\_\_To\_Date\_Paid\_Amount\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Amount that's paid until the current date. This is a calculated field. - **Formula**: cgcloud\_\_Tactic\_\_r.cgcloud\_\_To\_Date\_Paid\_Amount\_\_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\_Tactic\_\_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\_Tactic\_\_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\_Tactic\_\_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\_Tactic\_\_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\_Tactic\_\_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. # cgcloud\_\_Payment\_Tactic\_Fund\_\_c This object stores the relationship between the Fund and Payment Tactic junction objects. 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. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Adjustment\_Type\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Adjustment type of the payment. ### cgcloud\_\_Amount\_\_c - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: Average amount of a specific tactic. ### cgcloud\_\_Anchor\_Customer\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Anchor customer of the fund. This is a calculated field. - **Formula**: cgcloud\_\_Fund\_\_r.cgcloud\_\_Anchor\_Account\_\_r.Name ### cgcloud\_\_Anchor\_Product\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Anchor product of the fund. This is a calculated field. - **Formula**: cgcloud\_\_Fund\_\_r.cgcloud\_\_Anchor\_Product\_\_r.Name ### cgcloud\_\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description of the fund. This is a calculated field. - **Formula**: cgcloud\_\_Fund\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Fund\_Name\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Name of the fund. This is a calculated field. - **Formula**: cgcloud\_\_Fund\_\_r.Name ### cgcloud\_\_Fund\_Type\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Type of the fund. This is a calculated field. - **Formula**: cgcloud\_\_Fund\_\_r.cgcloud\_\_Fund\_Template\_\_r.Name ### cgcloud\_\_Fund\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the fund. This is a relationship field. - **Relationship Name**: cgcloud\_\_Fund\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Fund\_\_c (the master object) ### cgcloud\_\_Funding\_Percent\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Value that drives the amount distribution for the fund. ### cgcloud\_\_LE\_Revenue\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Total value of KPI that's referenced in the Fund Template’s LE Revenue field,. This is a calculated field. - **Formula**: cgcloud\_\_Fund\_\_r.cgcloud\_\_LE\_Revenue\_\_c ### cgcloud\_\_LE\_Volume\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Total value of the KPI that's referenced in the Fund Template’s LE Volume field. This is a calculated field. - **Formula**: cgcloud\_\_Fund\_\_r.cgcloud\_\_LE\_Volume\_\_c ### cgcloud\_\_Payment\_Age\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Reads the Payment Age off of the related Payment record. This field is helpful for reporting purposes. This is a calculated field. - **Formula**: cgcloud\_\_Payment\_Tactic\_\_r.cgcloud\_\_Payment\_\_r.cgcloud\_\_Payment\_Age\_\_c ### cgcloud\_\_Payment\_Anchor\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: References to the name of the Payment Anchor with which the Payment Tactic is associated. This field is a calculated field. This field is available in API version 55.0 and later. - **Formula**: cgcloud\_\_Payment\_Tactic\_\_r.cgcloud\_\_Payment\_\_r.cgcloud\_\_Payment\_Anchor\_\_r.Name ### cgcloud\_\_Payment\_Status\_\_c - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Status of the payment to which this record is assigned. ### cgcloud\_\_Payment\_Tactic\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Payment Tactic. This is a relationship field. - **Relationship Name**: cgcloud\_\_Payment\_Tactic\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Payment\_Tactic\_\_c ### cgcloud\_\_Payment\_Type\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Reads the Payment Type off of the related Payment record. This field is helpful for reporting purposes. This is a calculated field. - **Formula**: cgcloud\_\_Payment\_Tactic\_\_r.cgcloud\_\_Payment\_\_r.cgcloud\_\_Payment\_Type\_\_c ### cgcloud\_\_Promotion\_Anchor\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: References to the Tactic Anchor name with which the Payment Tactic is associated. This field is a calculated field. This field is available in API version 55.0 and later. - **Formula**: cgcloud\_\_Payment\_Tactic\_\_r.cgcloud\_\_Tactic\_\_r.cgcloud\_\_Anchor\_\_c ### cgcloud\_\_Promotion\_Tactic\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: References to the Promotion Tactic with which the Payment Tactic is associated. This field is a calculated field. This field is available in API version 55.0 and later. - **Formula**: cgcloud\_\_Payment\_Tactic\_\_r.cgcloud\_\_Promotion\_Tactic\_\_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\_Tactic\_Fund\_\_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\_Tactic\_Fund\_\_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\_Tactic\_Fund\_\_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\_Tactic\_Fund\_\_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\_Tactic\_Fund\_\_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. # cgcloud\_\_Payment\_Tactic\_Product\_\_c This object contains payment tactic products and assigned values at the LDP level or at the level that the project defines as payment product level. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), 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. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Additional\_Kpi\_Value\_1\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: KPI value for the measure that's defined in Payment\_Template\_\_c.Additional\_Snapshot\_Kpi\_Definition\_1\_\_c. ### cgcloud\_\_Additional\_Kpi\_Value\_2\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: KPI value for the measure that's defined in Payment\_Template\_\_c.Additional\_Snapshot\_Kpi\_Definition\_2\_\_c. ### cgcloud\_\_Additional\_Kpi\_Value\_3\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: KPI value for the measure that's defined in Payment\_Template\_\_c.Additional\_Snapshot\_Kpi\_Definition\_3\_\_c. ### cgcloud\_\_Amount\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Payment amount for the current tactic or product combination. ### cgcloud\_\_Payment\_Tactic\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Payment/Tactic combination to which the record belongs. This is a relationship field. - **Relationship Name**: cgcloud\_\_Payment\_Tactic\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Payment\_Tactic\_\_c ### cgcloud\_\_Payment\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the payment. This is a relationship field. - **Relationship Name**: cgcloud\_\_Payment\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Payment\_\_c (the master object) ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Product to which the record belongs. The level of the product is bound by Payment\_Template\_\_c.Snapshot\_Product\_Level\_\_c. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ## Associated Objects ### Associated Objects This object has these following 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\_Tactic\_Product\_\_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\_Tactic\_Product\_\_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\_Tactic\_Product\_\_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\_Tactic\_Product\_\_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\_Tactic\_Product\_\_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. # cgcloud\_\_Payment\_Tactic\_Product\_Manual\_Input\_\_c Stores manual inputs for payment tactic-specific manual inputs. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Effective\_Total\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Effective Total Value. ### cgcloud\_\_Measure\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Measure Code under which the manual input is stored in the .json file. ### cgcloud\_\_Obsolete\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Obsolete flag of the manual input entry. - **Default value**: 0 - **Possible values**: - 0—Non Obsolete - 1—Obsolete since removed - 2—Obsolete since overridden ### cgcloud\_\_Payment\_Tactic\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Payment or Tactic combination for which the manual input was entered. This is a relationship field. - **Relationship Name**: cgcloud\_\_Payment\_Tactic\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Payment\_Tactic\_\_c ### cgcloud\_\_Payment\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Related payment. This is a relationship field. - **Relationship Name**: cgcloud\_\_Payment\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Payment\_\_c (the master object) ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Product for which the manual input was entered. Because the manual input can happen on any level (also, total level), the value of this object can be null. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Input order of manual inputs. It's incremented by 1 for each new entry for a payment or tactic combination. ### cgcloud\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: User who entered the manual input. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Entered value. ## 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\_Tactic\_Product\_Manual\_Input\_\_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\_Tactic\_Product\_Manual\_Input\_\_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\_Tactic\_Product\_Manual\_Input\_\_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\_Tactic\_Product\_Manual\_Input\_\_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\_Tactic\_Product\_Manual\_Input\_\_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. # 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. # cgcloud\_\_Picklist\_Toggle\_Addon\_\_c This is a non-data object. It's purely used to define different picklists, which are retail mobile only or that don't have any real corresponding field in the RCG back end. These picklists are then mapped with the Picklist-Toggle-Mapping concepts in Sync Package. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### 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\_\_Dom\_Ast\_Presence\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Representation of the DomAstPresence domain. - **Default value**: 0 - **Possible values**: - 0 - 1 - 2 - 3 ### cgcloud\_\_Dom\_Pay\_Ctt\_Tactic\_Status\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Representation of the DomPayCttTacticStatus domain. - **Possible values**: - Approved - FullRejection ### cgcloud\_\_Dom\_Prd\_Meta\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Representation of the DomPrdMetaType domain. - **Possible values**: - Category - GenericCategory - PrdGroup - Product ## 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\_\_Picklist\_Toggle\_Addon\_\_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\_\_Picklist\_Toggle\_Addon\_\_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\_\_Picklist\_Toggle\_Addon\_\_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\_\_Picklist\_Toggle\_Addon\_\_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\_\_Picklist\_Toggle\_Addon\_\_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. # cgcloud\_\_POS\_\_c Stores the details of the POS object. A Point of Sale (POS) stores the information about a place in the customer's premises at which goods are sold to consumers. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to Customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (Master object) ### 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\_\_POS\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the POS template. This is a relationship field. - **Relationship Name**: cgcloud\_\_POS\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_POS\_Template\_\_c ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the POS record. This is a calculated field. - **Formula**: (HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top")) ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Valid from date of the POS. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Valid until date of the POS. ## 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\_\_POS\_\_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\_\_POS\_\_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\_\_POS\_\_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\_\_POS\_\_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\_\_POS\_\_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. # cgcloud\_\_POS\_Template\_\_c Stores the details of the POS template object that's to be used for POS (Point of Sale). 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**: 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**: Active flag. - **Default value**: true ### 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\_\_POS\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Type of POS. - **Default value**: shelf - **Possible values**: - ct—Cigarette Carrier - dairycase—Dairy Case - freezer—Freezer - refrigerator—Refrigerator - sc—Sales Counter - shelf—Shelf - smt—Cigarette Sales Panel - vm—Vending Machine ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the POS Template belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## Associated Objects ### Associated Objects This object has these associated objects. If the API version isn’t specified, they e available in the same API versions as this object. Otherwise, they are available in the specified API version and later. - **[cgcloud\_\_POS\_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\_\_POS\_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\_\_POS\_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\_\_POS\_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\_\_POS\_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. # cgcloud\_\_Product\_Assortment\_Order\_Template\_\_c Stores the details of the relationship between product assortment and order template. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Order\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Reference to a order template assigned to the assortment. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Order\_Template\_\_c (the detail object) ### cgcloud\_\_Product\_Assortment\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the assortment to which the order template relation belongs. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_Assortment\_\_r - **Relationship Type**: Master-detail - **Refers To**: Assortment (the master object) ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the product assortment order template record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ## 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\_\_Product\_Assortment\_Order\_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\_\_Product\_Assortment\_Order\_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\_\_Product\_Assortment\_Order\_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\_\_Product\_Assortment\_Order\_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\_\_Product\_Assortment\_Order\_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. # cgcloud\_\_Product\_Assortment\_Product\_Share\_\_c This object stores the details of categories that are assigned to a Product assortment. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Product\_Assortment\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Assortment to which the categories are assigned. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_Assortment\_\_r - **Relationship Type**: Master-detail - **Refers To**: Assortment (the master object) ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Category that's assigned to the assortment. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Record Link. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ## 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\_\_Product\_Assortment\_Product\_Share\_\_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\_\_Product\_Assortment\_Product\_Share\_\_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\_\_Product\_Assortment\_Product\_Share\_\_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\_\_Product\_Assortment\_Product\_Share\_\_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\_\_Product\_Assortment\_Product\_Share\_\_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. # cgcloud\_\_Product\_Assortment\_Store\_\_c The object holds the customers (stores) for which the Product assortment (authorization list) is valid. The store assignment is taken from the trade org hierarchy by the batch process that represents the listing finding. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Assortment\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the product assortment. This is a relationship field. - **Relationship Name**: cgcloud\_\_Assortment\_\_r - **Relationship Type**: Master-detail - **Refers To**: Assortment (the detail object) ### cgcloud\_\_Store\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Store\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ## 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\_\_Product\_Assortment\_Store\_\_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\_\_Product\_Assortment\_Store\_\_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\_\_Product\_Assortment\_Store\_\_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\_\_Product\_Assortment\_Store\_\_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\_\_Product\_Assortment\_Store\_\_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. # cgcloud\_\_Product\_Assortment\_Template\_\_c Template for product assortments. Controls the behavior of the instances of this template. For example, if a business partner is to be specified (AccountMultiplicity). This table is dependent on the sales organization. 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**: 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 ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### cgcloud\_\_Account\_Multiplicity\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the number of business partners that can be assigned to an assortment of this template. - **Possible values**: - 0—No - 1—Exactly One - m—One or More - n—Zero or More ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Boolean to identify whether the Product Assortment template is active. - **Default value**: true ### cgcloud\_\_Consider\_For\_APL\_Generation\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines the Product Assortment to be considered in the Account Product list. - **Default value**: false ### 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\_\_Product\_Level\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the product level. - **Possible values**: - Brand - Category - Flavor—Sub Brand - Package—Product Price Group - Product - SubCategory—Sub Category ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org to which the product assortment template belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## 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\_\_Product\_Assortment\_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\_\_Product\_Assortment\_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\_\_Product\_Assortment\_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\_\_Product\_Assortment\_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\_\_Product\_Assortment\_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. # cgcloud\_\_Product\_Category\_Share\_\_c This business class contains the product categories or brands that a user manages. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### 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\_\_Access\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Type of access. - **Possible values**: - Read - Read/Write ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the account for which the promotion access rights are defined. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Active\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Defines whether the current record is to be used for promotion access rights. - **Default value**: Inactive - **Possible values**: - Active - Inactive - ToBeActivated - ToBeDeactivated ### cgcloud\_\_Group\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: User group for which the product group rights is to be defined. ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to either the product at product level category or the brand for which rights are granted. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the details page of the Product Catergory Share related list record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_User\_Group\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: User group for which the product group rights is to be defined. ### cgcloud\_\_User\_Setting\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user setting. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_Setting\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_User\_Setting\_\_c ### cgcloud\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user for which the product group rights is to be defined. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ## 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\_\_Product\_Category\_Share\_\_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\_\_Product\_Category\_Share\_\_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\_\_Product\_Category\_Share\_\_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\_\_Product\_Category\_Share\_\_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\_\_Product\_Category\_Share\_\_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. # cgcloud\_\_Product\_Condition\_\_c This object uses product-specific conditions. For example, specifying product prices that are relevant for simple order value calculation. 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 ### 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\_\_Condition\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the condition template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Condition\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Condition\_Template\_\_c ### cgcloud\_\_Price\_List\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Price list type for wholesaler or direct customer. - **Default value**: WS1999 - **Possible values**: - NotRelevant—Not Relevant - WS1999—Wholesaler - WS2000—Direct Customer ### cgcloud\_\_Price\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Price type for factory or consumer. - **Default value**: factory - **Possible values**: - NotRelevant—Not Relevant - consumer—Consumer - factory—Factory ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Product for which the product condition is defined. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the Product Condition related list record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Template\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description of the condition template. This is a calculated field. - **Formula**: cgcloud\_\_Condition\_Template\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Day from which the Condition becomes valid for the Product. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Day until which the Condition is valid for the Product. ### cgcloud\_\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Value for the product condition. ## 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\_\_Product\_Condition\_\_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\_\_Product\_Condition\_\_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\_\_Product\_Condition\_\_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\_\_Product\_Condition\_\_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\_\_Product\_Condition\_\_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. # cgcloud\_\_Product\_Hierarchy\_\_c Relation from a product (Child\_Product) to its parent. This relation is time-framed. 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 ### 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\_\_Child\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the child product. This is a relationship field. - **Relationship Name**: cgcloud\_\_Child\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Parent\_Product\_Code\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Unique identifier of the parent product. This is a calculated field. - **Formula**: cgcloud\_\_Parent\_Product\_\_r.cgcloud\_\_Consumer\_Goods\_Product\_Code\_\_c ### cgcloud\_\_Parent\_Product\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Short description of the parent product. This is a calculated field. - **Formula**: cgcloud\_\_Parent\_Product\_\_r.cgcloud\_\_Short\_Description\_\_c ### cgcloud\_\_Parent\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the parent product. This is a relationship field. - **Relationship Name**: cgcloud\_\_Parent\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the product (Child\_Product) record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Structure\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the structure type of the hierarchy. - **Default value**: Sales - **Possible values**: - Sales ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The entry is valid from this date onwards. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The entry is valid until this date. ## 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\_\_Product\_Hierarchy\_\_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\_\_Product\_Hierarchy\_\_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\_\_Product\_Hierarchy\_\_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\_\_Product\_Hierarchy\_\_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\_\_Product\_Hierarchy\_\_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. # cgcloud\_\_Product\_Listing\_Module\_\_c Add products to Product Assortment with listing modules. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), 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\_\_Facing\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Product facings of the module. ### cgcloud\_\_Listing\_Module\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References to the listing module. ### cgcloud\_\_Price\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Product price of the module. ### cgcloud\_\_Product\_Assortment\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to a product assortment product. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_Assortment\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: AssortmentProduct ## 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\_\_Product\_Listing\_Module\_\_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\_\_Product\_Listing\_Module\_\_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\_\_Product\_Listing\_Module\_\_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\_\_Product\_Listing\_Module\_\_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\_\_Product\_Listing\_Module\_\_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. # cgcloud\_\_Product\_Part\_\_c Stores the details of the relationship between two products. Describes which and how many products (ChildPKey) are assembled into a parent product (ParentPKey). In comparison to a product assortment, the result is a real product. This relation is only used as information; it can't be used to define a set of products to be used in other applications. 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 ### 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\_\_Brand\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Reference to the brand of the child product. This field is a calculated field. This field is available in API version 55.0 and later. - **Formula**: cgcloud\_\_Child\_Product\_\_r.cgcloud\_\_Criterion\_3\_Product\_\_r.Name ### cgcloud\_\_Category\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Reference to the category of the child product. This field is a calculated field. This field is available in API version 55.0 and later. - **Formula**: cgcloud\_\_Child\_Product\_\_r.cgcloud\_\_Criterion\_1\_Product\_\_r.Name ### cgcloud\_\_Child\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the product that belongs to the bill of material referred by Parent ID. This is a relationship field. - **Relationship Name**: cgcloud\_\_Child\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_ExternalId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: The unique external id. This field is available in API version 55.0 and later. ### cgcloud\_\_Pack\_Size\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Reference to the Pack Size of the child product. This field is a calculated field. This field is available in API version 55.0 and later. - **Formula**: TEXT(cgcloud\_\_Child\_Product\_\_r.cgcloud\_\_Pack\_Size\_\_c) ### cgcloud\_\_Parent\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the product that contains the product referred by Child ID. This is a relationship field. - **Relationship Name**: cgcloud\_\_Parent\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Quantity\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Describes how often the child product is included in the parent product. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the Product Part record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sales\_Org\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Reference to the sales org of the parent product. This field is a calculated field. This field is available in API version 55.0 and later. - **Formula**: cgcloud\_\_Parent\_Product\_\_r.cgcloud\_\_Sales\_Org\_\_c ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The entry is valid from this date onwards. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The entry is valid until this date. ## 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\_\_Product\_Part\_\_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\_\_Product\_Part\_\_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\_\_Product\_Part\_\_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\_\_Product\_Part\_\_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\_\_Product\_Part\_\_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. # cgcloud\_\_Product\_Template\_\_c Stores the details of the product template object that's used for products. 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**: 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 ### 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\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the Product Assortment template is active. - **Default value**: true ### 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\_\_Price\_Required\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether a price is to be assigned to the product. - **Default value**: false ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org to which the product template belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## 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\_\_Product\_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\_\_Product\_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\_\_Product\_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\_\_Product\_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\_\_Product\_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. # cgcloud\_\_Promotion\_\_c Promotion is an activity of a user that includes the definition of prices for a time segment. 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 ### 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\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Decides whether a promotion is available. - **Default value**: true ### cgcloud\_\_Aggregation\_Category\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores information about the aggregation category. ### cgcloud\_\_Anchor\_Account\_Set\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the customer set. This is a relationship field. - **Relationship Name**: cgcloud\_\_Anchor\_Account\_Set\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Account\_Set\_\_c ### cgcloud\_\_Anchor\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Anchor\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Commit\_Date\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date on which the promotion was committed. This field is used to fetch the prices and discounts of a promotion. ### cgcloud\_\_Count\_Tactics\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Number of tactics associated with this promotion. This is a calculated field. ### cgcloud\_\_Custom1\_Date\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Start date of a project-specific time range. For example, pre-dip. ### cgcloud\_\_Custom1\_Date\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: End date of a project-specific time range. For example, pre-dip. ### cgcloud\_\_Custom2\_Date\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Start date of a project-specific time range. For example, pre-dip. ### cgcloud\_\_Custom2\_Date\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: End date of a project-specific time range. For example, pre-dip. ### cgcloud\_\_Date\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Promotion date from. ### cgcloud\_\_Date\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Promotion date thru. ### cgcloud\_\_Delivery\_Date\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Delivery date from. ### cgcloud\_\_Delivery\_Date\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Delivery date thru. ### cgcloud\_\_Effective\_Brands\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores a list (JSON array) of the effective Brand SfIds for this promotion. ### cgcloud\_\_Effective\_Categories\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores a list (JON array) of the effective Category Sf IDs for this promotion. ### cgcloud\_\_ExternalId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: ID of the promotion that's used as a reference in external systems. Integration uses this ID to import tactic-specific actuals into the offplatform back end. ### cgcloud\_\_Filter\_Criteria\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores the .json file that's used to apply product filters for the promotion. ### cgcloud\_\_Group\_Text\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the Group Text in language 1. ### cgcloud\_\_Group\_Text\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the Group Text in language 2. ### cgcloud\_\_Group\_Text\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the Group Text in language 3. ### cgcloud\_\_Group\_Text\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the Group Text in language 4. ### cgcloud\_\_Group\_Text\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Formula. This is a calculated field. - **Formula**: CASE($User.cgcloud\_\_Language\_Postfix\_\_c, "Language1", cgcloud\_\_Group\_Text\_Language\_1\_\_c, "Language2", BLANKVALUE(cgcloud\_\_Group\_Text\_Language\_2\_\_c,cgcloud\_\_Group\_Text\_Language\_1\_\_c), "Language3", BLANKVALUE(cgcloud\_\_Group\_Text\_Language\_3\_\_c,cgcloud\_\_Group\_Text\_Language\_1\_\_c), "Language4", BLANKVALUE(cgcloud\_\_Group\_Text\_Language\_4\_\_c,cgcloud\_\_Group\_Text\_Language\_1\_\_c), cgcloud\_\_Group\_Text\_Language\_1\_\_c) ### cgcloud\_\_In\_Calculation\_Time\_Frame\_\_c - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Checks the condition for calculation-relevant promotions within the offset timeframe (90 days) from today's date, and returns a boolean value. This is a calculated field. - **Formula**: IF(((TODAY() - $Setup.cgcloud\_\_Promotion\_Calculation\_Server\_Offset\_\_c.cgcloud\_\_Days\_Before\_\_c) <= cgcloud\_\_Date\_Thru\_\_c) && (cgcloud\_\_Date\_From\_\_c <= (TODAY() + $Setup.cgcloud\_\_Promotion\_Calculation\_Server\_Offset\_\_c.cgcloud\_\_Days\_After\_\_c)), true, false) ### cgcloud\_\_Is\_Frozen\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a dynamic product set is to be frozen so that it can't be changed anymore. This can be set manually or via a a workflow rule. - **Default value**: false ### cgcloud\_\_Is\_Locked\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the promotion is locked. - **Default value**: false ### cgcloud\_\_Is\_Push\_In\_Progress\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the push process for this promotion is currently in progress. This attribute is applicable for pushable promotions. - **Default value**: false ### cgcloud\_\_Is\_Transferable\_\_c - **Type**: boolean - **Properties**: Defaulted on create, Filter, Group, Sort - **Description**: Identifies whether the promotion is eligible for transfer. This field is a calculated field. - **Formula**: AND(ISPICKVAL(cgcloud\_\_Promotion\_Template\_\_r.cgcloud\_\_Is\_Transfer\_Relevant\_\_c, "YES"), RecordType.DeveloperName = 'Promotion', cgcloud\_\_Date\_From\_\_c - IF( ISBLANK(cgcloud\_\_Promotion\_Template\_\_r.cgcloud\_\_Transfer\_Lead\_Time\_\_c) , 0, cgcloud\_\_Promotion\_Template\_\_r.cgcloud\_\_Transfer\_Lead\_Time\_\_c) <= TODAY(),cgcloud\_\_Date\_Thru\_\_c + IF( ISBLANK(cgcloud\_\_Promotion\_Template\_\_r.cgcloud\_\_Transfer\_Follow\_Up\_Time\_\_c) , 0, cgcloud\_\_Promotion\_Template\_\_r.cgcloud\_\_Transfer\_Follow\_Up\_Time\_\_c) >= TODAY()) ### cgcloud\_\_KPI\_Dirty\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: This field is set as true whenever there is any modification in the promotion record. - **Default value**: false ### cgcloud\_\_KPI\_Value\_1\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Writeback Synchronized KPI 1. ### cgcloud\_\_KPI\_Value\_2\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Writeback Synchronized KPI 2. ### cgcloud\_\_KPI\_Value\_3\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Writeback Synchronized KPI 3. ### cgcloud\_\_KPI\_Value\_4\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Writeback Synchronized KPI 4. ### cgcloud\_\_Last\_Push\_Update\_Executed\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp when the parent promotion was last pushed. ### cgcloud\_\_Last\_Push\_Update\_Received\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp when the child promotion received the last push update. ### cgcloud\_\_Lock\_Deletion\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Configures promotions to indicate whether a promotion deletion is locked based on phases. - **Default value**: false ### cgcloud\_\_Manual\_Calculation\_Input\_\_c - **Type**: textarea - **Properties**: Create, Defaulted on create, Nillable, Update - **Description**: Stores the configuration of manually updated KPIs in .json format. ### cgcloud\_\_Manual\_Calculation\_Input\_2\_\_c - **Type**: textarea - **Properties** - **Description**: Continuation of Manual\_Calculation\_Input\_\_c. Filled if the manual calculation input .json is bigger than 128k. This field is available in API version 55.0 and later. ### cgcloud\_\_Manual\_Calculation\_Input\_3\_\_c - **Type**: textarea - **Properties** - **Description**: Continuation of Manual\_Calculation\_Input\_2\_\_c. Filled if the manual calculation input .json is bigger than 256k. This field is available in API version 55.0 and later. ### cgcloud\_\_Note\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: General notes about the promotion. ### cgcloud\_\_Order\_Date\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Order date from. ### cgcloud\_\_Order\_Date\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Order date thru. ### cgcloud\_\_Outdated\_Staging\_Records\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether this attribute must be recalculated when conditions are changed. - **Default value**: false ### cgcloud\_\_Parent\_Promotion\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the parent promotion. This is a relationship field. - **Relationship Name**: cgcloud\_\_Parent\_Promotion\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_\_c ### cgcloud\_\_Phase\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Phase of the promotion. - **Default value**: Preparation - **Possible values**: - Cancelled - Committed - ForApproval—For Approval - Modeling - Planning - Preparation - Rejected ### cgcloud\_\_Placement\_Date\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Placement date from. ### cgcloud\_\_Placement\_Date\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Placement date thru. ### cgcloud\_\_Promotion\_Template\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Stores the description of the selected promotion template. This is a calculated field. - **Formula**: cgcloud\_\_Promotion\_Template\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Promotion\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the promotion template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_Template\_\_c ### cgcloud\_\_Push\_Target\_Account\_Selection\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Only filled for Pushable promotions. Contains a .json file with the selected push target accounts. ### cgcloud\_\_Reference\_Date\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference date that's used for hierarchy search. The date is retrieved from the promotion template used reference date field. ### cgcloud\_\_Relevant\_For\_Account\_Plan\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the promotion is relevant for Account Plan Calculation. - **Default value**: true ### cgcloud\_\_Sales\_Org\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Sales org of the promotion. This is a calculated field. - **Formula**: TEXT (cgcloud\_\_Promotion\_Template\_\_r.cgcloud\_\_Sales\_Org\_\_c) ### cgcloud\_\_Scenario\_1\_Manual\_Inputs\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores the promotion-specific manual input for Scenario 1. ### cgcloud\_\_Scenario\_1\_Parameters\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores scenario parameters for Scenario 1 in .json format. ### cgcloud\_\_Scenario\_2\_Manual\_Inputs\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Descriptio**: Stores promotion-specific manual input for Scenario 2. ### cgcloud\_\_Scenario\_2\_Parameters\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores scenario parameters for Scenario 2 in .json format. ### cgcloud\_\_Scenario\_3\_Manual\_Inputs\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores promotion-specific manual input for Scenario 3. ### cgcloud\_\_Scenario\_3\_Parameters\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores scenario parameters for Scenario 3 in .json format. ### cgcloud\_\_Scenario\_4\_Manual\_Inputs\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores promotion-specific manual input for Scenario 4. ### cgcloud\_\_Scenario\_4\_Parameters\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores scenario parameters for Scenario 4 in .json format. ### cgcloud\_\_Scenario\_5\_Manual\_Inputs\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores promotion-specific manual input for Scenario 5. ### cgcloud\_\_Scenario\_5\_Parameters\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores scenario parameters for Scenario 5 in .json format. ### cgcloud\_\_Selected\_Scenario\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Indicates the active scenario for the promotion. ### cgcloud\_\_Skip\_Version\_Update\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Flag that's used to skip the version update. This flag is stored as false in the database, but the system verifies the input value to detect whether the version is to be upgraded. - **Default value**: false ### cgcloud\_\_Slogan\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the slogan in language 1. ### cgcloud\_\_Slogan\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the slogan in language 2. ### cgcloud\_\_Slogan\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the slogan in language 3. ### cgcloud\_\_Slogan\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the slogan in language 4. ### cgcloud\_\_Slogan\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Formula This is a calculated field. - **Formula**: CASE($User.cgcloud\_\_Language\_Postfix\_\_c, "Language1", cgcloud\_\_Slogan\_Language\_1\_\_c, "Language2", BLANKVALUE(cgcloud\_\_Slogan\_Language\_2\_\_c,cgcloud\_\_Slogan\_Language\_1\_\_c), "Language3", BLANKVALUE(cgcloud\_\_Slogan\_Language\_3\_\_c,cgcloud\_\_Slogan\_Language\_1\_\_c), "Language4", BLANKVALUE(cgcloud\_\_Slogan\_Language\_4\_\_c,cgcloud\_\_Slogan\_Language\_1\_\_c), cgcloud\_\_Slogan\_Language\_1\_\_c) ### cgcloud\_\_Source\_Promotion\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifies the source promotion. - **Relationship Name**: cgcloud\_\_Source\_Promotion\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_\_c ### cgcloud\_\_Sub\_Accounts\_Selection\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Determines the selection of the valid sub accounts of the parent customer. ### cgcloud\_\_Sync\_Relevant\_Changes\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Used for push promotions. This object indicates whether any changes are done to this promotion, which is to be synced down to the child promotions. - **Default value**: false ### cgcloud\_\_Trade\_Calendar\_Color\_Code\_1\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Property Based Coloring of Promotion Bars in the Trade Calendar. - **Default value**: 0x76DED9 - **Possible values**: - 0x002266—Violet Blue - 0x003344—Ink Blue - 0x0070D2—Navy Blue - 0x00716B—Pine Green - 0x008899—Sea Green - 0x009E73—Green Haze - 0x00A1E0—Pacific Blue - 0x00aa99—Aquamarine - 0x023248—Sherpa Blue - 0x08A69E—Persian Green - 0x16325C—Catalina Blue - 0x224433—Deep Green - 0x2f539c—Deep Violet - 0x337722—Forest Green - 0x359b4c—Emerald - 0x408fcd—Sky Blue - 0x551155—Red Violet - 0x60B17D—Ocean Green - 0x61022A—Tyrian Purple - 0x76DED9—Turquoise Blue - 0x7B399C—Vivid Violet - 0x94E3B1—Algae Green - 0x993399—Violet - 0xA10010—Carmine - 0xC23934—Flush Mahogany - 0xE2CE7D—Chenin - 0xE69F00—Gamboge - 0xFf9900—Yellow Orange - 0xaa1133—Cranberry - 0xbbbb00—Lime Green - 0xdd4411—Dark Orange - 0xeeaa00—Chrome Yellow ### cgcloud\_\_Trade\_Calendar\_Color\_Code\_2\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Property Based Coloring of Promotion Bars in the Trade Calendar. - **Default value**: 0x76DED9 - **Possible values**: - 0x002266—Violet Blue - 0x003344—Ink Blue - 0x0070D2—Navy Blue - 0x00716B—Pine Green - 0x008899—Sea Green - 0x009E73—Green Haze - 0x00A1E0—Pacific Blue - 0x00aa99—Aquamarine - 0x023248—Sherpa Blue - 0x08A69E—Persian Green - 0x16325C—Catalina Blue - 0x224433—Deep Green - 0x2f539c—Deep Violet - 0x337722—Forest Green - 0x359b4c—Emerald - 0x408fcd—Sky Blue - 0x551155—Red Violet - 0x60B17D—Ocean Green - 0x61022A—Tyrian Purple - 0x76DED9—Turquoise Blue - 0x7B399C—Vivid Violet - 0x94E3B1—Algae Green - 0x993399—Violet - 0xA10010—Carmine - 0xC23934—Flush Mahogany - 0xE2CE7D—Chenin - 0xE69F00—Gamboge - 0xFf9900—Yellow Orange - 0xaa1133—Cranberry - 0xbbbb00—Lime Green - 0xdd4411—Dark Orange - 0xeeaa00—Chrome Yellow ### cgcloud\_\_Trade\_Calendar\_Color\_Code\_3\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Property Based Coloring of Promotion Bars in the Trade Calendar. - **Default value**: 0x76DED9 - **Possible values**: - 0x002266—Violet Blue - 0x003344—Ink Blue - 0x0070D2—Navy Blue - 0x00716B—Pine Green - 0x008899—Sea Green - 0x009E73—Green Haze - 0x00A1E0—Pacific Blue - 0x00aa99—Aquamarine - 0x023248—Sherpa Blue - 0x08A69E—Persian Green - 0x16325C—Catalina Blue - 0x224433—Deep Green - 0x2f539c—Deep Violet - 0x337722—Forest Green - 0x359b4c—Emerald - 0x408fcd—Sky Blue - 0x551155—Red Violet - 0x60B17D—Ocean Green - 0x61022A—Tyrian Purple - 0x76DED9—Turquoise Blue - 0x7B399C—Vivid Violet - 0x94E3B1—Algae Green - 0x993399—Violet - 0xA10010—Carmine - 0xC23934—Flush Mahogany - 0xE2CE7D—Chenin - 0xE69F00—Gamboge - 0xFf9900—Yellow Orange - 0xaa1133—Cranberry - 0xbbbb00—Lime Green - 0xdd4411—Dark Orange - 0xeeaa00—Chrome Yellow ### cgcloud\_\_Trade\_Calendar\_Color\_Code\_4\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Property Based Coloring of Promotion Bars in the Trade Calendar. - **Default value**: 0x76DED9 - **Possible values**: - 0x002266—Violet Blue - 0x003344—Ink Blue - 0x0070D2—Navy Blue - 0x00716B—Pine Green - 0x008899—Sea Green - 0x009E73—Green Haze - 0x00A1E0—Pacific Blue - 0x00aa99—Aquamarine - 0x023248—Sherpa Blue - 0x08A69E—Persian Green - 0x16325C—Catalina Blue - 0x224433—Deep Green - 0x2f539c—Deep Violet - 0x337722—Forest Green - 0x359b4c—Emerald - 0x408fcd—Sky Blue - 0x551155—Red Violet - 0x60B17D—Ocean Green - 0x61022A—Tyrian Purple - 0x76DED9—Turquoise Blue - 0x7B399C—Vivid Violet - 0x94E3B1—Algae Green - 0x993399—Violet - 0xA10010—Carmine - 0xC23934—Flush Mahogany - 0xE2CE7D—Chenin - 0xE69F00—Gamboge - 0xFf9900—Yellow Orange - 0xaa1133—Cranberry - 0xbbbb00—Lime Green - 0xdd4411—Dark Orange - 0xeeaa00—Chrome Yellow ### cgcloud\_\_Trade\_Calendar\_Color\_Code\_5\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Property Based Coloring of Promotion Bars in the Trade Calendar. - **Default value**: 0x76DED9 - **Possible values**: - 0x002266—Violet Blue - 0x003344—Ink Blue - 0x0070D2—Navy Blue - 0x00716B—Pine Green - 0x008899—Sea Green - 0x009E73—Green Haze - 0x00A1E0—Pacific Blue - 0x00aa99—Aquamarine - 0x023248—Sherpa Blue - 0x08A69E—Persian Green - 0x16325C—Catalina Blue - 0x224433—Deep Green - 0x2f539c—Deep Violet - 0x337722—Forest Green - 0x359b4c—Emerald - 0x408fcd—Sky Blue - 0x551155—Red Violet - 0x60B17D—Ocean Green - 0x61022A—Tyrian Purple - 0x76DED9—Turquoise Blue - 0x7B399C—Vivid Violet - 0x94E3B1—Algae Green - 0x993399—Violet - 0xA10010—Carmine - 0xC23934—Flush Mahogany - 0xE2CE7D—Chenin - 0xE69F00—Gamboge - 0xFf9900—Yellow Orange - 0xaa1133—Cranberry - 0xbbbb00—Lime Green - 0xdd4411—Dark Orange - 0xeeaa00—Chrome Yellow ### cgcloud\_\_Trade\_Calendar\_Transparency\_1\_\_c - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Property Based Coloring of Promotion Bars in the Trade Calendar. ### cgcloud\_\_Trade\_Calendar\_Transparency\_2\_\_c - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Property Based Coloring of Promotion Bars in the Trade Calendar. ### cgcloud\_\_Trade\_Calendar\_Transparency\_3\_\_c - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Property Based Coloring of Promotion Bars in the Trade Calendar. ### cgcloud\_\_Trade\_Calendar\_Transparency\_4\_\_c - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Property Based Coloring of Promotion Bars in the Trade Calendar. ### cgcloud\_\_Trade\_Calendar\_Transparency\_5\_\_c - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Property Based Coloring of Promotion Bars in the Trade Calendar. ### cgcloud\_\_Transferred\_Version\_\_c - **Type**: Number - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Last transferred version value of the source promotion. ### cgcloud\_\_Version\_Synced\_Off\_Platform\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Version that Off Platform operations receive. ### cgcloud\_\_Version\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Current version of the record. The system updates this field after each operation. ### cgcloud\_\_Volume\_Percent\_\_c - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: SmartUI calculates this field every time the Sub Account list values are updated. ## 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\_\_Promotion\_\_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\_\_Promotion\_\_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\_\_Promotion\_\_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\_\_Promotion\_\_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\_\_Promotion\_\_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. # cgcloud\_\_Promotion\_Attachment\_\_c You can add pictures as attachments to a promotion. 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**: 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\_\_Description\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, 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\_\_Size\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the size of the attachment. ### cgcloud\_\_Type\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the type of attachment. ## 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\_\_Promotion\_Attachment\_\_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\_\_Promotion\_Attachment\_\_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\_\_Promotion\_Attachment\_\_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\_\_Promotion\_Attachment\_\_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\_\_Promotion\_Attachment\_\_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. # cgcloud\_\_Promotion\_Attachment\_Link\_\_c Relationship between promotion and promotion attachment. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Parent\_Promotion\_Attachment\_Link\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the Parent Promotion Attachment Link record. This is a relationship field. - **Relationship Name**: cgcloud\_\_Parent\_Promotion\_Attachment\_Link\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_Attachment\_Link\_\_c ### cgcloud\_\_Promotion\_Attachment\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Link to the promotion attachment. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_Attachment\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_Attachment\_\_c ### cgcloud\_\_Promotion\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Link to the promotion. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Promotion\_\_c (the master object) ## 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\_\_Promotion\_Attachment\_Link\_\_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\_\_Promotion\_Attachment\_Link\_\_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\_\_Promotion\_Attachment\_Link\_\_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\_\_Promotion\_Attachment\_Link\_\_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\_\_Promotion\_Attachment\_Link\_\_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. # cgcloud\_\_Promotion\_Calculation\_Server\_Offset\_\_c Stores the time range during which the server (Offplatform) calculates a Promotion. 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 ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique identification of the record. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The SetupOwnerId field on Hierarchy Custom Settings stores the Org, Profile, or User that's associated with a custom setting record. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ### cgcloud\_\_Days\_After\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Not used at the moment: used to schedule promotions for calculations. Only those promotions are scheduled that overlap with this time range: \[today() - Days\_Before\_\_c, today + Days\_After\_\_c\]. ### cgcloud\_\_Days\_Before\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Not used at the moment: used to schedule promotions for calculations. Only those promotions are scheduled that overlap with this time range: \[today() - Days\_Before\_\_c, today + Days\_After\_\_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\_\_Promotion\_Calculation\_Server\_Offset\_\_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\_\_Promotion\_Calculation\_Server\_Offset\_\_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\_\_Promotion\_Calculation\_Server\_Offset\_\_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\_\_Promotion\_Calculation\_Server\_Offset\_\_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\_\_Promotion\_Calculation\_Server\_Offset\_\_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. # cgcloud\_\_Promotion\_Hurdle\_\_c This object stores the restriction that must be satisfied to apply the rewards. 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. ### 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\_\_Boolean\_Value\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Value to compare against an output parameter. - **Possible values**: - false - true ### cgcloud\_\_Classification\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Classification of products. - **Possible values**: - C1 - C2 - C3 - C4 - C5 ### cgcloud\_\_Date\_Value\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Value to compare against an output parameter. ### cgcloud\_\_Numeric\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Value to compare against an output parameter. ### cgcloud\_\_Operation\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Defines how hurdles are combined based on the sequence. - **Default value**: AND - **Possible values**: - AND - OR ### cgcloud\_\_Operator\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Operator that's to be applied to the value returned from the user exit underlying the Expression. - **Possible values**: - PER - eq—= - ge—>= - gt—> - le—<= - lt—< - ne—<> ### cgcloud\_\_Promotion\_Hurdle\_Expression\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Master-Detail to the Expression that defines the Hurdle. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_Hurdle\_Expression\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Promotion\_Hurdle\_Expression\_\_c (Detail object) ### cgcloud\_\_Promotion\_Reward\_Group\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Master-Detail to the Reward Group to which the hurdle applies. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_Reward\_Group\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Promotion\_Reward\_Group\_\_c (Master object) ### cgcloud\_\_Sort\_Unique\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the uniqueness of the sort value. ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sort order of the displayable Hurdle records. ### cgcloud\_\_Text\_Value\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Value to compare against an output parameter. ### cgcloud\_\_Title\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the title of language 1. ### cgcloud\_\_Title\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the title of language 2. ### cgcloud\_\_Title\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the title of language 3. ### cgcloud\_\_Title\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the title of language 4. ### cgcloud\_\_Title\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Localizable title of the Hurdle. This is a calculated field. - **Formula**: CASE($User.cgcloud\_\_Language\_Postfix\_\_c, "Language1", cgcloud\_\_Title\_Language\_1\_\_c, "Language2", BLANKVALUE(cgcloud\_\_Title\_Language\_2\_\_c,cgcloud\_\_Title\_Language\_1\_\_c), "Language3", BLANKVALUE(cgcloud\_\_Title\_Language\_3\_\_c,cgcloud\_\_Title\_Language\_1\_\_c), "Language4", BLANKVALUE(cgcloud\_\_Title\_Language\_4\_\_c,cgcloud\_\_Title\_Language\_1\_\_c), cgcloud\_\_Title\_Language\_1\_\_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\_\_Promotion\_Hurdle\_\_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\_\_Promotion\_Hurdle\_\_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\_\_Promotion\_Hurdle\_\_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\_\_Promotion\_Hurdle\_\_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\_\_Promotion\_Hurdle\_\_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. # cgcloud\_\_Promotion\_Hurdle\_Expression\_\_c New object that stores the information about an expression. 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**: 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\_\_Allows\_Classification\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the expression function can dynamically consider the classification and the KAM is able to filter products according to the classification at Promotion Hurdle level. - **Default value**: false ### cgcloud\_\_Expression\_Function\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the function that's called to determine the value of the Expression. This function must be defined in the Mobility Modeler as a Javascript function. It receives a predefined list of parameters as input and returns a numeric value. ### cgcloud\_\_Expression\_Result\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of result of the expression (Text, Numeric, Boolean). - **Possible values**: - Boolean - Date - Numeric - Text ### cgcloud\_\_Field\_Api\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Optional parameter. ### cgcloud\_\_Job\_Definition\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Optional parameter. The question to be answered or verified. This is a relationship field. - **Relationship Name**: cgcloud\_\_Job\_Definition\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Job\_Definition\_Template\_\_c ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Optional parameter. The product that's to be verified from a survey. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the promotion expression belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## 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\_\_Promotion\_Hurdle\_Expression\_\_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\_\_Promotion\_Hurdle\_Expression\_\_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\_\_Promotion\_Hurdle\_Expression\_\_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\_\_Promotion\_Hurdle\_Expression\_\_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\_\_Promotion\_Hurdle\_Expression\_\_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. # cgcloud\_\_Promotion\_Product\_Share\_\_c This object holds the details of categories that are assigned to a promotion. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Parent\_Promotion\_Product\_Share\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Link to the parent promotion link for this record. This is a relationship field. - **Relationship Name**: cgcloud\_\_Parent\_Promotion\_Product\_Share\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_Product\_Share\_\_c ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Category that's assigned to the promotion. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Promotion\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the Promotion to which categories are assigned. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Promotion\_\_c (the master object) ## 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\_\_Promotion\_Product\_Share\_\_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\_\_Promotion\_Product\_Share\_\_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\_\_Promotion\_Product\_Share\_\_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\_\_Promotion\_Product\_Share\_\_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\_\_Promotion\_Product\_Share\_\_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. # cgcloud\_\_Promotion\_Push\_Status\_\_c Contains for each push process an entry that contains the status and statistics for the push. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### 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\_\_Calculation\_End\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Time at which the parent promotion calculation chain ended for this promotion. ### cgcloud\_\_Children\_Calculation\_End\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Time at which the Children Calculation Job ended for this parent promotion. ### cgcloud\_\_Distribution\_End\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Time at which the distribution job ended for this parent promotion. ### cgcloud\_\_Entry\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Time at which the push is scheduled. ### cgcloud\_\_Error\_Ocurred\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Flag that indicates whether an error occurred within the chain. - **Default value**: false ### cgcloud\_\_Metric\_Preparation\_End\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Time at which the prepare metric job ended for this parent promotion. ### cgcloud\_\_Nr\_Of\_Child\_Promotions\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Number of child promotions that are considered in this push process. ### cgcloud\_\_Parent\_Calculation\_End\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Time at which the Parent Calculation Job ended for this parent promotion. ### cgcloud\_\_Parent\_Promotion\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to Promotion. This is a relationship field. - **Relationship Name**: cgcloud\_\_Parent\_Promotion\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_\_c ### cgcloud\_\_Status\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Status of the promotion push process. - **Possible values**: - Initial: Scheduled to run. - Syncing: Syncing field values from the parent promotion to child promotions. - Calculating: Scheduled for calculation. - InProgress: Calculation is in progress. - Done: Completed successfully. - Error: Completed with errors. ### cgcloud\_\_Sync\_End\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Time at which the Synchronisation from parent to child promotions ended. ### cgcloud\_\_Transaction\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Transaction ID under which the push was run. ### cgcloud\_\_Upload\_Kpis\_End\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Time at which the Upload KPI Job is ended for this parent promotion. ## 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\_\_Promotion\_Push\_Status\_\_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\_\_Promotion\_Push\_Status\_\_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\_\_Promotion\_Push\_Status\_\_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\_\_Promotion\_Push\_Status\_\_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\_\_Promotion\_Push\_Status\_\_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. # cgcloud\_\_Promotion\_Reward\_\_c This object stores the details of rewards that are assigned to a reward group. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Automatically\_Granted\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the rewards must be automatically granted. - **Default value**: false ### cgcloud\_\_Boolean\_Value\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Value to compare with an output parameter. - **Possible values**: - false—False - true—True ### cgcloud\_\_Classification\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Classification of either Free Item Reward or Special Rewards. - **Possible values**: - C1 - C2 - C3 - C4 - C5 ### cgcloud\_\_Count\_Products\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Count of Promotion\_Reward\_Product\_\_c records. This is a calculated field. ### cgcloud\_\_Date\_Value\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Value to compare with an output parameter. ### cgcloud\_\_Default\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Default value depending on Condition\_Type. ### 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\_\_Free\_Item\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines a reward as free item-relevant. - **Default value**: false ### cgcloud\_\_Hurdle\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to Hurdle. Indicates whether a specific hurdle condition resolution is to be done for rewards values. This is a relationship field. - **Relationship Name**: cgcloud\_\_Hurdle\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_Hurdle\_\_c ### cgcloud\_\_Included\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Define whether the reward is to be included on pricing calculations in the context of selectable promotion. - **Default value**: true ### cgcloud\_\_Numeric\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Value to compare with an output parameter. ### cgcloud\_\_Pricing\_Condition\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the pricing condition template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Pricing\_Condition\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_CP\_Pricing\_Condition\_Template\_\_c ### cgcloud\_\_Promotion\_Reward\_Group\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Master-Detail to the Reward Group to which the Reward belongs. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_Reward\_Group\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Promotion\_Reward\_Group\_\_c (the master object) ### cgcloud\_\_Reward\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the type of reward. - **Possible values**: - AmountPerUnit—Amount Per Unit - FlatRate—Flat Rate - FreeItem—Free Item - PercentageDiscount—Percentage Discount - Special - SpecialBasePrice—Special Base Price ### cgcloud\_\_Sort\_Unique\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the uniqueness of the sort value. ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sort order of the displayable rewards records. ### cgcloud\_\_SubGroup\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the subgroup to which the rewards belongs. ### cgcloud\_\_Text\_Value\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Value to compare with an output parameter. ### cgcloud\_\_Title\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the title of language 1. ### cgcloud\_\_Title\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the title of language 2. ### cgcloud\_\_Title\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the title of language 3. ### cgcloud\_\_Title\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the title of language 4. ### cgcloud\_\_Title\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Localizable title of the Reward Group. Reference to the title based on the user-specified language. This is a calculated field. - **Formula**: CASE($User.cgcloud\_\_Language\_Postfix\_\_c, "Language1", cgcloud\_\_Title\_Language\_1\_\_c, "Language2", BLANKVALUE(cgcloud\_\_Title\_Language\_2\_\_c,cgcloud\_\_Title\_Language\_1\_\_c), "Language3", BLANKVALUE(cgcloud\_\_Title\_Language\_3\_\_c,cgcloud\_\_Title\_Language\_1\_\_c), "Language4", BLANKVALUE(cgcloud\_\_Title\_Language\_4\_\_c,cgcloud\_\_Title\_Language\_1\_\_c), cgcloud\_\_Title\_Language\_1\_\_c) ### cgcloud\_\_User\_Exit\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines a Reward as a Special Reward. ## 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 e available in the specified API version and later. - **[cgcloud\_\_Promotion\_Reward\_\_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\_\_Promotion\_Reward\_\_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\_\_Promotion\_Reward\_\_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\_\_Promotion\_Reward\_\_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\_\_Promotion\_Reward\_\_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. # cgcloud\_\_Promotion\_Reward\_Group\_\_c This object holds the details of the reward group that's assigned to a promotion. 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\_\_Count\_Hurdles\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Count of promotion hurdles with Reward Group-Specific Record Type. This is a calculated field. ### cgcloud\_\_Count\_Rewards\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Count of promotion rewards. This is a calculated field. ### 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\_\_Included\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Define whether the reward group is to be considered on pricing calculations in context of selectable promotion. - **Default value**: true ### cgcloud\_\_Promotion\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to the promotion to which the Reward Group is linked. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_\_c ### cgcloud\_\_Reward\_Multiplicity\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the number of rewards that can be selected in mobility if conditions are fulfilled. - **Default value**: n - **Possible values**: - 1—Up to One - n—Zero or More ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the promotion reward group belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Sort\_Unique\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the uniqueness of the sort value. ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sort order of the displayable reward groups records. ### cgcloud\_\_Title\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the title of language 1. ### cgcloud\_\_Title\_Language\_2\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the title of language 2. ### cgcloud\_\_Title\_Language\_3\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the title of language 3. ### cgcloud\_\_Title\_Language\_4\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the title of language 4. ### cgcloud\_\_Title\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Localizable title of the Reward Group. Reference to the title based on the user-specifiied language. This is a calculated field. - **Formula**: CASE($User.cgcloud\_\_Language\_Postfix\_\_c, "Language1", cgcloud\_\_Title\_Language\_1\_\_c, "Language2", BLANKVALUE(cgcloud\_\_Title\_Language\_2\_\_c,cgcloud\_\_Title\_Language\_1\_\_c), "Language3", BLANKVALUE(cgcloud\_\_Title\_Language\_3\_\_c,cgcloud\_\_Title\_Language\_1\_\_c), "Language4", BLANKVALUE(cgcloud\_\_Title\_Language\_4\_\_c,cgcloud\_\_Title\_Language\_1\_\_c),cgcloud\_\_Title\_Language\_1\_\_c) ## Associated Objects ### Associated Objects This object has theseassociated 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\_\_Promotion\_Reward\_Group\_\_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\_\_Promotion\_Reward\_Group\_\_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\_\_Promotion\_Reward\_Group\_\_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\_\_Promotion\_Reward\_Group\_\_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\_\_Promotion\_Reward\_Group\_\_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. # cgcloud\_\_Promotion\_Reward\_Product\_\_c This object stores the details of the product that's assigned to a promotion reward. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Default\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Default value that's to be delivered for this product. ### cgcloud\_\_Included\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the product is to be included on pricing calculations in the context of selectable promotions. - **Default value**: true ### cgcloud\_\_Logistic\_Unit\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Unit of measure of the products that belong to a promotion reward. - **Possible values**: - ConsumerUnit—Consumer Unit - Layer - Pallet - SalesUnit—Sales Unit ### cgcloud\_\_Max\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Maximum value that can be delivered for this product. ### cgcloud\_\_Product\_Unique\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique identifier of the linked product. ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to the product to which the specific configuration applies. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Promotion\_Reward\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Master-Detail to the reward to which the product-specific configuration applies. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_Reward\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Promotion\_Reward\_\_c (Master object) ### cgcloud\_\_Reward\_Type\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Formula to show the type of the related reward. This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Promotion\_Reward\_\_r.cgcloud\_\_Reward\_Type\_\_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\_\_Promotion\_Reward\_Product\_\_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\_\_Promotion\_Reward\_Product\_\_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\_\_Promotion\_Reward\_Product\_\_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\_\_Promotion\_Reward\_Product\_\_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\_\_Promotion\_Reward\_Product\_\_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. # cgcloud\_\_Promotion\_Sales\_Folder\_\_c Junction object between Promotion and Sales folder. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Promotion\_Anchor\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Displays the anchor that's used in the promotion. This is a calculated field. - **Formula**: IF(ISPICKVAL(cgcloud\_\_Promotion\_\_r.cgcloud\_\_Promotion\_Template\_\_r.cgcloud\_\_Anchor\_Type\_\_c,'Customer'),cgcloud\_\_Promotion\_\_r .cgcloud\_\_Anchor\_Account\_\_r.Name,IF(ISPICKVAL(cgcloud\_\_Promotion\_\_r.cgcloud\_\_Promotion\_Template\_\_r.cgcloud\_\_Anchor\_Type\_\_c, 'CustomerSet'), cgcloud\_\_Promotion\_\_r.cgcloud\_\_Anchor\_Account\_Set\_\_r.cgcloud\_\_Description\_\_c, '')) ### cgcloud\_\_Promotion\_Date\_From\_\_c - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: References to the promotion from date. This is a calculated field. - **Formula**: cgcloud\_\_Promotion\_\_r.cgcloud\_\_Date\_From\_\_c ### cgcloud\_\_Promotion\_Date\_Thru\_\_c - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: References to the promotion thru date. This is a calculated field. - **Formula**: cgcloud\_\_Promotion\_\_r.cgcloud\_\_Date\_Thru\_\_c ### cgcloud\_\_Promotion\_Phase\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: References to the promotion phase. This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Promotion\_\_r.cgcloud\_\_Phase\_\_c) ### cgcloud\_\_Promotion\_Slogan\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: References to the promotion slogan. This is a calculated field. - **Formula**: HYPERLINK('/' & cgcloud\_\_Promotion\_\_c, cgcloud\_\_Promotion\_\_r.cgcloud\_\_Slogan\_\_c, '\_top') ### cgcloud\_\_Promotion\_Template\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: References to the promotion template. This is a calculated field. - **Formula**: HYPERLINK('/' & cgcloud\_\_Promotion\_\_r.cgcloud\_\_Promotion\_Template\_\_c, cgcloud\_\_Promotion\_\_r.cgcloud\_\_Promotion\_Template\_\_r.Name, '\_top') ### cgcloud\_\_Promotion\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the promotion. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Promotion\_\_c (the master object) ### cgcloud\_\_Sales\_Folder\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: References to the sales folder description. This is a calculated field. - **Formula**: cgcloud\_\_Sales\_Folder\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Sales\_Folder\_Valid\_From\_\_c - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: References to the sales folder valid from date. This is a calculated field. - **Formula**: cgcloud\_\_Sales\_Folder\_\_r.cgcloud\_\_Valid\_From\_\_c ### cgcloud\_\_Sales\_Folder\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Filter, Group, Nillable, Sort - **Description**: References to the sales folder valid thru date. This is a calculated field. - **Formula**: cgcloud\_\_Sales\_Folder\_\_r.cgcloud\_\_Valid\_Thru\_\_c ### cgcloud\_\_Sales\_Folder\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the sales folder. This is a relationship field. - **Relationship Name**: cgcloud\_\_Sales\_Folder\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Sales\_Folder\_\_c (the detail object) ## 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\_\_Promotion\_Sales\_Folder\_\_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\_\_Promotion\_Sales\_Folder\_\_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\_\_Promotion\_Sales\_Folder\_\_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\_\_Promotion\_Sales\_Folder\_\_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\_\_Promotion\_Sales\_Folder\_\_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. # cgcloud\_\_Promotion\_Store\_\_c This object holds the relation for the customer promotion hierarchy. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Promotion\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to Promotion ID. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Promotion\_\_c (the detail object) ### cgcloud\_\_Store\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to Customer ID. This is a relationship field. - **Relationship Name**: cgcloud\_\_Store\_\_r - **Relationship Type**: Master-detail - **Refers To**: Account (the master object) ## 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\_\_Promotion\_Store\_\_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\_\_Promotion\_Store\_\_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\_\_Promotion\_Store\_\_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\_\_Promotion\_Store\_\_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\_\_Promotion\_Store\_\_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. # cgcloud\_\_Promotion\_Template\_\_c Template to create promotions. 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**: 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 ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### cgcloud\_\_Active\_Policy\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether a promotion of this template is initially active or if a tactic of this type is initially pre-set as included in the promotion (not considered if the tactic is manually added to the promotion). - **Default value**: false ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the template is active. - **Default value**: true ### cgcloud\_\_Additional\_Custom\_Main\_KPI\_Subsets\_\_c - **Type**: multipicklist - **Properties**: Create, Defaulted on create, Filter, Nillable, Restricted picklist, Update - **Description**: Used when Subset Load Optimization is enabled to specify subsets that are additionally loaded when opening a promotion. - **Default value**: Planning - **Possible values**: - Adjustment - BaselineManagement - Broker - Finance - MidLevelPlanning - Monitoring - Planning - PromoUI - PromotionScenarios - Retailer - SPC - SPCLumpSum - SPCPR - VPC ### cgcloud\_\_Adjustment\_KPI\_1\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Stores the description of KPI Set KPI Definition. This is a calculated field. - **Formula**: cgcloud\_\_Adjustment\_KPI\_1\_\_r.cgcloud\_\_KPI\_Definition\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Adjustment\_KPI\_1\_Name\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Currently not used in the layout. It will be referred by the UI team. This is a calculated field. - **Formula**: cgcloud\_\_Adjustment\_KPI\_1\_\_r.cgcloud\_\_KPI\_Definition\_\_r.Name ### cgcloud\_\_Adjustment\_KPI\_1\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to KPI Set KPI Definition of the attached KPI Set. This is a relationship field. - **Relationship Name**: cgcloud\_\_Adjustment\_KPI\_1\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Set\_KPI\_Definition\_\_c ### cgcloud\_\_Adjustment\_KPI\_2\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Stores the description of KPI Set KPI Definition. This is a calculated field. - **Formula**: cgcloud\_\_Adjustment\_KPI\_2\_\_r.cgcloud\_\_KPI\_Description\_\_c ### cgcloud\_\_Adjustment\_KPI\_2\_Name\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Currently not used in the layout. It will be referred by the UI team. This is a calculated field. - **Formula**: cgcloud\_\_Adjustment\_KPI\_2\_\_r.cgcloud\_\_KPI\_Definition\_\_r.Name ### cgcloud\_\_Adjustment\_KPI\_2\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to KPI Set KPI Definition of the attached KPI Set. This is a relationship field. - **Relationship Name**: cgcloud\_\_Adjustment\_KPI\_2\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Set\_KPI\_Definition\_\_c ### cgcloud\_\_Adjustment\_KPI\_3\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Stores the description of KPI Set KPI Definition. This is a calculated field. - **Formula**: cgcloud\_\_Adjustment\_KPI\_3\_\_r.cgcloud\_\_KPI\_Description\_\_c ### cgcloud\_\_Adjustment\_KPI\_3\_Name\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Currently not used in the layout. It will be referred by the UI team. This is a calculated field. - **Formula**: cgcloud\_\_Adjustment\_KPI\_3\_\_r.cgcloud\_\_KPI\_Definition\_\_r.Name ### cgcloud\_\_Adjustment\_KPI\_3\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to KPI Set KPI Definition of the attached KPI Set. This is a relationship field. - **Relationship Name**: cgcloud\_\_Adjustment\_KPI\_3\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Set\_KPI\_Definition\_\_c ### cgcloud\_\_Anchor\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the anchor type of the promotion. - **Possible values**: - Customer - CustomerSet ### cgcloud\_\_Auto\_Close\_On\_Filter\_Apply\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the manage product modal window is closed automatically after applying the filters. - **Default value**: false ### cgcloud\_\_Available\_Product\_Level\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Specifies whether the multiple set of values that a user can choose that will be further used for aggregation on the calculation grid for promotions. - **Possible values**: - Brand - Category - Flavor—Sub Brand - Package—Product Price Group - SubCategory—Sub Category ### cgcloud\_\_BOM\_Handler\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Determines whether BOM products will be considered in promotions created using the template. - **Default value**: None - **Possible values**: - ConsiderBOMs - ExcludeBOMs - None ### cgcloud\_\_Calculation\_Mode\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the values of Calculation Mode for the promotion. - **Default value**: No - **Possible values**: - AdHoc - No - Writeback ### cgcloud\_\_Consider\_Account\_Product\_List\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Flag that indicates whether Account Product List is considered for Promotions. - **Default value**: false ### cgcloud\_\_Consider\_Listing\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether all products of active listings are considered when bringing back the products that are part of the promoted cluster or product group according to the specified listing finding template. - **Default value**: false ### cgcloud\_\_Consider\_Product\_KAM\_Status\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the promotion dates that are used to determine valid products based on KAM Status. - **Default value**: PromotionCommitDate - **Possible values**: - PromotionCommitDate—Promotion Commit Date - PromotionTimeframe—Promotion Timeframe ### cgcloud\_\_Consider\_Promotion\_Rewards\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the promotion is considered for rewards. - **Default value**: false ### cgcloud\_\_Creation\_Platform\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the platform on which this template can be used to create new promotions. - **Possible values**: - Both - Laptop - Mobility ### 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**: Stores the description. 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\_\_Display\_Fund\_Card\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether a fund card is enabled for promotions created by using this template. - **Default value**: true ### cgcloud\_\_Display\_In\_Visit\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: If at the call date the promotion is valid for the business partner of the call, the promotion is shown in a call. - **Default value**: false ### cgcloud\_\_Display\_KPI\_Validations\_Only\_On\_Save\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether KPI validations are shown only on save while editing the promotion. - **Default value**: false ### cgcloud\_\_Display\_SPC\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Depending on the value of this checkbox, SPC is shown. - **Default value**: false ### cgcloud\_\_Display\_VPC\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: VPC is shown. - **Default value**: false ### cgcloud\_\_Displayed\_Product\_Level\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Product levels that are shown in P&L Views (VPC/SPC). - **Possible values**: - Brand - Category - Flavor—Sub Brand - Package—Product Price Group - SubCategory—Sub Category ### cgcloud\_\_Enable\_Condition\_Creation\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Feature flag to enable the Tactic Condition Creation for promotions of this template. When enabled, conditions will be created for condition generating tactics. This field is available in API version 55.0 and later. - **Default value**: false ### cgcloud\_\_Ignore\_Time\_When\_Deleting\_The\_Promotion\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: If a TPM promotion is associated with a promotion template where Ignore\_Time\_When\_Deleting\_The\_Promotion is true, then the dates of the TPM promotion (and the transfer lead time or the followup time) aren’t observed to determine if the promotion is relevant for the deletion process. The default value is false. ### cgcloud\_\_Is\_Copyable\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Flag that indicates whether a promotion template is copyable. '. - **Default value**: false ### cgcloud\_\_Is\_Derivable\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the Promotion Template can be used for a derive action. - **Default value**: false ### cgcloud\_\_Is\_Pushable\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Identifies whether the Promotion Template is pushable. - **Default value**: false ### cgcloud\_\_Is\_Transfer\_Relevant\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifies and evaluates the promotion associated with the promotion template where Is Transfer Relevant is Yes for the promotion transfer process.Possible values are - No - Yes - **Default value**: No ### cgcloud\_\_KPI\_Set\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This is a relationship field. - **Relationship Name**: cgcloud\_\_KPI\_Set\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Set\_\_c ### cgcloud\_\_Mass\_Copy\_Start\_Date\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Controls how the dates of new promotions are determined when promotions are copied via the Mass Copy process. - **Default value**: Weekday - **Possible values**: - Date - Weekday ### cgcloud\_\_Mobility\_Color\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Color that are used to show the promotion. - **Possible values**: - Black - Blue - Coral - Corn Flower Blue - Cranberry Red - Dark Orange - Dark Salmon - Dark Sea Green - Gold - Golden Rod - Grey Blue - Ink Blue - Khaki 2 - Light Blue - Light Coral - Light Salmon - Light Sea Green - Light Sky Blue - Light Steel Blue - Lime Green 2 - Periwinkle Blue - Plum - Red - Red Violet - Rosy Brown - Sage Green - Salmon - Sandy Brown - Sea Green 2 - Sky Blue - Sky Blue 2 - Turquoise 2 - White - Yellow - Yellow Orange ### cgcloud\_\_Number\_Of\_Copy\_Usage\_Hierarchies\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Total number of Hierarchies under the Promotion Template with Copy Usage. This is a calculated field. ### cgcloud\_\_Number\_Of\_Derive\_Usage\_Hierarchies\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Total number of Hierarchies under the Promotion Template with Derive Usage. This is a calculated field. ### cgcloud\_\_Number\_Of\_Push\_Usage\_Hierarchies\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Number of Child Templates in the Hierarchy with Usage as Push. This is a calculated field. ### cgcloud\_\_Product\_Definition\_Level\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the level at which products are defined. - **Default value**: Tactic - **Possible values**: - Promotion - Tactic ### cgcloud\_\_Product\_Definition\_Policy\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: For Dynamic policy, promotion products can be defined via a filter. Promotion products change according to the changes in the product master data. The result can change until the promotion is frozen (Promotion.Is\_Frozen = 'True'). For Static policy, promotion products are explicitly defined. Changes in the product master data don't trigger a change of the promotion products. - **Possible values**: - Dynamic - Static ### cgcloud\_\_Promo\_Phases\_Cleaning\_\_c - **Type**: multipicklist - **Properties**: Create, Defaulted on create, Filter, Nillable, Restricted picklist, Update - **Description**: Promotion phases in which promotion cleaning (scenarios, inactive tactics) happens. Depends on the Promotion\_Phases global picklist. - **Default value**: Preparation - **Possible values**: - Cancelled - Committed - ForApproval - Modeling - Planning - Preparation ### cgcloud\_\_Promotion\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of promotion. - **Possible values**: - Promotion - SellablePromotion ### cgcloud\_\_Push\_Process\_Flow\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Promotion push process type. - **Possible values**: - calculate - distributeAndCalculate ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org of the promotion template. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Selectable\_Promotion\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the promotion is auto-granted or selectable by selecting the corresponding checkbox. - **Default value**: false ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sort number. ### cgcloud\_\_Special\_Order\_Relevant\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Flag indicates whether the Promotion is special order-relevant. - **Default value**: false ### cgcloud\_\_Sub\_Accounts\_Enabled\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the Sub Account Planning feature is enabled for the promotions with this template. This checkbox can only be enabled if Anchor Type is Customer. - **Default value**: false ### cgcloud\_\_Synchronize\_Promotion\_Timeframes\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: If this field is selected as TRUE, the Shipment Dates From and Thru and InStore From and Thru dates always have the values set in Date From and Date Thru. - **Default value**: false ### cgcloud\_\_Target\_Promotion\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifies target promotion template. - **Relationship Name**: cgcloud\_\_Target\_Promotion\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_Template\_\_c ### cgcloud\_\_TFD\_Commit\_Date\_Offset\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Offset that's used to calculate the value of Commit Date from Date From, if the Timeframe Determination Policy isn't Manual. ### cgcloud\_\_TFD\_Delivery\_Date\_From\_Offset\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Offset that's used to calculate the value of Shipment Date From from In-Store Date From, if the Timeframe Determination Policy isn't Manual. ### cgcloud\_\_TFD\_Delivery\_Date\_Thru\_Offset\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Offset that's used to calculate the value of Shipment Date Thru from n-Store Date Thru, if the Timeframe Determination Policy isn't Manual. ### cgcloud\_\_Timeframe\_Determination\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Determines whether promotion dates are added by the user or automatically determined by the system from a given pair of In-Store dates. - **Default value**: Manual - **Possible values**: - Manual - Simple—Automatic Simple ### cgcloud\_\_Trade\_Calendar\_Color\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the color of the promotion in Trade Calendar. - **Default value**: x76DED9 - **Possible values**: - 0x002266—Violet Blue - 0x003344—Ink Blue - 0x0070D2—Navy Blue - 0x00716B—Pine Green - 0x008899—Sea Green - 0x009E73—Green Haze - 0x00A1E0—Pacific Blue - 0x00aa99—Aquamarine - 0x023248—Sherpa Blue - 0x08A69E—Persian Green - 0x16325C—Catalina Blue - 0x224433—Deep Green - 0x2f539c—Deep Violet - 0x337722—Forest Green - 0x359b4c—Emerald - 0x408fcd—Sky Blue - 0x551155—Red Violet - 0x60B17D—Ocean Green - 0x61022A—Tyrian Purple - 0x76DED9—Turquoise Blue - 0x7B399C—Vivid Violet - 0x94E3B1—Algae Green - 0x993399—Violet - 0xA10010—Carmine - 0xC23934—Flush Mahogany - 0xE2CE7D—Chenin - 0xE69F00—Gamboge - 0xFf9900—Yellow Orange - 0xaa1133—Cranberry - 0xbbbb00—Lime Green - 0xdd4411—Dark Orange - 0xeeaa00—Chrome Yellow ### cgcloud\_\_Trade\_Calendar\_Relevant\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies whether the promotion is to be shown in Trade Calendar. - **Default value**: Yes - **Possible values**: - Default - No - Yes ### cgcloud\_\_Transfer\_Relevant\_Phases\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Identifies the promotion phases for the transfer process. Only the promotions in the transfer-relevant phases are considered for transfer. - **Possible values**: - Canceled - Committed - ForApproval - Modeling - Planning - Preparation - Rejected ### cgcloud\_\_Transfer\_Lead\_Time\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines the number of days in the past from the current date the promotion is eligible for transfer. ### cgcloud\_\_Transfer\_Follow\_Up\_Time\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines the number of days in the future from the current date the promotion is eligible for transfer. ### cgcloud\_\_Transfer\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Identifies the target sales org. The picklist values are preset from the global picklist value set of the cgcloud\_\_Sales\_Org\_Value\_\_c field in the cgcloud\_\_Sales\_Organization\_\_c object. ### cgcloud\_\_UI\_Contract\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Contract that's associated with a template. This is a relationship field. - **Relationship Name**: cgcloud\_\_UI\_Contract\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_UI\_Contract\_\_c ### cgcloud\_\_UI\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies that the UI is displayed for a particular promotion type. - **Default value**: StandardUI - **Possible values**: - SmartUI - StandardUI ### cgcloud\_\_Use\_UI\_Contract\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Flag that indicates whether UI contracts are switched off for promotions. - **Default value**: false ### cgcloud\_\_Used\_Reference\_Date\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the date that's to be used for the product hierarchy resolution if promotions of this type are calculated. - **Default value**: commitdate - **Possible values**: - commitdate—Commit Date - today—Today ## 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\_\_Promotion\_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\_\_Promotion\_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\_\_Promotion\_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\_\_Promotion\_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\_\_Promotion\_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. # cgcloud\_\_Promotion\_Template\_Hierarchy\_\_c Object that helps create promotion hierarchies. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Child\_Promo\_Relevant\_KPI\_Definition\_1\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to the first KPI that's used to transfer values from the parent to the child process. This is a relationship field. - **Relationship Name**: cgcloud\_\_Child\_Promo\_Relevant\_KPI\_Definition\_1\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Child\_Promo\_Relevant\_KPI\_Definition\_2\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to the first KPI that's used to transfer values from the parent to the child process. This is a relationship field. - **Relationship Name**: cgcloud\_\_Child\_Promo\_Relevant\_KPI\_Definition\_2\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Child\_Promo\_Relevant\_KPI\_Definition\_3\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Lookup to the first KPI that's used to transfer values from the parent to the child process. This is a relationship field. - **Relationship Name**: cgcloud\_\_Child\_Promo\_Relevant\_KPI\_Definition\_3\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Child\_Promotion\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Lookup to a promotion template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Child\_Promotion\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_Template\_\_c ### cgcloud\_\_Copied\_Components\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: Components of a promotion that must be copied to the child promotion when a promotion is copied or derived. - **Possible values**: - ManualInput—Manual Input - Notes - Products - Tactics ### cgcloud\_\_Parent\_Child\_Usage\_Combo\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: It stores the combination of parent promotion template and child promotion template for Derive Usage to avoid duplication of entries. ### cgcloud\_\_Parent\_Promotion\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the parent (current) promotion template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Parent\_Promotion\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Promotion\_Template\_\_c (the master object) ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the Promotion Template Hierarchy. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Usage\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the process type for which the relation record is used. - **Possible values**: - Copy - Derive - Push ## 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\_\_Promotion\_Template\_Hierarchy\_\_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\_\_Promotion\_Template\_Hierarchy\_\_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\_\_Promotion\_Template\_Hierarchy\_\_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 tracked fields of the object. - **[cgcloud\_\_Promotion\_Template\_Hierarchy\_\_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\_\_Promotion\_Template\_Hierarchy\_\_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. # cgcloud\_\_Promotion\_Template\_Tactic\_Template\_\_c Junction Object between Promotion Templates and Tactic Templates. 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 ### cgcloud\_\_Is\_Transfer\_Relevant\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Identifies if the tactic template is eligible for transfer.Possible values are - No - Yes ### cgcloud\_\_Promotion\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Link to the Promotion Template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Promotion\_Template\_\_c (the master object) ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the Promotion Template Tactic Template. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Determines the display order of the tactic template while adding a tactic to a promotion. By default, ‌tactic templates are shown in ascending order. Make sure that you enter a value that’s unique within the promotion template. ### cgcloud\_\_Tactic\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the tactic template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tactic\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Tactic\_Template\_\_c (the detail object) ## 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\_\_Promotion\_Template\_Tactic\_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\_\_Promotion\_Template\_Tactic\_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\_\_Promotion\_Template\_Tactic\_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 tracked fields of the object. - **[cgcloud\_\_Promotion\_Template\_Tactic\_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\_\_Promotion\_Template\_Tactic\_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. # 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. # cgcloud\_\_RBF\_Category\_\_c Junction object between Rate Based Funding and Product for driving RBF and Product association. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Master Detail Relationship for Product from RateBasedFunding\_Product Junction Object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Rate\_based\_Funding\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Master Detail Relationship for Rate Based Funding from RateBasedFunding\_Product Junction Object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Rate\_based\_Funding\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Rate\_Based\_Funding\_\_c (the master object) ## 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\_\_RBF\_Category\_\_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\_\_RBF\_Category\_\_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\_\_RBF\_Category\_\_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 tracked fields of the object. - **[cgcloud\_\_RBF\_Category\_\_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\_\_RBF\_Category\_\_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. # cgcloud\_\_RBF\_Product\_Manual\_Input\_\_c This object represents the junction between Rate-based Funding and Product. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Edit\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Sort, Update - **Description**: Sequences a user's manual edits to the grid data. ### cgcloud\_\_External\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Federated ID - concatenating Rate-based\_Funding\_\_c and Product2. ### cgcloud\_\_Measure\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Measure Code of the manual calculation input entry that this record defines. ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Product to which the manual calculation input entry that's defined by this record is anchored. If the entry is at the total level, the value of this field can be null. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Rate\_based\_Funding\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Rate based funding to which the manual calculation input entry belongs. This is a relationship field. - **Relationship Name**: cgcloud\_\_Rate\_based\_Funding\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Rate\_Based\_Funding\_\_c (Master object) ### cgcloud\_\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: User-provided value of the manual calculation input entry. ## 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\_\_RBF\_Product\_Manual\_Input\_\_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\_\_RBF\_Product\_Manual\_Input\_\_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\_\_RBF\_Product\_Manual\_Input\_\_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\_\_RBF\_Product\_Manual\_Input\_\_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\_\_RBF\_Product\_Manual\_Input\_\_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. # cgcloud\_\_RBF\_Template\_\_c Creation template for Rate-based Funding (RBF) records. 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**: 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 Rate-Based Funding Record, regardless of User Role. - **Default value**: true ### cgcloud\_\_Anchor\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Customer Anchor Type for the Rate-Based Funding record which drives the visibility for the Anchor attribute. - **Possible values**: - Customer ### cgcloud\_\_Condition\_Source\_KPI\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Condition Source KPI (Lookup to KPI Definition). This is a relationship field. - **Relationship Name**: cgcloud\_\_Condition\_Source\_KPI\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Condition\_Target\_KPI\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Condition Target KPI (Lookup to KPI Definition). This is a relationship field. - **Relationship Name**: cgcloud\_\_Condition\_Target\_KPI\_\_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 Sales Org assigned to the template. ### 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\_\_Fund\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Reference to Fund Template. Template from which the RBF Template determines the fund type. This is a relationship field. - **Relationship Name**: cgcloud\_\_Fund\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Fund\_Template\_\_c ### cgcloud\_\_Internal\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Internal ID is created to ensure that the same short code doesn't correspond to the same Sales Org. ### cgcloud\_\_KPI\_Set\_KPI\_Definition\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: KPI that's used to populate the Total RBF attribute on the Rate Based Funding. This is a relationship field. - **Relationship Name**: cgcloud\_\_KPI\_Set\_KPI\_Definition\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_KPI\_Set\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Reference to 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 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\_\_RBF\_Total\_KPI\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to KPI Definition. This is a relationship field. - **Relationship Name**: cgcloud\_\_RBF\_Total\_KPI\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Rate\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Allows for the various calculation methods of Rate Based Funding KPIs. - **Possible values**: - Currency/Case - Fixed - Percent of Revenue ### cgcloud\_\_Sales\_Org\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Reference to 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 for integration. ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sort order of the Rate Based Fund template. ## 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\_\_RBF\_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\_\_RBF\_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\_\_RBF\_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 tracked fields of the object. - **[cgcloud\_\_RBF\_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\_\_RBF\_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. # cgcloud\_\_Route\_\_c Stores the details of the route object. 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**: 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 ### cgcloud\_\_Default\_Start\_Time\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Default start time of the first call of the respective tour. ### cgcloud\_\_Default\_Truck\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Default truck that's used for the route. This is a relationship field. - **Relationship Name**: cgcloud\_\_Default\_Truck\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Vehicle\_\_c ### cgcloud\_\_Default\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Default user (driver) of the route. This is a relationship field. - **Relationship Name**: cgcloud\_\_Default\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### 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 of the route. 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\_\_End\_Warehouse\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: End warehouse details. This is a relationship field. - **Relationship Name**: cgcloud\_\_End\_Warehouse\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Warehouse\_\_c ### cgcloud\_\_Route\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the route template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Route\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Route\_Template\_\_c ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org to which the route template belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Start\_Warehouse\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Start warehouse details. This is a relationship field. - **Relationship Name**: cgcloud\_\_Start\_Warehouse\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Warehouse\_\_c ### cgcloud\_\_Trailer\_1\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: First default trailer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Trailer\_1\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Vehicle\_\_c ### cgcloud\_\_Trailer\_2\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Second default trailer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Trailer\_2\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Vehicle\_\_c ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: First date of validity period of the route. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the route is valid. ## 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\_\_Route\_\_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\_\_Route\_\_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\_\_Route\_\_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\_\_Route\_\_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\_\_Route\_\_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. # cgcloud\_\_Route\_Account\_\_c Stores the details of the relationship between routes and customers. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the linked account. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_City\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Shipping city of the linked account This is a calculated field. - **Formula**: cgcloud\_\_Account\_\_r.ShippingCity ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the Detail page of the Route Customer record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Route\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the referenced route. This is a relationship field. - **Relationship Name**: cgcloud\_\_Route\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Route\_\_c (the master object) ### cgcloud\_\_Sequence\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sequence or Order of the record that's used for sorting. ### cgcloud\_\_Street\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Shipping street of the linked account. This is a calculated field. - **Formula**: cgcloud\_\_Account\_\_r.ShippingStreet ### cgcloud\_\_Visit\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the referenced visit template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Visit\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Visit\_Template\_\_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\_\_Route\_Account\_\_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\_\_Route\_Account\_\_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\_\_Route\_Account\_\_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\_\_Route\_Account\_\_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\_\_Route\_Account\_\_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. # cgcloud\_\_Route\_Template\_\_c Stores the details of the route template object that's to be used for routes. 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**: 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**: Indicates whether the template is active. Only active templates are available to create routes. - **Default value**: true ### 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 of the route template in the languages that are configured for the sales organization. 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\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales organization in which the template can be used. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Tour\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the tour template object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tour\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Tour\_Template\_\_c ### cgcloud\_\_Visit\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the visit template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Visit\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Visit\_Template\_\_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\_\_Route\_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\_\_Route\_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\_\_Route\_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\_\_Route\_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\_\_Route\_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. # cgcloud\_\_RTR\_Report\_Configuration\_\_c This object contains Real Time Report (RTR) Configurations. One record defines the data that's to be loaded for a report and what or how it gets shown in a declarative manner. 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\_\_Internal\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Unique key for the configuration of the report: concatenation of the report name, usage, and sales org. This object ensures that no duplicate reports or configurations exist on the same Sales org. ### cgcloud\_\_Usage\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Type of report or type of configuration. - **Default value**: reportmeta - **Possible values**: - intaccountdim—Integration Account Dimension - integrationmeta—Integration Metadata - intproductdim—Integration Product Dimension - intpromotiondim—Integration Promotion Dimension - inttacticdim—Integration Tactic Dimension - paymentdim—Report Payment Dimension - productdim—Report Product Dimension - promotiondim—Report Promotion Dimension - reportmeta—Report Metadata - tacticdim—Report Tactic Dimension - tacticprodcondattrmeta—Report Tactic Product Condition Attribute Metadata ## 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\_\_RTR\_Report\_Configuration\_\_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\_\_RTR\_Report\_Configuration\_\_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\_\_RTR\_Report\_Configuration\_\_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\_\_RTR\_Report\_Configuration\_\_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\_\_RTR\_Report\_Configuration\_\_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. # cgcloud\_\_Sales\_Folder\_\_c This object contains the attributes that are associated with the Sales Folder. 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**: 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\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the customer. 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**: Active flag. - **Default value**: false ### 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\_\_Note\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: General notes about the Sales Folder. ### cgcloud\_\_Org\_Unit\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Org Unit. This is a relationship field. - **Relationship Name**: cgcloud\_\_Org\_Unit\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Org\_Unit\_\_c ### cgcloud\_\_Sales\_Folder\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Sales Folder Template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Sales\_Folder\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Sales\_Folder\_Template\_\_c ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org to which the sales folder belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: First date of the validity period of the sales folder. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Last date of the validity period of the sales folder. ## 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\_\_Sales\_Folder\_\_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\_\_Sales\_Folder\_\_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\_\_Sales\_Folder\_\_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\_\_Sales\_Folder\_\_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\_\_Sales\_Folder\_\_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. # cgcloud\_\_Sales\_Folder\_Sell\_Sheet\_\_c This object stores the details of the relationship between the sales folder and sell sheet. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the sales folder sell sheet record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sales\_Folder\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the Sales Folder. This is a relationship field. - **Relationship Name**: cgcloud\_\_Sales\_Folder\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Sales\_Folder\_\_c ( Master object) ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales Organization to which the sales folder sell sheet assignment of the sales folder (and the sales folder itself) belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Sell\_Sheet\_Unique\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This field ensures that one sell sheet is attached only once to a sales folder. It's a concatenation of Sales Folder Id and Sell Sheet Id. This field is updated by a Workflow. ### cgcloud\_\_Sell\_Sheet\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the Sell Sheet. This is a relationship field. - **Relationship Name**: cgcloud\_\_Sell\_Sheet\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Sell\_Sheet\_\_c (the detail object) ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sort field for the Sales Folder Sell Sheet. ## 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\_\_Sales\_Folder\_Sell\_Sheet\_\_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\_\_Sales\_Folder\_Sell\_Sheet\_\_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\_\_Sales\_Folder\_Sell\_Sheet\_\_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\_\_Sales\_Folder\_Sell\_Sheet\_\_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\_\_Sales\_Folder\_Sell\_Sheet\_\_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. # cgcloud\_\_Sales\_Folder\_Template\_\_c This object contains the attributes that are associated with the Sales Folder Template. 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**: 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**: Active flag. - **Default value**: true ### cgcloud\_\_Anchor\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Type of object to which the sales folder is assigned. - **Default value**: BusinessPartner - **Possible values**: - BusinessPartner—Customer - OrgUnit—Org Unit ### 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\_\_Promotion\_Relevant\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the related Sales Folder record is available for Promotion support. - **Default value**: false ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org to which the Sales Folder Template belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## 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\_\_Sales\_Folder\_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\_\_Sales\_Folder\_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\_\_Sales\_Folder\_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\_\_Sales\_Folder\_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\_\_Sales\_Folder\_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. # cgcloud\_\_Sales\_Organization\_\_c This object stores the details of the Sales Organization. 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**: 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\_\_APM\_Product\_List\_Relevant\_Measures\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Stores the measure codes that are defined for the accountproductmeasure table. - **Possible values**: - BASP ### cgcloud\_\_Account\_Number\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Account number at the bank. ### cgcloud\_\_Account\_Product\_List\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the Product List that's to be used. - **Default value**: global - **Possible values**: - global - timedependent ### cgcloud\_\_Automatic\_Promotion\_Push\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Activates the automatic push on leave of the promotion. - **Default value**: true ### cgcloud\_\_Available\_Trade\_Calendar\_Color\_Schemas\_\_c - **Type**: multipicklist - **Properties**: Create, Defaulted on create, Filter, Nillable, Restricted picklist, Update - **Description**: Property Based Coloring of Promotion Bars within the Trade Calendar. - **Default value**: 1 - **Possible values**: - 1—Promotion Template - 2—Phase - 3—Custom 3 - 4—Custom 4 - 5—Custom 5 ### cgcloud\_\_BIN\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Bank Identification Number. ### cgcloud\_\_Bank\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Code of the bank. ### cgcloud\_\_Bank\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Bank that's used for payments. ### cgcloud\_\_Business\_Unit\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the book keeping segment. ### cgcloud\_\_City\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the city. ### cgcloud\_\_Country\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the country. ### cgcloud\_\_Currency\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Currency of the sales organization. - **Possible values**: - BRL - CAD—Canadian Dollar - CHF—Swiss Franc - EUR—Euro - GBP—Pound Sterling - JPY—Yen - MXN - NOK—Norwegian Krone - RUB—Russian currency - THB - USD—US Dollar ### cgcloud\_\_Custom\_Calendar\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the custom calendar that's used for the sales org. This is a relationship field. - **Relationship Name**: cgcloud\_\_Custom\_Calendar\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Custom\_Calendar\_\_c ### cgcloud\_\_DMI\_Product\_List\_Relevant\_Measures\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Stores measure codes that are defined for the daily measurement table. - **Possible values**: - DMI ### cgcloud\_\_DMR\_Product\_List\_Relevant\_Measures\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Stores measure codes that are defined for the dailymeasurereal table. - **Possible values**: - SHIP ### cgcloud\_\_Default\_Mobility\_Visit\_Color\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Field to define the default color of visits on the calendar of a mobility device. - **Default value**: 0176D3 - **Possible values**: - 003344 - 008899 - 0176D3 - 20B2AA - 467596 - 551155 - 6495ED - 6688BB - 77AA99 - 87CEEB - 87CEFA - 8FBC8F - AA1133 - ADD8E6 - B0C4DE - BBBB00 - BC8F8F - D1DDEC - DAA520 - DD4411 - DDECD1 - E9967A - EE9B38 - EED2E0 - F08080 - F4A460 - F7EBD9 - FA8072 - FF7F50 - FFA07A - FFD700 ### cgcloud\_\_Default\_Price\_List\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Default price list type of the sales organization. - **Possible values**: - NotRelevant—Not Relevant - WS1999—Wholesaler - WS2000—Direct Customers ### cgcloud\_\_Default\_Price\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Default price type of the sales organization. - **Possible values**: - NotRelevant - consumer - factory ### cgcloud\_\_Default\_Tactic\_Fund\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Default template that's used as a fallback if no fund template is selected in the tactic. This is a relationship field. - **Relationship Name**: cgcloud\_\_Default\_Tactic\_Fund\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Fund\_Template\_\_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\_\_Distance\_Unit\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Distance unit for mobility. - **Default value**: km - **Possible values**: - km—Kilometer - miles—Miles ### cgcloud\_\_Email\_\_c - **Type**: email - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Email address. ### cgcloud\_\_Enable\_Acc\_Cat\_WDS\_Profile\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the account, category, account, and sales org-specific profiles use the Profile bucket share calculation, which is found first. - **Default value**: false ### cgcloud\_\_Enable\_Account\_Set\_Search\_in\_TPC\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the customer set search filter is available in the trade calendar filter. - **Default value**: true ### cgcloud\_\_Enable\_Auto\_Tactic\_Fund\_Assignment\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the tactic fund assignment is automatic. - **Default value**: true ### cgcloud\_\_Enable\_Payment\_Overwrite\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the payment can be overwritten for the sales organization. - **Default value**: true ### cgcloud\_\_Enable\_Sub\_Account\_Search\_In\_TPC\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the customer set search filter is available in the trade calendar filter. - **Default value**: false ### cgcloud\_\_Enable\_Subperiod\_Writeback\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the system stores subperiod values with writebacks. - **Default value**: false ### cgcloud\_\_Enable\_Subset\_Load\_Optimization\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the system uses KPI subset configurations for optimized loading of KPIs in promotion and account plan. - **Default value**: true ### cgcloud\_\_Enable\_Tactic\_Condition\_Creation\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the condition can be created at the tactic level. - **Default value**: false ### cgcloud\_\_Fax\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Fax number. ### cgcloud\_\_First\_Day\_Of\_Week\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the day of the week. - **Possible values**: - 1—Sunday - 2—Monday - 3—Tuesday - 4—Wednesday - 5—Thursday - 6—Friday - 7—Saturday ### cgcloud\_\_First\_Week\_Of\_Year\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Shows the week for call scheduling. - **Possible values**: - 1—First January - 2—First Four Days - 3—First Full Week ### cgcloud\_\_Geofence\_Distance\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Maximum distance(in kilometers) allowed for geofencing validation (start-of-day, end-of-day, visit). ### cgcloud\_\_Global\_Sales\_Org\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the current sales org is the global sales org. - **Default value**: false ### cgcloud\_\_Has\_Activated\_Business\_Years\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the business years are activated for the sales org. - **Default value**: false ### cgcloud\_\_IBAN\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: International Bank Account Number. ### cgcloud\_\_Language\_1\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Language 1 of the sales org. - **Possible values**: - de—German - en—English - es—Spanish - fr—French - it—Italian ### cgcloud\_\_Language\_2\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Language 2 of the sales org. - **Possible values**: - de—German - en—English - es—Spanish - fr—French - it—Italian ### cgcloud\_\_Language\_3\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Language 3 of the sales org. - **Possible values**: - de—German - en—English - es—Spanish - fr—French - it—Italian ### cgcloud\_\_Language\_4\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Language 4 of the sales org. - **Possible values**: - de—German - en—English - es—Spanish - fr—French - it—Italian ### cgcloud\_\_Legal\_Information\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Legal information to be shown on the printouts. ### cgcloud\_\_Lookback\_Period\_In\_Years\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: The products with an end date within the lookback period are selected for the calculation of account plan profit and loss and customer business plan. - **Possible values**: - 1 - 2 ### cgcloud\_\_No\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: House Number. ### cgcloud\_\_PMR\_Product\_List\_Relevant\_Measures\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Stores measure codes that are defined for the WeeklyPromotionMeasureResult and MonthlyPromotionMeasureResult tables. - **Possible values**: - PIV - PTV ### cgcloud\_\_PM\_Product\_List\_Relevant\_Measures\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Stores measure codes that are defined for the product measure table. - **Possible values**: - COGS ### cgcloud\_\_Phone\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Phone number. ### cgcloud\_\_Postbox\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Number of a post box. ### cgcloud\_\_Promotion\_Access\_Definition\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Defines whether the edit and access rights are dependent on either the product categories that the user has assigned or the account and product category relationship. - **Default value**: Independent\_Anchors - **Possible values**: - Combined\_Anchors—Combined Anchors - Independent\_Anchors—Independent Anchors ### cgcloud\_\_Promotion\_Aggregation\_Level\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Defines at which level the product is located. - **Default value**: Brand - **Possible values**: - Brand - Category - Flavor - Package - Product - SubCategory ### cgcloud\_\_SWIFT\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: International bank account identifier. ### cgcloud\_\_Sales\_Org\_Admin\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifies the admin user of the sales org. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Sales\_Org\_Admin\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Sales\_Org\_Value\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Value of the sales org that are defined in the global value picklist. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Sales\_Organization\_Cluster\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Values of the organization cluster. - **Possible values**: - EU - NA - SA ### cgcloud\_\_Should\_Include\_Discontinued\_Products\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the discontinued products are included in the calculation of the account plan profit and loss and customer business plan. A single lookback period spans 380 days. The lookback period goes back from the start of the customer business plan or account plan. It goes back by 380 days for a 1-year period and 760 days for a 2-year period. - **Default value**: false ### cgcloud\_\_State\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the state. ### cgcloud\_\_Street\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of a street. ### cgcloud\_\_Tax\_Jurisdiction\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Tax Account Number. ### cgcloud\_\_Used\_Reference\_Date\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Determines the value that's selected in the view for the product hierarchy resolution reference date. - **Default value**: startdate - **Possible values**: - dynamic—Dynamic - startdate—Start Date ### cgcloud\_\_Visit\_Start\_Time\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the Visit Start Time value. ### cgcloud\_\_Volume\_Unit\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Item volume unit used for complex pricing. Assumption: All pricing relevant volume values (product master data, condition data) are interpreted in this overall specified unit. - **Default value**: l - **Possible values**: - cm3—cubic meters - gallon - l—liter ### cgcloud\_\_WMI\_Product\_List\_Relevant\_Measures\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Stores the measure codes that are defined for the weeklymeasureint table. - **Possible values**: - BSL - CONS ### cgcloud\_\_WMR\_Product\_List\_Relevant\_Measures\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Stores the measure codes that are defined for the weeklymeasurereal table. - **Possible values**: - WMR ### cgcloud\_\_Week\_Day\_Share\_Profile\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the weekday share profile that's used as the default for the sales organization. This is a relationship field. - **Relationship Name**: cgcloud\_\_Week\_Day\_Share\_Profile\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Week\_Day\_Share\_Profile\_\_c ### cgcloud\_\_Weight\_Unit\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Item weight unit that's used for complex pricing. Assumption: All pricing relevant weight values (product master data, condition data) are interpreted in this overall specified unit. - **Default value**: kg - **Possible values**: - kg - oz - pound - ton ### cgcloud\_\_Zip\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Postal code. ## 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\_\_Sales\_Organization\_\_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\_\_Sales\_Organization\_\_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\_\_Sales\_Organization\_\_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\_\_Sales\_Organization\_\_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\_\_Sales\_Organization\_\_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. # cgcloud\_\_Sales\_Organization\_User\_\_c This object stores the details of the relationship between a sales organization and a user. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Default\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the default customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Default\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Default\_Visit\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the default visit template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Default\_Visit\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Visit\_Template\_\_c ### cgcloud\_\_Is\_Tour\_Selection\_Required\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether tour selection is enabled for the user. This field is reserved for future. - **Default value**: false ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Internally used to show the record's hyperlink. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sales\_Organization\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the sales organization. This is a relationship field. - **Relationship Name**: cgcloud\_\_Sales\_Organization\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Sales\_Organization\_\_c (the master object) ### cgcloud\_\_Unique\_User\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Used internally. Contains these unique values: - User.Id - Sales\_Organisation.Id ### cgcloud\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Work\_Begins\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Time at which the user begins to work. ### cgcloud\_\_Work\_Ends\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Time at which the user stops to work. ### cgcloud\_\_Works\_On\_Friday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Day of the week on which the user typically works. For example, used for capacity planning. - **Default value**: false ### cgcloud\_\_Works\_On\_Monday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Day of the week on which the user typically works. For example, used for capacity planning. - **Default value**: false ### cgcloud\_\_Works\_On\_Saturday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Day of the week on which the user typically works. For example, used for capacity planning. - **Default value**: false ### cgcloud\_\_Works\_On\_Sunday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Day of the week on which the user typically works. For example, used for capacity planning. - **Default value**: false ### cgcloud\_\_Works\_On\_Thursday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Day of the week on which the user typically works. For example, used for capacity planning. - **Default value**: false ### cgcloud\_\_Works\_On\_Tuesday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Day of the week on which the user typically works. For example, used for capacity planning. - **Default value**: false ### cgcloud\_\_Works\_On\_Wednesday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Day of the week on which the user typically works. For example, used for capacity planning. - **Default value**: false ## 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\_\_Sales\_Organization\_User\_\_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\_\_Sales\_Organization\_User\_\_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\_\_Sales\_Organization\_User\_\_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\_\_Sales\_Organization\_User\_\_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\_\_Sales\_Organization\_User\_\_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. # cgcloud\_\_Segmentation\_Rule\_\_c This object stores the details of the segmentation rule. 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\_\_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\_\_Hierarchy\_Node\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the field that shows the account lookup to select the hierarchy node and then apply filters on the customer hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Hierarchy\_Node\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Input\_Variables\_JSON\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: .json files that contains the user input. ### cgcloud\_\_Org\_Unit\_Hierarchy\_Node\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the field that shows the account lookup to select the hierarchy node and then apply filters on the customer hierarchy. This is a relationship field. - **Relationship Name**: cgcloud\_\_Org\_Unit\_Hierarchy\_Node\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Org\_Unit\_\_c ### cgcloud\_\_Result\_Level\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the level from which to retrieve customers. - **Default value**: Trade Org - **Possible values**: - Store - Trade Org ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the segmentation rule belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Segmentation\_Rule\_Def\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Segmentation Rule Definition. This is a relationship field. - **Relationship Name**: cgcloud\_\_Segmentation\_Rule\_Def\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Segmentation\_Rule\_Def\_\_c ### cgcloud\_\_Segmentation\_Rule\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Segmentation Rule Template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Segmentation\_Rule\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Segmentation\_Rule\_Template\_\_c ## Associated Objects ### Associated Objects This object has these following 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\_\_Segmentation\_Rule\_\_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\_\_Segmentation\_Rule\_\_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\_\_Segmentation\_Rule\_\_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\_\_Segmentation\_Rule\_\_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\_\_Segmentation\_Rule\_\_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. # cgcloud\_\_Segmentation\_Rule\_Def\_\_c Contains the available queries and its attributes to create segmentation rules. 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**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique identifier. ### 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\_\_Description\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores the description for the segmentation rule definition. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org to which the segmentation rule definition belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Segmentation\_Query\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: SOQL statement with bindings for segmentation rule definition columns. ### cgcloud\_\_State\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the current status of the segmentation rule definition. - **Default value**: Initial - **Possible values**: - Initial - Released ### cgcloud\_\_Target\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the type of the source programmatic language. - **Possible values**: - SOQL ### cgcloud\_\_Use\_Account\_Hierarchy\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the account hierarchy is used. - **Default value**: false ### cgcloud\_\_Use\_Org\_Unit\_Hierarchy\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the org unit hierarchy is used. - **Default value**: false ## 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\_\_Segmentation\_Rule\_Def\_\_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\_\_Segmentation\_Rule\_Def\_\_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\_\_Segmentation\_Rule\_Def\_\_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\_\_Segmentation\_Rule\_Def\_\_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\_\_Segmentation\_Rule\_Def\_\_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. # cgcloud\_\_Segmentation\_Rule\_Def\_Column\_\_c This object defines the query attributes of the Segmentation Rule Definition. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Field\_Alias\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Alias that's specified in the SOQL building. ### cgcloud\_\_Field\_Default\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Default value that's shown when the input mask is rendered for this field. ### cgcloud\_\_Field\_List\_Template\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: If the field type is List, then this field defines the content of the list. - **Possible values**: - number - picklist - text ### cgcloud\_\_Field\_Number\_Digits\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: For Number fields, it defines the number of digits after the decimal point. ### cgcloud\_\_Field\_Picklist\_Target\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: If the field type is either Picklist or List with the template as Picklist, then this field defines the picklist to choose. The format is .. This field is ignored for any other field type. ### cgcloud\_\_Field\_Regex\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Applies to user input. If the input is a list, the regex applies to each list entry separately. ### cgcloud\_\_Field\_Title\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the label of the field that used to define segmentation parameters. ### cgcloud\_\_Field\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the type of field that's used to define segmentation parameters. - **Default value**: text - **Possible values**: - boolean - date - list - number - picklist - text ### cgcloud\_\_Segmentation\_Rule\_Def\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the segmentation rule definition. This is a relationship field. - **Relationship Name**: cgcloud\_\_Segmentation\_Rule\_Def\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Segmentation\_Rule\_Def\_\_c (Master object) ## 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\_\_Segmentation\_Rule\_Def\_Column\_\_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\_\_Segmentation\_Rule\_Def\_Column\_\_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\_\_Segmentation\_Rule\_Def\_Column\_\_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\_\_Segmentation\_Rule\_Def\_Column\_\_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\_\_Segmentation\_Rule\_Def\_Column\_\_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. # cgcloud\_\_Segmentation\_Rule\_Template\_\_c This object contains information that configures the behavior for the associated segmentation rules. 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**: 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**: Reference to the owner of the segmentation rule template record. This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### cgcloud\_\_Private\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the segmentation rule is private. - **Default value**: false ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the segmentation rule template belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Update\_Policy\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Type of the segmentation rule. - **Possible values**: - OnDemand - Periodically ## 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\_\_Segmentation\_Rule\_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\_\_Segmentation\_Rule\_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\_\_Segmentation\_Rule\_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\_\_Segmentation\_Rule\_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\_\_Segmentation\_Rule\_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. # cgcloud\_\_Sell\_Sheet\_\_c This object contains the attributes that are associated with the sell sheet to be used on the Sales folder. 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**: 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**: Active flag. - **Default value**: false ### 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\_\_Note\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: General note about the sell sheet. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the sell sheet belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## 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\_\_Sell\_Sheet\_\_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\_\_Sell\_Sheet\_\_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\_\_Sell\_Sheet\_\_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\_\_Sell\_Sheet\_\_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\_\_Sell\_Sheet\_\_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. # cgcloud\_\_Signature\_\_c This object stores the attributes for signatures. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Name of the user whose signature is captured. ### 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**: Reference to the customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name in clear text. ### cgcloud\_\_Order\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the order. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Order\_\_c ### cgcloud\_\_Reference\_Object\_Phase\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Phase in which the signature process started. ### cgcloud\_\_Signature\_Flow\_Step\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the signature flow step. This is a relationship field. - **Relationship Name**: cgcloud\_\_Signature\_Flow\_Step\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Signature\_Flow\_Step\_\_c ### cgcloud\_\_Tour\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the tour. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tour\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Tour\_\_c ### cgcloud\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ## 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\_\_Signature\_\_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\_\_Signature\_\_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\_\_Signature\_\_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\_\_Signature\_\_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\_\_Signature\_\_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. # cgcloud\_\_Signature\_Attribute\_\_c Entity that stores the attributes and values for signatures. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Attribute\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Attribute combinations. - **Possible values**: - ASN - ActualAmount - Amount - Cashier - Checker - Customer - CustomerId - Date - Difference - Driver - Guard - InvoiceId - LineItems - Original - Time - TourId - VehicleId - Warehouse - WarehouseId ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Name of the record link. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Signature\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the Signature record. This is a relationship field. - **Relationship Name**: cgcloud\_\_Signature\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Signature\_\_c (the master object) ### cgcloud\_\_Value\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Value of the attribute. ## 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\_\_Signature\_Attribute\_\_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\_\_Signature\_Attribute\_\_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\_\_Signature\_Attribute\_\_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\_\_Signature\_Attribute\_\_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\_\_Signature\_Attribute\_\_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. # cgcloud\_\_Signature\_Flow\_Step\_\_c This object stores the details of the signature flow steps that are used in a signature template. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### 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\_\_Authentication\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the data that's required for a step. - **Default value**: None - **Possible values**: - Name (optional) - Name (required) - None ### 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\_\_Function\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Associated user role. - **Possible values**: - Cashier - Checker - Co-driver - Customer - Driver - Guard - Mobile User ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Name of the record link. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales organization to which the signature flow step belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Signature\_Required\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a signature is mandatory for a step. - **Default value**: true ### cgcloud\_\_Signature\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the signature template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Signature\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Signature\_Template\_\_c ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Controls the position of the step in the signature flow. ## 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\_\_Signature\_Flow\_Step\_\_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\_\_Signature\_Flow\_Step\_\_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\_\_Signature\_Flow\_Step\_\_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\_\_Signature\_Flow\_Step\_\_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\_\_Signature\_Flow\_Step\_\_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. # cgcloud\_\_Signature\_Template\_\_c Stores the details of the signature template object that's used for signature flow steps. 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**: 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 signatures. - **Default value**: true ### cgcloud\_\_Attribute\_Set\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the combinations of the attribute. - **Possible values**: - CashCheckIn—Cash Check In - CashCheckOut—Cash Check Out - InwardInventoryTransfer—Inward Inventory Transfer - OutwardInventoryTransfer—Outward Inventory Transfer - ProductCheckIn—Product Check In - ProductCheckOut—Product Check Out - ReplenishmentOrder—Replenishment Order - SalesandDeliveryDocument—Sales and Delivery Document - TourStartandEndofDay—Tour Start and End of Day - TruckAudit—Truck Audit ### cgcloud\_\_Capture\_Location\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether GPS coordinates are to be captured during the signature process. - **Default value**: false ### 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\_\_Mobility\_Relevant\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether the template is usable on Mobility devices. - **Default value**: false ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Reference to the internal sales organization segment. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ## 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\_\_Signature\_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\_\_Signature\_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\_\_Signature\_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\_\_Signature\_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\_\_Signature\_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. # cgcloud\_\_Smart\_UI\_Lightning\_Settings\_\_c Internal Object contains Smart UI configurations. 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 ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique identification of the record. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the setup owner. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ### cgcloud\_\_Custom\_Remote\_Actions\_Mapping\_Class\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Class mapping UI actions to Apex classes that execute the action on the platform. ### cgcloud\_\_JSON\_Static\_Resource\_Name\_\_c - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The date when a user last did something related to the record. ### cgcloud\_\_Static\_Metadata\_Static\_Resource\_\_c - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Static resource from which to retrieve the static metadata. ### cgcloud\_\_Use\_Static\_Metadata\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Enables or disables the usage of pre-generated metadata for SmartUI. - **Default value**: false ## 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\_\_Smart\_UI\_Lightning\_Settings\_\_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\_\_Smart\_UI\_Lightning\_Settings\_\_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\_\_Smart\_UI\_Lightning\_Settings\_\_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\_\_Smart\_UI\_Lightning\_Settings\_\_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\_\_Smart\_UI\_Lightning\_Settings\_\_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. # cgcloud\_\_Substitution\_\_c The use case stores the details of the substitute object that specifies the basis of a substitution depending on a substitution period and user. 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**: The date when a user last did something related to 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\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the customer. 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**: Active flag. - **Default value**: false ### 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, "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\_\_Follow\_Up\_Time\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Follow up time (number of days) of the substitution. ### cgcloud\_\_Lead\_Time\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Lead time (number of days) of the substitution. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the substitution detail page. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org to which the substitution belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Substitute\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the substitute user. This is a relationship field. - **Relationship Name**: cgcloud\_\_Substitute\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Substituted\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user for whom the substitution is planned. This is a relationship field. - **Relationship Name**: cgcloud\_\_Substituted\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Substitution\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Type of the substitution. - **Default value**: Vacation - **Possible values**: - Other - Sickness - Training - Vacation ### cgcloud\_\_Substitution\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the substitution with which the substitution item record is related. This is a relationship field. - **Relationship Name**: cgcloud\_\_Substitution\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Substitution\_\_c ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: First date of validity period of the customer substitution. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Last date of validity period of the customer substitution. ## 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\_\_Substitution\_\_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\_\_Substitution\_\_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\_\_Substitution\_\_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\_\_Substitution\_\_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\_\_Substitution\_\_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. # cgcloud\_\_System\_Number\_\_c This object specifies the number definition that's used for number generation on CAS OnPremise Mobility. 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\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: When the number definition is selected as empty, the validation of number definition and segments applies. - **Default value**: true ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org to which the system number belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Segment\_Validation\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Segment validation. This is a calculated field. ### cgcloud\_\_System\_Fallback\_Number\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the fallback number definition. This is a relationship field. - **Relationship Name**: cgcloud\_\_System\_Fallback\_Number\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_System\_Number\_\_c ### cgcloud\_\_Usage\_Validate\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Only used for validation of the Usage field (unique). ### cgcloud\_\_Usage\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the item for which the number definition is to be used. - **Possible values**: - CashInvoice - CreditInvoice - CreditNote - DeliveryNote - FallbackNumber - Invoice - NonValuatedDeliveryNote - OrderConfirmation - OrderEntry - SvcRequest - Tour - ValuatedDeliveryNote ### cgcloud\_\_Warning\_Limit\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Specifies a minimum limit of the number range that shows a warning message. ## 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\_\_System\_Number\_\_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\_\_System\_Number\_\_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\_\_System\_Number\_\_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\_\_System\_Number\_\_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\_\_System\_Number\_\_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. # cgcloud\_\_System\_Number\_Last\_\_c Last used number of a specific number type and device. 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 ### 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\_\_Last\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Last number used for the number definition. ### cgcloud\_\_System\_Number\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to a number definition. This is a relationship field. - **Relationship Name**: cgcloud\_\_System\_Number\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_System\_Number\_\_c ### cgcloud\_\_User\_Lu\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to a logical unit (device of the user). ## 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\_\_System\_Number\_Last\_\_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\_\_System\_Number\_Last\_\_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\_\_System\_Number\_Last\_\_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\_\_System\_Number\_Last\_\_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\_\_System\_Number\_Last\_\_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. # cgcloud\_\_System\_Number\_Segment\_\_c Segment of the number definition. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Initial\_Value\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Value used if there was no previous number for this number definition. ### cgcloud\_\_Max\_Value\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Maximum value of the number definition. ### cgcloud\_\_Numerical\_System\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Numerical system. - **Possible values**: - Alpha - Binary - Decimal - Hex ### cgcloud\_\_Post\_Delimiter\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Optional postfix of the segment. ### cgcloud\_\_Pre\_Delimiter\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Optional prefix of the segment. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Required for technical reasons. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Segment\_Length\_\_c - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: Number of characters of this segment including delimiters. ### cgcloud\_\_Segment\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of the segment. - **Possible values**: - Constant - Counter - InitCounter - LU - Year ### cgcloud\_\_Sort\_Validation\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Used for validation, not for Layout. ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Sort, Update - **Description**: Position of this segment in the segment sequence of this number definition. ### cgcloud\_\_System\_Number\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the System Number. This is a relationship field. - **Relationship Name**: cgcloud\_\_System\_Number\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_System\_Number\_\_c (the master object) ### cgcloud\_\_Type\_Unique\_Validation\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Segment Type is a unique field for Number Definition. It's a hidden field for Validation. ### cgcloud\_\_Type\_Validation\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Required for technical reasons. This is a calculated field. - **Formula**: CASE( cgcloud\_\_Segment\_Type\_\_c , 'LU', 19, 'Counter', 20, 'InitCounter',22,0) ## 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\_\_System\_Number\_Segment\_\_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\_\_System\_Number\_Segment\_\_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\_\_System\_Number\_Segment\_\_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\_\_System\_Number\_Segment\_\_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\_\_System\_Number\_Segment\_\_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. # cgcloud\_\_System\_Setting\_\_c Custom setting that stores all system setting attributes as a key-value pair. 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 ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Sort, Update - **Description**: Unique identification of the record. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the setup owner. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ### cgcloud\_\_Description\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the description of the System Setting attribute. ### cgcloud\_\_Value\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the value of the respective System Setting. ## 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\_\_System\_Setting\_\_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\_\_System\_Setting\_\_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\_\_System\_Setting\_\_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\_\_System\_Setting\_\_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\_\_System\_Setting\_\_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. # cgcloud\_\_Tactic\_\_c Configures the relation between a Promotion and a Tactic. 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. ### 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\_\_Absolute\_Lift\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Estimated Lift value of the tactic. If the tactic is executed, the Baseline Volume is increased by this volume. ### cgcloud\_\_Aggregation\_Category\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Aggregation category for the tactic under the promotion. ### cgcloud\_\_Amount\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Tactic Cost Amount. ### cgcloud\_\_Anchor\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Anchor of the promotion to which the tactic is related. This is a calculated field. - **Formula**: cgcloud\_\_Promotion\_\_r.cgcloud\_\_Anchor\_Account\_\_r.Name ### cgcloud\_\_Comment\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the comment that describes different tactics. ### cgcloud\_\_Compensation\_Model\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the compensation model for the tactic execution. - **Default value**: LumpSum - **Possible values**: - LumpSum - PerCase - Percentage - WeeklyLumpSum ### cgcloud\_\_Condition\_Creation\_Incidents\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Information about duplicate condition incidents. This field is available in API version 55.0 and later. ### cgcloud\_\_Condition\_Creation\_Levels\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: JSON file which contains a list of effective product levels. This field is available in API version 55.0 and later. ### cgcloud\_\_Condition\_Maintenance\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the action on the conditions that the tactic generates. - **Default value**: initial - **Possible values**: - delete - freeze - initial - upsert ### cgcloud\_\_Create\_Default\_Conditions\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the system needs to create the default tactic condition creation definitions for the tactics when this tactic is saved in the database. This field is available in API version 55.0 and later. - **Default value**: false ### cgcloud\_\_Custom1\_Date\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Refers to the start of a project-specific time range. ### cgcloud\_\_Custom1\_Date\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Refers to the end of a project-specific time range. ### cgcloud\_\_Custom2\_Date\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Refers to the start of a project-specific time range. ### cgcloud\_\_Custom2\_Date\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Refers to the end of a project-specific time range. ### cgcloud\_\_Date\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Start of a project-specific time range. For example, pre-dip. ### cgcloud\_\_Date\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: End of a project-specific time range. For example, pre-dip. ### cgcloud\_\_Effective\_Brands\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Effective brands of the tactic. The field stores a list of sfIds of effective brands that are calculated from the effective SKUs or LDPs of the tactic. ### cgcloud\_\_Effective\_Categories\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Effective categories of the tactic. The field stores a list of sfIds of effective categories that are calculated from the effective SKUs or LDPs of the tactic. ### cgcloud\_\_ExternalId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Reference to the promotion ID that the external system uses to import tactic-specific actuals into the offplatform back end. ### cgcloud\_\_Filter\_Criteria\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Text field that stores the .json file that's used to apply product filters. ### cgcloud\_\_Fund\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Fund Type of the funds that are automatically assigned to the tactic. This is a relationship field. - **Relationship Name**: cgcloud\_\_Fund\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Fund\_Template\_\_c ### cgcloud\_\_Included\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Included in the promotion. - **Default value**: true ### cgcloud\_\_Instore\_Date\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Instore start date of a tactic ### cgcloud\_\_Instore\_Date\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Instore end date of a tactic. ### cgcloud\_\_KPI\_Value\_1\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Writeback synchronized KPI 1. ### cgcloud\_\_KPI\_Value\_2\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Writeback synchronized KPI 2. ### cgcloud\_\_KPI\_Value\_3\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Writeback synchronized KPI 3. ### cgcloud\_\_KPI\_Value\_4\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Writeback synchronized KPI 4. ### cgcloud\_\_LE\_Spend\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: LE Spend KPI value that's to be distributed to the associated tactic funds based on the funding percentage. ### cgcloud\_\_Liabilities\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Liability Accrual KPI value that's to be distributed to the associated tactic funds based on the funding percentage. ### cgcloud\_\_Lift\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Type of lift of the tactic. - **Possible values**: - % - Abs ### cgcloud\_\_Lift\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Value of the lift type (fixed or percentage value). ### cgcloud\_\_Lift\_\_c - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Incremental Lift Factor. ### cgcloud\_\_OI\_Costs\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Link to the tactic in the parent promotion that created this tactic. ### cgcloud\_\_Parent\_Tactic\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Link to the tactic in the parent promotion that created this tactic. This is a relationship field. - **Relationship Name**: cgcloud\_\_Parent\_Tactic\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Tactic\_\_c ### cgcloud\_\_Payment\_Method\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Payment method that a business partner uses to pay the costs due to the tactic execution. - **Default value**: Deduction - **Possible values**: - Check - Deduction - OffInvoice—Off Invoice - OnInvoice—On Invoice ### cgcloud\_\_Pct\_of\_Stores\_\_c - **Type**: percent - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Percentage of stores that participate in the tactic. ### cgcloud\_\_Pending\_Amount\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Amount that's pending to be paid. This is a calculated field. ### cgcloud\_\_Plan\_Spend\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Planned costs of the tactic. ### cgcloud\_\_Promotion\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Slogan of the promotion to which this tactic is assigned. This is a calculated field. - **Formula**: HYPERLINK("/one/one.app#/sObject/" & cgcloud\_\_Promotion\_\_r.Id & "/view", cgcloud\_\_Promotion\_\_r.cgcloud\_\_Slogan\_\_c) ### cgcloud\_\_Promotion\_Phase\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Phase of the promotion to which this tactic is assigned. This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Promotion\_\_r.cgcloud\_\_Phase\_\_c) ### cgcloud\_\_Promotion\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the promotion. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Promotion\_\_c (Master object) ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the Tactic when accessed from the related list of the Promotion object. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sales\_Org\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Sales org of the tactic. This is a calculated field. - **Formula**: TEXT(cgcloud\_\_Tactic\_Template\_\_r.cgcloud\_\_Sales\_Org\_\_c) ### cgcloud\_\_Scenario\_Participation\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Indicates the scenarios to which the tactic belongs. ### cgcloud\_\_Shipment\_Date\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Shipment start date of a tactic. ### cgcloud\_\_Source\_Tactic\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifies the source tactic. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Source\_Tactic\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Tactic\_\_c ### cgcloud\_\_Tactic\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the tactic template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tactic\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Tactic\_Template\_\_c ### cgcloud\_\_Tactic\_Type\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Label of the Tactic Template of this tactic. This is a calculated field. - **Formula**: cgcloud\_\_Tactic\_Template\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Tier\_Definition\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Text field that stores the .json file that's used to define the tiers of the tactic. ### cgcloud\_\_To\_Date\_Paid\_Amount\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Total amount paid until the current date. This is a calculated field. ### cgcloud\_\_Total\_Plan\_Spend\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum of all plan spends of funds. This is a calculated field. ## 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\_\_Tactic\_\_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\_\_Tactic\_\_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\_\_Tactic\_\_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\_\_Tactic\_\_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\_\_Tactic\_\_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. # cgcloud\_\_Tactic\_Condition\_Creation\_Definition\_\_c Holds the details of tactic condition creation definition. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Additional\_KPI\_Definition\_1\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the KPI definition used to provide additional information for the condition. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Additional\_KPI\_Definition\_1\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Additional\_KPI\_Definition\_2\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the KPI definition used to provide additional information for the condition. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Additional\_KPI\_Definition\_2\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Additional\_KPI\_Definition\_3\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the KPI definition used to provide additional information for the condition. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Additional\_KPI\_Definition\_3\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Allowed\_Product\_Levels\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Defines the eligible product levels when determining automatically the product levels on condition generation. - **Possible values**: - Brand - Category - Component - Flavor—Sub Brand - Package—Product Price Group - Product - SubCategory ### cgcloud\_\_Change\_Rule\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Determines the rule to handle past conditions. - **Default value**: finish - **Possible values**: - finish - update ### cgcloud\_\_Check\_For\_Duplicates\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the system reports generated internal conditions conflicting with pre existing conditions. - **Default value**: true ### cgcloud\_\_Maintenance\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the action on the conditions generated by the tactic. - **Default value**: initial - **Possible values**: - delete - freeze - initial - upsert ### cgcloud\_\_Measure\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Measure Code of the Condition. ### cgcloud\_\_Parent\_TCCD\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Used for the push process. If a promotion is pushed to the selected child accounts and has tactics with TCCDs, TCCDs are also created for the tactics of the child promotions based on the TCCDs of the parent tactic. This reference is used to identify the parent/source TCCD for the child TCCDs and is used if later on changes in the parent tactic are synced with the child tactics. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Parent\_TCCD\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Tactic\_Condition\_Creation\_Definition\_\_c ### cgcloud\_\_Product\_Level\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the product group level at which the condition is generated. - **Possible values**: - Brand - Category - Component - Flavor—Sub Brand - Package—Product Price Group - Product - SubCategory—Sub Category ### cgcloud\_\_Source\_KPI\_Definition\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the KPI definition which is used as the source for generating condition. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Source\_KPI\_Definition\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Tactic\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Tactic for which the rule is defined. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Tactic\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Tactic\_\_c (the master object) ### cgcloud\_\_Targets\_\_c - **Type**: multipicklist - **Properties**: Create, Defaulted on create, Filter, Nillable, Restricted picklist, Update - **Description**: Defines the targets to which the conditions are written. - **Default value**: External - **Possible values**: - External - Internal ### cgcloud\_\_Unique\_Measure\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Contains unique concatenation of tactic Id and source KPI definition Editable Code ## Associated Objects ### 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\_\_Tactic\_Condition\_Creation\_Definition\_\_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\_\_Tactic\_Condition\_Creation\_Definition\_\_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\_\_Tactic\_Condition\_Creation\_Definition\_\_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 tracked fields of the object. - **[cgcloud\_\_Tactic\_Condition\_Creation\_Definition\_\_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\_\_Tactic\_Condition\_Creation\_Definition\_\_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. # cgcloud\_\_Tactic\_Fund\_\_c This object stores the relationship between the Fund and Payment Tactic junction objects. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Active\_Tactic\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the referred tactic is included. - **Default value**: false ### cgcloud\_\_Calculated\_Funding\_Percent\_\_c - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Funding Percent value that's calculated based on the Plan Spend amount that's allocated to the Tactic Fund and Total Plan Spend amount for the tactic. It is used when the Fund Auto-Determination option is disabled. This is a calculated field. - **Formula**: IF( NOT(ISBLANK(cgcloud\_\_Tactic\_\_r.cgcloud\_\_Total\_Plan\_Spend\_\_c)) , (cgcloud\_\_Plan\_Spend\_\_c/ cgcloud\_\_Tactic\_\_r.cgcloud\_\_Total\_Plan\_Spend\_\_c), 0) ### cgcloud\_\_Fund\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description of the related fund. This is a calculated field. - **Formula**: cgcloud\_\_Fund\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Fund\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort, Update - **Description**: Reference to the fund. This is a relationship field. - **Relationship Name**: cgcloud\_\_Fund\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Fund\_\_c (Detail object) ### cgcloud\_\_Funding\_Percent\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Value that drives amount distribution for the fund. ### cgcloud\_\_LE\_Spend\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Tactic-level spend KPI that's synced to this tactic fund record (restricted to the product spend of the fund's anchor product). ### cgcloud\_\_Liabilities\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Tactic-level liabilities KPI that's synced to this tactic fund record (restricted to the product spend of the fund's anchor product). ### cgcloud\_\_OI\_Costs\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Tactic-level costs that appear on invoices, and the KPI is synced to this tactic fund record (restricted to the product spend of the fund's anchor product). ### cgcloud\_\_Phase\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Represents the phase field on the Promotion object. ### cgcloud\_\_Plan\_Spend\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Tactic-level planned spend KPI that's synced to this tactic fund record (restricted to the product spend of the fund's anchor product). ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the Tactic Fund Record for related custom lists. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Tactic\_Type\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Reads Tactic Type off of related Tactic record; helpful for reporting purposes. This is a calculated field. - **Formula**: cgcloud\_\_Tactic\_\_r.cgcloud\_\_Tactic\_Type\_\_c ### cgcloud\_\_Tactic\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the tactic. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tactic\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Tactic\_\_c (Master object) ### cgcloud\_\_Unaccrued\_Costs\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Subtracts the Tactic Fund Liabilities value from the LE Spend value. This is a calculated field. - **Formula**: cgcloud\_\_LE\_Spend\_\_c - cgcloud\_\_Liabilities\_\_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\_\_Tactic\_Fund\_\_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\_\_Tactic\_Fund\_\_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\_\_Tactic\_Fund\_\_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\_\_Tactic\_Fund\_\_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\_\_Tactic\_Fund\_\_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. # cgcloud\_\_Tactic\_Product\_\_c Junction object between Tactic and Product. 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 ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique name of the tactic product. ### cgcloud\_\_Classification\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Classification of products. - **Possible values**: - C1 - C2 - C3 - C4 - C5 ### cgcloud\_\_Currency\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Currency of the tactic product. - **Possible values**: - CAD - CHF - EUR - GBP - JPY - NOK - RUB - USD ### cgcloud\_\_Default\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines the default quantity that can be given to the product in a free item promotion reward context. ### cgcloud\_\_Group\_Id\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines the order of display of the group. ### cgcloud\_\_Group\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Product register grouping drives the way that the products are shown in the order. ### cgcloud\_\_Group\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sort order for the products within a register. ### cgcloud\_\_Included\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Included in the tactic. - **Default value**: true ### cgcloud\_\_Is\_Transferred\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Identifies if the tactic product is transferred. - **Default value**: false ### cgcloud\_\_Lift\_Pct\_\_c - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Incremental lift factor. ### cgcloud\_\_Max\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Defines the maximum quantity that's given to the product in a free item promotion reward context. ### cgcloud\_\_Pct\_of\_Stores\_\_c - **Type**: percent - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Percentage of stores of the account that participate in the tactic. ### cgcloud\_\_Planned\_Costs\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Planned cost. ### cgcloud\_\_Product\_Description\_1\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Associated product description. This is a calculated field. - **Formula**: cgcloud\_\_Product\_\_r.cgcloud\_\_Description\_1\_\_c ### cgcloud\_\_Product\_Name\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Associated product name. This is a calculated field. - **Formula**: cgcloud\_\_Product\_\_r.Name ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the product. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Promoted\_Price\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Consumer price. ### cgcloud\_\_Quantity\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Quantity of the product. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the Tactic Product related list record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sales\_Org\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Reference to the sales org of the product. This is a calculated field. - **Formula**: cgcloud\_\_Product\_\_r.cgcloud\_\_Sales\_Org\_\_c ### cgcloud\_\_TacticIdProductId\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique field that validates the product added to the tactic. ### cgcloud\_\_Tactic\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the tactic. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tactic\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Tactic\_\_c (Master object) ## 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\_\_Tactic\_Product\_\_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\_\_Tactic\_Product\_\_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\_\_Tactic\_Product\_\_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\_\_Tactic\_Product\_\_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\_\_Tactic\_Product\_\_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. # cgcloud\_\_Tactic\_Product\_Condition\_\_c Use this object to store the internal conditions that are generated out of promotions. 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\_\_Additional\_KPI\_Value\_1\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Value of Additional Condition KPI 1 if it's defined in the template of the related tactic. ### cgcloud\_\_Additional\_KPI\_Value\_2\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Value of Additional Condition KPI 2 if it's defined in the template of the related Tactic. ### cgcloud\_\_Additional\_KPI\_Value\_3\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Value of Additional Condition KPI 3 if it's defined in the template of the related Tactic. ### cgcloud\_\_Bom\_Header\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the BOM header of the product that was used to generate this condition. This field is a relationship field. This field is available in API version 55.0 and later. - **Relationship Name**: cgcloud\_\_Bom\_Header\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Export\_Status\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the status of the export process. - **Default value**: Initial - **Possible values**: - Failed - Initial - Processed ### cgcloud\_\_Exported\_Version\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Version of the exported record. ### cgcloud\_\_In\_Product\_Filter\_Result\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product is available because it is in the result of the product filter (or, products under this group are in the result of the product filter). - **Default value**: false ### cgcloud\_\_Last\_Synced\_Date\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Date on which the record was last synced. ### cgcloud\_\_Last\_Synced\_Version\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Version of the record that's synchronized from off-platform. ### cgcloud\_\_Listed\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the product is available because it is listed (or, products under this group are listed). - **Default value**: false ### cgcloud\_\_Measure\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The measure code of the condition source KPI that was used to generate this condition. This field is available in API version 55.0 and later. ### cgcloud\_\_Off\_Platform\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: GUID generated off-platform. ### cgcloud\_\_Product\_Part\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the product part linking the BOM component to its header. This field is a relationship field. This field is available in API version 55.0 and later. - **Relationship Name**: cgcloud\_\_Product\_Part\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Product\_Part\_\_c ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Product (group) for which the condition is generated. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Status\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Status of the promotion to which the tactic belongs. - **Possible values**: - Cancelled - Committed - Deleted - ForApproval - Modeling - Planning - Preparation - Rejected ### cgcloud\_\_Tactic\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Tactic that generated the condition. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tactic\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Tactic\_\_c ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Start date of the condition. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: End date of the condition. ### cgcloud\_\_Value\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Value of the condition. ## 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\_\_Tactic\_Product\_Condition\_\_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\_\_Tactic\_Product\_Condition\_\_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\_\_Tactic\_Product\_Condition\_\_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\_\_Tactic\_Product\_Condition\_\_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\_\_Tactic\_Product\_Condition\_\_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. # cgcloud\_\_Tactic\_Template\_\_c Template that controls the behavior of a tactic. 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**: 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**: Indicates whether a tactic template is active. - **Default value**: true ### cgcloud\_\_Additional\_Condition\_KPI\_1\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to additional KPI Definition 1 for the condition. This is a relationship field. - **Relationship Name**: cgcloud\_\_Additional\_Condition\_KPI\_1\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Additional\_Condition\_KPI\_2\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to additional KPI Definition 2 for the condition. This is a relationship field. - **Relationship Name**: cgcloud\_\_Additional\_Condition\_KPI\_2\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Additional\_Condition\_KPI\_3\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to additional KPI Definition 3 for the condition. This is a relationship field. - **Relationship Name**: cgcloud\_\_Additional\_Condition\_KPI\_3\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Condition\_Change\_Rule\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Determines the rule to handle past conditions. - **Possible values**: - finish - update ### cgcloud\_\_Condition\_Creation\_Definition\_Level\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines which configuration is used to create conditions out of tactics. This field is available in API version 55.0 and later. - **Possible values**: - Tactic - TacticTemplate ### cgcloud\_\_Condition\_Product\_Group\_Level\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the product level at which the condition can be set. - **Possible values**: - Brand - Category - Flavor—Sub Brand - Package—Product Price Group - Product - SubCategory ### cgcloud\_\_Condition\_Source\_Kpi\_Name\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: KPI source definition name. This is a calculated field. - **Formula**: cgcloud\_\_Condition\_Source\_Kpi\_\_r.Name ### cgcloud\_\_Condition\_Source\_Kpi\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the KPI definition. This is a relationship field. - **Relationship Name**: cgcloud\_\_Condition\_Source\_Kpi\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Default\_Lift\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Lift type used as the default for the tactic. - **Default value**: Percentage - **Possible values**: - Absolute - Percentage ### 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**: Selects the description depending on the current 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\_\_Display\_KPI\_Subset\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Subset of KPIs that are shown on the Spend Planning card. - **Default value**: SPC - **Possible values**: - Adjustment - Broker - Finance - Monitoring - Planning - Promotion Scenarios - Retailer - SPC - SPCLumpSum - SPCPR - VPC ### cgcloud\_\_Enable\_Condition\_Creation\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the condition creation is enabled. - **Default value**: false ### cgcloud\_\_Number\_Of\_TT\_Cond\_Creation\_Def\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Number of tactic template condition creation definitions. A maximum of 3 TCCDs are allowed per tactic template. This field is a calculated field. This field is available in API version 55.0 and later. ### cgcloud\_\_Order\_Relevant\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Boolean that identifies whether the tactic template is order-relevant. - **Default value**: false ### cgcloud\_\_Possible\_Lift\_Types\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Lift type to be used or shown for the lift calculation. - **Default value**: Percentage - **Possible values**: - Percentage - Percentage/Absolute ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org of the tactic template. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Tactic\_Total\_Amount\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Determines the configuration that provides the total amount for a tactic to be used in the progress bar. - **Default value**: Plan\_Spend\_\_c - **Possible values**: - 100% - LE\_Spend\_\_c—LE Spend - Plan\_Spend\_\_c—Plan Spend ### cgcloud\_\_Target\_Tactic\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifies the target tactic template. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Target\_Tactic\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Tactic\_Template\_\_c ### cgcloud\_\_Tactic\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Type of the tactic template. - **Default value**: Display - **Possible values**: - Display - DisplayPerAbs - PriceReduction - PriceReductionPerAbs ### cgcloud\_\_UI\_Contract\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the UI Contract that's mapped to the tactic template. This is used to display the layout of the tactics. This is a relationship field. - **Relationship Name**: cgcloud\_\_UI\_Contract\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_UI\_Contract\_\_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\_\_Tactic\_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\_\_Tactic\_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\_\_Tactic\_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\_\_Tactic\_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\_\_Tactic\_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. # cgcloud\_\_Tactic\_Template\_Cond\_Creation\_Def\_\_c Contains the configuration of condition creation definitions that will be generated for the related tactic. This object is available in API version 55.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Additional\_KPI\_Definition\_1\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Additional value that will be stored with the condition. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Additional\_KPI\_Definition\_1\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Additional\_KPI\_Definition\_2\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Additional value that will be stored with the condition. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Additional\_KPI\_Definition\_2\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Additional\_KPI\_Definition\_3\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Additional value that will be stored with the condition. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Additional\_KPI\_Definition\_3\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Allowed\_Product\_Levels\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Defines the eligible product levels when determining automatically the product levels on condition. Set only when product level defined in TTCCD is empty. - **Possible values**: - Brand - Category - Component - Flavor - Package - Product - SubCategory ### cgcloud\_\_Change\_Rule\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the rule to handle past conditions. - **Default value**: finish - **Possible values**: - finish - update ### cgcloud\_\_Check\_For\_Duplicates\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the system reports generated internal conditions conflicting with pre-existing conditions. - **Default value**: true ### cgcloud\_\_Measure\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Measure code of the condition. ### cgcloud\_\_Product\_Level\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the product level at which the condition is created. - **Possible values**: - Brand - Category - Component - Flavor—Sub Brand - Package—Product Price Group - Product - SubCategory ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the Tactic Template Condition Creation Definition related list record. This field is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_RECORD\_LINK, "\_top") ### cgcloud\_\_Source\_Kpi\_Definition\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the KPI used to generate conditions. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Source\_Kpi\_Definition\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_KPI\_Definition\_\_c ### cgcloud\_\_Tactic\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to Tactic Template. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Tactic\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Tactic\_Template\_\_c (the master object) ### cgcloud\_\_Targets\_\_c - **Type**: multipicklist - **Properties**: Create, Defaulted on create, Filter, Nillable, Restricted picklist, Update - **Description**: Defines in which tables the conditions are generated. - **Default value**: External - **Possible values**: - External - Internal ### cgcloud\_\_Unique\_Measure\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: This is a helper field which is used to ensure that a measure code can only be assigned once to a TCCD of a tactic template. TacticTemplate.Id|MeasureCode, where Measure code is either directly assigned to the rule or the editable measure code of the source KPI definition as fallback. ## Associated Objects ### 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\_\_Tactic\_Template\_Cond\_Creation\_Def\_\_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\_\_Tactic\_Template\_Cond\_Creation\_Def\_\_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\_\_Tactic\_Template\_Cond\_Creation\_Def\_\_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 tracked fields of the object. - **[cgcloud\_\_Tactic\_Template\_Cond\_Creation\_Def\_\_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\_\_Tactic\_Template\_Cond\_Creation\_Def\_\_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. # cgcloud\_\_Tactic\_Template\_Fund\_Template\_\_c Junction object between tactic template and fund template. This object defines the valid fund types for the given tactic template. 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**: The date when a User last did something related to the record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Default\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the current fund template is the default fund type for a tactic template. For each tactic template, only one default fund type can exist. - **Default value**: false ### cgcloud\_\_Fund\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the fund template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Fund\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Fund\_Template\_\_c (Detail object) ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of Tactic Template Fund Template. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_self") ### cgcloud\_\_Tactic\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the tactic template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tactic\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Tactic\_Template\_\_c (Master object) ## 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\_\_Tactic\_Template\_Fund\_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\_\_Tactic\_Template\_Fund\_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\_\_Tactic\_Template\_Fund\_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\_\_Tactic\_Template\_Fund\_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\_\_Tactic\_Template\_Fund\_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. # cgcloud\_\_Tour\_\_c Stores the details of the tour object. 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 that a user referenced this record on. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: Most recent date that a user viewed this record on. ### 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 field 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**: Reference to the record type. This field is a relationship field. - **Relationship Name**: RecordType - **Relationship Type**: Lookup - **Refers To**: RecordType ### cgcloud\_\_Assignment\_Confirmation\_\_c - **Type**: Picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the tour assignment confirmation type for the user. This field is reserved for future use. - **Possible values**: - Confirmed - NoConfirmationRequired—No Confirmation Required - PendingConfirmation—Pending Confirmation ### cgcloud\_\_Cancel\_Note\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Note that can be specified if the tour is canceled. ### cgcloud\_\_Cancel\_Reason\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates the reason that the tour was canceled for. - **Possible values**: - RouteClosed—Route Closed - VehicleProblems—Vehicle Problems ### cgcloud\_\_Cash\_Check\_In\_Required\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines whether the cash check-in at the end of each tour is mandatory. - **Possible values**: - Mandatory - Optional ### cgcloud\_\_Cash\_Handling\_Required\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the driver can perform cash-related actions during the tour execution. - **Default value**: false ### cgcloud\_\_Completion\_Release\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the tour end release time. ### cgcloud\_\_Consider\_Mileage\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether it's mandatory that the driver documents the odometer information when beginning and ending the tour. - **Possible values**: - No - Optional - Yes ### cgcloud\_\_Consider\_Vehicle\_Status\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether the driver must check and document the status or damages of the truck (and its trailers) at the beginning and the end of the tour. - **Possible values**: - No - Status—Only Status - StatusReason—Status + Reason ### cgcloud\_\_Consider\_Vehicle\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether the driver must check the license plate numbers of the truck and its trailers. - **Possible values**: - No - Truck - TruckTrailer—Truck + Trailer - TruckTrailers—Truck + Trailer 1,2 ### cgcloud\_\_Default\_Currency\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the default currency of the tour template. - **Possible values**: - CAD - CHF - EUR - GBP - JPY—Yen - NOK - RUB - USD ### cgcloud\_\_Default\_Driver\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the default driver of the tour. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Default\_Driver\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Default\_Tour\_Visit\_Duration\_\_c - **Type**: number - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The duration for creating tour-related visits based on the sequence. It’s measured in minutes. - **Default value**: 30 ### 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**: Reference to the description based on the user-specified language. This field 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\_\_End\_Date\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: First date and time of validity period of the tour. ### cgcloud\_\_End\_Warehouse\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the warehouse where the tour ended. This field is a relationship field. - **Relationship Name**: cgcloud\_\_End\_Warehouse\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Warehouse\_\_c ### cgcloud\_\_Express\_Check\_Out\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the driver is allowed to use the express checkout type. - **Default value**: false ### cgcloud\_\_Has\_End\_Tour\_Veh\_Details\_Rvw\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the vehicle details are reviewed (true) or not (false) during the end tour activities. - **Default value**: false ### cgcloud\_\_Is\_Odometer\_Photo\_Required\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the user documents the odometer reading at the start and the end of the day with a picture. - **Default value**: false ### cgcloud\_\_Message\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Message for the driver of the tour. ### cgcloud\_\_Multiple\_Cash\_Check\_In\_Allowed\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether multiple cash check-ins for one tour are allowed. - **Default value**: false ### cgcloud\_\_Odometer\_End\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Mileage of the truck after ending the tour. ### cgcloud\_\_Odometer\_Start\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Mileage of the truck before starting the tour. ### cgcloud\_\_Route\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the route. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Route\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Route\_\_c ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org that the tour belongs to. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Show\_Cash\_Info\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Show cash or expenses information in the tour summary report. - **Default value**: false ### cgcloud\_\_Should\_Allow\_End\_Day\_Geofencing\_\_c - **Type**: Boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the validation of the user's GPS location against warehouse location is enabled at the end of the day. - **Default value**: false ### cgcloud\_\_Should\_Allow\_End\_Day\_GPS\_Tracking\_\_c - **Type**: Boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether GPS tracking is allowed at the end of the day. - **Default value**: false ### cgcloud\_\_Should\_Allow\_End\_Day\_Time\_Tracking\_\_c - **Type**: Boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether end-of-day time tracking is allowed. - **Default value**: false ### cgcloud\_\_Should\_Allow\_Seal\_Scanning\_\_c - **Type**: Boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the user validates a list of seals through scanning or manual entry. This field is applicable only when the Express Check-Out field is selected. - **Default value**: false ### cgcloud\_\_Should\_Allow\_Start\_Day\_Geofencing\_\_c - **Type**: Boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the validation of the user's GPS location against warehouse location is enabled at the start of the day. - **Default value**: false ### cgcloud\_\_Should\_Allow\_Start\_Day\_GPS\_Tracking\_\_c - **Type**: Boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether GPS tracking is allowed at the start of the day. - **Default value**: false ### cgcloud\_\_Should\_Allow\_Start\_Day\_Time\_Tracking\_\_c - **Type**: Boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the day and time tracking at the start of the day is allowed. - **Default value**: false ### cgcloud\_\_Start\_Date\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Last date and time of validity period of the tour. ### cgcloud\_\_Start\_Release\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Stores the start release time. ### cgcloud\_\_Start\_Warehouse\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the warehouse. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Start\_Warehouse\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Warehouse\_\_c ### cgcloud\_\_Status\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Current status of the tour. - **Default value**: Open - **Possible values**: - Canceled - Completed - Initial - Open - Running ### cgcloud\_\_Tour\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the tour template. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Tour\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Tour\_Template\_\_c ### cgcloud\_\_Trailer\_1\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the truck with trailer. Reference to the vehicle. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Trailer\_1\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Vehicle\_\_c ### cgcloud\_\_Trailer\_2\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the truck with second trailer. Reference to the vehicle. This field is a relationship field. - **Relationship Name**: cgcloud\_\_Trailer\_2\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Vehicle\_\_c ### cgcloud\_\_Truck\_Status\_End\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of damage observed after the tour finishes. - **Possible values**: - Brakes—Brakes are Broken - Lights—Lights broken - Mirror—Wing mirror broken - Misc - Paint—Paint scratch - Tires—Flat tire - Vehicle—Vehicle damaged - Wash—Screenwash empty ### cgcloud\_\_Truck\_Status\_Start\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the type of damage observed before the tour starts. - **Possible values**: - Brakes—Brakes are Broken - Lights—Lights broken - Mirror—Wing mirror broken - Misc - Paint—Paint scratch - Tires—Flat tire - Vehicle—Vehicle damaged - Wash—Screenwash empty ### cgcloud\_\_Truck\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the truck that carries out the tour. Reference to the vehicle. This is a relationship field. - **Relationship Name**: cgcloud\_\_Truck\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Vehicle\_\_c ### cgcloud\_\_Truck\_ok\_End\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether the truck (and its trailers) have had any damage after finishing the tour. - **Possible values**: - 0—No - 1—Yes ### cgcloud\_\_Truck\_ok\_Start\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether the truck (and its trailers) had any damage before starting the tour. - **Possible values**: - 0—No - 1—Yes ## Associated Objects ### Associated Objects This object has these 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\_\_Tour\_\_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\_\_Tour\_\_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\_\_Tour\_\_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\_\_Tour\_\_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\_\_Tour\_\_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. # cgcloud\_\_Tour\_Check\_\_c Stores the details of the tour check object that's used as part of tour execution for tour checking. 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**: 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**: Active flag. - **Default value**: true ### cgcloud\_\_Check\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Describes the check type. - **Default value**: VehicleCheck - **Possible values**: - SafetyCheck—Safety Check - VehicleCheck—Vehicle Check ### 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) ## 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\_\_Tour\_Check\_\_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\_\_Tour\_Check\_\_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\_\_Tour\_Check\_\_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\_\_Tour\_Check\_\_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\_\_Tour\_Check\_\_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. # cgcloud\_\_Tour\_Object\_Reference\_\_c Stores the details of the object references of a tour. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_End\_Of\_Day\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The respective template is only available within the end-of-day activities of the tour. - **Default value**: false ### cgcloud\_\_Order\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the order template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Order\_Template\_\_c ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the tour object reference record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Signature\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the signature template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Signature\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Signature\_Template\_\_c ### cgcloud\_\_Start\_Of\_Day\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The respective template is only available within the start-of-day activities of the tour. - **Default value**: false ### cgcloud\_\_Tour\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the tour. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tour\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Tour\_\_c (Master object) ### cgcloud\_\_Usage\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Usage of the referenced object. - **Possible values**: - ClbMeta.Visit—Delivery Visit - SdoMeta.CashCheck—Cash Check - SdoMeta.CashCheckIn—Cash Check In - SdoMeta.CashCheckOut—Cash Check Out - SdoMeta.Expenses—Expenses - SdoMeta.ForcedTruckAudit—Forced Truck Audit - SdoMeta.Order—Delivery Document - SdoMeta.Payments—Payment - SdoMeta.ProductCheckIn—Product Check In - SdoMeta.ProductCheckOut—Product Check Out - SdoMeta.TckIvcAddCorrection—Truck Inventory Add Correction - SdoMeta.TckIvcSubCorrection—Truck Inventory Subtract Correction - SdoMeta.TckIvcTransferInward—Inward Truck Inventory Transfer - SdoMeta.TckIvcTransferOutward—Outward Truck Inventory Transfer - SdoMeta.TruckAudit—Truck Inventory Audit - SdoMeta.TruckInventory—Truck Inventory - TmgMain.EndOfDay—End of Day - TmgMain.StartOfDay—Start of Day ### cgcloud\_\_Visit\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the visit template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Visit\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Visit\_Template\_\_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\_\_Tour\_Object\_Reference\_\_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\_\_Tour\_Object\_Reference\_\_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\_\_Tour\_Object\_Reference\_\_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\_\_Tour\_Object\_Reference\_\_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\_\_Tour\_Object\_Reference\_\_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. # cgcloud\_\_Tour\_Template\_\_c Stores the details of the tour template object that's to be used for tours. 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**: 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 field 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**: Active flag. - **Default value**: true ### cgcloud\_\_Cash\_Check\_In\_Required\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines whether the cash check-in at the end of each tour is mandatory. - **Possible values**: - Mandatory - Optional ### cgcloud\_\_Cash\_Handling\_Required\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the driver can perform cash-related actions during the tour execution. - **Default value**: false ### cgcloud\_\_Consider\_Mileage\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether it's mandatory for the driver to document odometer information when beginning and ending the tour. - **Default value**: No - **Possible values**: - No - Optional - Yes ### cgcloud\_\_Consider\_Multiple\_Warehouses\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines if more than one warehouse must be considered for the tour. - **Default value**: false ### cgcloud\_\_Consider\_Vehicle\_Status\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether the driver must check and document the status or damages of the truck (and its trailers) at the beginning and end of the tour. - **Default value**: No - **Possible values**: - No - Status—Only Status - StatusReason—Status + Reason ### cgcloud\_\_Consider\_Vehicle\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the vehicle that the driver has to provide identification (license number) for. - **Default value**: Truck - **Possible values**: - No - Truck - TruckTrailer—Truck+Trailer - TruckTrailers—Truck + Trailer 1,2 ### cgcloud\_\_Creation\_Platform\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the platform on which the template can be used for creating tours. - **Possible values**: - Laptop - Mobility - Both ### cgcloud\_\_Default\_Currency\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the default currency of the tour template. - **Possible values**: - CAD - CHF - EUR - GBP - JPY—Yen - NOK - RUB - USD ### cgcloud\_\_Default\_Tour\_Visit\_Duration\_\_c - **Type**: number - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: The duration for creating tour-related visits based on the sequence. It’s measured in minutes. - **Default value**: 30 ### 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 field 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\_\_Express\_Check\_Out\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether express checkout is allowed for this template. - **Default value**: false ### cgcloud\_\_Is\_Odometer\_Photo\_Required\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the user documents the odometer reading at the start and the end of the day with a picture. - **Default value**: false ### cgcloud\_\_Mobility\_User\_Guidance\_End\_of\_Day\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Mobility user guidance for the end of the day process. - **Default value**: None - **Possible values**: - Delivery - None ### cgcloud\_\_Mobility\_User\_Guidance\_Start\_of\_Day\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Mobility user guidance for the start of the day process. - **Default value**: None - **Possible values**: - Delivery - None ### cgcloud\_\_Multiple\_Cash\_Check\_In\_Allowed\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Defines whether the multiple cash check-ins for one tour are allowed. - **Default value**: false ### cgcloud\_\_Should\_Allow\_End\_Day\_Geofencing\_\_c - **Type**: Boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the validation of the user's GPS location against warehouse location is enabled at the end of the day. - **Default value**: false ### cgcloud\_\_Should\_Allow\_End\_Day\_GPS\_Tracking\_\_c - **Type**: Boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether GPS tracking is allowed at the end of the day. - **Default value**: false ### cgcloud\_\_Should\_Allow\_End\_Day\_Time\_Tracking\_\_c - **Type**: Boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether end-of-day time tracking is allowed. - **Default value**: false ### cgcloud\_\_Should\_Allow\_Seal\_Scanning\_\_c - **Type**: Boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the user validates a list of seals through scanning or manual entry. This field is applicable only when the Express Check-Out field is selected. - **Default value**: false ### cgcloud\_\_Should\_Allow\_Start\_Day\_Geofencing\_\_c - **Type**: Boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the validation of the user's GPS location against warehouse location is enabled at the start of the day. - **Default value**: false ### cgcloud\_\_Should\_Allow\_Start\_Day\_GPS\_Tracking\_\_c - **Type**: Boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether GPS tracking is allowed at the start of the day. - **Default value**: false ### cgcloud\_\_Should\_Allow\_Start\_Day\_Time\_Tracking\_\_c - **Type**: Boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the day and time tracking for the start of the day is allowed. - **Default value**: false ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org that the tour template belongs to. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Show\_Cash\_Info\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Shows cash and expenses information in the tour summary report. - **Default value**: false ### cgcloud\_\_Sync\_Options\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies whether an immediate background synchronization is to be started after a special event. - **Default value**: No - **Possible values**: - No - OnTourEnd—On Tour End - OnTourEndStart—On Tour End/Start - OnTourStart—On Tour Start ## Associated Objects ### Associated Objects This object has these 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\_\_Tour\_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\_\_Tour\_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\_\_Tour\_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\_\_Tour\_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\_\_Tour\_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. # cgcloud\_\_Tour\_Template\_Object\_Reference\_\_c Stores the details of the object references of a tour template. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_End\_Of\_Day\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The respective template is only available within the end-of-day activities of the tour. - **Default value**: false ### cgcloud\_\_Order\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the order template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Order\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Order\_Template\_\_c ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the tour template object reference record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Signature\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the signature template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Signature\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Signature\_Template\_\_c ### cgcloud\_\_Start\_Of\_Day\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The respective template is only available within the start-of-day activities of the tour. - **Default value**: false ### cgcloud\_\_Tour\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the tour template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tour\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Tour\_Template\_\_c (Master object) ### cgcloud\_\_Usage\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Usage of the referenced object. - **Possible values**: - ClbMeta.Visit—Delivery Visit - SdoMeta.CashCheck—Cash Check - SdoMeta.CashCheckIn—Cash Check In - SdoMeta.CashCheckOut—Cash Check Out - SdoMeta.Expenses—Expenses - SdoMeta.ForcedTruckAudit—Forced Truck Audit - SdoMeta.Order—Delivery Document - SdoMeta.Payments—Payment - SdoMeta.ProductCheckIn—Product Check In - SdoMeta.ProductCheckOut—Product Check Out - SdoMeta.TckIvcAddCorrection—Truck Inventory Add Correction - SdoMeta.TckIvcSubCorrection—Truck Inventory Subtract Correction - SdoMeta.TckIvcTransferInward—Inward Truck Inventory Transfer - SdoMeta.TckIvcTransferOutward—Outward Truck Inventory Transfer - SdoMeta.TruckAudit—Truck Inventory Audit - SdoMeta.TruckInventory—Truck Inventory - TmgMain.EndOfDay—End of Day - TmgMain.StartOfDay—Start of Day ### cgcloud\_\_Visit\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the visit template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Visit\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Visit\_Template\_\_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\_\_Tour\_Template\_Object\_Reference\_\_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\_\_Tour\_Template\_Object\_Reference\_\_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\_\_Tour\_Template\_Object\_Reference\_\_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\_\_Tour\_Template\_Object\_Reference\_\_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\_\_Tour\_Template\_Object\_Reference\_\_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. # cgcloud\_\_Tour\_Template\_Tour\_Check\_\_c Stores the details of the relationship between tour template and tour check, which is used to define the relevant tour checks on a tour. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Check\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the check type of the tour check. - **Default value**: VehicleCheck - **Possible values**: - SafetyCheck—Safety Check - VehicleCheck—Vehicle Check ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the tour template tour check record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sort number. ### cgcloud\_\_Tour\_Check\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Specifies the description of the tour check. This is a calculated field. - **Formula**: cgcloud\_\_Tour\_Check\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Tour\_Check\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the tour check. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tour\_Check\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Tour\_Check\_\_c ### cgcloud\_\_Tour\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the tour template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tour\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Tour\_Template\_\_c (Master object) ### cgcloud\_\_Usage\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Usage of the tour check. - **Default value**: S - **Possible values**: - E—End of Day - S—Start of Day ## 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\_\_Tour\_Template\_Tour\_Check\_\_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\_\_Tour\_Template\_Tour\_Check\_\_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\_\_Tour\_Template\_Tour\_Check\_\_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\_\_Tour\_Template\_Tour\_Check\_\_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\_\_Tour\_Template\_Tour\_Check\_\_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. # cgcloud\_\_Tour\_Tour\_Check\_\_c Stores the details of the relationship between tour and tour check. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Answer\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specified whether the answer has been given. - **Default value**: false ### cgcloud\_\_Check\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the check type of the tour check. - **Default value**: VehicleCheck - **Possible values**: - SafetyCheck—Safety Check - VehicleCheck—Vehicle Check ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sort number. ### cgcloud\_\_Tour\_Check\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Specifies the description of the tour check. This is a calculated field. - **Formula**: cgcloud\_\_Tour\_Check\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Tour\_Check\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the tour check. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tour\_Check\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Tour\_Check\_\_c ### cgcloud\_\_Tour\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the tour. This is a relationship field. - **Relationship Name**: cgcloud\_\_Tour\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Tour\_\_c (Master object) ### cgcloud\_\_Usage\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Usage of the tour check. - **Possible values**: - E—End of Day - S—Start of Day ## 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\_\_Tour\_Tour\_Check\_\_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\_\_Tour\_Tour\_Check\_\_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\_\_Tour\_Tour\_Check\_\_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\_\_Tour\_Tour\_Check\_\_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\_\_Tour\_Tour\_Check\_\_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. # cgcloud\_\_Transaction\_Log\_\_c This object contains all transaction log messages that are related to CG. 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 ### 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\_\_Details\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Stores the details of log entries in .json format. ### cgcloud\_\_Duration\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Duration of the call (it's the duration of the outermost trace). ### cgcloud\_\_Entry\_Time\_\_c - **Type**: dateTime - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Timestamp when the record was added to the log. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales organization to which the transaction log belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Source\_Name\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the calling class. ### cgcloud\_\_Source\_Type\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Source from which the class made the call. ### cgcloud\_\_Status\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Status of the transaction. - **Possible values**: - Error - Success - Warning ### cgcloud\_\_Transaction\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Transaction under which the message was logged. ### cgcloud\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: User under which the transaction log entry was created This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ## Associated Objects ### Associated Objects This object contains 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\_\_Transaction\_Log\_\_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\_\_Transaction\_Log\_\_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\_\_Transaction\_Log\_\_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\_\_Transaction\_Log\_\_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\_\_Transaction\_Log\_\_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. # cgcloud\_\_Trigger\_Setting\_\_c Custom Setting, helper object that enables clients to disable certain triggers that are part of the managed package. 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 ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Sort, Update - **Description**: Unique identification of the record. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the setup owner. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ### cgcloud\_\_Deactivate\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Switch to deactivate trigger. - **Default value**: false ## Associated Objects ### Associated Objects This object contains these following 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\_\_Trigger\_Setting\_\_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\_\_Trigger\_Setting\_\_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\_\_Trigger\_Setting\_\_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\_\_Trigger\_Setting\_\_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\_\_Trigger\_Setting\_\_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. # cgcloud\_\_Trip\_List\_\_c Use Trip List to plan visits based on a predefined sequence of customers. 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**: 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\_\_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", cgcloud\_\_Description\_Language\_2\_\_c, "Language3", cgcloud\_\_Description\_Language\_3\_\_c, "Language4", cgcloud\_\_Description\_Language\_4\_\_c, cgcloud\_\_Description\_Language\_1\_\_c) ### cgcloud\_\_Responsible\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user who's responsible for the trip list. This is a relationship field. - **Relationship Name**: cgcloud\_\_Responsible\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org of the trip list. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Type of the trip list. - **Possible values**: - Daily—Daily Schedule - Weekly—Weekly Schedule ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date from which the trip list is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date until which the trip list is valid. ## Associated Objects ### Associated Objects This object contains 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\_\_Trip\_List\_\_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\_\_Trip\_List\_\_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\_\_Trip\_List\_\_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\_\_Trip\_List\_\_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\_\_Trip\_List\_\_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. # cgcloud\_\_Trip\_List\_Account\_\_c The object stores the association between a trip list and a customer. 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**: The date when a User last did something related to the record. ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Account\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the customer. This is a relationship field. - **Relationship Name**: cgcloud\_\_Account\_\_r - **Relationship Type**: Lookup - **Refers To**: Account ### cgcloud\_\_City\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Customer's city. This is a calculated field. - **Formula**: cgcloud\_\_Account\_\_r.ShippingCity ### cgcloud\_\_Day\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Day of the week on which the call is to be scheduled. - **Default value**: 0 - **Possible values**: - 0—No Day - 1—Monday - 2—Tuesday - 3—Wednesday - 4—Thursday - 5—Friday - 6—Saturday - 7—Sunday ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the trip list customer record. This is a calculated field. - **Formula**: HYPERLINK("/"&Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Sort, Update - **Description**: Specifies the position of the customer in the trip list. ### cgcloud\_\_Street\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Customer's street. This is a calculated field. - **Formula**: cgcloud\_\_Account\_\_r.ShippingStreet ### cgcloud\_\_Trip\_List\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the trip list. This is a relationship field. - **Relationship Name**: cgcloud\_\_Trip\_List\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Trip\_List\_\_c (the master object) ### cgcloud\_\_Valid\_From\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Date on the entry from which the trip list is valid. ### cgcloud\_\_Valid\_Thru\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Date on the entry until which the trip list is valid. ## Associated Objects ### Associated Objects This object contains 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\_\_Trip\_List\_Account\_\_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\_\_Trip\_List\_Account\_\_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\_\_Trip\_List\_Account\_\_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\_\_Trip\_List\_Account\_\_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\_\_Trip\_List\_Account\_\_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. # cgcloud\_\_UI\_Contract\_\_c This object contains the contract information for templates that are used in the smart UI. 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\_\_Contract\_Definition\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Contract .json file in string format. ### cgcloud\_\_Description\_Language\_1\_\_c - **Type**: string - **Properties**: Create, Filter, Group, 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\_\_Usage\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Description of the usage of this contract. - **Possible values**: - Promotion - Tactic ## Associated Objects ### Associated Objects This object contains 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\_\_UI\_Contract\_\_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\_\_UI\_Contract\_\_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\_\_UI\_Contract\_\_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\_\_UI\_Contract\_\_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\_\_UI\_Contract\_\_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. # cgcloud\_\_Unit\_of\_Measure\_\_c Stores the details of the units of measure (logistic unit) of a product. 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 ### 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\_\_Check\_isConsumer\_Unique\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Used internally for validation. ### cgcloud\_\_Check\_isOrder\_Unique\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Used internally for validation. ### cgcloud\_\_Check\_isPrice\_Unique\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Used internally for validation. ### cgcloud\_\_GTIN\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Global trade item number. ### cgcloud\_\_Is\_Consumer\_Unit\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the item is a consumer unit. - **Default value**: false ### cgcloud\_\_Is\_Order\_Unit\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the item is a default order unit. - **Default value**: false ### cgcloud\_\_Is\_Price\_Unit\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the item is a price unit. - **Default value**: false ### cgcloud\_\_Order\_Ability\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the unit of measure can be ordered. - **Default value**: false ### cgcloud\_\_Pieces\_per\_Smallest\_Unit\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Number of pieces of the smallest unit that this unit contains. ### cgcloud\_\_Pieces\_per\_parent\_unit\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Number of pieces of this unit of measure that the parent unit of measure contains. ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to product. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the unit of measure record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, /\*IMAGE("/img/func\_icons/util/lookup20.gif", "View")\*/"View", "\_top") ### cgcloud\_\_Rounding\_Rule\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the rounding rule to be applied for the target unit of measure. - **Default value**: Never - **Possible values**: - Down - Nearest - Never - Up - UserExit ### cgcloud\_\_Rounding\_Target\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls whether the unit of measure is to be considered for rounding quantities. - **Default value**: false ### cgcloud\_\_Sort\_Validation\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Used internally for validation. ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Sequence of unit of measures of a product (from the smallest unit to the largest unit). ### cgcloud\_\_Unit\_Type\_Validation\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Used internally for validation. ### cgcloud\_\_Unit\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Type of the unit of measure. - **Default value**: SalesUnit - **Possible values**: - ConsumerUnit - Layer - Pallet - SalesUnit ### cgcloud\_\_Volume\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Item volume used for complex pricing. ### cgcloud\_\_Weight\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Item weight used for complex pricing. ## 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\_\_Unit\_of\_Measure\_\_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\_\_Unit\_of\_Measure\_\_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\_\_Unit\_of\_Measure\_\_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\_\_Unit\_of\_Measure\_\_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\_\_Unit\_of\_Measure\_\_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. # cgcloud\_\_Update\_Activation\_\_c This custom setting defines the sales org-specific update activation record to make sure that maintenance is only possible by using the Update Activation page. 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 ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Sort, Update - **Description**: Unique identification of the record. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the setup owner. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ### cgcloud\_\_Activation\_Date\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Activation date of the update or feature. ### cgcloud\_\_Activation\_Release\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Release version that will automatically enable the feature. ### cgcloud\_\_Identifier\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Identifier of the update or feature. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the sales org for which the record is used. ## Associated Objects ### Associated Objects This object contains 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\_\_Update\_Activation\_\_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\_\_Update\_Activation\_\_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\_\_Update\_Activation\_\_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\_\_Update\_Activation\_\_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\_\_Update\_Activation\_\_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. # cgcloud\_\_User\_Accountable\_\_c Represents a Sales Rep or Supervisor or other Retail Execution user who is accountable for a Retail Execution business process. This object is available in API version 55.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**: The timestamp for when the current user last viewed a record related to this object. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this object. ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Required. Default name of this record. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the record owner. This field is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### cgcloud\_\_Unique\_User\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique identification of the user. ### cgcloud\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References to the user. This field is a relationship field. - **Relationship Name**: cgcloud\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ## 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\_\_User\_Accountable\_\_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\_\_User\_Accountable\_\_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\_\_User\_Accountable\_\_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 tracked fields of the object. - **[cgcloud\_\_User\_Accountable\_\_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\_\_User\_Accountable\_\_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. # cgcloud\_\_User\_Document\_\_c Stores the details of the daily report object. 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() ## ields ### 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\_\_Accountable\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the accountable user. This is a relationship field. - **Relationship Name**: cgcloud\_\_Accountable\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Annotation\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Annotations for the user document. ### cgcloud\_\_Creation\_Date\_\_c - **Type**: date - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Date of initiation of the daily report. ### cgcloud\_\_Date\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date of the daily report. ### cgcloud\_\_Phase\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Phase of a user document. - **Possible values**: - Approved - Correction—Rejected - Initial - Released ### cgcloud\_\_Responsible\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user who's responsible for the user document. This is a relationship field. - **Relationship Name**: cgcloud\_\_Responsible\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Template\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description of the daily report template. This is a calculated field. - **Formula**: cgcloud\_\_User\_Document\_Template\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Total\_Duration\_Min\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Indicates the sum of activities in minutes. This is a calculated field. ### cgcloud\_\_Total\_Working\_Duration\_Min\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Total working duration in minutes (difference of work time from and work time thru). This is a calculated field. - **Formula**: (VALUE(LEFT(cgcloud\_\_Work\_Time\_Thru\_\_c, 2)) \* 60 + VALUE(RIGHT(cgcloud\_\_Work\_Time\_Thru\_\_c, 2))) - (VALUE(LEFT(cgcloud\_\_Work\_Time\_From\_\_c, 2)) \* 60 + VALUE(RIGHT(cgcloud\_\_Work\_Time\_From\_\_c, 2))) ### cgcloud\_\_User\_Document\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user document template. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_Document\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_User\_Document\_Template\_\_c ### cgcloud\_\_Work\_Time\_From\_\_c - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Start of the working time. ### cgcloud\_\_Work\_Time\_Thru\_\_c - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: End of the working time. ### cgcloud\_\_Workflow\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Reference to the workflow that the corresponding daily report uses. This is a calculated field. - **Formula**: cgcloud\_\_User\_Document\_Template\_\_r.cgcloud\_\_Workflow\_\_r.Name ## Associated Objects ### Associated Objects This object contains 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\_\_User\_Document\_\_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\_\_User\_Document\_\_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\_\_User\_Document\_\_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\_\_User\_Document\_\_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\_\_User\_Document\_\_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. # cgcloud\_\_User\_Document\_Activity\_\_c Stores the details of the relationship between the daily report and user activity. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Activity\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the activity. This is a relationship field. - **Relationship Name**: cgcloud\_\_Activity\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Visit\_Template\_\_c ### cgcloud\_\_Duration\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Minutes spent for the activity. This is a calculated field. - **Formula**: cgcloud\_\_Hours\_\_c \* 60 + cgcloud\_\_Minutes\_\_c ### cgcloud\_\_Hours\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Number of hours spent for the activity. ### cgcloud\_\_Minutes\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Number of minutes spent for the activity. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the user document template activity record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_Top") ### cgcloud\_\_User\_Document\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the user document. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_Document\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_User\_Document\_\_c (Master object) ## Associated Objects ### Associated Objects This object contains 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\_\_User\_Document\_Activity\_\_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\_\_User\_Document\_Activity\_\_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\_\_User\_Document\_Activity\_\_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\_\_User\_Document\_Activity\_\_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\_\_User\_Document\_Activity\_\_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. # cgcloud\_\_User\_Document\_Template\_\_c Stores the details of the daily report template, which is to be used for daily reports. 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 ### 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\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Active flag. - **Default value**: true ### cgcloud\_\_Allow\_Postdating\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Validation for post dating. - **Default value**: false ### cgcloud\_\_Check\_Activity\_Duration\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Validation for the system to consider maximum activity duration. - **Default value**: false ### cgcloud\_\_Creation\_Platform\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Indicates the platform that can be used to create the user document that references this template. - **Default value**: All - **Possible values**: - All - Mobility ### 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\_\_Max\_Activity\_Duration\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Maximum activity duration that the user document referencing this template can have. ### cgcloud\_\_Mobility\_Relevant\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Controls the validation of restrictions that are necessary for usage on mobility devices. - **Default value**: false ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org of the template. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Position of this instance in overviews or toggles. ### cgcloud\_\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Type of user document report. Report. - **Default value**: Daily - **Possible values**: - Daily Report ### cgcloud\_\_Workflow\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the workflow that's to be used by the corresponding user document report. This is a relationship field. - **Relationship Name**: cgcloud\_\_Workflow\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Workflow\_\_c ## Associated Objects ### Associated Objects This object contains 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\_\_User\_Document\_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\_\_User\_Document\_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\_\_User\_Document\_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\_\_User\_Document\_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\_\_User\_Document\_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. # cgcloud\_\_User\_Document\_Template\_Activity\_\_c Stores the details of the relationship between the daily report template and user activity. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Activity\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the activity. This is a relationship field. - **Relationship Name**: cgcloud\_\_Activity\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Visit\_Template\_\_c ### cgcloud\_\_Max\_Hours\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Maximal number of hours that's allowed for an activity. ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the user document template activity record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Unique\_Activity\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Technical field that verifies whether an activity is added only once to a daily report template. ### cgcloud\_\_User\_Document\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the user document template. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_Document\_Template\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_User\_Document\_Template\_\_c (the master object) ## Associated Objects ### Associated Objects This object contains 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\_\_User\_Document\_Template\_Activity\_\_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\_\_User\_Document\_Template\_Activity\_\_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\_\_User\_Document\_Template\_Activity\_\_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\_\_User\_Document\_Template\_Activity\_\_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\_\_User\_Document\_Template\_Activity\_\_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. # cgcloud\_\_User\_Setting\_\_c Object that's created to store user settings. 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**: Standard field. Owner of the record This is a polymorphic relationship field. - **Relationship Name**: Owner - **Relationship Type**: Lookup - **Refers To**: Group, User ### cgcloud\_\_Bluetooth\_Device\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Determines the Bluetooth device to use with the Consumer Goods Cloud offline mobile app. - **Default value**: Scanner - **Possible values**: - Keyboard - Scanner ### cgcloud\_\_Current\_Account\_View\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the view that was last used by the user. This is a relationship field. - **Relationship Name**: cgcloud\_\_Current\_Account\_View\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_View\_\_c ### cgcloud\_\_Current\_Promotion\_View\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the promotion that was last used by the user. This is a relationship field. - **Relationship Name**: cgcloud\_\_Current\_Promotion\_View\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_View\_\_c ### cgcloud\_\_Default\_Management\_Type\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Default management type. - **Possible values**: - Consultant—Consultant (Merchandizer) - Sales - Service ### cgcloud\_\_Default\_Visit\_Status\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Default visit status. - **Possible values**: - All - Open ### cgcloud\_\_Display\_Considered\_Promotions\_Filter\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the Considered Promotions Filter field is shown in the Account Plan Filter. - **Default value**: false ### cgcloud\_\_Display\_Weekend\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the call calendar (Agenda) on mobility devices shows weekends. - **Default value**: false ### cgcloud\_\_Initial\_Time\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Initial time. ### cgcloud\_\_Initial\_View\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Initial view. - **Possible values**: - DayWithMap - Week ### cgcloud\_\_KPI\_Subsets\_\_c - **Type**: multipicklist - **Properties**: Create, Defaulted on create, Filter, Nillable, Restricted picklist, Update - **Description**: ID of the KPI subset. - **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\_\_Landing\_Page\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Specifies the landing or the first page that's to be shown whenever a user logs in the mobility application. - **Default value**: MainMenu - **Possible values**: - AdvancedUserCockpit—Advanced User Cockpit - MainMenu—Main Menu - UserCockpit—User Cockpit ### cgcloud\_\_Picture\_Quality\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Picture quality of the attached image. To evaluate the picture quality when creating a new picture attachment on a mobility device, the picklist values require specification of Picklist\_Toggle\_Mapping\_Extension.ValidationCode that represents the width-height-quality of the picture. - **Possible values**: - H-Large - M-Large - Medium - Small ### cgcloud\_\_Route\_In\_Map\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the navigation route is shown on the map. - **Default value**: false ### cgcloud\_\_Show\_Agenda\_Time\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether agenda time information is required in the agenda of the call calendar. - **Default value**: false ### cgcloud\_\_Show\_Calendar\_Week\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether calender week information is required in the agenda of the call calender. - **Default value**: false ### cgcloud\_\_Sync\_Time\_Interval\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: No longer in use. Indicated the time interval between sync requests. ### cgcloud\_\_Traffic\_In\_Map\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether traffic is shown on the map. - **Default value**: false ### cgcloud\_\_Unique\_User\_Id\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Unique user ID. ### cgcloud\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user to which the segment belongs. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Works\_On\_Friday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates the day of the week on which the user typically works. For example, used for capacity planning. - **Default value**: false ### cgcloud\_\_Works\_On\_Monday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates the day of the week on which the user typically works. For example, used for capacity planning. - **Default value**: false ### cgcloud\_\_Works\_On\_Saturday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates the day of the week on which the user typically works. For example, used for capacity planning. - **Default value**: false ### cgcloud\_\_Works\_On\_Sunday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description** ### cgcloud\_\_Works\_On\_Thursday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates the day of the week on which the user typically works. For example, used for capacity planning. - **Default value**: false ### cgcloud\_\_Works\_On\_Tuesday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates the day of the week on which the user typically works. For example, used for capacity planning. - **Default value**: false ### cgcloud\_\_Works\_On\_Wednesday\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates the day of the week on which the user typically works. For example, used for capacity planning. - **Default value**: false ## Associated Objects ### Associated Objects This object contains 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\_\_User\_Setting\_\_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\_\_User\_Setting\_\_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\_\_User\_Setting\_\_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\_\_User\_Setting\_\_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\_\_User\_Setting\_\_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. # cgcloud\_\_User\_View\_\_c This object is a User and View relation junction object. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### 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\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user to which the view belongs. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_View\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the default view. This is a relationship field. - **Relationship Name**: cgcloud\_\_View\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_View\_\_c ## Associated Objects ### Associated Objects This object contains 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\_\_User\_View\_\_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\_\_User\_View\_\_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\_\_User\_View\_\_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\_\_User\_View\_\_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\_\_User\_View\_\_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. # cgcloud\_\_Validation\_Rules\_Setting\_\_c Custom setting that manages various validation rules, such as granting bypass access. 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 ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique identification of the record. ### SetupOwnerId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the record owner. This is a polymorphic relationship field. - **Relationship Name**: SetupOwner - **Relationship Type**: Lookup - **Refers To**: Organization, Profile, User ### cgcloud\_\_Bypass\_Validation\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a validation rule is to be run. - **Default value**: false ## Associated Objects ### Associated Objects This object contains 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\_\_Validation\_Rules\_Setting\_\_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\_\_Validation\_Rules\_Setting\_\_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\_\_Validation\_Rules\_Setting\_\_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\_\_Validation\_Rules\_Setting\_\_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\_\_Validation\_Rules\_Setting\_\_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. # cgcloud\_\_Vehicle\_\_c Stores the details of the vehicle object. 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**: 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\_\_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**: Reference to the 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\_\_License\_Plate\_Number\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: License plate number of the vehicle. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Describes the sales org to which the vehicle belongs - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Vehicle\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the vehicle specific speed profiles that are used in the external ptv tool for route optimization. - **Default value**: Car - **Possible values**: - Car—Car Standard - Trailer - TruckFast—Truck Fast - TruckSlow—Truck Slow ## Associated Objects ### Associated Objects This object contains 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\_\_Vehicle\_\_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\_\_Vehicle\_\_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\_\_Vehicle\_\_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\_\_Vehicle\_\_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\_\_Vehicle\_\_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. # cgcloud\_\_Vehicle\_Warehouse\_\_c This object stores the relationship between a vehicle and a warehouse. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Active flag. - **Default value**: false ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the vehicle warehouse record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org to which the vehicle warehouse belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Vehicle\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the vehicle. This is a relationship field. - **Relationship Name**: cgcloud\_\_Vehicle\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Vehicle\_\_c (the master object) ### cgcloud\_\_Warehouse\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the warehouse. This is a relationship field. - **Relationship Name**: cgcloud\_\_Warehouse\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Warehouse\_\_c (the detail object) ## Associated Objects ### Associated Objects This object contains 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\_\_Vehicle\_Warehouse\_\_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\_\_Vehicle\_Warehouse\_\_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\_\_Vehicle\_Warehouse\_\_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\_\_Vehicle\_Warehouse\_\_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\_\_Vehicle\_Warehouse\_\_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. # cgcloud\_\_View\_\_c This object stores the filter criteria for the trade calendar. 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 ### 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\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the record is activated. - **Default value**: false ### cgcloud\_\_Current\_View\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates the current view for the user. - **Default value**: false ### 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\_\_Promotion\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the Promotion Template for which the current view is used. This attribute is used only for promotion views. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_Template\_\_c ### cgcloud\_\_Usage\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Usage of the view. - **Possible values**: - Plan - Promotion - Reporting ### cgcloud\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user to which the view belongs. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_View\_Definition\_\_c - **Type**: textarea - **Properties**: Create, Nillable, Update - **Description**: Contains the .json file of the View record. ## Associated Objects ### Associated Objects This object contains 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\_\_View\_\_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\_\_View\_\_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\_\_View\_\_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\_\_View\_\_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\_\_View\_\_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. # cgcloud\_\_Visit\_Job\_\_c This object contains answered questions and product surveys (jobs). 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. ### cgcloud\_\_Data\_Type\_Option\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the answer of a pick list. internally required. This is a relationship field. - **Relationship Name**: cgcloud\_\_Data\_Type\_Option\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Data\_Type\_Option\_\_c ### cgcloud\_\_Display\_Value\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: If the reference Job\_Definition\_Template is of type Toggle, description of the toggle value is shown else value is shown This is a calculated field. - **Formula**: IF(ISPICKVAL(cgcloud\_\_Job\_Definition\_Template\_\_r.cgcloud\_\_Data\_Type\_\_r.cgcloud\_\_Data\_Type\_\_c, "Toggle") , cgcloud\_\_Data\_Type\_Option\_\_r.cgcloud\_\_Description\_\_c , cgcloud\_\_Value\_\_c ) ### cgcloud\_\_Done\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The answer has been entered: The job will be marked as Yes. - **Default value**: false ### cgcloud\_\_Job\_Definition\_Template\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description text taken from job definition template. This is a calculated field. - **Formula**: cgcloud\_\_Job\_Definition\_Template\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Job\_Definition\_Template\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the job definition template. This is a relationship field. - **Relationship Name**: cgcloud\_\_Job\_Definition\_Template\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Job\_Definition\_Template\_\_c ### cgcloud\_\_Job\_Definition\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the job definition of the respective activity. This is a relationship field. - **Relationship Name**: cgcloud\_\_Job\_Definition\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Job\_DL\_Job\_Definition\_Template\_\_c ### cgcloud\_\_Job\_List\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to job list of a non-standard JDL This is a relationship field. - **Relationship Name**: cgcloud\_\_Job\_List\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Job\_List\_\_c ### cgcloud\_\_Job\_Template\_Description\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Description text taken from job definition template. This is a calculated field. - **Formula**: cgcloud\_\_Job\_Definition\_Template\_\_r.cgcloud\_\_Job\_Template\_\_r.cgcloud\_\_Description\_\_c ### cgcloud\_\_Last\_Value\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Answered value taken from the last relevant call. The Value depends on the DataType that has been specified in the job definition template. ### cgcloud\_\_Manually\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: The answer (job) has been manually added by the user. - **Default value**: false ### cgcloud\_\_Number\_of\_Pictures\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Nillable, Sort, Update - **Description**: Count of number of pictures associated with the question. ### cgcloud\_\_POS\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to POS. This is a relationship field. - **Relationship Name**: cgcloud\_\_POS\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_POS\_\_c ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the product (in case of a product related survey). This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Promotion\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: References to the name of the promotion. This is a relationship field. - **Relationship Name**: cgcloud\_\_Promotion\_\_r - **Relationship Type**: Lookup - **Refers To**: cgcloud\_\_Promotion\_\_c ### cgcloud\_\_Target\_Value\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stored value taken from the relevant product assortment where the product was taken from. ### cgcloud\_\_Value\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Answered value. The value depends on the DataType that has been specified in the job. definition template. ### cgcloud\_\_Visit\_Date\_\_c - **Type**: date - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Date of visit. ### cgcloud\_\_Visit\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the Visit. This is a relationship field. - **Relationship Name**: cgcloud\_\_Visit\_\_r - **Relationship Type**: Master-detail - **Refers To**: Visit (Master object) ## Associated Objects ### Associated Objects This object contains 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\_\_Visit\_Job\_\_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\_\_Visit\_Job\_\_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\_\_Visit\_Job\_\_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\_\_Visit\_Job\_\_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\_\_Visit\_Job\_\_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. # cgcloud\_\_Visit\_Template\_\_c Template that describes the basic call behavior. 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**: 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**: Active flag. - **Default value**: true ### cgcloud\_\_Add\_Job\_Policy\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether tasks and survey questions can be manually added to visits. - **Default value**: false ### cgcloud\_\_Auto\_Status\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Visit status set when call will be planned automatically. - **Default value**: Planned - **Possible values**: - Abandoned - Completed - Planned ### cgcloud\_\_Cancel\_Reason\_Required\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the user must provide a reason for visit cancellation. - **Default value**: false ### cgcloud\_\_Capture\_Proceeding\_Time\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Captures the start and end time of a visit. - **Default value**: false ### cgcloud\_\_Check\_Overlap\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether to check for overlaps while creating calls. If this option is selected, the system checks if a current visit overlaps with any other visits. Only visits in Planned state are considered. - **Default value**: false ### cgcloud\_\_Cmpl\_Vst\_Geolc\_Validation\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the validation type when a user completes a visit, based on the comparison between their GPS location and the geolocation of the store. - **Default value**: None - **Possible values**: - Error - None - Warning ### cgcloud\_\_Company\_Required\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Required company details. - **Default value**: Not required - **Possible values**: - Mandatory - Not required ### cgcloud\_\_Consider\_POS\_Check\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: If its value is true, then the Call considers POS in its questions. - **Default value**: true ### cgcloud\_\_Creation\_Platform\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Creation platform. - **Default value**: Both - **Possible values**: - Both - Laptop - Mobility ### cgcloud\_\_Default\_Duration\_\_c - **Type**: double - **Properties**: Create, Defaulted on create, Filter, Sort, Update - **Description**: Visit default duration in minutes. ### cgcloud\_\_Delete\_Allowed\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a visit can be deleted using a mobile device. - **Default value**: false ### 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**: Reference to the 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\_\_Display\_Promotions\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether valid promotions for the customer selected for a visit creation are shown in the Promotions tab of the Visit Detail page. - **Default value**: false ### cgcloud\_\_Does\_Show\_Read\_Only\_Visit\_Info\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether the users sees an information message that indicates that the visit hasn’t started and is in read-only mode. - **Default value**: false ### cgcloud\_\_Historical\_Products\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Determines whether and how historical products are considered when determining the list of products to be surveyed in a visit. - **Default value**: No - **Possible values**: - All - No - SameMeta—Same Template ### cgcloud\_\_Is\_Start\_Visit\_Rqr\_To\_Check\_In\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Determines whether a user needs to start a visit before visit execution. - **Default value**: false ### cgcloud\_\_KPI\_Relevant\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Restricted picklist, Update - **Description**: Defines whether a call is relevant for KPI calculation for the selected KPIs. - **Possible values**: - All—All KPIs ### cgcloud\_\_Limit\_To\_One\_Visit\_In\_Progress\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Prevent users from executing multiple visits at the same time. - **Default value**: false ### cgcloud\_Location\_Capture\_at\_Start\_\_C - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates if a user’s GPS location is captured at the start of a visit. This field applies only to Direct Store Delivery and Van Sales processes. - **Default value**: false ### cgcloud\_\_Loc\_Capture\_During\_Cancel\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the user's GPS location is recorded during visit cancellation. - **Default value**: false ### cgcloud\_\_Loc\_Capture\_During\_Complete\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether the GPS location of the user is captured at visit completion. - **Default value**: false ### cgcloud\_\_Max\_Pictures\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Maximum number of pictures. ### cgcloud\_\_Meta\_Type\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Defines another level of abstraction - categorizes templates into template templates. For example, is it a template for a Call, a Delivery Visit, a Van Sales, a Merchandising, a Service, or a Phone. - **Default value**: Call - **Possible values**: - Call - DeliveryVisit—Delivery Visit - Merchandising - Phone - Service - VanSales—Van Sales ### cgcloud\_\_Mobility\_Color\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Field that defines the color of call on a mobility device. - **Possible values**: - 003344—ink blue - 008899—sea green 2 - 20B2AA—light sea green - 467596—grey blue - 551155—red violet - 6495ED—corn flower blue - 6688BB—periwinkle blue - 77AA99—sage green - 87CEEB—sky blue - 87CEFA—light sky blue - 8FBC8F—dark seagreen - AA1133—cranberry red - ADD8E6—light blue - B0C4DE—light steel blue - BBBB00—lime green 2 - BC8F8F—rosy brown - D1DDEC—sky blue 2 - DAA520—golden rod - DD4411—dark orange - DDECD1—turquoise 2 - E9967A—dark salmon - EE9B38—yellow orange - EED2E0—plum - F08080—light coral - F4A460—sandy brown - F7EBD9—khaki 2 - FA8072—salmon - FF7F50—coral - FFA07A—light salmon - FFD700—gold ### cgcloud\_\_Mobility\_Relevant\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether a visit created can be executed using mobile devices. - **Default value**: false ### cgcloud\_\_Mobility\_User\_Guidance\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Process navigation (user guidance) that is used on mobility devices. - **Default value**: Sales - **Possible values**: - Delivery - Merchandizing - NonCustomer - Sales ### cgcloud\_\_Promotion\_Finding\_Lead\_Time\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Number of days that specifies future time range for finding of planned promotions. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Defines the Sales Organization in which the template can be used. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Sort\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: On Selection of visit template (For example, when creating a new visit): Defines the order of the templates. ### cgcloud\_\_Start\_Vst\_Geolc\_Validation\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Specifies the validation type when a user starts a visit, based on the comparison between their GPS location and the geolocation of the store. - **Default value**: None - **Possible values**: - Error - None - Warning ### cgcloud\_\_Sync\_Options\_\_c - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Defines when a visit based on this template will be synced automatically: - **Default value**: No - **Possible values**: - CancelCall - CompleteCall - CompleteCancelCall - No ### cgcloud\_\_Tag\_Media\_Date\_Time\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether date and time of media captured during visit execution on mobile devices is stored. - **Default value**: false ### cgcloud\_\_Tag\_Media\_Geo\_Location\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates whether GPS coordinates of media captured during visit execution on mobile devices is stored. - **Default value**: false ### cgcloud\_\_Update\_Planned\_Times\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Indicates if the Start or End datetimes and duration of the visit should be set - **Default value**: false ### cgcloud\_\_User\_Roles\_\_c - **Type**: multipicklist - **Properties**: Create, Filter, Nillable, Update - **Description**: User roles that are assigned to the Order Template. **Note**: Ensure that the master picklist values exactly match the technical name of the permission sets. Select the user value in translation. For example, if CGCloud\_Master\_Data\_Admin is the master picklist value, then Master Data Admin is the translated value. - **Possible values**: - CGCloud\_KAM—KAM - CGCloud\_Master\_Data\_Admin—Master Data Admin - CGCloud\_Retail\_Admin—Retail Admin - CGCloud\_Sales\_User—Sales User - CGCloud\_Security\_Admin—Security Admin - CGCloud\_Supervisor—Supervisor - CGCloud\_Tour\_User ## Associated Objects ### Associated Objects This object contains 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\_\_Visit\_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\_\_Visit\_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\_\_Visit\_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\_\_Visit\_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\_\_Visit\_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. # cgcloud\_\_Warehouse\_\_c Stores the details of the warehouse object. An organizational segmentation for the purpose of maintaining materials that are stored in different places. 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**: 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\_\_Address\_Note\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Description for the address. It can contain the building name and other hints to find the site. ### cgcloud\_\_Business\_Unit\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Defines the bookkeeping segment. ### cgcloud\_\_City\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the city. ### cgcloud\_\_Country\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the country. - **Possible values**: - ar—Argentina - at—Austria - au—Australia - be—Belgium - br—Brazil - ca—Canada - ch—Switzerland - cl—Chile - cn—China - de—Germany - es—Spain - fr—France - gb—United Kingdom - ie—Ireland - in—India - it—Italy - jp—Japan - mx—Mexico - nl—Netherlands - pl—Poland - ru—Russian Federation - us—United States - za—South Africa ### cgcloud\_\_County\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the county. ### 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\_\_District\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: District of the city or state. ### cgcloud\_\_Email\_\_c - **Type**: email - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Email address. ### cgcloud\_\_Fax\_\_c - **Type**: phone - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Fax number. ### cgcloud\_\_GLN\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Global location number. ### cgcloud\_\_House\_Number\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Indicates where the building can be found in a street. ### cgcloud\_\_International\_Postal\_Code\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Postal code with the format valid for every country. ### cgcloud\_\_Is\_Postbox\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Specifies whether the warehouse is a postbox. - **Default value**: false ### cgcloud\_\_Latitude\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Decimal degree of latitude. ### cgcloud\_\_Longitude\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Decimal degree of longitude. ### cgcloud\_\_Phone\_1\_\_c - **Type**: phone - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: First phone number. ### cgcloud\_\_Phone\_2\_\_c - **Type**: phone - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Second phone number. ### cgcloud\_\_Postbox\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Number of a numbered post box. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales organization to which the data type option belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_State\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: State or province of the country. - **Possible values**: - AL—Alabama - AZ—Arizona - CA—California - GA—Georgia - IA—Iowa - ID—Idaho - IL—Illinois - KS—Kansas - MD—Maryland - MI—Michigan - MO—Missouri - NC—North Carolina - ND—North Dakota - NE—Nebraska - NM—New Mexico - NY—New York - OH—Ohio - OR—Oregon - PA—Pennsylvania - SC—South Carolina - SD—South Dakota - TX—Texas - VA—Virginia - WA—Washington ### cgcloud\_\_Street\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Name of the street. ## Associated Objects This object contains these following 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\_\_Warehouse\_\_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\_\_Warehouse\_\_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\_\_Warehouse\_\_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\_\_Warehouse\_\_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\_\_Warehouse\_\_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. # cgcloud\_\_Warehouse\_Product\_\_c Stores the relationship between a warehouse and a product. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Active flag. - **Default value**: false ### cgcloud\_\_Product\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the product object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Product\_\_r - **Relationship Type**: Lookup - **Refers To**: Product2 ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the warehouse product record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org of the vehicle’s warehouse. This field is reserved for future use. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Warehouse\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the warehouse object. This is a relationship field. - **Relationship Name**: cgcloud\_\_Warehouse\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Warehouse\_\_c (Master object) ## Associated Objects ### Associated Objects This object contains these 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\_\_Warehouse\_Product\_\_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\_\_Warehouse\_Product\_\_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\_\_Warehouse\_Product\_\_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\_\_Warehouse\_Product\_\_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\_\_Warehouse\_Product\_\_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. # cgcloud\_\_Warehouse\_User\_\_c Stores the details of the relationship between a warehouse and a user. This object is available in API version 54.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Fields ### Name - **Type**: string - **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort - **Description**: Unique identification of the record. ### cgcloud\_\_Active\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: Active flag. - **Default value**: false ### cgcloud\_\_Record\_Link\_\_c - **Type**: string - **Properties**: Filter, Nillable, Sort - **Description**: Link to the detail page of the warehouse user record. This is a calculated field. - **Formula**: HYPERLINK("/" &Id, $Label.cgcloud\_\_record\_link, "\_top") ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org to which the warehouse user belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_User\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the user. This is a relationship field. - **Relationship Name**: cgcloud\_\_User\_\_r - **Relationship Type**: Lookup - **Refers To**: User ### cgcloud\_\_Warehouse\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the warehouse. This is a relationship field. - **Relationship Name**: cgcloud\_\_Warehouse\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Warehouse\_\_c (the master object) ## Associated Objects ### Associated Objects This object contains 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\_\_Warehouse\_User\_\_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\_\_Warehouse\_User\_\_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\_\_Warehouse\_User\_\_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\_\_Warehouse\_User\_\_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\_\_Warehouse\_User\_\_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. # cgcloud\_\_Week\_Day\_Share\_Profile\_\_c Contains statistical profiles of the distribution of weekly data among different days of a week. 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\_\_Description\_Language\_1\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the description of language 1. ### cgcloud\_\_Description\_Language\_2\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the description of language 2. ### cgcloud\_\_Description\_Language\_3\_\_c - **Type**: textarea - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Stores the description of language 3. ### cgcloud\_\_Description\_Language\_4\_\_c - **Type**: textarea - **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\_\_Friday\_Percentage\_\_c - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Utilized share value on Fridays = Friday/Total. Rounded up to two decimal places. This is a calculated field. - **Formula**: cgcloud\_\_Friday\_\_c / cgcloud\_\_Total\_\_c ### cgcloud\_\_Friday\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Input value for the share valid on Fridays. ### cgcloud\_\_Monday\_Percentage\_\_c - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Utilized share value on Mondays = Monday/Total. Rounded up to two decimal places. This is a calculated field. - **Formula**: cgcloud\_\_Monday\_\_c / cgcloud\_\_Total\_\_c ### cgcloud\_\_Monday\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Input value for the share valid on Mondays. ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales organization to which the Week Day Share Profile belongs. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Saturday\_Percentage\_\_c - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Utilized share value on Saturdays = Saturday/Total. Rounded up to two decimal places. This is a calculated field. - **Formula**: cgcloud\_\_Saturday\_\_c / cgcloud\_\_Total\_\_c ### cgcloud\_\_Saturday\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Input value for the share valid on Saturdays. ### cgcloud\_\_Sunday\_Percentage\_\_c - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Utilized share value on Sundays = Sunday/Total. Rounded up to two decimal places. This is a calculated field. - **Formula**: cgcloud\_\_Sunday\_\_c / cgcloud\_\_Total\_\_c ### cgcloud\_\_Sunday\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Input value for the share valid on Sundays. ### cgcloud\_\_Thursday\_Percentage\_\_c - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Utilized share value on Thursdays = Thursday/Total. Rounded up to two decimal places. This is a calculated field. - **Formula**: cgcloud\_\_Thursday\_\_c / cgcloud\_\_Total\_\_c ### cgcloud\_\_Thursday\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Input value for the share valid on Thursdays. ### cgcloud\_\_Total\_\_c - **Type**: double - **Properties**: Filter, Nillable, Sort - **Description**: Sum total of all input weekday values in the current profile. This is a calculated field. - **Formula**: cgcloud\_\_Sunday\_\_c + cgcloud\_\_Monday\_\_c + cgcloud\_\_Tuesday\_\_c + cgcloud\_\_Wednesday\_\_c + cgcloud\_\_Thursday\_\_c + cgcloud\_\_Friday\_\_c + cgcloud\_\_Saturday\_\_c ### cgcloud\_\_Tuesday\_Percentage\_\_c - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Utilized share value on Tuesdays = Tuesday/Total. Rounded up to two decimal places. This is a calculated field. - **Formula**: cgcloud\_\_Tuesday\_\_c / cgcloud\_\_Total\_\_c ### cgcloud\_\_Tuesday\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Input value for the share valid on Tuesdays. ### cgcloud\_\_Wednesday\_Percentage\_\_c - **Type**: percent - **Properties**: Filter, Nillable, Sort - **Description**: Utilized share value on Wednesdays = Wednesday/Total. Rounded up to two decimal places. This is a calculated field. - **Formula**: cgcloud\_\_Wednesday\_\_c / cgcloud\_\_Total\_\_c ### cgcloud\_\_Wednesday\_\_c - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Input value for the share valid on Wednesdays. ## Associated Objects ### Associated Objects This object contains 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\_\_Week\_Day\_Share\_Profile\_\_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\_\_Week\_Day\_Share\_Profile\_\_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\_\_Week\_Day\_Share\_Profile\_\_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\_\_Week\_Day\_Share\_Profile\_\_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\_\_Week\_Day\_Share\_Profile\_\_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. # cgcloud\_\_Workflow\_\_c Stores the attributes of the workflow. 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**: 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\_\_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**: Reference to the 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\_\_Recent\_State\_Policy\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: This attribute controls the creation of the Recent State data records for the workflow. If the attribute is selected as No, the system doesn't create a Recent State data record when the business object reaches a new state. - **Default value**: false ### cgcloud\_\_Sales\_Org\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update - **Description**: Sales org of the workflow. - **Possible values**: - 0000 - 0001 - 0002 - 0003 ### cgcloud\_\_Usage\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Module or business object in which the workflow can be used. - **Possible values**: - CustomerTask—Customer Task - DailyReport—Daily Report - JobDefList—Job Def List - OrderEntry—Order Entry - Payment—Contract Payment - Promotion ## Associated Objects ### Associated Objects This object contains 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\_\_Workflow\_\_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\_\_Workflow\_\_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\_\_Workflow\_\_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\_\_Workflow\_\_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\_\_Workflow\_\_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. # cgcloud\_\_Workflow\_State\_Transition\_\_c Stores the details of the workflow state transition. 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 ### Name - **Type**: string - **Properties**: Create, Defaulted on create, Filter, Group, idLookup, Nillable, Sort, Update - **Description**: Unique identification of the record. ### cgcloud\_\_Event\_\_c - **Type**: string - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Event that triggers the state transition. For example, Save or Delete. ### cgcloud\_\_From\_Initial\_Stage\_\_c - **Type**: boolean - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: From initial stage value. - **Default value**: false ### cgcloud\_\_From\_Status\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the state that's valid before the state transition. - **Possible values**: - Active - Approved - Cancelled - Check - Closed - Committed - Correction - ForApproval - Frozen - HoldBack - Planning - Ready - Rejected - Released - SendFax - WorkCompleted - final - initial - normal ### cgcloud\_\_To\_Status\_\_c - **Type**: picklist - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Reference to the state that's valid after the state transition. - **Possible values**: - Active - Approved - Cancelled - Check - Closed - Committed - Correction - ForApproval - Frozen - HoldBack - Planning - Ready - Rejected - Released - SendFax - WorkCompleted - final - initial - normal ### cgcloud\_\_Workflow\_\_c - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: Reference to the workflow. This is a relationship field. - **Relationship Name**: cgcloud\_\_Workflow\_\_r - **Relationship Type**: Master-detail - **Refers To**: cgcloud\_\_Workflow\_\_c (Master object) ## Associated Objects ### Associated Objects This object contains 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\_\_Workflow\_State\_Transition\_\_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\_\_Workflow\_State\_Transition\_\_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\_\_Workflow\_State\_Transition\_\_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\_\_Workflow\_State\_Transition\_\_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\_\_Workflow\_State\_Transition\_\_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. # Checking CSV Export Status The next step is to check the status of this export. As soon as it's ready (that is, "Status" = "Ready"), you can continue with the actual download of the file. ## Sample Apex Request: .OffPlatformCallout request = new .OffPlatformCallout('GET\_RTR\_EXPORT\_STATUS','0001'); Map params = new Map(); params.put('csvGuid', ''); .OffPlatformCalloutResponse response = request.execute(.TransactionHandler.getTransactionIdentifier(), params, null); ## Sample Response { "Status": "Ready", "RequestDate": "2021-09-14T13:33:29.000Z", "MetaName": "AccountAndPromotionMeasures", "BusinessYear": 2020, "Statistics": { "csvGuid": "94f49a3f-37bc-4794-8051-123456789", "jobStartTime": "Tue, 14 Sep 2021 13:34:02 GMT", "hasDelta": false, "deltaToCsvGuid": null, "metaName": "AccountAndPromotionMeasures", "metaVersion": 8, "totalAccounts": 1, "totalCategories": 6, "dimDataRetrievalDuration": 1188, "numRecords": 0, "numAccountCategoryKeys": 6, "runDuration": 1592, "processedAccountCategories": 6, "jobCompletionTime": "Tue, 14 Sep 2021 13:34:06 GMT", "jobDuration": 4734 }, "FullExport": "tpm/long/export/full/94f49a3f-37bc-4794-8051-396f545500eb.csv.gz", "DeltaExport": "tpm/long/export/delta/94f49a3f-37bc-4794-8051-396f545500eb.csv.gz" } # Checking Job Status Use the CSV Export Job Status API to get the status of the scheduled export. The API uses the csvGuid of the scheduled export as an input parameter. The job status can have one of the following values: - Queued - InProgress - Ready - Error - Aborted ## Resource /services/apexrest/cgcloud/measures/export//status?salesorg= ## Method GET ## Path Parameters | URL Parameter | Sample Value | Description | | --- | --- | --- | | csvGuid | 3b549543-d420-401a-b424-29c7f3c75713 | Enter the csvGuid value of the scheduled CSV export. This value is received as a response to the API request sent to Triggering CSV Exports API. | ## Query Parameters | URL Parameter | Type | Description | | --- | --- | --- | | salesorg | String | Enter the Salesorg name. | ## Sample Response Body for Queued Status { "Status":"Queued", "RequestDate":"2025-08-01T12:55:56.000Z", "MetaName":"IntegrationExportPromotion", "BusinessYear":2025, "Statistics":null } ## Sample Response Body for Ready Status { "Status":"Ready", "RequestDate":"2025-08-01T12:55:56.000Z", "MetaName":"IntegrationExportPromotion", "BusinessYear":2025, "Statistics": { "csvGuid":"5a2cb107-bc1f-4995-a782-291ec3d62d55", "jobStartTime":"Fri, 01 Aug 2025 12:56:47 GMT", "hasDelta":false, "deltaToCsvGuid":null, "metaName":"IntegrationExportPromotion", "metaVersion":1, "totalAccounts":131, "totalCategories":6, "dimDataRetrievalDuration":480, "numRecords":1908,"numAccountCategoryKeys":786, "runDuration":31262,"processedAccountCategories":786, "jobCompletionTime":"Fri, 01 Aug 2025 12:57:19 GMT", "jobDuration":31975}, "FullExport":"full/5a2cb107-bc1f-4995-a782-291ec3d62d55.csv.gz", "DeltaExport":"delta/5a2cb107-bc1f-4995-a782-291ec3d62d55.csv.gz" } # Commit Job Scheduling Transaction Explicitly commit an open scheduling transaction for a job in a job chain. ## Resource COMMIT\_JOB\_SCHEDULING\_TRANSACTION ## Available version 55.0 ## Request Parameters | Name | Type | Description | Required or Optional | | --- | --- | --- | --- | | jobChain | String | ID of the job chain record. | Required | | jobId | String | ID of the job record for which scheduling transaction is to be started. | Required | ## Apex Request Example // name of the salesorg for which the job should be scheduled String salesOrg = '0001'; .JobSchedulingCommitCallout callout = new .JobSchedulingCommitCallout(salesOrg); // Log Transaction Id String txId = .TransactionHandler.getTransactionIdentifier(); // Job object .Job job = new .Job(); job.JobChainName = 'TPM\_Calculation\_Chain\_'; job.JobName = 'PromotionCalculation'; .OffplatformCalloutResponse response = callout.execute(txId, job); if (response.status != 200) { // Handle error } # Committing CSV Export This Apex call commits a full or delta CSV export. Generally, there are two types of CSV exports generated by the system—a full and a delta export. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note The committed exports are retained for 30 days. - The full data contains all the data for the provided business year, report, and sales org. - The delta export contains only the changed data for the provided business year, report, and sales org since the last commit. ## Sample Apex Request OffPlatformCallout request = new .OffPlatformCallout('COMMIT\_RTR\_EXPORT',''); Map data = new Map(); data.put('metaname','ReportData0001'); data.put('salesorg', '0001'); data.put('businessyear',2020); String requestBodyContent = JSON.serialize(data, true); Map params = new Map(); params.put('csvGuid', ''); .OffPlatformCalloutResponse response = request.execute(.TransactionHandler.getTransactionIdentifier(), params, requestBodyContent); System.debug(response); ## Sample Response { "csvGuid": "94f49a3f-37bc-4794-8051-123456789", "commitdate": "Thu, 16 Sep 2021 13:04:23 GMT" } # Committing CSV Export Use the Commit CSV Export API to commit a specific csvGuid and take the related CSV as a new baseline for future delta exports. This means after this commit, the next delta export contains only those records in the KPIs that have been either added, changed, or deleted from the previous committed state. The current version of a metadata configuration is available in the response of Checking Job Status. For example: "metaVersion": 8. If the underlying RTR Report Configuration record in a Salesforce org changes, then the previous commit is no longer valid for a delta export. A full export is scheduled next time. ## Resource /services/apexrest/cgcloud/measures/export/{{csvguid}}/commit ## Method POST ## Path Parameters | URL Parameter | Sample Value | Description | | --- | --- | --- | | csvGuid | 3b549543-d420-401a-b424-29c7f3c75713 | Enter the csvGuid value of the scheduled CSV export. This value is received as a response to the API request sent to Triggering CSV Exports API. | ## Request Parameters | Parameter | Mandatory | Type | Description | | --- | --- | --- | --- | | businessyear | Yes | Integer | Enter the business year for which the CSV export must be triggered. | | metaname | Yes | String | Enter the Internal Name of the RTR Report Configuration. | | salesorg | Yes | String | Enter the Salesorg ID. | ## Sample Request Body { "salesorg": "0001", "metaname": "IntegrationExportPromotion", "businessyear": 2024 } ## Sample Response Body {"csvGuid":"5a2cb107-bc1f-4995-a782-291ec3d62d55","commitdate":"Fri, 01 Aug 2025 13:02:28 GMT"} # Configuration Entities Business Object API records contains Workflows and Output Entities. - Workflows: The available workflows for this Business Object - Output Entities: Entities of type Output this Business Object manipulates ## Business Object API Entity Business Object API use the concept of “Entities” to identify “kinds” of objects in both the data input (Input Payloads) and output (Generated Objects or Records). Entities are used to group similar types of information. This information is later used to determine which Workflow Steps are executed with which input. | Object | Description | Required/Optional | | --- | --- | --- | | Name | Name of the Entity. | Required | | Location | If the entity is an Input or Output entity. | Required | | Description | High-level description of the entity. | Required | | Path | List of comma separated JSON paths where entities of this type will be found on the input payloadDefines the path of the entity with these structures:- .objectProperty.property- .arrayProperty\[\*\].property- .property- .arrayProperty\[\*\]- An empty path (represents the root of the input object and is considered as a valid path). For a successful configuration, ensure that the path property adheres to the specified structure:- Mark the array property \[\*\] at the end of the field name.- Ensure that the path property is a dot-separated list of fields. For example, .AnchorAccount, .CommitDate.- Specify multiple paths by separating paths with a comma \[,\].- Validate the path before a record is saved; an error message appears if the path doesn't match. | Required | ## Business Object API Workflow Business Object API Workflow is akin to a process or method to be executed for the given Business Object. Different workflows can be created to suit different needs and different processes, such a “create” workflow or an “update” workflow. Each workflow contains: - Input Entities and Mapping: A list of the input entities this workflow is able to handle. Use the mapping properties to map each input entity type to an output entity - Workflow Steps: Ordered list of workflow steps that will be executed when the Workflow is requested to be run. Each workflow step will be executed for all the entities of a given type present in the input or output You can see the input payload schema required for a Workflow by clicking on the “View Schema” button on the workflow page. | Object | Description | Required/Optional | | --- | --- | --- | | Name | Name of the Workflow. | Required | | Business Object API | Business Object the Workflow belongs to | Required | | Description | High-level description of the workflow. | Required | ## Business Object API Workflow Step Business Object API Workflow Steps represent individual functions to be executed to achieve the expected final result. Workflow Steps map to an APEX class which implements the Step behavior: | Object | Description | Required/Optional | | --- | --- | --- | | Name | Name of the business rule. | Required | | Entity | Entity of the Input the rule must be applied to. | Optional | | Method | Action method that is passed to the callable class. | Optional | | Classname | Name of the APEX Callable class implementing the transformation. | Required | | Description | High-level overview of what the rule does | Optional | | Sales Org | Sales Organization | Required | These Workflow steps can be shared between different workflows. Each Workflow Step contains: - Step Input Structures: List of input structure records that reflect the expected inputs for the rule. ## Business Object API Workflow Step Input Structure Define the input structures used for the related workflow step. This information is used to validate the input payload. Different types of expected inputs can be defined based on the SObject record type. # Configuration of Integration Meta Data The integration meta configuration defines dimensions, export columns, filters, or conditions for CSV exports. Before creating an integration meta configuration entry in RTR Report Configuration", the Salesforce integration dimension meta configuration must be created, saved, and synchronized to off-platform. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note If additional custom period is enabled for a salesorg, then the property enableForCustomTimeLevel: true should be added to the export configuration. You can create CSV export integration metadata configuration by adding new report configuration entry to RTR Report Configurations. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note **It is mandatory to include the key fields of each dimension in the exported columns when exporting a CSV file of the report.** For CSV export reports, provide the following inputs: | Attribute | Description | | --- | --- | | Information Internal Name | A unique internal name of the integration metadata configuration. | | Configuration Usage | Integration Metadata. | | Configuration of sales org | The sales organization to which the product belongs. | | Configuration Reporting KPI Set | The KPI set connected to measure dimension. | ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note When you trigger an inbound integration data source, ensure that you specify the calendaryear instead of businessyear in the request parameters. For more information, see [Triggering CSV Exports](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_triggering_csv_exports.htm "Use the Triggering CSV Exports API to trigger CSV exports simultaneously. The CSV exports are generated asynchronously."). ## Examples of the supported data sources Examples of different supported data sources are listed in this section. Such a meta JSON must be saved to off-platform in order to enable CSV export. A meta JSON consists of the following blocks: - datasources: Inbound data source meta configuration supports only accountdimension and kpidimension. If other dimensions are configured, then they are ignored. Inbound datasources. - PromotionTacticDailyMeasureReal - PromotionTacticWeeklyMeasureReal - DailyRealData - DailyIntData - ProductMeasures - AccountMeasures - AccountProductMeasures - WeeklyMeasureReal - WeeklyMeasureInt Writeback datasources: - AccountAndPromotionMeasures - PromotionMeasures - PromotionAndTacticMeasures - PromotionMeasuresWithBOMComponents - PromotionAndTacticMeasuresWithBOMComponents See [Triggering the CSV Export Process](https://developer.salesforce.com/docs/atlas.en-us.264.0.cgcloud_rtr_dev_guide.meta/cgcloud_rtr_dev_guide/rtr_triggering_csv_export_process.htm) for more information. - dimensions: Specifies dimensions to fetch data based on the selected data source: - accountdimension: Retrieves Salesforce data from CGCloud\_\_Account\_Extension\_\_c - promotiondimension: Retrieves Salesforce data from CGCloud\_\_Promotion\_\_c - tacticdimension: Retrieves Salesforce data from CGCloud\_\_Tactic\_\_c - productdimension: Retrieves Salesforce data from Product2 - kpidimension: Specifies the KPIs that are exported. The KPIs that are calculated based on the KPI set defined in the report configuration are available for the export. - timedimension: Specifies how to define the time dimension, by default, it’s fixed to the business year. - includetotal: true or false (include the total value of the KPI) - splitweeks: true (only valid for weekly or custom period) or false. For more information on splitweek measures export behavior and configuration restrictions, see [Splitweek Measures Export Behavior and Configuration Restrictions](https://help.salesforce.com/s/articleView?id=005385612&type=1&language=en_US). - period: weekly, monthly, custom, customweek, and custommonth. An additional custom period-enabled salesorg supports only custom, customweek, and custommonth whereas a custom period-enabled salesorg supports custom and monthly period types only. An org using a standard calendar supports only weekly and monthly period types. For period type customweek/custommonth, it is mandatory to include the timedimension.StartDate as the first timedimension column. - exportsettings: Specifies columns to generate in CSV file and CSV separator. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note Export columns is not supported for inbound data sources. This means exportsettings.columns should not be specified in the export meta configuration. - columns: Array of strings referencing dimension attributes. dimensionname.attribute must exist in the corresponding dimension. the allowed accessors for timedimension: - timedimension.label - timedimension.StartDate - timedimension.EndDate - timedimension.yearnumber The allowed accessors for kpidimension: - kpidimension.label - kpidimension.measurecode - kpidimension.name - Spread operator: The last column requires spread operator on either a kpidimension or timedimension accessor. When spread operator is used on kpidimension as the last column, accessors of kpidimension can’t be used in columns before. When spread operator is used on timedimension as the last column, accessors of timedimension can’t be used in columns before. - Separator: The string specifying CSV separator. The allowed separators are: - , - | - ; - : - exportfilters: Specifies conditions to apply when export process fetches data from Salesforce dimensions. For inbound data sources, filtering is supported only on accountdimension. # Configuring Integration Dimension Meta Create RTR report configuration records to export CSVs.
Available in: Lightning Experience in Enterprise and Unlimited Editions that have Consumer Goods Cloud Trade Promotion Management enabled.
There’s a object called RTR Report Configuration—CGCloud\_RTR\_Report\_Configuration\_\_c—available in your Salesforce org. You must create RTR report configuration records to export CSVs as they hold the dimension meta information for the integration export. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note The user mapped to Calculation Result Export Processing Service should have access to the fields and objects configured in report dimensions. The TPM Calculation Result Export permission set provides access to product, account, promotion, tactic, and product part objects and fields. An administrator can assign the TPM Calculation Result Export permission set for this user and also provide access to the additional objects that are used in report dimensions. For each dimension and sales org, you must create dimension meta as RTR Report Configuration records: - Account Dimension - Promotion Dimension - Tactic Dimension - Product Dimension ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note When the dimension meta is created and configured, you must save and synchronize the dimension meta to Consumer Goods Cloud Processing Service. - **[Account Dimension](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_account_dimension.htm)** The account dimension for integration export must be configured for each sales org on which CSV exports is executed. - **[Promotion Dimension](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_promotion_dimension.htm)** You must configure the promotion dimension for integration export for each sales org on which CSV exports is executed. - **[Tactic Dimension](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_tactic_dimension.htm)** You must configure the tactic dimension for integration exports for each sales org on which CSV exports is executed. - **[Product Dimension](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_product_dimension.htm)** You must configure product dimension for integration export for each sales org on which CSV exports is executed. - **[Product Part Dimension](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_integration_product_part_dimension.htm)** To extract data at the Bill of Materials (BOM) component or product part level, configure Product Part Dimension for each sales org on which CSV exports are executed. - **[Configuration of Integration Meta Data](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_configuration_integration_meta.htm)** The integration meta configuration defines dimensions, export columns, filters, or conditions for CSV exports. # Copy Promotion Wizard Invocable Actions This class contains support for Data Source providers used in the CopyPromotion wizard. - **[getPromotion](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/copy_promotion_getpromotions.htm)** This method returns the requested fields for the given promotion ID. - **[getAccounts](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/copy_promotion_getaccounts.htm)** This method returns the list of accounts valid for the target promotion. Target promotion timeframe is calculated by the difference in days between the original promotion date and the new date. - **[getAccountSets](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/copy_promotion_getaccountsets.htm)** This method returns the list of account sets valid for the target promotion. Target promotion timeframe is calculated by the difference in days between the original promotion date and the new date. - **[IsPromotionTemplateCopyable](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/copy_promotion_is_promotion_template_copy.htm)** This method validates the given promotion has a promotion template that can be copied. - **[isPromotionAndUserSameSalesOrg](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/copy_promotion_is_promotion_and_user_same.htm)** This method validates if the given promotion belongs to the same Salesorg where the user exists. # Custom Metadata Types in Sync Management Use custom metadata types and fields that help deliver additional features for Consumer Goods Cloud. Fields and custom metadata types in the package have the \_\_c and \_\_mdt suffix respectively. For example, Client\_App\_Id\_\_c is a custom field on Sync Ignored Fields. Sync\_Ignored\_fields\_\_mdt is a custom metadata type. Not all fields are listed for some custom metadata types. To verify the complete list of fields for a custom metadata type, use a describe call from the API, inspect the WSDL, or request the xml files from the developer. - **[Sync Ignored Fields Custom Metadata type](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/meta_sync_ignored_fields__mdt.htm)** Represents the specific fields of Salesforce objects omitted during the synchronization process. # Custom Objects for Direct Store Delivery Consumer Goods Cloud data model provides custom objects and fields to support Direct Store Delivery. - **[cgcloud\_\_Route\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__route__c.htm)** Stores the details of the route object. This object is available in API version 54.0 and later. - **[cgcloud\_\_Route\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__route_template__c.htm)** Stores the details of the route template object that's to be used for routes. This object is available in API version 54.0 and later. - **[cgcloud\_\_Tour\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tour__c.htm)** Stores the details of the tour object. This object is available in API version 54.0 and later. - **[cgcloud\_\_Tour\_Check\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tour_check__c.htm)** Stores the details of the tour check object that's used as part of tour execution for tour checking. This object is available in API version 54.0 and later. - **[cgcloud\_\_Tour\_Object\_Reference\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tour_object_reference__c.htm)** Stores the details of the object references of a tour. This object is available in API version 54.0 and later. - **[cgcloud\_\_Tour\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tour_template__c.htm)** Stores the details of the tour template object that's to be used for tours. This object is available in API version 54.0 and later. - **[cgcloud\_\_Tour\_Template\_Object\_Reference\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tour_template_object_reference__c.htm)** Stores the details of the object references of a tour template. This object is available in API version 54.0 and later. - **[cgcloud\_\_Tour\_Template\_Tour\_Check\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tour_template_tour_check__c.htm)** Stores the details of the relationship between tour template and tour check, which is used to define the relevant tour checks on a tour. This object is available in API version 54.0 and later. - **[cgcloud\_\_Tour\_Tour\_Check\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tour_tour_check__c.htm)** Stores the details of the relationship between tour and tour check. This object is available in API version 54.0 and later. - **[cgcloud\_\_Vehicle\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__vehicle__c.htm)** Stores the details of the vehicle object. This object is available in API version 54.0 and later. - **[cgcloud\_\_Vehicle\_Warehouse\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__vehicle_warehouse__c.htm)** This object stores the relationship between a vehicle and a warehouse. This object is available in API version 54.0 and later. - **[cgcloud\_\_Route\_Account\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__route_account__c.htm)** Stores the details of the relationship between routes and customers. This object is available in API version 54.0 and later. # Custom Objects for Retail Execution The consumer goods data model provides objects and fields to support Retail Execution (RE). To learn about the custom objects that are common between Retail Execution and Trade Promotion Management, refer to [Custom Objects for Retail Execution and Trade Promotion Management](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_236_tpm_custom_objects.htm "The consumer goods data model provides objects and fields that supports both RE and TPM.") - **[cgcloud\_\_Account\_Receivable\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_receivable__c.htm)** Holds the customer related information regarding invoices to be paid and debit and credit notes. This object is available in API version 55.0 and later. - **[cgcloud\_\_Account\_Sales\_Data\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_sales_data__c.htm)** Contains the information of the sales of a customer for two consecutive years. Access of the object provided to the System Admin. This object is available in API version 54.0 and later. - **[cgcloud\_\_Account\_Specific\_Product\_Condition\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_specific_product_condition__c.htm)** Holds the relation between a customer and the condition template. This object is available in API version 54.0 and later. - **[cgcloud\_\_Account\_Task\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_task__c.htm)** This object represents the details of the customer task (customer issue). This object is available in API version 54.0 and later. - **[cgcloud\_\_Account\_Task\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_task_template__c.htm)** Represents the details of the customer task template to be used for customer tasks. This object is available in API version 54.0 and later. - **[cgcloud\_\_Account\_Visit\_Setting\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_visit_setting__c.htm)** This object stores the settings for the calls of a user based on a customer. This object is available in API version 54.0 and later. - **[cgcloud\_\_Asset\_Audit\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__asset_audit__c.htm)** Represents the details of an asset survey. This object is available in API version 54.0 and later. - **[cgcloud\_\_Asset\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__asset_template__c.htm)** An asset is a physical element that has a certain value which a manufacturer can place at a customer's location (retailer, bar, hotel, shop, and so on), and it can be associated to a POS (such as a shelf, cooler, fridge, and more). This object is available in API version 54.0 and later. - **[cgcloud\_\_Approval\_Code\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__approval_code__c.htm)** Represents the attributes for approval code of users. This object is available in API version 54.0 and later. - **[cgcloud\_\_Batch\_Last\_Successful\_Run\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__batch_last_successful_run__c.htm)** Keeps track of the last successful runs. This object is available in API version 55.0 and later. - **[cgcloud\_\_Batch\_Process\_Configuration\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__batch_process_configuration__c.htm)** Custom setting that captures the configuration of the batch process. This object is available in API version 54.0 and later. - **[cgcloud\_\_Color\_Schema\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__color_schema__c.htm)** Defines various Sales Organization-dependent property-based color schemes for the Trade Calendar. This object is available in API version 54.0 and later. - **[cgcloud\_\_BO\_API\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__bo_api__c.htm)** This table stores the header record of Business Object APIs. This object is available in API version 54.0 and later. - **[cgcloud\_\_BO\_API\_Entity\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__bo_api_entity__c.htm)** This table stores the entity definitions of Business Object APIs. This object is available in API version 54.0 and later. - **[cgcloud\_\_BO\_API\_Output\_Entity\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__bo_api_output_entity__c.htm)** This table stores the output entities of the Business Object API. This object is available in API version 54.0 and later. - **[cgcloud\_\_BO\_API\_Step\_Input\_Structure\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__bo_api_step_input_structure__c.htm)** This table stores the input structure configuration that the business object API workflow step expects. This object is available in API version 54.0 and later. - **[cgcloud\_\_BO\_API\_Transaction\_Log\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__bo_api_transaction_log__c.htm)** This object stores information about Business Object API Transaction Log, which is a collection of one or more promotions that should be created or updated under the same name via the Promotion BO Creation API. This object is available in API version 54.0 and later. - **[cgcloud\_\_BO\_API\_Workflow\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__bo_api_workflow__c.htm)** This table stores the workflows that are defined for the Business Object. This object is available in API version 54.0 and later. - **[cgcloud\_\_BO\_API\_Workflow\_Entity\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__bo_api_workflow_entity__c.htm)** This object stores the entities that Business Object API Workflows use. This object is available in API version 54.0 and later. - **[cgcloud\_\_BO\_API\_Workflow\_Step\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__bo_api_workflow_step__c.htm)** This table stores the definitions of the workflow step. This object is available in API version 54.0 and later. - **[cgcloud\_\_BO\_API\_Workflow\_Workflow\_Step\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__bo_api_workflow_workflow_step__c.htm)** This table stores the junction object to identify the workflow steps that apply for each workflow. This object is available in API version 54.0 and later. - **[cgcloud\_\_Consider\_Default\_SalesOrg\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__consider_default_salesorg__c.htm)** Use this object to assign Global Sales Org. This object is available in API version 54.0 and later. - **[cgcloud\_\_CP\_Calculation\_Schema\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__cp_calculation_schema__c.htm)** The calculation schema object is used for complex pricing. This object is available in API version 54.0 and later. - **[cgcloud\_\_CP\_Calculation\_Schema\_Determination\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__cp_calculation_schema_determination__c.htm)** The calculation schema determination object is used to determine the rule based on order template pricing type and customer pricing type. This object is available in API version 54.0 and later. - **[cgcloud\_\_CP\_Calculation\_Schema\_Step\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__cp_calculation_schema_step__c.htm)** This object stores the details of the relationship between calculation schema and pricing condition template that's used for the calculation steps that belong to a calculation schema. This object is available in API version 54.0 and later. - **[cgcloud\_\_CP\_Key\_Attribute\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__cp_key_attribute__c.htm)** The key attribute object is used to determine the complex pricing condition. This object is available in API version 54.0 and later. - **[cgcloud\_\_CP\_Key\_Type\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__cp_key_type__c.htm)** The key type object is used in the complex pricing search strategy. This object is available in API version 54.0 and later. - **[cgcloud\_\_CP\_Pricing\_Condition\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__cp_pricing_condition__c.htm)** This object holds the details of the pricing condition object that the Penny Perfect Pricing functionality uses. This object is available in API version 54.0 and later. - **[cgcloud\_\_CP\_Pricing\_Condition\_Scale\_Stage\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__cp_pricing_condition_scale_stage__c.htm)** Staging table for condition scales that complex pricing uses. This object is available in API version 54.0 and later. - **[cgcloud\_\_CP\_Pricing\_Condition\_Stage\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__cp_pricing_condition_stage__c.htm)** Staging table for conditions that complex pricing uses. This object is available in API version 54.0 and later. - **[cgcloud\_\_CP\_Pricing\_Condition\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__cp_pricing_condition_template__c.htm)** The pricing condition template object is used to define what is to be calculated in a step of a calculation schema. This object is available in API version 54.0 and later. - **[cgcloud\_\_CP\_Search\_Strategy\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__cp_search_strategy__c.htm)** The search strategy object is used to search for complex pricing conditions. This object is available in API version 54.0 and later. - **[cgcloud\_\_CP\_Search\_Strategy\_Step\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__cp_search_strategy_step__c.htm)** This object stores the details of the relationship between search strategy and key type, which is used to search for complex pricing strategy steps. This object is available in API version 54.0 and later. - **[cgcloud\_\_Data\_Type\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__data_type__c.htm)** Stores the flexible data type. This object is available in API version 54.0 and later. - **[cgcloud\_\_Data\_Type\_Option\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__data_type_option__c.htm)** Stores the item (picklist item) of a flexible data type. This object is available in API version 54.0 and later. - **[cgcloud\_\_Field\_Sales\_Activity\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__field_sales_activity__c.htm)** Stores the details of the field sales activity object. Field Sales Activity (FSA) covers a set of job definition lists. This object is available in API version 54.0 and later. - **[cgcloud\_\_Flatten\_Org\_Unit\_Hierarchy\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__flatten_org_unit_hierarchy__c.htm)** This object stores node org unit hierarchy information for the Customer Segmentation functionality. This object is available in API version 54.0 and later. - **[cgcloud\_\_Historic\_Product\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__historic_product__c.htm)** Junction object between the Customer (Account) and Product (Product\_\_c) objects. This object is available in API version 54.0 and later. - **[cgcloud\_\_Inventory\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__inventory__c.htm)** Stores the details of the inventory object. This object is available in API version 54.0 and later. - **[cgcloud\_\_Inventory\_Control\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__inventory_control_template__c.htm)** Stores the details of the inventory control template that's to be used for inventories. This object is available in API version 54.0 and later. - **[cgcloud\_\_Inventory\_Transaction\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__inventory_transaction__c.htm)** Captures Inventory Transaction records. This object is available in API version 54.0 and later. - **[cgcloud\_\_Inventory\_Transaction\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__inventory_transaction_template__c.htm)** Stores the details of the inventory control template that's to be used for inventory control transactions. This object is available in API version 54.0 and later. - **[cgcloud\_\_Job\_Definition\_List\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__job_definition_list__c.htm)** Stores the set of questions or surveys that are to be carried out in the respective call and contains further relevant configurations. This object is available in API version 54.0 and later. - **[cgcloud\_\_Job\_Definition\_List\_Account\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__job_definition_list_account__c.htm)** Stores the details of the relationship between job definition list and customer. This object is available in API version 54.0 and later. - **[cgcloud\_\_Job\_Definition\_List\_Account\_Set\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__job_definition_list_account_set__c.htm)** Junction object between Job Definition List and Customer Set. This object is available in API version 54.0 and later. - **[cgcloud\_\_Job\_Definition\_List\_Product\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__job_definition_list_product__c.htm)** Stores the details of the relationship between the Job Definition List and Product related lists. This object is available in API version 54.0 and later. - **[cgcloud\_\_Job\_Definition\_List\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__job_definition_list_template__c.htm)** Template that controls the behavior of Job definition lists. This object is available in API version 54.0 and later. - **[cgcloud\_\_Job\_Definition\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__job_definition_template__c.htm)** Stores the definition of the questions or product surveys that are available in the system. This object is available in API version 54.0 and later. - **[cgcloud\_\_Job\_DL\_Job\_Definition\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__job_dl_job_definition_template__c.htm)** This object stores the questions or surveys that are used in the job definition list. This object is available in API version 54.0 and later. - **[cgcloud\_\_Job\_DL\_Template\_Def\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__job_dl_template_def_template__c.htm)** Stores the list of job definition templates in the Job definition list template. When creating a job definition list based on this template, the assigned job definition templates are used to preset job definitions. This object is available in API version 54.0 and later. - **[cgcloud\_\_Job\_List\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__job_list__c.htm)** Stores the job lists that are generated from non-standard job definition lists. This object is available in API version 54.0 and later. - **[cgcloud\_\_Job\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__job_template__c.htm)** Stores whether a job is to be considered as either a task, a question, a product related question (survey), or any other object related job like capturing orders. This object is available in API version 54.0 and later. - **[cgcloud\_\_Listing\_Classification\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__listing_classification__c.htm)** Holds the information about the listing modules and the product category for a customer. This object is available in API version 54.0 and later. - **[cgcloud\_\_Listing\_Module\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__listing_module__c.htm)** This object stores information about listing modules for a product assortment. This object is available in API version 54.0 and later. - **[cgcloud\_\_Mobile\_Link\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__mobile_link__c.htm)** Deep Link Object. This object is available in API version 54.0 and later. - **[cgcloud\_\_Order\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__order__c.htm)** Stores the header details of the order entry. This object is available in API version 54.0 and later. - **[cgcloud\_\_Order\_Item\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__order_item__c.htm)** Stores the details of the order item object. This object is available in API version 54.0 and later. - **[cgcloud\_\_Order\_Item\_Inventory\_Transaction\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__order_item_inventory_transaction__c.htm)** Holds the association details for the order item template, the inventory control template, and the inventory transaction template. This object is available in API version 54.0 and later. - **[cgcloud\_\_Order\_Item\_Order\_Template\_Association\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__order_item_order_template_association__c.htm)** Holds the association of order item templates with order template. This object is available in API version 54.0 and later. - **[cgcloud\_\_Order\_Item\_Rule\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__order_item_rule__c.htm)** Defines the rules handled by the pricing engine during the complex pricing calculation. This object is available in API version 54.0 and later. - **[cgcloud\_\_Order\_Item\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__order_item_template__c.htm)** This template controls the behavior of an Order Item Template. For example, OrderEntry is an important template, which allows a sales document to behave like an order entry. This object is available in API version 54.0 and later. - **[cgcloud\_\_Order\_Payment\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__order_payment__c.htm)** Holds the attributes of the Order Payment object. This object is available in API version 54.0 and later. - **[cgcloud\_\_Order\_Payment\_Inventory\_Transaction\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__order_payment_inventory_transaction__c.htm)** Holds the association details for the order payment template, the inventory template, and the inventory transaction template. This object is available in API version 54.0 and later. - **[cgcloud\_\_Order\_Payment\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__order_payment_template__c.htm)** Holds the attributes of the order payment template. This object is available in API version 54.0 and later. - **[cgcloud\_\_Order\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__order_template__c.htm)** Template that controls the behavior of a sales document. This object is available in API version 54.0 and later. - **[cgcloud\_\_Order\_Template\_Order\_Payment\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__order_template_order_payment_template__c.htm)** Holds the association details for the order template and the order payment template. This object is available in API version 54.0 and later. - **[cgcloud\_\_Order\_Template\_Product\_Selector\_Group\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__order_template_product_selector_group__c.htm)** Stores the relation between Order Template and Product selection. This object is available in API version 54.0 and later. - **[cgcloud\_\_Org\_Unit\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__org_unit__c.htm)** Stores the details of the Organization unit object that defines a manufacturer's organizational structure. This object is available in API version 54.0 and later. - **[cgcloud\_\_Org\_Unit\_Hierarchy\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__org_unit_hierarchy__c.htm)** Stores the details of the relationship between two org units. It's typically used for the sales org unit hierarchy. This object is available in API version 54.0 and later. - **[cgcloud\_\_Org\_Unit\_User\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__org_unit_user__c.htm)** Stores the details of the relationship between the organization unit and the user. This object is available in API version 54.0 and later. - **[cgcloud\_\_Organization\_Setting\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__organization_setting__c.htm)** This object enables or disables the role hierarchy in a call module. This object is available in API version 54.0 and later. - **[cgcloud\_\_Package\_Setting\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__package_setting__c.htm)** This is a custom setting that helps you manage dynamic namespaces. This object is available in API version 54.0 and later. - **[cgcloud\_\_Picklist\_Toggle\_Addon\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__picklist_toggle_addon__c.htm)** This is a non-data object. It's purely used to define different picklists, which are retail mobile only or that don't have any real corresponding field in the RCG back end. These picklists are then mapped with the Picklist-Toggle-Mapping concepts in Sync Package. This object is available in API version 54.0 and later. - **[cgcloud\_\_POS\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__pos__c.htm)** Stores the details of the POS object. A Point of Sale (POS) stores the information about a place in the customer's premises at which goods are sold to consumers. This object is available in API version 54.0 and later. - **[cgcloud\_\_POS\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__pos_template__c.htm)** Stores the details of the POS template object that's to be used for POS (Point of Sale). This object is available in API version 54.0 and later. - **[cgcloud\_\_Product\_Condition\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__product_condition__c.htm)** This object uses product-specific conditions. For example, specifying product prices that are relevant for simple order value calculation. This object is available in API version 54.0 and later. - **[cgcloud\_\_Product\_Listing\_Module\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__product_listing_module__c.htm)** Add products to Product Assortment with listing modules. This object is available in API version 54.0 and later. - **[cgcloud\_\_Product\_Assortment\_Order\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__product_assortment_order_template__c.htm)** Stores the details of the relationship between product assortment and order template. This object is available in API version 54.0 and later. - **[cgcloud\_\_Product\_Assortment\_Store\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__product_assortment_store__c.htm)** The object holds the customers (stores) for which the Product assortment (authorization list) is valid. The store assignment is taken from the trade org hierarchy by the batch process that represents the listing finding. This object is available in API version 54.0 and later. - **[cgcloud\_\_Promotion\_Hurdle\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__promotion_hurdle__c.htm)** This object stores the restriction that must be satisfied to apply the rewards. This object is available in API version 54.0 and later. - **[cgcloud\_\_Promotion\_Hurdle\_Expression\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__promotion_hurdle_expression__c.htm)** New object that stores the information about an expression. This object is available in API version 54.0 and later. - **[cgcloud\_\_Promotion\_Reward\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__promotion_reward__c.htm)** This object stores the details of rewards that are assigned to a reward group. This object is available in API version 54.0 and later. - **[cgcloud\_\_Promotion\_Reward\_Group\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__promotion_reward_group__c.htm)** This object holds the details of the reward group that's assigned to a promotion. This object is available in API version 54.0 and later. - **[cgcloud\_\_Promotion\_Reward\_Product\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__promotion_reward_product__c.htm)** This object stores the details of the product that's assigned to a promotion reward. This object is available in API version 54.0 and later. - **[cgcloud\_\_Promotion\_Sales\_Folder\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__promotion_sales_folder__c.htm)** Junction object between Promotion and Sales folder. This object is available in API version 54.0 and later. - **[cgcloud\_\_Promotion\_Store\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__promotion_store__c.htm)** This object holds the relation for the customer promotion hierarchy. This object is available in API version 54.0 and later. - **[cgcloud\_\_Sales\_Folder\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__sales_folder__c.htm)** This object contains the attributes that are associated with the Sales Folder. This object is available in API version 54.0 and later. - **[cgcloud\_\_Sales\_Folder\_Sell\_Sheet\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__sales_folder_sell_sheet__c.htm)** This object stores the details of the relationship between the sales folder and sell sheet. This object is available in API version 54.0 and later. - **[cgcloud\_\_Sales\_Folder\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__sales_folder_template__c.htm)** This object contains the attributes that are associated with the Sales Folder Template. This object is available in API version 54.0 and later. - **[cgcloud\_\_Sell\_Sheet\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__sell_sheet__c.htm)** This object contains the attributes that are associated with the sell sheet to be used on the Sales folder. This object is available in API version 54.0 and later. - **[cgcloud\_\_Signature\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__signature__c.htm)** This object stores the attributes for signatures. This object is available in API version 54.0 and later. - **[cgcloud\_\_Signature\_Attribute\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__signature_attribute__c.htm)** Entity that stores the attributes and values for signatures. This object is available in API version 54.0 and later. - **[cgcloud\_\_Signature\_Flow\_Step\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__signature_flow_step__c.htm)** This object stores the details of the signature flow steps that are used in a signature template. This object is available in API version 54.0 and later. - **[cgcloud\_\_Signature\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__signature_template__c.htm)** Stores the details of the signature template object that's used for signature flow steps. This object is available in API version 54.0 and later. - **[cgcloud\_\_Substitution\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__substitution__c.htm)** The use case stores the details of the substitute object that specifies the basis of a substitution depending on a substitution period and user. This object is available in API version 54.0 and later. - **[cgcloud\_\_System\_Number\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__system_number__c.htm)** This object specifies the number definition that's used for number generation on CAS OnPremise Mobility. This object is available in API version 54.0 and later. - **[cgcloud\_\_System\_Number\_Last\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__system_number_last__c.htm)** Last used number of a specific number type and device. This object is available in API version 54.0 and later. - **[cgcloud\_\_System\_Number\_Segment\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__system_number_segment__c.htm)** Segment of the number definition. This object is available in API version 54.0 and later. - **[cgcloud\_\_Trip\_List\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__trip_list__c.htm)** Use Trip List to plan visits based on a predefined sequence of customers. This object is available in API version 54.0 and later. - **[cgcloud\_\_Trip\_List\_Account\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__trip_list_account__c.htm)** The object stores the association between a trip list and a customer. This object is available in API version 54.0 and later. - **[cgcloud\_\_Unit\_of\_Measure\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__unit_of_measure__c.htm)** Stores the details of the units of measure (logistic unit) of a product. This object is available in API version 54.0 and later. - **[cgcloud\_\_User\_Accountable\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__user_accountable__c.htm)** Represents a Sales Rep or Supervisor or other Retail Execution user who is accountable for a Retail Execution business process. This object is available in API version 55.0 and later. - **[cgcloud\_\_User\_Document\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__user_document__c.htm)** Stores the details of the daily report object. This object is available in API version 54.0 and later. - **[cgcloud\_\_User\_Document\_Activity\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__user_document_activity__c.htm)** Stores the details of the relationship between the daily report and user activity. This object is available in API version 54.0 and later. - **[cgcloud\_\_User\_Document\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__user_document_template__c.htm)** Stores the details of the daily report template, which is to be used for daily reports. This object is available in API version 54.0 and later. - **[cgcloud\_\_User\_Document\_Template\_Activity\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__user_document_template_activity__c.htm)** Stores the details of the relationship between the daily report template and user activity. This object is available in API version 54.0 and later. - **[cgcloud\_\_Visit\_Job\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__visit_job__c.htm)** This object contains answered questions and product surveys (jobs). This object is available in API version 54.0 and later. - **[cgcloud\_\_Visit\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__visit_template__c.htm)** Template that describes the basic call behavior. This object is available in API version 54.0 and later. - **[cgcloud\_\_Warehouse\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__warehouse__c.htm)** Stores the details of the warehouse object. An organizational segmentation for the purpose of maintaining materials that are stored in different places. This object is available in API version 54.0 and later. - **[cgcloud\_\_Warehouse\_Product\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__warehouse_product__c.htm)** Stores the relationship between a warehouse and a product. This object is available in API version 54.0 and later. - **[cgcloud\_\_Warehouse\_User\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__warehouse_user__c.htm)** Stores the details of the relationship between a warehouse and a user. This object is available in API version 54.0 and later. - **[cgcloud\_\_Workflow\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__workflow__c.htm)** Stores the attributes of the workflow. This object is available in API version 54.0 and later. - **[cgcloud\_\_Workflow\_State\_Transition\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__workflow_state_transition__c.htm)** Stores the details of the workflow state transition. This object is available in API version 54.0 and later. # Custom Objects for Retail Execution and Trade Promotion Management The consumer goods data model provides objects and fields that supports both RE and TPM. - **[cgcloud\_\_Account\_Condition\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_condition__c.htm)** Contains the details of the relationship between customer and the customer conditions. This object is available in API version 54.0 and later. - **[cgcloud\_\_Account\_Extension\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_extension__c.htm)** This object records account roles and further product-related attributes. This object is available in API version 54.0 and later. - **[cgcloud\_\_Account\_Manager\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_manager__c.htm)** This object stores the details of users who manage specific accounts in a particular function (ManagementType). This object is available in API version 54.0 and later. - **[cgcloud\_\_Account\_Relationship\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_relationship__c.htm)** This object represents the relationship between two customer accounts. This object is available in API version 54.0 and later. - **[cgcloud\_\_Account\_Set\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_set__c.htm)** Represents the object for the creation of Customer Sets. This object is available in API version 54.0 and later. - **[cgcloud\_\_Account\_Set\_Account\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_set_account__c.htm)** Junction object between Customer and Customer Set. This object is available in API version 54.0 and later. - **[cgcloud\_\_Account\_Set\_Manager\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_set_manager__c.htm)** Custom object to store the relation between Customer Set and User. This object is available in API version 54.0 and later. - **[cgcloud\_\_Account\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_template__c.htm)** Stores the details of the account template object that's to be used for accounts. This object is available in API version 54.0 and later. - **[cgcloud\_\_Account\_Trade\_Org\_Hierarchy\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_trade_org_hierarchy__c.htm)** This object represents the details of the account hierarchy. This object is available in API version 54.0 and later. - **[cgcloud\_\_Account\_Org\_Unit\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_org_unit__c.htm)** Contains the details of the relationship between customer and the org unit. This object is available in API version 54.0 and later. - **[cgcloud\_\_Batch\_Run\_Status\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__batch_run_status__c.htm)** Keeps track of batch processes. This object is available in API version 54.0 and later. - **[cgcloud\_\_Batch\_Run\_Status\_Detail\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__batch_run_status_detail__c.htm)** Collects further batch monitoring details. This object is available in API version 54.0 and later. - **[cgcloud\_\_CGCPS\_Service\_Settings\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__cgcps_service_settings__c.htm)** Use this custom setting to either enable or disable CGCPS service data mocking. With this setting, you can develop non-CGCPS service-enabled orgs. This object is available in API version 54.0 and later. - **[cgcloud\_\_Condition\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__condition_template__c.htm)** Stores the details of the condition template object. This object is available in API version 54.0 and later. - **[cgcloud\_\_Custom\_Permission\_User\_Role\_Mapping\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__custom_permission_user_role_mapping__c.htm)** This object assigns (Mapping) mobility user roles to permission sets. This object is available in API version 54.0 and later. - **[cgcloud\_\_Flatten\_Account\_Hierarchy\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__flatten_account_hierarchy__c.htm)** This object stores node hierarchy information for the Customer Segmentation functionality. This object is available in API version 54.0 and later. - **[cgcloud\_\_Product\_Assortment\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__product_assortment_template__c.htm)** Template for product assortments. Controls the behavior of the instances of this template. For example, if a business partner is to be specified (AccountMultiplicity). This table is dependent on the sales organization. This object is available in API version 54.0 and later. - **[cgcloud\_\_Product\_Category\_Share\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__product_category_share__c.htm)** This business class contains the product categories or brands that a user manages. This object is available in API version 54.0 and later. - **[cgcloud\_\_Product\_Hierarchy\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__product_hierarchy__c.htm)** Relation from a product (Child\_Product) to its parent. This relation is time-framed. This object is available in API version 54.0 and later. - **[cgcloud\_\_Product\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__product_template__c.htm)** Stores the details of the product template object that's used for products. This object is available in API version 54.0 and later. - **[cgcloud\_\_Promotion\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__promotion__c.htm)** Promotion is an activity of a user that includes the definition of prices for a time segment. This object is available in API version 54.0 and later. - **[cgcloud\_\_Promotion\_Attachment\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__promotion_attachment__c.htm)** You can add pictures as attachments to a promotion. This object is available in API version 54.0 and later. - **[cgcloud\_\_Promotion\_Attachment\_Link\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__promotion_attachment_link__c.htm)** Relationship between promotion and promotion attachment. This object is available in API version 54.0 and later. - **[cgcloud\_\_Promotion\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__promotion_template__c.htm)** Template to create promotions. This object is available in API version 54.0 and later. - **[cgcloud\_\_Promotion\_Template\_Hierarchy\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__promotion_template_hierarchy__c.htm)** Object that helps create promotion hierarchies. This object is available in API version 54.0 and later. - **[cgcloud\_\_Promotion\_Template\_Tactic\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__promotion_template_tactic_template__c.htm)** Junction Object between Promotion Templates and Tactic Templates. This object is available in API version 54.0 and later. - **[cgcloud\_\_Sales\_Organization\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__sales_organization__c.htm)** This object stores the details of the Sales Organization. This object is available in API version 54.0 and later. - **[cgcloud\_\_Sales\_Organization\_User\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__sales_organization_user__c.htm)** This object stores the details of the relationship between a sales organization and a user. This object is available in API version 54.0 and later. - **[cgcloud\_\_Segmentation\_Rule\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__segmentation_rule__c.htm)** This object stores the details of the segmentation rule. This object is available in API version 54.0 and later. - **[cgcloud\_\_Segmentation\_Rule\_Def\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__segmentation_rule_def__c.htm)** Contains the available queries and its attributes to create segmentation rules. This object is available in API version 54.0 and later. - **[cgcloud\_\_Segmentation\_Rule\_Def\_Column\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__segmentation_rule_def_column__c.htm)** This object defines the query attributes of the Segmentation Rule Definition. This object is available in API version 54.0 and later. - **[cgcloud\_\_Segmentation\_Rule\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__segmentation_rule_template__c.htm)** This object contains information that configures the behavior for the associated segmentation rules. This object is available in API version 54.0 and later. - **[cgcloud\_\_System\_Setting\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__system_setting__c.htm)** Custom setting that stores all system setting attributes as a key-value pair. This object is available in API version 54.0 and later. - **[cgcloud\_\_Trigger\_Setting\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__trigger_setting__c.htm)** Custom Setting, helper object that enables clients to disable certain triggers that are part of the managed package. This object is available in API version 54.0 and later. - **[cgcloud\_\_Tactic\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tactic__c.htm)** Configures the relation between a Promotion and a Tactic. This object is available in API version 54.0 and later. - **[cgcloud\_\_Tactic\_Product\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tactic_product__c.htm)** Junction object between Tactic and Product. This object is available in API version 54.0 and later. - **[cgcloud\_\_Tactic\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tactic_template__c.htm)** Template that controls the behavior of a tactic. This object is available in API version 54.0 and later. - **[cgcloud\_\_Transaction\_Log\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__transaction_log__c.htm)** This object contains all transaction log messages that are related to CG. This object is available in API version 54.0 and later. - **[cgcloud\_\_Update\_Activation\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__update_activation__c.htm)** This custom setting defines the sales org-specific update activation record to make sure that maintenance is only possible by using the Update Activation page. This object is available in API version 54.0 and later. - **[cgcloud\_\_User\_Setting\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__user_setting__c.htm)** Object that's created to store user settings. This object is available in API version 54.0 and later. - **[cgcloud\_\_Validation\_Rules\_Setting\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__validation_rules_setting__c.htm)** Custom setting that manages various validation rules, such as granting bypass access. This object is available in API version 54.0 and later. # Custom Objects for Sync Management Consumer Goods Cloud data model provides custom objects and fields to support sync management. - **[cgc\_sync\_\_Sync\_API\_Log\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_api_log__c.htm)** Stores performance information that's executed on synchronization endpoints. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Client\_App\_Profile\_Mapping\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_client_app_profile_mapping__c.htm)** Maps either a user, role, or profile to a specific sync configuration. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Client\_Registration\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__client_registration__c.htm)** Stores the details of the Consumer Goods Cloud offline mobile app device that a synchronization request to Salesforce is initiated from. This object is available in API version 61.0 and later. - **[cgc\_sync\_\_Sync\_Config\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_config__c.htm)** Represents the settings for synchronization engine client and its backend. For example, background sync, sync on startup, and Apex endpoint thresholds. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_ID\_Mapping\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_id_mapping__c.htm)** Contains information about the mappings of the local mobile application IDs to Salesforce IDs. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_History\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_history__c.htm)** Stores information about every sync that's performed on the mobile app along with its status information and associated Key Performance Indicators (KPIs). This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_History\_Detail\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_history_detail__c.htm)** Contains detailed information about all sync history records. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Message\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_message__c.htm)** Represents the messages that are exposed to a mobile app user during the sync process. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Message\_Translation\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_message_translation__c.htm)** Contains translated sync messages. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Metadata\_Changes\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_metadata_changes__c.htm)** Stores the timestamps for the changes that are made in the metadata. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Component\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_mobile_app_component__c.htm)** Contains the settings for different customizable UI components in the theme. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Domain\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_mobile_app_domain__c.htm)** Stores information about domains that are available as dropdown boxes in the mobile app. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_mobile_app_depl_pkg__c.htm)** Deployment packages that contain application runtime artifacts of the mobile app. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_As\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_mobile_app_depl_pkg_as__c.htm)** Contains information about the recipient of the deployment package. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Depl\_Pkg\_Inst\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_mobile_app_depl_pkg_inst__c.htm)** Maintains a record of the installed deployment packages, their installation timestamps, and devices on which those packages are deployed. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Installation\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_mobile_app_installation__c.htm)** Contains information about the user to whom the deployment package is to be distributed. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Log\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_mobile_app_log__c.htm)** Stores the error messages and warnings that occurred in the mobile app. Such error messages and warnings are uploaded every time a user runs the upload to Salesforce action in the mobile app. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Macro\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_mobile_app_macro__c.htm)** Contains the color macros that are used for themes. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Config\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_mobile_app_pl_config__c.htm)** Contains the mapping information of picklists for dropdown boxes in the mobile app. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Map\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_mobile_app_pl_map__c.htm)** Contains the mapping information of picklists and dropdown boxes in the mobile application. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Map\_Ext\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_mobile_app_pl_map_ext__c.htm)** Contains the mapping information of picklists and dropdown boxes in the mobile app. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_PL\_Repo\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_mobile_app_pl_repo__c.htm)** Represents the repository of dropdown boxes in a mobile app. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Mobile\_App\_Theme\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_mobile_app_theme__c.htm)** Represents the themes of a mobile app. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Named\_Fetch\_Tree\_Nodes\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_named_fetch_tree_nodes__c.htm)** Contains information about the nodes that are used to construct the tree structure of sync objects. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Named\_Query\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_named_query__c.htm)** Contains details and SOQL (Salesforce Object Query Language) statements for a named query. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Remote\_Request\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_remote_request__c.htm)** Stores requests to trigger technical activities on the mobile app. For example, data resupply and clean-up upload queue. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Report\_Links\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_report_links__c.htm)** Contains information about the conjunction object for reports and related logs. This object is available in API version 53.0 and later. - **[cgc\_sync\_\_Sync\_Tracked\_Object\_Config\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgc_sync_r1__sync_tracked_object_config__c.htm)** Contains configurations for tracked objects including data distribution, sync settings, and client schema. This object is available in API version 53.0 and later. # Custom Objects for Trade Promotion Management The Consumer Goods Cloud data model provides objects and fields to support Trade Promotion Management (TPM). To learn about the custom objects that are common between Retail Execution and Trade Promotion Management, refer to [Custom Objects for Retail Execution and Trade Promotion Management](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_236_tpm_custom_objects.htm "The consumer goods data model provides objects and fields that supports both RE and TPM.") - **[cgcloud\_\_Account\_Sub\_Account\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_sub_account__c.htm)** Defines the account to sub-account relationship. This object is available in API version 54.0 and later. - **[cgcloud\_\_Account\_Plan\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_plan__c.htm)** 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. - **[cgcloud\_\_Account\_Plan\_Category\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_plan_category__c.htm)** Categories of the account plan including the manual inputs. Categories can be assigned to an account plan. A category can only be assigned to one account/business year combination. This object is available in API version 54.0 and later. - **[cgcloud\_\_Account\_Plan\_User\_Filter\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_plan_user_filter__c.htm)** Contains the filter selections of a user for a planning account. This object is available in API version 54.0 and later. - **[cgcloud\_\_Account\_Product\_Profile\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__account_product_profile__c.htm)** This object stores statistical profiles that indicate the distribution of weekly data between a customer and category. This object is available in API version 54.0 and later. - **[cgcloud\_\_Auto\_Number\_Sequence\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__auto_number_sequence__c.htm)** Stores information about the numbered index of the next transaction log record. This object is available in API version 54.0 and later. - **[cgcloud\_\_Business\_Year\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__business_year__c.htm)** This object stores the attributes of the Business Year. This object is available in API version 54.0 and later. - **[cgcloud\_\_Condition\_Search\_Group\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__condition_search_group__c.htm)** Holds the attributes of Condition Search Group. This object is available in API version 55.0 and later. - **[cgcloud\_\_Condition\_Search\_Rule\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__condition_search_rule__c.htm)** Holds the attributes of Condition Search Rule. This object is available in API version 55.0 and later. - **[cgcloud\_\_Custom\_Period\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__custom_period__c.htm)** This object stores the attributes of the custom period. This object is available in API version 54.0 and later. - **[cgcloud\_\_Custom\_Calendar\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__custom_calendar__c.htm)** This object stores the attributes of the custom calendar. This object is available in API version 54.0 and later. - **[cgcloud\_\_Fund\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__fund__c.htm)** A fund is the amount of money that's given to an employee for a special reason during a specific business period. This money is used to pay special activities such as promotion campaigns. This object is available in API version 54.0 and later. - **[cgcloud\_\_Fund\_Product\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__fund_product__c.htm)** A Fund object can be linked to multiple brands or categories based on the fund template settings. This object is available in API version 54.0 and later. - **[cgcloud\_\_Fund\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__fund_template__c.htm)** Template for the creation of a Fund. This object is available in API version 54.0 and later. - **[cgcloud\_\_Fund\_Transaction\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__fund_transaction__c.htm)** Holds the fund transaction details. This object is available in API version 54.0 and later. - **[cgcloud\_\_Fund\_Transaction\_Header\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__fund_transaction_header__c.htm)** Fund Transaction Header object facilitates the creation of multiple fund transactions in either a multiple source or target fund business scenario. This object dictates key fields such as the fund transaction template. The source or target funds for the fund transaction records to be created are based on transaction types such as Transfer, drawback, and more. This object is available in API version 54.0 and later. - **[cgcloud\_\_Fund\_Transaction\_Row\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__fund_transaction_row__c.htm)** Transaction rows for the funds. This object is available in API version 54.0 and later. - **[cgcloud\_\_Fund\_Transaction\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__fund_transaction_template__c.htm)** Template for the creation of a transaction for the Fund. This object is available in API version 54.0 and later. - **[cgcloud\_\_KPI\_Definition\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__kpi_definition__c.htm)** Contains the description of a single measure. The fields of the table can be derived from the current KPI\_Set .json file. This object is available in API version 54.0 and later. - **[cgcloud\_\_KPI\_Map\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__kpi_map__c.htm)** Holds the information about the KPI Map configuration. This object is available in API version 54.0 and later. - **[cgcloud\_\_KPI\_Set\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__kpi_set__c.htm)** This table contains information about KPI Set Configuration. This object is available in API version 54.0 and later. - **[cgcloud\_\_KPI\_Set\_KPI\_Definition\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__kpi_set_kpi_definition__c.htm)** Junction object between KPI Definition and KPI Definition Set. This object is available in API version 54.0 and later. - **[cgcloud\_\_Payment\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__payment_template__c.htm)** 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\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__payment__c.htm)** 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\_External\_Reference\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__payment_external_reference__c.htm)** This object contains the hyperlinks that are related to a payment record. This object is available in API version 54.0 and later. - **[cgcloud\_\_Payment\_Tactic\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__payment_tactic__c.htm)** This object represents the relationship between Fund and Payment Tactic junction objects. This object is available in API version 54.0 and later. - **[cgcloud\_\_Payment\_Tactic\_Fund\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__payment_tactic_fund__c.htm)** This object stores the relationship between the Fund and Payment Tactic junction objects. This object is available in API version 54.0 and later. - **[cgcloud\_\_Payment\_Tactic\_Product\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__payment_tactic_product__c.htm)** This object contains payment tactic products and assigned values at the LDP level or at the level that the project defines as payment product level. This object is available in API version 54.0 and later. - **[cgcloud\_\_Payment\_Tactic\_Product\_Manual\_Input\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__payment_tactic_product_manual_input__c.htm)** Stores manual inputs for payment tactic-specific manual inputs. This object is available in API version 54.0 and later. - **[cgcloud\_\_Product\_Part\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__product_part__c.htm)** Stores the details of the relationship between two products. Describes which and how many products (ChildPKey) are assembled into a parent product (ParentPKey). In comparison to a product assortment, the result is a real product. This relation is only used as information; it can't be used to define a set of products to be used in other applications. This object is available in API version 54.0 and later. - **[cgcloud\_\_Product\_Assortment\_Product\_Share\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__product_assortment_product_share__c.htm)** This object stores the details of categories that are assigned to a Product assortment. This object is available in API version 54.0 and later. - **[cgcloud\_\_Promotion\_Calculation\_Server\_Offset\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__promotion_calculation_server_offset__c.htm)** Stores the time range during which the server (Offplatform) calculates a Promotion. This object is available in API version 54.0 and later. - **[cgcloud\_\_Promotion\_Product\_Share\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__promotion_product_share__c.htm)** This object holds the details of categories that are assigned to a promotion. This object is available in API version 54.0 and later. - **[cgcloud\_\_Promotion\_Push\_Status\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__promotion_push_status__c.htm)** Contains for each push process an entry that contains the status and statistics for the push. This object is available in API version 54.0 and later. - **[cgcloud\_\_Rate\_Based\_Funding\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__rate_based_funding__c.htm)** 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\_\_RBF\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__rbf_template__c.htm)** Creation template for Rate-based Funding (RBF) records. This object is available in API version 54.0 and later. - **[cgcloud\_\_RBF\_Category\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__rbf_category__c.htm)** Junction object between Rate Based Funding and Product for driving RBF and Product association. This object is available in API version 54.0 and later. - **[cgcloud\_\_RBF\_Product\_Manual\_Input\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__rbf_product_manual_input__c.htm)** This object represents the junction between Rate-based Funding and Product. This object is available in API version 54.0 and later. - **[cgcloud\_\_RTR\_Report\_Configuration\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__rtr_report_configuration__c.htm)** This object contains Real Time Report (RTR) Configurations. One record defines the data that's to be loaded for a report and what or how it gets shown in a declarative manner. This object is available in API version 54.0 and later. - **[cgcloud\_\_Smart\_UI\_Lightning\_Settings\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__smart_ui_lightning_settings__c.htm)** Internal Object contains Smart UI configurations. This object is available in API version 54.0 and later. - **[cgcloud\_\_Tactic\_Fund\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tactic_fund__c.htm)** This object stores the relationship between the Fund and Payment Tactic junction objects. This object is available in API version 54.0 and later. - **[cgcloud\_\_Tactic\_Condition\_Creation\_Definition\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tactic_condition_creation_definition__c.htm)** Holds the details of tactic condition creation definition. This object is available in API version 55.0 and later. - **[cgcloud\_\_Tactic\_Product\_Condition\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tactic_product_condition__c.htm)** Use this object to store the internal conditions that are generated out of promotions. This object is available in API version 54.0 and later. - **[cgcloud\_\_Tactic\_Template\_Cond\_Creation\_Def\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tactic_template_cond_creation_def__c.htm)** Contains the configuration of condition creation definitions that will be generated for the related tactic. This object is available in API version 55.0 and later. - **[cgcloud\_\_Tactic\_Template\_Fund\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tactic_template_fund_template__c.htm)** Junction object between tactic template and fund template. This object defines the valid fund types for the given tactic template. This object is available in API version 54.0 and later. - **[cgcloud\_\_UI\_Contract\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__ui_contract__c.htm)** This object contains the contract information for templates that are used in the smart UI. This object is available in API version 54.0 and later. - **[cgcloud\_\_User\_View\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__user_view__c.htm)** This object is a User and View relation junction object. This object is available in API version 54.0 and later. - **[cgcloud\_\_View\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__view__c.htm)** This object stores the filter criteria for the trade calendar. This object is available in API version 54.0 and later. - **[cgcloud\_\_Week\_Day\_Share\_Profile\_\_c](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_cgcloud__week_day_share_profile__c.htm)** Contains statistical profiles of the distribution of weekly data among different days of a week. This object is available in API version 54.0 and later. # Customize the Promotion Transfer Process To modify the promotion details being transferred, create a callable Apex class as a customization hook. 1. Log in to your Salesforce org, and go to Developer Console. 2. Create a global Apex class that implements the System.Callable interface. 3. Override the global call method that has these parameters. - action: String. The behavior for the method to exhibit. - params: Map. Arguments to be used by the specified action. The object is of type List. The RE\_PromotionTransfer class exposes methods to access the promotion. For a list of all the exposed methods, see [RE\_PromotionTransfer Class Reference](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/RE_promotion_transfer_class.htm "The RE_PromotionTransfer Apex class provides programmatic access to the RE_PromotionTransfer sObject and its related sObjects."). Here’s the Apex class structure. global class implements System.Callable { global Object call(String action, Map params) { // Get the RE\_PromotionTransfer instances from the arguments List promotionTransferWrapper = (List) params.get('promotionTransfer'); // Your custom logic goes here return promotionTransferWrapper; } } 4. To modify the promotion fields, use the methods exposed by the RE\_PromotionTransfer class. Add your customizations in the Apex class to: - Create promotion records. - Modify and delete existing promotion records. Here’s a sample Apex class that adds a new promotion sObject record during the promotion save process. global class PromotionTransferSaveCust implements System.Callable { global Object call(String action, Map < String, Object > params) { // Get the List of RE\_PromotionTransfer instances List < cgcloud.RE\_PromotionTransfer > promotionTransferWrapperList = (List < cgcloud.RE\_PromotionTransfer > ) params.get('promotionTransfer'); //Get the first Promotion Record from the wrapper cgcloud\_\_Promotion\_\_c record = (cgcloud\_\_Promotion\_\_c) promotionTransferWrapper\[0\].getPromotion().getRecord(); List < cgcloud\_\_Promotion\_\_c > promotionList = new List < cgcloud\_\_Promotion\_\_c > (); for (Integer count = 0; count < 1; count++) { cgcloud\_\_Promotion\_\_c newPromotion = new cgcloud\_\_Promotion\_\_c(); newPromotion.cgcloud\_\_Slogan\_Language\_1\_\_c = record.cgcloud\_\_Slogan\_Language\_1\_\_c + count; promotionList.add(newPromotion); newPromotion.cgcloud\_\_Promotion\_Template\_\_c = 'a2X8D0000003NHQUA2'; //Update the new promotion with the target Promotion Template newPromotion.cgcloud\_\_Date\_From\_\_c = Date.newInstance(2023, 9, 9); newPromotion.cgcloud\_\_Date\_Thru\_\_c = Date.newInstance(2023, 9, 12); newPromotion.RecordTypeId = '0128D000002MRKEQA4'; //Update the new promotion with the correct Record Type ID promotionTransferWrapper.add(new cgcloud.RE\_PromotionTransfer(newPromotion)); } return promotionTransferWrapper; } } For use cases related to the promotion and tactic transfer process customization, see [Promotion and Tactic Transfer Customization Use Cases](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tactic_transfer_apex_save_customization.htm "This section provides different Apex customization use cases for the promotion and tactic transfer process."). 5. From Setup, in the Quick Find box, enter Custom Metadata Types, and then expand **Custom Metadata Types**. 6. On the **CGCloud Process Customization** row, click **Manage Records**. 7. Click **New**, fill in these details, and then save your work. - **Label**: RE\_Promotion\_Transfer\_Save - **DeveloperName**: RE\_Promotion\_Transfer\_Save - **Class**: - **Method**: save - **Enabled**: Select the checkbox. The Apex customization hook is enabled. When a planned promotion is saved in TPM, the call method modifies the existing promotion. Or it adds a promotion record based on your custom logic before transferring it to RE, where the promotion becomes sellable. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note The transfer of custom attributes is supported only for advanced promotion, tactic, and tactic product objects. # Customize the Retail Order Proposal List Creation Process To customize the order proposal list creation process, create a callable Apex class as a customization hook. 1. Log in to your Salesforce org, and go to Developer Console. 2. Create a global Apex class that implements the System.Callable interface. 3. Override the global call method that has these parameters. - action: String. The behavior for the method to exhibit. - params: Map. Arguments to be used by the specified action. Here’s the Apex class structure. global class implements System.Callable { global Object call(String action, Map params) { // Retrieve the list of proposed products from the parameters List products = (List) params.get('products'); // Retrieve the account ID and order ID from the parameters Id accountId = (Id) params.get('accountId'); Id orderId = (Id) params.get('orderId'); // Initialize a list to store product IDs List productIdList = new List(); // Custom code to add or remove products // Add or remove product IDs to/from productIdList as needed // Return the productIdList in JSON string format return JSON.serialize(productIdList); } } 4. Modify the list of products displayed on the order proposal list UI based on your custom logic. Here’s a sample Apex code that adds additional product IDs from a custom object, Proposed\_Products\_\_c, and the IDs that belong to the beverages product category to the list of proposed products. global class OrderProposalListCustomization implements System.Callable { public class CustomizationException extends Exception { } public Object call(String m, Map params) { List products = (List) params.get('products'); Id accountId = (Id) params.get('accountId'); Id orderId = (Id) params.get('orderId'); List productIdList = new List(); Integer productListSize = 4; // Get the account name List accountList = \[ SELECT Id, Name FROM Account WHERE Id = :accountId LIMIT 1 \]; if (!accountList.isEmpty()) { Account account = accountList\[0\]; // If the account name contains 'NTO', display a higher number of products. if (account.Name.contains('NTO')) { productListSize = 12; } } for (Integer i = 0; i < productListSize; i++) { productIdList.add(products.get(i).Id); } return JSON.serialize(productIdList); } } 5. From Setup, in the Quick Find box, enter Custom Metadata Types, and then expand **Custom Metadata Types**. 6. Click **Manage Records** on the **CGCloud Process Customization** row. 7. Click **New**, fill in these details, and then save your work. - **Label**: RE\_Order\_Proposal\_List - **DeveloperName**: RE\_Order\_Proposal\_List - **Class**: - **Method**: proposalList - **Enabled**: Select the checkbox ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note Before invoking the customization hook, ensure that the Consider Listing setting in Order Template is set to Yes. Your Apex customization hook is enabled. When an order proposal list is created, the call method modifies the proposed product list based on your custom logic. # Customize the Retail Order Save Process To customize the retail order save process, create a callable Apex class as a customization hook. 1. Log in to your Salesforce org, and go to Developer Console. 2. Create a global Apex class that implements the System.Callable interface. 3. Override the global call method that has these parameters. - action: String. The behavior for the method to exhibit. - params: Map. Arguments to be used by the specified action. The object is of type RE\_Order. The RE\_Order class exposes methods to access the retail order sObject. For a list of all the exposed methods, see [RE\_Order Class Reference](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/RE_order_class.htm "This Apex class provides programmatic access to the retail order sObject, and its related sObjects."). Here’s the Apex class structure. global class implements System.Callable { global Object call(String action, Map params) { // Get the RE\_Order instances from the arguments cgcloud.RE\_Order orderWrapper = (cgcloud.RE\_Order) params.get('order'); // Get the Order SObject cgcloud\_\_Order\_\_c order = (cgcloud\_\_Order\_\_c) orderWrapper.getOrder().getRecord(); // Retrieve your custom state sent to UI String payloadString = (String) params.get('customState'); // Your custom logic goes here return null; } } 4. To modify the order fields, use the methods exposed by the RE\_Order class. Add your customizations in the Apex class to: - Create retail order records. - Modify and delete existing retail order records. Here’s a sample Apex class that adds a custom sObject record during the order save process. global class RetailOrderSaveCustomization implements System.Callable { public Object call(String m, Map params) { // Get the RE\_Order instance cgcloud.RE\_Order orderWrapper = (cgcloud.RE\_Order) params.get('order'); // Get the Order\_\_c SObject cgcloud\_\_Order\_\_c order = (cgcloud\_\_Order\_\_c) orderWrapper.getOrder() .getRecord(); /\*\* \* MyCustomSObject\_\_c is a custom object and it has a Custom\_\_c field. \* Use append method so that this new SObject will be created as part of the order save process. \*/ MyCustomSObject\_\_c mySObject = new MyCustomSObject\_\_c(); mySObject.Custom\_\_c = order.cgcloud\_\_Customer\_Order\_Id\_\_c; cgcloud.RE\_Order.Record myRecordWrapper = orderWrapper.append(mySObject); return null; } } For use cases related to the order save process customization, see [Retail Order Save Customization Use Cases](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/retail_order_apex_save_customization.htm "Here are the different Apex customization use cases for the retail order save process."). 5. From Setup, in the Quick Find box, enter Custom Metadata Types, and then expand **Custom Metadata Types**. 6. Click **Manage Records** on the **CGCloud Process Customization** row. 7. Click **New**, fill in these details, and then save your work. - **Label**: RE\_Order\_Save - **DeveloperName**: RE\_Order\_Save - **Class**: - **Method**: save - **Enabled**: Select the checkbox The Apex customization hook is enabled. When a retail order is saved, the call method modifies the saved order based on your custom logic. # Customize the Tactic Transfer Process To modify the tactic details related to the promotion being transferred, create a callable Apex class as a customization hook. 1. Log in to your Salesforce org, and go to Developer Console. 2. Create a global Apex class that implements the System.Callable interface. 3. Override the global call method that has these parameters. - action: String. The behavior for the method to exhibit.. - params: Map. Arguments to be used by the specified action. The object is of type List. The RE\_TacticTransfer class exposes methods to access the promotion and its tactic or tactic products. For a list of all the exposed methods, see [RE\_TacticTransfer Class Reference](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/RE_tactic_transfer_class.htm "The RE_TacticTransfer Apex class provides programmatic access to the RE_TacticTransfer sObject and its related sObjects."). Here’s the Apex class structure. global class < Your Callable APEX Class > implements System.Callable { global Object call(String action, Map < String, Object > params) { // Get the RE\_TacticTransfer instances from the arguments List < cgcloud.RE\_TacticTransfer > tacticTransferWrapper = (List < cgcloud.RE\_TacticTransfer > ) params.get('tacticTransfer'); // Your custom logic goes here return tacticTransferWrapper; } } 4. To modify the tactic or tactic product fields, use the methods exposed by the RE\_TacticTransfer class. Add your customizations in the Apex class to: - Create additional tactic records. - Modify and delete existing tactic records. Here’s a sample Apex class that adds additional tactic sObject records to a planned promotion that’s saved. global class TacticTransferSaveCust implements System.Callable { global Object call(String action, Map < String, Object > params) { // Get the RE\_TacticTransfer instances from the arguments List < cgcloud.RE\_TacticTransfer > tacticTransferWrapper = (List < cgcloud.RE\_TacticTransfer > ) params.get('tacticTransfer'); for (Integer count = 0; count < 2; count++) { cgcloud\_\_Tactic\_\_c newTactic = new cgcloud\_\_Tactic\_\_c(); newTactic.cgcloud\_\_Tactic\_Template\_\_c = 'a3A8D000000RFbnUAG'; newTactic.cgcloud\_\_Date\_From\_\_c = Date.newInstance(2023, 9, 9); newTactic.cgcloud\_\_Date\_Thru\_\_c = Date.newInstance(2023, 9, 12); newTactic.RecordTypeId = '0128D000002MRKIQA4'; newTactic.cgcloud\_\_Promotion\_\_c = 'a2Y8D000000g4kZUAQ'; tacticTransferWrapper.add(new cgcloud.RE\_TacticTransfer(newTactic)); } return tacticTransferWrapper; } } For use cases related to the promotion and tactic transfer process customization, see [Promotion and Tactic Transfer Customization Use Cases](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tactic_transfer_apex_save_customization.htm "This section provides different Apex customization use cases for the promotion and tactic transfer process."). 5. From Setup, in the Quick Find box, enter Custom Metadata Types, and then expand **Custom Metadata Types**. 6. On the **CGCloud Process Customization** row, click **Manage Records**. 7. Click **New**, fill the following details, and then save your work. - **Label**: RE\_Tactic\_Transfer\_Save - **DeveloperName**: RE\_Tactic\_Transfer\_Save - **Class**: - **Method**: save - **Enabled**: Select the checkbox. The Apex customization hook is enabled. When a planned promotion is saved in TPM, the call method modifies the tactic or tactic product details related to the promotion based on your custom logic before transferring it to RE. # Customize the TPM Calendar Launchpad To customize the promotion hover content and buttons on the TPM calendar launchpad UI, create a callable Apex class as a customization hook. 1. Log in to your Salesforce org, and go to Developer Console. 2. Create a global Apex class that implements the System.Callable interface. 3. Add the global call method with these parameters. - action: String. The behavior for the method to exhibit. - params: Map. Arguments with these key value pairs. - txId: String. ID of the transaction. - promoId: Id. ID of the promotion record. - promotionHoverContent: Object of type PromotionHoverContent. The PromotionHoverContent class exposes methods to access the UI elements and content on the promotion launchpad. For a list of all the exposed methods, see [PromotionHoverContent Class](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/promotion_content_hover_class.htm "The PromotionHoverContent Apex class provides programmatic access to the promotion hover content and the buttons on the trade calendar promotion launchpad UI."). global class < Your Callable APEX Class > implements System.Callable { global Object call(String action, Map < String, Object > params) { String txId = (String) params.get('txId'); Id promoId = (Id) params.get('promotionId'); PromotionHoverContent promoHoverContent = (PromotionHoverContent) params.get('promotionHoverContent'); // Your custom logic goes here return null; } } 4. To modify the content and the UI elements, use the methods exposed by the PromotionHoverContent class. You can add a maximum of 4 attributes and 8 KPIs on a promotion launchpad. Here’s a sample Apex class that modifies the header content, adds attributes and KPIs, and sets the visibility of the edit button to false on the promotion launchpad. global class TPM\_TC\_LaunchPad\_Cust implements System.Callable { global class CustomizationException extends Exception {} global Object call(String action, Map < String, Object > params) { String txId = (String) params.get('txId'); Id promoId = (Id) params.get('promotionId'); PromotionHoverContent promoHoverContent = (PromotionHoverContent) params.get('promotionHoverContent'); List < PromotionHoverContent.Attribute > attrs = promoHoverContent.getAttributes(); promoHoverContent.setAttributes( new List < PromotionHoverContent.Attribute > { new PromotionHoverContent.Attribute( attrs\[0\].getLabel() + '\_cust', attrs\[0\].getValue() + '\_cust' ), new PromotionHoverContent.Attribute( attrs\[1\].getLabel() + '\_cust', attrs\[1\].getValue() + '\_cust' ) } ); List < PromotionHoverContent.Kpi > kpis = promoHoverContent.getKPIs(); List < PromotionHoverContent.Kpi > newKpis = new List < PromotionHoverContent.Kpi > (); for (PromotionHoverContent.Kpi kpi: kpis) { newKpis.add( new PromotionHoverContent.Kpi( kpi.getReadCode(), kpi.getLabel() + '\_cust' ) ); } promoHoverContent.setKpis(newKpis); promoHoverContent.setHeaderRow1( promoHoverContent.getHeaderRow1() + '\_cust' ); promoHoverContent.setHeaderRow2( promoHoverContent.getHeaderRow2() + '\_cust' ); promoHoverContent.setHeaderRow3( promoHoverContent.getHeaderRow3() + '\_cust' ); promoHoverContent.setEditButtonVisible(false); return null; } } 5. From Setup, in the Quick Find box, enter Custom Metadata Types, and then expand **Custom Metadata Types**. 6. On the **CGCloud Process Customization** row, click **Manage Records**. 7. Click **New**, fill in these details, and then save your work. - **Label**: TPM\_TradePlanning\_PromotionHoverContent - **DeveloperName**: TPM\_TradePlanning\_PromotionHoverContent - **Class**: - **Method**: call - **Enabled**: Select the checkbox. The Apex customization hook is enabled. The call method updates the promotion launchpad on the trade calendar based on your custom logic. # Customize the TPM UI EARights Enable the global editability and visibility of a promotion or tactic by modifying its EARights. 1. Log in to your Salesforce org, and go to Developer Console. 2. Create a global Apex class that implements the System.Callable interface. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note Create two different Apex classes to modify the promotion and tactic EARights separately. 3. Override the global call method that has these parameters. - action: String. The behavior for the method to exhibit. - params: Map. Arguments to be used by the specified action. The object is of type List. Each EARightsAccess instance has properties that you can modify. For information on this class, see [EARightsAccess Class Reference](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/tpm_editaccessrights_class.htm "Use the EARightsAccess class to access EARights the application uses."). Here’s the Apex class structure for the promotion and tactic EARights customization. global class implements System.Callable { global Object call(String action, Map args) { // Read Transaction Id String txId = (String) args.get('txId'); // Get the Promotion Id Id promotionId = args.get('promotionId'); // Get the Promotion EARigths List promotionRights = (List) args.get('EARights'); // Your custom logic goes here } } global class implements System.Callable { global Object call(String action, Map args) { // Read Transaction Id String txId = (String) args.get('txId'); // Get the Promotion Id Id promotionId = args.get('promotionId'); // Get the Tactic EARigths List tacticRights = (List) args.get('EARights'); // Your custom logic goes here } } 4. To modify the EARights associated with a promotion or tactic, edit the properties of the associated EARightsAccess instance in the respective Apex class. For a list of modifiable promotion and tactic EARights, see [Modifiable Promotion and Tactic EARights](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/promotion_tactic_editaccessrights.htm "This section provides all the modifiable promotion and tactic EARights."). Here’s a sample Apex class that modifies the EARights of the promotion edit button associated with an existing promotion. global class MyEditAccessRightsHook implements System.Callable { global Object call(String action, Map args) { // Read Transaction Id String txId = (String) args.get('txId'); // Get the Promotion Id Id promotionId = args.get('promotionId'); // Get the EARigths List promotionRights = (List) args.get('EARights'); // Get the Promotion Template name List promos = \[ SELECT cgcloud\_\_Promotion\_Template\_\_r.Name FROM cgcloud\_\_Promotion\_\_c WHERE Id = :promotionId LIMIT 1 \]; // Check if its the target template Boolean isNoTactics = promos\[0\].cgcloud\_\_Promotion\_Template\_\_r.Name == 'No Tactics'; // Search the related EARightsAccess instance for (cgcloud.EARightsAccess acl : promotionRights) { if (acl.Name == 'PROMOTION\_EDIT\_BUTTON' && isNoTactics) { acl.Visible = false; acl.Editable = false; } } } } 5. From Setup, in the Quick Find box, enter Custom Metadata Types, and then expand **Custom Metadata Types**. 6. On the **CGCloud Process Customization** row, click **Manage Records**. 7. Click **New**, complete these fields, and then save your work. For promotion EARights customization, fill these details. - **Label**: TPM\_Promotion\_EARightsAccess\_Promotion - **DeveloperName**: TPM\_Promotion\_EARightsAccess\_Promotion - **Class**: - **Method**: save - **Enabled**: Select the checkbox. For tactic EARights customization, fill these details. - **Label**: TPM\_Promotion\_EARightsAccess\_Tactic - **DeveloperName**: TPM\_Promotion\_EARightsAccess\_Tactic - **Class**: - **Method**: save - **Enabled**: Select the checkbox. The Apex customization hook is enabled. The call method modifies the EARights of an existing promotion, or tactic based on your custom logic. # Data Source: Account and Promotion Measures This section provides sample code snippets for different data sources. An integration metadata report configuration using the data source AccountandPromotionMeasures requires the following dimensions: - accountdimension - promotiondimension - productdimension - kpidimension - timedimension - **[Example: Spreading Time Label](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_example_spreading_time_label.htm)** This example provides details on the integration metadata JSON with datasource AccountAndPromotionMeasures (time label spreaded). # Data Source: AccountMeasure This example provides details on the integration metadata JSON with the data source. This example provides details on the integration metadata JSON with the data source. The following example shows the datasources configuration payload for AccountMeasure. { "datasources": \[ { "name": "{{DatasourceName}}" } \], "dimensions": { "kpidimension": { "measures": \[ { "name": "ProPlanIncrVolume", "label": "Planned Incr. Volume" } \] } }, "exportsettings": { "csvseparator": ",", }, "exportfilters": { "conditions": \[\] } } # Data Source: AccountProductMeasure This example provides details on the integration metadata JSON with the data source. The following example shows the datasources configuration payload for AccountProductMeasure. { "datasources": \[ { "name": "{{DatasourceName}}" } \], "dimensions": { "kpidimension": { "measures": \[ { "name": "ProPlanIncrVolume", "label": "Planned Incr. Volume" } \] } }, "exportsettings": { "csvseparator": ",", }, "exportfilters": { "conditions": \[\] } } # Data Source: DailyRealData/DailyIntData This section provides sample code snippets for the integration metadata JSON with the data source. The following example shows the datasources configuration payload for DailyRealData/dailyIntData. { "datasources": \[ { "name": "{{DatasourceName}}" } \], "dimensions": { "kpidimension": { "measures": \[ { "name": "ProPlanIncrVolume", "label": "Planned Incr. Volume" } \] } }, "exportsettings": { "csvseparator": ",", }, "exportfilters": { "conditions": \[\] } } # Data Source: ProductMeasure This section provides sample code snippets for the integration metadata JSON with the data source. The following example shows the datasources configuration payload for ProductMeasure. { "datasources": \[ { "name": "{{DatasourceName}}" } \], "dimensions": { "kpidimension": { "measures": \[ { "name": "ProPlanIncrVolume", "label": "Planned Incr. Volume" } \] } }, "exportsettings": { "csvseparator": ",", }, "exportfilters": { "conditions": \[\] } } # Data Source: Promotion and Tactic Measures An integration metadata report configuration using the data source PromotionAndTacticMeasures requires dimensions. Here is a list of dimensions: - accountdimension - promotiondimension - productdimension - kpidimension - timedimension - **[Example](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_example_promotion_and_tactic_measures.htm)** This example provides details on the integration metadata JSON with data source. - **[Export CSV File](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_example_promotion_and_tactic_export_csv.htm)** # Data Source: Promotion and Tactic Measures with BOM Components The PromotionAndTacticMeasuresWithBOMComponents data source allows export of information related to promotion and tactic measures at the Bill of Material (BOM) component or product part level in RTR. Here’s a list of dimensions required for the PromotionAndTacticMeasuresWithBOMComponents data source in the integration metadata report configuration: - accountdimension - promotiondimension - productdimension - kpidimension - timedimension - productpartdimension - **[Example](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_example_promotion_and_tactic_measures_bom_components.htm)** This sample integration metadata configuration specifies product data at the product part level. # Data Source: Promotion Measures An integration metadata report configuration using the data source PromotionMeasures requires dimensions. Here is a list of dimensions: - accountdimension - promotiondimension - productdimension - kpidimension - timedimension - **[Example](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_example_promotion_measures.htm)** This example provides details on the integration metadata JSON with data source. - **[Export CSV File](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_example_export_csv_files.htm)** # Data Source: Promotion Measures with BOM Components The PromotionMeasuresWithBOMComponents data source allows export of information related to promotion measures at the Bill of Material (BOM) component or product part level in RTR. Here’s a list of dimensions required for the PromotionMeasuresWithBOMComponents data source in the integration metadata report configuration: - accountdimension - promotiondimension - productdimension - kpidimension - timedimension - productpartdimension - **[Example](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_example_promotion_measures_bom_components.htm)** This sample integration metadata configuration specifies product data at the product part level, and defines the fields from the sObjects to be exported along with the KPIs. # Data Source: PromotionTacticDailyMeasureReal This example provides details on the integration metadata JSON with the data source. This example provides details on the integration metadata JSON with the data source. The following example shows the datasources configuration payload for PromotionTacticDailyMeasureReal. { "datasources": \[ { "name": "{{DatasourceName}}" } \], "dimensions": { "kpidimension": { "measures": \[ { "name": "ProPlanIncrVolume", "label": "Planned Incr. Volume" } \] } }, "exportsettings": { "csvseparator": ",", }, "exportfilters": { "conditions": \[\] } } # Data Source: PromotionTacticWeeklyMeasureReal This example provides details on the integration metadata JSON with the data source. This example provides details on the integration metadata JSON with the data source. The following example shows the datasources configuration payload for PromotionTacticWeeklyMeasureReal. { "datasources": \[ { "name": "{{DatasourceName}}" } \], "dimensions": { "kpidimension": { "measures": \[ { "name": "ProPlanIncrVolume", "label": "Planned Incr. Volume" } \] } }, "exportsettings": { "csvseparator": ",", }, "exportfilters": { "conditions": \[\] } } # Data Source: WeeklyMeasureInt This section provides sample code snippets for the integration metadata JSON with the data source. The following example shows the datasources configuration payload for WeeklyMeasureInt. { "datasources": \[ { "name": "{{DatasourceName}}" } \], "dimensions": { "kpidimension": { "measures": \[ { "name": "ProPlanIncrVolume", "label": "Planned Incr. Volume" } \] } }, "exportsettings": { "csvseparator": ",", }, "exportfilters": { "conditions": \[\] } } # Data Source: WeeklyMeasureReal This section provides sample code snippets for the integration metadata JSON with the data source. The following example shows the datasources configuration payload for WeeklyMeasureReal. { "datasources": \[ { "name": "{{DatasourceName}}" } \], "dimensions": { "kpidimension": { "measures": \[ { "name": "ProPlanIncrVolume", "label": "Planned Incr. Volume" } \] } }, "exportsettings": { "csvseparator": ",", }, "exportfilters": { "conditions": \[\] } } # DataCloudExportScheduler Class This Class is used to trigger a data cloud process on the processing service. The data cloud process prepares the data in the processing service which can be retrieved later by data cloud to the platform. This implements [System.Schedulable](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexref.meta/apexref/apex_interface_system_schedulablecontext.htm#apex_interface_system_schedulablecontext) interface and typically scheduled every 24hrs. This Apex class has one method and two constructors. ## Namespace cgcloud ## Signature of the Method global voidexecute(SchedulableContext sc) This method is overridden for the System.Schedulable interface. It calls the processing service to prepare processing service tables for Data Cloud. ## Parameters **sc: SchedulableContext** A platform class instance provided by the Salesforce platform when the class is scheduled via Apex. ## new cgcloud.DataCloudExportScheduler() This is a no-parameter constructor. It prepares all available tables for Data Cloud in the processing service. ## DataCloudExportScheduler(List tables) Constructs the scheduler to prepare specific tables for Data Cloud. **Parameters:** tables: List - Represents the tables the customer wants to have in Data Cloud. Currently available tables include promotionmeasures, paymenttacticmeasures, dailymeasurereal, and dailymeasureint . ## Usage Example This example shows how to schedule the DataCloudExportScheduler. cgcloud.DataCloudExportScheduler cgDataCloudScheduler = new cgcloud.DataCloudExportScheduler(); // Example: Schedule to run daily at 11 AM String cronExp = '0 0 11 \* \* ?'; String jobID = System.schedule('CgDataCloud', cronExp, cgDataCloudScheduler); // To schedule for specific tables: // List specificTables = new List{'promotionmeasures', 'dailymeasurereal'}; // cgcloud.DataCloudExportScheduler specificTableScheduler = new cgcloud.DataCloudExportScheduler(specificTables); // String specificJobId = System.schedule('CgDataCloudSpecific', cronExp, specificTableScheduler); # DeliveryTask Represents information about shipments and orders to be delivered to a store in a visit. This object is available in API version 50.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### AssessmentTaskId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the associated assessment task. ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Description of the delivery task. ### LastReferencedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed a record related to this record. ### LastViewedDate - **Type**: dateTime - **Properties**: Filter, Nillable, Sort - **Description**: The timestamp for when the current user last viewed this record. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: Name of the delievry task. ### OwnerId - **Type**: reference - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: ID of the owner of this record. ### PlaceId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Location to which delivery is to be made. ### Status - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update - **Description**: User defined status of the delivery task. - **Possible values**: - Completed - In Progress - Not Started ### StatusCategory - **Type**: picklist - **Properties**: Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Status of delivery task. - **Possible values**: - Completed - InProgress - NotStarted ### VisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the visit associated with the delivery task ## Associated Objects This object has the following associated objects. Unless noted, they are available in the same API version as this object. - **[DeliveryTaskOwnerSharingRule](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. - **[DeliveryTaskShare](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. - **[DeliveryTaskFeed](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 is available for the object. # Derive and Copy Promotions with MetadataWizard and Business Object API The Derive and Copy Promotion features use Metadata wizard and Business Object API. This allows complete customization of the UI Wizards, and the Derive and Copy Apex processes for promotions by leveraging MetadataWizard and Business Object API customization capabilities. ## Licensing In order to use this feature, your users must have the TPM License. ## CGCloud System Configuration To enable this feature, the required configuration records need to be created for your sales orgs. They can be created with the following Apex commands: cgcloud.TPMSetupData.setupMetadataWizard(''); cgcloud.TPMSetupData.setupBOApi(''); ## Details When executing Derive or Copy functionalities, the system checks for the following conditions: - The selected promotion is a TPM Promotion - A BO API Workflow for Promotion, the user current Sales Org and for the operation exists - A MetadataWizard configuration, the user current Sales Org and for the operation exists If the above conditions are met, the system will execute the Derive or Copy Process by using MetadataWizard and Business Object API. If the conditions are not met, the legacy wizards are used instead. # Derive Promotion Wizard Invocable Actions This class contains support for Data Source providers used in the DerivePromotion wizard. - **[getPromotionTemplates](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/derive_promo_getpromotiontemplates.htm)** This method returns the list of possible Promotion Templates for derive workflow. - **[getAccounts](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/derive_promo_getaccounts.htm)** This method returns the list of accounts valid for the target derived promotion. - **[isPromotionCommitted](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/derive_promo_ispromotioncommitted.htm)** This method validates if the given promotion is on Committed phase. - **[isPromotionTemplateDerivable](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/derive_promo_is_promo_template_deriveable.htm)** This method validates if the given promotion has a derivable promotion template. # Direct Store Delivery Direct Store Delivery (DSD) is a supply chain model where a manufacturer sells goods directly to retailers. You can process orders, payments, deliveries, and returns by using DSD. - **[Custom Objects for Direct Store Delivery](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/retail_custom_objects_for_dsd.htm)** Consumer Goods Cloud data model provides custom objects and fields to support Direct Store Delivery. # EARightsAccess Class Use the EARightsAccess class to access EARights the application uses. You can’t add new instances of this class. However, you can modify the existing instances to change EARights of the existing elements. Each EARightsAccess instance provides these properties: - Name: String (name of the right) - Type: String (category of the right) - Visible: Boolean (indicates whether the referenced item is visible) - Editable: Boolean (indicates whether the referenced item is editable) ## Namespace cgcloud ## Example Implementation cgcloud.EARightsAccess eaRights; ## Supported Methods ## forRecordType Set EARights for different record types of the Promotion and Tactic sObject by calling the forRecordType method on an EARightsAccess instance. This method returns a new EARightsAccess instance where you can set specific visibility and editability permissions for the record type ID of a record. ## Example Here’s an example that shows how to disable the compensation model and SPC card for a specific tactic record type ID: global class TacticEARights implements System.Callable { global Object call(String action, Map args) { // Read Transaction Id String txId = (String) args.get('txId'); // Get the Promotion Id Id promotionId = args.get('promotionId'); // Get the EARights List tacticRights = (List) args.get('EARights'); // Get the relevant record type id Id LUMP\_SUM\_TACTIC\_RECTYPE\_ID = '01x000000000000000'; // Custom logic goes here for (cgcloud.EARightsAccess ear: tacticRights) { // EXAMPLE: Compensation Model is disabled for // specific Tactic RecordType id if (ear.Name == cgcloud\_\_Tactic\_\_c.cgcloud\_\_Compensation\_Model\_\_c.getDescribe().getName()) { ear.forRecordType(recordTypeId).Editable = false; } // EXAMPLE: SPC card is disabled for // specific Tactic RecordType id if (ear.Name == 'SPEND\_PLANNING\_CARD') { ear.forRecordType(recrodTypeId).Editable = false; } } } } # Einstein Visit Activity Recommendation Standard Objects Einstein Visit Activity Recommendation data model provides you objects and fields to contain data about visit task recommendation requests and visit task recommendations. Einstein Visit Activity Recommendation supports sales managers and field reps in scheduling tasks and assessment indicators for visits. - **[AiVisitTaskRcmd](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_aivisittaskrcmd.htm)** Represents the visit task recommendations. These recommendations can be accepted or rejected by a sales manager. This object is available in API version 51.0 and later. - **[AiVisitTaskRcmdRequest](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_aivisittaskrcmdrequest.htm)** Represents the request parameters and responses of visit task recommendations. This object is available in API version 51.0 and later. # Einstein Visit and Activity Recommendation This section provides a list of objects and fields that are related to Einstein Visit and Activity Recommendation. - **[Einstein Visit Recommendation Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/industries_einstein_visit_recommendation_api_overview.htm)** Einstein Visit Recommendation data model provides you objects and fields to contain data about visit recommendation requests and visit recommendations. Einstein Visit Recommendation supports sales managers and field reps in scheduling visits to the right stores, at the right time. - **[Einstein Visit Recommendation Recommendation Associated Objects](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_list_einstein.htm)** This section provides a list of objects associated to Einstein Visit Recommendation standard objects with their standard fields. - **[Einstein Visit Recommendation Recommendation Actions](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/einstein_visit_recommendation_actions_parent.htm)** Save visit and task recommendation decisions. - **[Einstein Visit Activity Recommendation Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/industries_einstein_visit_activity_recommendation_api_overview.htm)** Einstein Visit Activity Recommendation data model provides you objects and fields to contain data about visit task recommendation requests and visit task recommendations. Einstein Visit Activity Recommendation supports sales managers and field reps in scheduling tasks and assessment indicators for visits. - **[Einstein Visit Task Recommendation Associated Objects](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_list_einstein_task.htm)** This section provides a list of objects associated to Einstein Visit Task Recommendation standard objects with their standard fields. # Einstein Visit Recommendation Recommendation Actions Save visit and task recommendation decisions. - **[Save Recommendation Decisions](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/actions_obj_save_recommendation_decision.htm)** Save visit and task recommendation decisions. # Einstein Visit Recommendation Recommendation Associated Objects This section provides a list of objects associated to Einstein Visit Recommendation standard objects with their standard fields. Some fields may not be listed for some objects. To see the system fields for each object, see [System Fields](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/system_fields.htm "HTML (New Window)") in the Object Reference for Salesforce and Lightning Platform. To verify the complete list of fields for an object, use a describe call from the API or inspect with an appropriate tool. For example, inspect the WSDL or use a schema viewer. - **[StandardObjectNameFeed](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_feed_einstein.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. - **[StandardObjectNameHistory](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_history_einstein.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. - **[StandardObjectNameOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_ownersharingrule_einstein.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. - **[StandardObjectNameShare](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_share_einstein.htm)** StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object. # Einstein Visit Recommendation Standard Objects Einstein Visit Recommendation data model provides you objects and fields to contain data about visit recommendation requests and visit recommendations. Einstein Visit Recommendation supports sales managers and field reps in scheduling visits to the right stores, at the right time. - **[AiVisitRecommendation](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/industries_einstein_objects_aivisitrecommendation.htm)** Represents the details of a visit recommendation. This object is available in API version 50.0 and later. - **[AiVisitRecommendRequest](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/industries_einstein_objects_aivisitrecommendrequest.htm)** Represents the details of a visit recommendation request. This object is available in API version 50.0 and later. # Einstein Visit Task Recommendation Associated Objects This section provides a list of objects associated to Einstein Visit Task Recommendation standard objects with their standard fields. Some fields may not be listed for some objects. To see the system fields for each object, see [System Fields](https://developer.salesforce.com/docs/atlas.en-us.264.0.object_reference.meta/object_reference/system_fields.htm "HTML (New Window)") in the Object Reference for Salesforce and Lightning Platform. To verify the complete list of fields for an object, use a describe call from the API or inspect with an appropriate tool. For example, inspect the WSDL or use a schema viewer. - **[StandardObjectNameFeed](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_feed_einstein_task.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. - **[StandardObjectNameHistory](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_history_einstein_task.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. - **[StandardObjectNameOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_ownersharingrule_einstein_task.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. - **[StandardObjectNameShare](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_share_einstein_task.htm)** StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object. # Example This sample integration metadata configuration specifies product data at the product part level. **PromotionAndTacticMeasuresWithBOMComponents** { "datasources":\[ { "name":"PromotionAndTacticMeasuresWithBOMComponents" } \], "dimensions":{ "accountdimension":{ "attributes":\[ { "label":"ExternalId", "name":"externalid" }, { "label":"Name", "name":"name" }, { "label":"AccountNUmber", "name":"accountnumber" } \], "key":"externalid", "level":"" }, "productdimension":{ "attributes":\[ { "label":"Description", "name":"description" }, { "label":"ExternalId", "name":"externalid" }, { "label":"Category", "name":"category" } \], "key":"externalid", "level":"Product" }, "timedimension":{ "includetotal":false, "splitweeks":false, "periodtype":"custom" }, "productpartdimension":{ "attributes":\[ { "label":"id", "name":"id" }, { "label":"quantity", "name":"quantity" }, { "label":"externalid", "name":"externalid" } \], "key":"id", "level":"" }, "kpidimension":{ "measures":\[ { "label":"Incremental Volume", "name":"ProPlanIncrVolume" }, { "label":"Tactic Spend", "name":"PlanTotalPromoCosts" }, { "label":"Lump Sum", "name":"FixedAmountLumpSum" } \] }, "promotiondimension":{ "attributes":\[ { "label":"id", "name":"id" }, { "label":"datefrom", "name":"datefrom" }, { "label":"templateName", "name":"templateName" }, { "label":"accountid", "name":"accountid" }, { "label":"accountplanrelevant", "name":"accountplanrelevant" }, { "label":"accountexternalid", "name":"accountexternalid" } \], "key":"id", "level":"" }, "tacticdimension":{ "attributes":\[ { "name":"lifttype", "label":"lifttype" }, { "name":"name", "label":"name" }, { "name":"liftvalue", "label":"liftvalue" }, { "name":"compensationmodel", "label":"compensationmodel" } \], "key":"name", "level":"" } }, "exportsettings":{ "columns":\[ "accountdimension.externalid", "promotiondimension.id", "promotiondimension.datefrom", "promotiondimension.templateName", "tacticdimension.name", "tacticdimension.compensationmodel", "productdimension.externalid", "productdimension.category", "productdimension.description", "productpartdimension.id", "productpartdimension.externalid", "kpidimension.label", "kpidimension.measurecode", "timedimension.label" \], "csvseparator":"," }, "exportfilters":{ "conditions":\[ { "operator":"includes", "value":\[ "Kroger\_Atlanta" \], "attribute":"externalid", "dimension":"accountdimension", "name":"cond1" } \] } } # Example This example provides details on the integration metadata JSON with data source. **PromotionandTacticMeasures** { "datasources": \[ { "name": "PromotionAndTacticMeasures" } \], "dimensions": { "accountdimension": { "attributes": \[ { "label": "ExternalId", "name": "externalid" }, { "label": "Name", "name": "name" }, { "label": "AccountNUmber", "name": "accountnumber" } \], "key": "externalid", "level": "" }, "productdimension": { "attributes": \[ { "label": "Description", "name": "description" }, { "label": "ExternalId", "name": "externalid" }, { "label": "Category", "name": "category" } \], "key": "externalid", "level": "Product" }, "timedimension": { "includetotal": false, "splitweeks": false, "periodtype": "custom" }, "kpidimension": { "measures": \[ { "label": "Incremental Volume", "name": "ProPlanIncrVolume" }, { "label": "Tactic Spend", "name": "PlanTotalPromoCosts" }, { "label": "Lump Sum", "name": "FixedAmountLumpSum" } \] }, "promotiondimension": { "attributes": \[ { "label": "id", "name": "id" }, { "label": "datefrom", "name": "datefrom" }, { "label": "templateName", "name": "templateName" }, { "label": "accountid", "name": "accountid" }, { "label": "accountplanrelevant", "name": "accountplanrelevant" }, { "label": "accountexternalid", "name": "accountexternalid" } \], "key": "id", "level": "" }, "tacticdimension": { "attributes": \[ { "name": "lifttype", "label": "lifttype" }, { "name": "name", "label": "name" }, { "name": "liftvalue", "label": "liftvalue" }, { "name": "compensationmodel", "label": "compensationmodel" } \], "key": "name", "level": "" } }, "exportsettings": { "columns": \[ "accountdimension.externalid", "promotiondimension.id", "promotiondimension.datefrom", "promotiondimension.templateName", "tacticdimension.name", "tacticdimension.compensationmodel", "productdimension.externalid", "productdimension.category", "productdimension.description", "kpidimension.label", "kpidimension.measurecode", "...timedimension.label" \], "csvseparator": "," }, "exportfilters": { "conditions": \[ { "operator": "includes", "value": \[ "Kroger\_Atlanta" \], "attribute": "externalid", "dimension": "accountdimension", "name": "cond1" } \] } } # Example This sample integration metadata configuration specifies product data at the product part level, and defines the fields from the sObjects to be exported along with the KPIs. **PromotionMeasuresWithBOMComponents** { "datasources":\[ { "name":"PromotionMeasuresWithBOMComponents" } \], "dimensions":{ "accountdimension":{ "attributes":\[ { "label":"ExternalId", "name":"externalid" }, { "label":"Name", "name":"name" }, { "label":"AccountNUmber", "name":"accountnumber" } \], "key":"externalid", "level":"" }, "productdimension":{ "attributes":\[ { "label":"Description", "name":"description" }, { "label":"ExternalId", "name":"externalid" }, { "label":"Category", "name":"category" } \], "key":"externalid", "level":"Product" }, "timedimension":{ "includetotal":false, "splitweeks":false, "periodtype":"custom" }, "kpidimension":{ "measures":\[ { "name":"BOMPlanIncrVolAll", "label":"Planned Incremental Volume" } \] }, "promotiondimension":{ "attributes":\[ { "label":"id", "name":"id" }, { "label":"datefrom", "name":"datefrom" }, { "label":"templateName", "name":"templateName" }, { "label":"accountid", "name":"accountid" }, { "label":"accountplanrelevant", "name":"accountplanrelevant" }, { "label":"accountexternalid", "name":"accountexternalid" } \], "key":"id", "level":"" } }, "productpartdimension":{ "attributes":\[ { "label":"id", "name":"id" }, { "label":"quantity", "name":"quantity" }, { "label":"externalid", "name":"externalid" } \], "key":"id", "level":"" }, "exportsettings":{ "columns":\[ "accountdimension.externalid", "promotiondimension.id", "promotiondimension.datefrom", "promotiondimension.templateName", "productdimension.externalid", "productdimension.category", "productdimension.description", "productpartdimension.id", "productpartdimension.externalid", "productpartdimension.quantity", "kpidimension.label", "kpidimension.measurecode", "timedimension.label" \], "csvseparator":"," }, "exportfilters":{ "conditions":\[ { "operator":"includes", "value":\[ "Kroger\_Atlanta" \], "attribute":"externalid", "dimension":"accountdimension", "name":"cond1" } \] } } # Example This example provides details on the integration metadata JSON with data source. **PromotionMeasures** { "datasources": \[ { "name": "PromotionMeasures" } \], "dimensions": { "accountdimension": { "attributes": \[ { "label": "ExternalId", "name": "externalid" }, { "label": "Name", "name": "name" }, { "label": "AccountNUmber", "name": "accountnumber" } \], "key": "externalid", "level": "" }, "productdimension": { "attributes": \[ { "label": "Description", "name": "description" }, { "label": "ExternalId", "name": "externalid" }, { "label": "Category", "name": "category" } \], "key": "externalid", "level": "Product" }, "timedimension": { "includetotal": false, "splitweeks": false, "periodtype": "custom" }, "kpidimension": { "measures": \[ { "name": "ProPlanIncrVolume", "label": "Incremental Volume" } \] }, "promotiondimension": { "attributes": \[ { "label": "id", "name": "id" }, { "label": "datefrom", "name": "datefrom" }, { "label": "templateName", "name": "templateName" }, { "label": "accountid", "name": "accountid" }, { "label": "accountplanrelevant", "name": "accountplanrelevant" }, { "label": "accountexternalid", "name": "accountexternalid" } \], "key": "id", "level": "" } }, "exportsettings": { "columns": \[ "accountdimension.externalid", "promotiondimension.id", "promotiondimension.datefrom", "promotiondimension.templateName", "productdimension.externalid", "productdimension.category", "productdimension.description", "kpidimension.label", "kpidimension.measurecode", "...timedimension.label" \], "csvseparator": "," }, "exportfilters": { "conditions": \[ { "operator": "includes", "value": \[ "Kroger\_Atlanta" \], "attribute": "externalid", "dimension": "accountdimension", "name": "cond1" } \] } } # Example: Spreading Time Label This example provides details on the integration metadata JSON with datasource AccountAndPromotionMeasures (time label spreaded). { "datasources": \[ { "name": "AccountAndPromotionMeasures" } \], "dimensions": { "accountdimension": { "attributes": \[ { "label": "ExternalId", "name": "externalid" }, { "label": "Name", "name": "name" }, { "label": "AccountNUmber", "name": "accountnumber" } \], "key": "externalid", "level": "" }, "productdimension": { "attributes": \[ { "label": "Description", "name": "description" }, { "label": "ExternalId", "name": "externalid" }, { "label": "Category", "name": "category" } \], "key": "externalid", "level": "Product" }, "timedimension": { "includetotal": false, "splitweeks": false, "periodtype": "custom" }, "kpidimension": { "measures": \[ { "name": "ProPlanIncrVolume", "label": "Incremental Volume" }, { "name": "PlanTotalVolumeResult", "label": "Planned Baseline" } \] }, "promotiondimension": { "attributes": \[ { "label": "id", "name": "id" }, { "label": "accountid", "name": "accountid" }, { "label": "accountplanrelevant", "name": "accountplanrelevant" } \], "key": "id", "level": "" } }, "exportsettings": { "columns": \[ "accountdimension.externalid", "productdimension.externalid", "productdimension.category", "productdimension.description", "kpidimension.label", "kpidimension.measurecode", "...timedimension.label" \], "csvseparator": "," }, "exportfilters": { "conditions": \[ { "operator": "includes", "value": \[ "Kroger\_Atlanta" \], "attribute": "externalid", "dimension": "accountdimension", "name": "cond1" } \] } } # Examples This section provides sample code snippets for different data sources.
Available in: Lightning Experience in Enterprise and Unlimited Editions that have Consumer Goods Cloud Trade Promotion Management enabled.
- **[Data Source: Account and Promotion Measures](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_account_and_promotion_measures.htm)** This section provides sample code snippets for different data sources. - **[Data Source: Promotion Measures](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_promotion_measures.htm)** An integration metadata report configuration using the data source PromotionMeasures requires dimensions. - **[Data Source: Promotion Measures with BOM Components](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_promotion_measures_bom_components.htm)** The PromotionMeasuresWithBOMComponents data source allows export of information related to promotion measures at the Bill of Material (BOM) component or product part level in RTR. - **[Data Source: Promotion and Tactic Measures](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_promotion_and_tactic_measures.htm)** An integration metadata report configuration using the data source PromotionAndTacticMeasures requires dimensions. - **[Data Source: Promotion and Tactic Measures with BOM Components](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_promotion_and_tactic_measures_bom_components.htm)** The PromotionAndTacticMeasuresWithBOMComponents data source allows export of information related to promotion and tactic measures at the Bill of Material (BOM) component or product part level in RTR. - **[Data Source: DailyRealData/DailyIntData](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_daily_RealData.htm)** This section provides sample code snippets for the integration metadata JSON with the data source. The following example shows the datasources configuration payload for DailyRealData/dailyIntData. - **[Data Source: AccountMeasure](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_AccountMeasure.htm)** This example provides details on the integration metadata JSON with the data source. This example provides details on the integration metadata JSON with the data source. The following example shows the datasources configuration payload for AccountMeasure. - **[Data Source: PromotionTacticDailyMeasureReal](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_promotion_tactic_daily_measure_real.htm)** This example provides details on the integration metadata JSON with the data source. This example provides details on the integration metadata JSON with the data source. The following example shows the datasources configuration payload for PromotionTacticDailyMeasureReal. - **[Data Source: PromotionTacticWeeklyMeasureReal](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_promotion_tactic_weekly_measure_real.htm)** This example provides details on the integration metadata JSON with the data source. This example provides details on the integration metadata JSON with the data source. The following example shows the datasources configuration payload for PromotionTacticWeeklyMeasureReal. - **[Data Source: AccountProductMeasure](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_AccountProductMeasure.htm)** This example provides details on the integration metadata JSON with the data source. The following example shows the datasources configuration payload for AccountProductMeasure. - **[Data Source: ProductMeasure](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_product_measure.htm)** This section provides sample code snippets for the integration metadata JSON with the data source. The following example shows the datasources configuration payload for ProductMeasure. - **[Data Source: WeeklyMeasureReal](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_weekly_measure_real.htm)** This section provides sample code snippets for the integration metadata JSON with the data source. The following example shows the datasources configuration payload for WeeklyMeasureReal. - **[Data Source: WeeklyMeasureInt](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_weekly_measure_int.htm)** This section provides sample code snippets for the integration metadata JSON with the data source. The following example shows the datasources configuration payload for WeeklyMeasureInt. # Export CSV File accountdimension.externalid,promotiondimension.id,promotiondimension.datefrom,promotiondimension.tem plateName, productdimension.externalid,productdimension.category,productdimension.description,label,measurecode ,Period-1 /2021,Period-2/2021,Period-3/2021,Period-4/2021,Period-5/2021,Period-6/2021,Period-7/2021,Period- 8/2021,Period-9 /2021,Period-10/2021,Period-11/2021,Period-12/2021,Period-13/2021,Period-14/2021,Period- 15/2021,Period-16/2021, Period-17/2021,Period-18/2021,Period-19/2021,Period-20/2021,Period-21/2021,Period-22/2021,Period- 23/2021,Period- 24/2021,Period-25/2021,Period-26/2021,Period-27/2021,Period-28/2021,Period-29/2021,Period- 30/2021,Period-31 /2021,Period-32/2021,Period-33/2021,Period-34/2021,Period-35/2021,Period-36/2021,Period- 37/2021,Period-38/2021, Period-39/2021,Period-40/2021,Period-41/2021,Period-42/2021,Period-43/2021,Period-44/2021,Period- 45/2021,Period- 46/2021,Period-47/2021,Period-48/2021,Period-49/2021,Period-50/2021,Period-51/2021,Period-52/2021 Kroger\_Atlanta,a2o11000001950rAAA,2021-03-08,Customer Promotion,Crispy\_Caramel\_Wafer,Snacks,Upples Matcha Chocolate Chip,Incremental Volume,PPIV,,,,,,,,,, 1388.888333,1620.369722,1620.369722,231.481389,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, Kroger\_Atlanta,a2o11000001950rAAA,2021-03-08,Customer Promotion,Crispy\_Cream\_Wafer,Snacks,Upples Golden Oat Crumples,Incremental Volume,PPIV,,,,,,,,,, 1388.888333,1620.369722,1620.369722,231.481389,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, # Export CSV File accountdimension.externalid,promotiondimension.id,promotiondimension.datefrom,promotiondimension.tem plateName, tacticdimension.name,tacticdimension.compensationmodel,productdimension.externalid,productdimension. category, productdimension.description,label,measurecode,Period-1/2021,Period-2/2021,Period-3/2021,Period- 4/2021,Period-5 /2021,Period-6/2021,Period-7/2021,Period-8/2021,Period-9/2021,Period-10/2021,Period-11/2021,Period- 12/2021, Period-13/2021,Period-14/2021,Period-15/2021,Period-16/2021,Period-17/2021,Period-18/2021,Period- 19/2021,Period- 20/2021,Period-21/2021,Period-22/2021,Period-23/2021,Period-24/2021,Period-25/2021,Period- 26/2021,Period-27 /2021,Period-28/2021,Period-29/2021,Period-30/2021,Period-31/2021,Period-32/2021,Period- 33/2021,Period-34/2021, Period-35/2021,Period-36/2021,Period-37/2021,Period-38/2021,Period-39/2021,Period-40/2021,Period- 41/2021,Period- 42/2021,Period-43/2021,Period-44/2021,Period-45/2021,Period-46/2021,Period-47/2021,Period- 48/2021,Period-49 /2021,Period-50/2021,Period-51/2021,Period-52/2021 Kroger\_Atlanta,a2o11000001950rAAA,2021-03-08,Customer Promotion,,,Crispy\_Caramel\_Wafer,Snacks,Upples Matcha Chocolate Chip,Incremental Volume,PPIV,,,,,,,,,, 1388.888333,1620.369722,1620.369722,231.481389,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, ... ... ... Kroger\_Atlanta,a2o11000001950rAAA,2021-03-08,Customer Promotion,T- 0000064,LumpSum,Crispy\_Caramel\_Wafer,Snacks, Upples Matcha Chocolate Chip,Lump Sum,FIXA,,,,,,,,,, 59.52381,69.444444,69.444444,9.920635,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, ... ... ... # Exporting the KPIs from Hyperforce This section provides information on how to export the KPIs from Hyperforce. You can create CSV export integration metadata configuration by adding new report configuration entry to RTR Report Configurations. - **[Prerequisites](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_integration_prerequisites.htm)** - **[Configuring Integration Dimension Meta](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_configuring_integration_dimension_meta.htm)** Create RTR report configuration records to export CSVs. - **[Triggering the CSV Export Process](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_triggering_csv_export_process.htm)** The CSV export for a configured integration metadata report is triggered with endpoints provided by the RTR gateway. When the CSV export process is finished, the CSV file can be downloaded through the integration API endpoints. - **[REST API Endpoints](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_api_endpoints.htm)** This section describes the different REST API endpoints. - **[Examples](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/rtr_examples.htm)** This section provides sample code snippets for different data sources. - **[CGCloud Namespace](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_namespace_CGCloud.htm)** The CGCloud namespace provides classes that allow you to customise Real Time Reporting (RTR) data extraction from Apex. # FlatList Class Represents a Real Time Reporting (RTR) report UI Flatlist component. This class extends the ReportComponent class. ## Namespace [CGCloud](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_namespace_CGCloud.htm "The CGCloud namespace provides classes that allow you to customise Real Time Reporting (RTR) data extraction from Apex.") ## Usage The RTRReportResult.FlatList class is used to access Flatlist information from RTR reports. ## Example Here’s an example of how to extract the Flatlist data from the RTRReportResult object. // Extract the Flatlist from the result // - The component name must match its 'uimapping' name // - The result must be casted to the correct type. cgcloud.RTRReportResult.Flatlist flatlist = (cgcloud.RTRReportResult.Flatlist) reportResult.getComponent('FlatList'); // Retrieve the rows Iterable object // All rows can be retrieved with the parameter-less "getRows" cgcloud.RTRReportResult.FlatlistRowIterable iterator = flatlist.getRows('Promo-Product'); // Iterate over all the rows while (iterator.hasNext()) { cgcloud.RTRReportResult.FlatlistRow row = iterator.next(); // Extract column data. We assume the specified columns are in the report // Dimension information can be extracted with . String promotionId = String.valueOf(row.getColumnValue('promotiondimension.id')); // KPI Value information can be extracted by querying the KPI Name Decimal kpiValue = (Decimal) row.getColumnValue('ProPlanIncrVolume'); system.debug('Values: ' + promotionId + ' ' + kpiValue); } - **[FlatList Methods](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_FlatList.htm#apex_CGCloud_FlatList_methods)** ## FlatList Methods The following are methods for FlatList. - **[getRows()](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_FlatList.htm#apex_CGReporting_getRows)** Returns an instance of a FlatlistRowIterable object with all the rows contained in the Flatlist. - **[getRows(String rowTypeFilter)](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_FlatList.htm#apex_CGReporting_getRows_1)** Returns an instance of a FlatlistRowIterable object with all the rows that match the specified row type filter. The available values for the row type filter can be extracted with the getRowTypes method. - **[getColumns()](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_FlatList.htm#apex_CGReporting_getColumns)** Returns a set that includes all the available column names in the Flatlist. - **[getRowTypes()](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_FlatList.htm#apex_CGReporting_getRowTypes)** Returns all the available row type filters present in the Flatlist. The row type filters can be used to filter the dataset. ### getRows() Returns an instance of a FlatlistRowIterable object with all the rows contained in the Flatlist. #### Signature static RTRReportResult.FlatList getRows() #### Return Value Type:[FlatlistRowIterable](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_FlatListRowIterable.htm#apex_class_CGReporting_RTRReportResult_FlatListRowIterable "Represents a Real Time Reporting (RTR) report UI Flatlist component set of rows. This class implements the Iterable interface that allows it to be used in batch processes.") ### getRows(String rowTypeFilter) Returns an instance of a FlatlistRowIterable object with all the rows that match the specified row type filter. The available values for the row type filter can be extracted with the getRowTypes method. #### Signature static RTRReportResult.FlatList getRows(String rowTypeFilter) #### Parameters - **rowTypeFilter**: Type:String. The value of the row type to filter the rows. #### Return Value Type:[FlatlistRowIterable](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_FlatListRowIterable.htm#apex_class_CGReporting_RTRReportResult_FlatListRowIterable "Represents a Real Time Reporting (RTR) report UI Flatlist component set of rows. This class implements the Iterable interface that allows it to be used in batch processes.") ### getColumns() Returns a set that includes all the available column names in the Flatlist. The method returns the following: - Dimension attributes—Include the name of the dimension and a report field separated by a dot. For example, productdimension.id, promotiondimension.id, and promotiondimension.phase. - KPI columns—Include the KPI name. For example, ProPlanIncrVolume. #### Signature static RTRReportResult.FlatList getColumns() #### Return Value Type:Set ### getRowTypes() Returns all the available row type filters present in the Flatlist. The row type filters can be used to filter the dataset. #### Signature static RTRReportResult.FlatList getRowTypes() #### Return Value Type:Set # FlatListRow Class Represents a Real Time Reporting (RTR) report UI Flatlist component single rows. ## Namespace [CGCloud](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_namespace_CGCloud.htm "The CGCloud namespace provides classes that allow you to customise Real Time Reporting (RTR) data extraction from Apex.") - **[FlatListRow Methods](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_FlatListRow.htm#apex_CGCloud_FlatListRow_methods)** ## FlatListRow Methods The following are methods for FlatListRow. - **[getColumnValue(String columnName)](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_FlatListRow.htm#apex_CGReporting_FlatListRow_getColumnValue)** Extracts the column value specified for the column name Row type filters can be used to filter the dataset. ### getColumnValue(String columnName) Extracts the column value specified for the column name Row type filters can be used to filter the dataset. #### Signature public RTRReportResult.FlatListRow getColumnValue(String columnName) #### Parameters - **columnName**: Type:String. The name of the column whose value is to be retrieved. The column name has the following format: - Dimension attributes—Include the name of the dimension and a report field separated by a dot. For example, productdimension.id, promotiondimension.id, and promotiondimension.phase. - KPI columns—Include the KPI name. For example, ProPlanIncrVolume. #### Return Value Type:Object # FlatListRowIterable Class Represents a Real Time Reporting (RTR) report UI Flatlist component set of rows. This class implements the [Iterable](https://developer.salesforce.com/docs/atlas.en-us.264.0.apexcode.meta/apexcode/apex_classes_iterable.htm "HTML (New Window)") interface that allows it to be used in batch processes. ## Namespace [CGCloud](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_namespace_CGCloud.htm "The CGCloud namespace provides classes that allow you to customise Real Time Reporting (RTR) data extraction from Apex.") - **[FlatlistRowIterable Methods](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_FlatListRowIterable.htm#apex_CGCloud_FlowListRowIterable_methods)** ## FlatlistRowIterable Methods The following are methods for FlatlistRowIterable. - **[hasNext()](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_FlatListRowIterable.htm#apex_CGReporting_FlatlistRowIterable_hasNext)** Returns true if a record can be retrieved. - **[next()](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_FlatListRowIterable.htm#apex_CGReporting_FlatListRowIterable_next)** Returns the next record in the dataset. ### hasNext() Returns true if a record can be retrieved. #### Signature public RTRReportResult.FlatlistRowIterable hasNext() #### Return Value Type:Boolean ### next() Returns the next record in the dataset. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note If no more records are present in the dataset, this method returns an error. #### Signature public RTRReportResult.FlatlistRowIterable hasNext() #### Return Value Type:[FlatlistRow](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/apex_class_CGCloud_RTRReportResult_FlatList.htm#apex_class_CGReporting_RTRReportResult_FlatList "Represents a Real Time Reporting (RTR) report UI Flatlist component. This class extends the ReportComponent class.") # Generic This section provides information about the mapValues. ## **mapValues** This rule reads the Maps\_To\_\_c property of the workflow input structure records in order to map the input attribute described into the output field in the Maps\_To\_\_c property. - Description: Maps values from the input to the output structure without any processing. - Classname: Promotion2BoApiCoreWorkflowSteps - Method: mapValues. # Get Global Account Product List Retrieves the account products from the global account product list based on the volumes and measures for the customer for the account. A product is included in a global list if one of these criteria is met. - Volume or condition record exists for the product. - The product is included in a promotion that's created for the customer. ## Resource GET\_GLOBAL\_ACCOUNT\_PRODUCT\_LIST ## Available version 55.0 ## Request Parameters | Name | Type | Description | Required or Optional | | --- | --- | --- | --- | | accountId | String | ID of the account record from Salesforce. | Required | ## Apex Request Example // Logical endpoint name String endpointName = 'GET\_GLOBAL\_ACCOUNT\_PRODUCT\_LIST'; // name of the salesorg for which the API must be scheduled String salesOrg = '0001'; .OffplatformCallout callout = new .OffplatformCallout(endpointName, salesOrg); // Log Transaction Id String txId = .TransactionHandler.getTransactionIdentifier(); // Account Id for which the products in the global apl should be retrieved Id accountId = '001B000001Q48yMIAR'; // Kroger Atlanta Map urlParameters = new Map(); urlParameters.put('accountid', accountId); String payload = null; .OffplatformCalloutResponse response = callout.execute(txId, urlParameters, payload); if (response.status != 200) { // Handle error and return error info to caller } // Fetch the list from the response Set accountproducts = new Set(); String aplListString = (String) response.Result; if (!String.isEmpty(aplListString)) { Map mapAccountProductList = (Map) JSON.deserializeUntyped( aplListString ); List listAccountProductListIds = (List) mapAccountProductList.get( 'accountproducts' ); for (Object obj : listAccountProductListIds) { accountproducts.add((Id) obj); } } # Get Measure Exports Retrieves the list of the exports scheduled for a particular period. This list provides an overview of the scheduled exports and identifies the exports to be aborted. ## Sample Apex Code Snippet OffPlatformCallout request = new OffPlatformCallout('GET\_MEASURE\_EXPORTS','0001'); Map data = new Map(); data.put('days','1'); data.put('state', 'Aborted'); OffPlatformCalloutResponse response = request.execute(TransactionHandler.getTransactionIdentifier(), data, null); System.debug(response); ## Response Body \[ { "Status": "Ready", "RequestDate": "2025-03-19T06:35:04.000Z", "csvGuid": "25439edc-3b83-44ed-a15c-f122af21335c", "salesorg": "0001", "MetaName": "PromotionDataExportCustom", "BusinessYear": 2024, "Statistics": { "csvGuid": "25439edc-3b83-44ed-a15c-f122af21335c", "jobStartTime": "Wed, 19 Mar 2025 12:05:30 GMT", "hasDelta": false, "deltaToCsvGuid": null, "metaName": "PromotionDataExportCustom", "metaVersion": 3, "totalAccounts": 1, "totalCategories": 6, "dimDataRetrievalDuration": 557, "numRecords": 1554, "numAccountCategoryKeys": 6, "runDuration": 1016, "processedAccountCategories": 6, "jobCompletionTime": "Wed, 19 Mar 2025 12:05:32 GMT", "jobDuration": 2255 }, "FullExport": "full/25439edc-3b83-44ed-a15c-f122af21335c.csv.gz", "DeltaExport": "delta/25439edc-3b83-44ed-a15c-f122af21335c.csv.gz" }, { "Status": "Queued", "RequestDate": "2025-03-19T09:01:50.000Z", "MetaName": "PromotionDataExportCustom", "csvGuid": "25439edc-3b83-44ed-a15c-f122af21335c", "salesorg": "0001", "BusinessYear": 2024, "Statistics": null } \] # Get Measure Exports Uses the GET method to retrieve the list of the exports scheduled for a particular period. This list provides an overview of the scheduled exports and identifies the exports to be aborted. It takes Days and State as the query parameters. ## Resource /measures/exports?days=&state= ## Available Version 65.0 and later ## HTTP Method GET - **[Get Measure Exports Input](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/connect_request_fetch_status_scheduled_exports.htm)** Query paramters for Get Measure Exports API. - **[Get Measure Exports Output](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/connect_response_fetch_status_scheduled_exports.htm)** Response body for Get Measure Exports API. ## Query Parameters
Parameter Type Description Required or Optional Available Version
days String Enter the number of days between 1 and 7 to retrieve the list of exports. The API request uses this input as a reference point to calculate start date and the day request is being sent as a reference point for end date. Required 65.0
state String Enter the CSV export's state. For multiple states, provide the inputs in comma-separated values (CSV) format. The supported values are:
  • Queued
  • InProgress
  • Aborted
  • Ready
  • Error
 Required 65.0
## Response Body \[ { "Status": "Ready", "RequestDate": "2025-03-19T06:35:04.000Z", "csvGuid": "25439edc-3b83-44ed-a15c-f122af21335c", "salesorg": "0001", "MetaName": "PromotionDataExportCustom", "BusinessYear": 2024, "Statistics": { "csvGuid": "25439edc-3b83-44ed-a15c-f122af21335c", "jobStartTime": "Wed, 19 Mar 2025 12:05:30 GMT", "hasDelta": false, "deltaToCsvGuid": null, "metaName": "PromotionDataExportCustom", "metaVersion": 3, "totalAccounts": 1, "totalCategories": 6, "dimDataRetrievalDuration": 557, "numRecords": 1554, "numAccountCategoryKeys": 6, "runDuration": 1016, "processedAccountCategories": 6, "jobCompletionTime": "Wed, 19 Mar 2025 12:05:32 GMT", "jobDuration": 2255 }, "FullExport": "full/25439edc-3b83-44ed-a15c-f122af21335c.csv.gz", "DeltaExport": "delta/25439edc-3b83-44ed-a15c-f122af21335c.csv.gz" }, { "Status": "Queued", "RequestDate": "2025-03-19T09:01:50.000Z", "MetaName": "PromotionDataExportCustom", "csvGuid": "25439edc-3b83-44ed-a15c-f122af21335c", "salesorg": "0001", "BusinessYear": 2024, "Statistics": null } \] # Get Measure Exports Input Query paramters for Get Measure Exports API. ## Query Parameters
Parameter Type Description Required or Optional Available Version
days String Enter the number of days between 1 and 7 to retrieve the list of exports. The API request uses this input as a reference point to calculate start date and the day request is being sent as a reference point for end date. Required 65.0
state String Enter the CSV export's state. For multiple states, provide the inputs in comma-separated values (CSV) format. The supported values are:
  • Queued
  • InProgress
  • Aborted
  • Ready
  • Error
 Required 65.0
# Get Measure Exports Output Response body for Get Measure Exports API. ## Response Body \[ { "Status": "Ready", "RequestDate": "2025-03-19T06:35:04.000Z", "csvGuid": "25439edc-3b83-44ed-a15c-f122af21335c", "salesorg": "0001", "MetaName": "PromotionDataExportCustom", "BusinessYear": 2024, "Statistics": { "csvGuid": "25439edc-3b83-44ed-a15c-f122af21335c", "jobStartTime": "Wed, 19 Mar 2025 12:05:30 GMT", "hasDelta": false, "deltaToCsvGuid": null, "metaName": "PromotionDataExportCustom", "metaVersion": 3, "totalAccounts": 1, "totalCategories": 6, "dimDataRetrievalDuration": 557, "numRecords": 1554, "numAccountCategoryKeys": 6, "runDuration": 1016, "processedAccountCategories": 6, "jobCompletionTime": "Wed, 19 Mar 2025 12:05:32 GMT", "jobDuration": 2255 }, "FullExport": "full/25439edc-3b83-44ed-a15c-f122af21335c.csv.gz", "DeltaExport": "delta/25439edc-3b83-44ed-a15c-f122af21335c.csv.gz" }, { "Status": "Queued", "RequestDate": "2025-03-19T09:01:50.000Z", "MetaName": "PromotionDataExportCustom", "csvGuid": "25439edc-3b83-44ed-a15c-f122af21335c", "salesorg": "0001", "BusinessYear": 2024, "Statistics": null } \] # Get Products Retrieve a list of products. The list is returned based on the Product Definition Level setting that you configured in the promotion template. For more information on managing promotion products at either the promotion or the tactic level, see [Manage Your Products](https://help.salesforce.com/s/articleView?id=ind.tpm_concept_manage_your_products.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. ## Resource GET\_PRODUCTS ## Available version 55.0 ## Apex Request Example Before running this apex code snippet: - Ensure the AUTHORIZATIONLISTFILTER process step is added to filter the discontinued products. - The yearoffset value for considerdiscontinued products is either set to 1 or 2 and ensure it's provided when the process step DISCONTINUEDPRODUCTSFILTER is added. String salesOrg = '0001'; cgcloud.GetProductsCallout request = new cgcloud.GetProductsCallout(salesOrg); cgcloud.ProductResolutionConfiguration configuration = new cgcloud.ProductResolutionConfiguration(cgcloud.ProductResolution.ResponseFormat.DENORMALIZED /\* || ProductResolution.ResponseFormat.NORMALIZED => Deprecated \*/); // Depending on each step we add, we will need to add some required properties to ProductResolutionConfiguration configuration.setSteps(new List{ // Product Source: Execute a product query with the given product filter criteria. // Requires 'productfilter', 'salesorg' cgcloud.ProductResolution.ProcessStep.PRODUCTQUERY, //Product Source: Extract manual fixed products from the input and adds them to the result. // Requires 'manualproducts' cgcloud.ProductResolution.ProcessStep.MANUALPRODUCTS, //Product Source: Load products for the tactic actuals defined for the tactics of the promotion defined by PromotionId. // Requires 'promotionid' cgcloud.ProductResolution.ProcessStep.TACTICACTUALPRODUCTS, //Product Source: Load products for the payment measures defined for the tactics of the promotion defined by PromotionId. // Requires 'promotionid' cgcloud.ProductResolution.ProcessStep.PAYMENTPRODUCTS, //Product Source: Load products for the Promotion Conditions of the promotion defined by PromotionId. // Requires 'promotionid' cgcloud.ProductResolution.ProcessStep.PROMOTIONCONDITIONPRODUCTS, //Product Source: Load frozen products of the promotion defined by PromotionId. // Requires 'promotionid' cgcloud.ProductResolution.ProcessStep.FROZENPRODUCTS, //Product Filter: Products those are exclude manually will be filtered out from the dynamic product resolution result. // Requires 'manualproducts' cgcloud.ProductResolution.ProcessStep.MANUALEXCLUDEDPRODUCTSFILTER, //Product Filter: Only planning products are returned from the dynamic product resolution result. // Requires 'datefrom', 'datethru', 'referencedate' (KAMStateFilter by timeframe), // or 'commitdate', 'referencedate' (KAMStateFilter by commit date) cgcloud.ProductResolution.ProcessStep.KAMSTATEFILTER, //Product Filter: Only products that are within the global account product list of the current account are returned from the dynamic product resolution result. // Requires 'accountid' cgcloud.ProductResolution.ProcessStep.GLOBALACCOUNTPRODUCTLISTFILTER, //Product Filter: Only products that are part of the Authorization List of the Account defined by AccountId are returned from the dynamic product resolution result. Requires 'accountid', 'datefrom', 'datethru' cgcloud.ProductResolution.ProcessStep.AUTHORIZATIONLISTFILTER, //Post Processing Step: Resolves the product hierarchy for the result products. // Requires 'productgrouplevels', 'referenceDate' cgcloud.ProductResolution.ProcessStep.RESOLVEHIERARCHY, //Post Processing Step: Resolves the tactic product excludes. // Requires 'tactics' cgcloud.ProductResolution.ProcessStep.RESOLVETACTICPRODUCTEXCLUDES, //Post Processing Step: Resolves the bill of material components cgcloud.ProductResolution.ProcessStep.RESOLVEBILLOFMATERIALS, //Product Filter: Discontinued products will be filtered as per year offset. Requires considerdiscontinuedproductsyearoffset cgcloud.ProductResolution.ProcessStep.DISCONTINUEDPRODUCTSFILTER }); configuration.setAccountId(''); configuration.setPromotionId(''); configuration.setReferenceDate(Date.today()); configuration.setCommitDate(Date.today()); configuration.setDateFrom(Date.today().addDays(-5)); configuration.setDateThru(Date.today().addDays(5)); configuration.setProductGroupLevels('Category'); configuration.setProductFilter( new Map{ 'cgcloud\_\_criterion\_1\_product\_\_c' => new List{ '' } }); configuration.setManualProducts(new List{ new Map{ 'productid' => '', 'included'\=> true }, new Map{ 'productid' => '', 'included'\=> false } }) configuration.setKAMStateFilter('bytimeframe'); // or setKAMStateFilter('bycommitdate') configuration.addTactic('', new List('')); //List of excluded products configuration.addTactic('', new List('')); configuration.setConsiderDiscontinuedProductsYearOffset(); // lookback period to filter discontinued products cgcloud.GetProductsCallout.GetProductsCalloutResponse response = request.execute( cgcloud.TransactionHandler.getTransactionIdentifier(), configuration ); cgcloud.GetProductsCallout.DeNormalizedCalloutProductRows result = ((cgcloud.GetProductsCallout.GetProductDeNormalizedCalloutResponse) response).getResult(); System.debug(JSON.serialize(result)); # Get Report Data Get runtime report data for display on the user-interface. ## Resource GET\_REPORT\_DATA ## Available version 55.0 ## Request Parameters | Property Name | Type | Description | Required or Optional | | --- | --- | --- | --- | | filters | Map | Specify filters for the report execution. For more information on the report filters, see [Consumer Good Cloud Real Time Reporting Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.cgcloud_rtr_dev_guide.meta/cgcloud_rtr_dev_guide/apex_namespace_CGCloud.htm "HTML (New Window)"). | Required | | reportName | String | Report name to execute. The Report name must exist on the target Sales org. | Required | | unZippedResponse | String | Report data without compressing the reponse. Always send true from APEX. | Required | | productIdsForApex | Boolean | Indicates whether the product IDs are in a format that can be used by Apex (true) or not (false). Always specify true. | Required | ## Apex Request Example // Logical endpoint name String endpointName = 'GET\_REPORT\_DATA'; // name of the salesorg for which the report should be executed String salesOrg = '0001'; .OffplatformCallout callout = new .OffplatformCallout(endpointName, salesOrg); // Log Transaction Id String txId = .TransactionHandler.getTransactionIdentifier(); // Execute callout .OffplatformCalloutResponse response = callout.execute( txId, new Map(), // No URL Parameters JSON.serialize( new Map { 'unzippedresponse' => 'true', // Required 'productidsforapex' => true, // Required 'reportname' => 'Promotion Report', // Report to execute 'filters' => new Map { // Report filters. Filters are dependent on the report definition! 'periodmonth' => new Map { 'start' => 0, 'total' => 12, 'year' => 2022 }, 'accountsfids' => new List {'001TC000000Ot6mYAC'}, 'productsfids' => new List {'01tTC0000001oHLYAY'}, 'promo\_templatesfid' => new List {'a2UTC00000017Hd2AI', 'a2UTC00000017Hb2AI'}, 'promo\_phase' => new List { 'Planning', 'Modeling', 'Committed', 'ForApproval' }, 'productlevel'\=> 'product' } } ) ); if (response.status != 200) { // Handle error and return error info to caller } // Deserialize Response Map report = (Map) JSON.deserializeUntyped(response.result); // The names of the components come from the uimapping section of the // report definition. The UI components defined in the report definition will be present // in the result // ScoreCard component is represented by an array of decimals. // Each value matches the kpi defined in the report configuration inside the "scorecard" // KPI Group under attributes->kpidimension // the matching is index based (Kpi in first position is index 0) List scoreCard = (List) report.get('ScoreCard'); // Flatlist components are represented by an object with a header and data property. // header property contains all the column headers // data property is an array of arrays. Each outer // array represents a row and inner array represent column values // The 3 first elements of each row are reserved // - Index 0 represent the row type. All row types can be mapped with the "rowTypeMapping" // Present in the response. // All product related ids use a shorter format. These product ids can be mapped // to SFDC Product2 ids by using the "internalIdToSfId" property of the reponse Map prodIdToSFIdMap = (Map) report.get('internalIdToSfId'); Map flatlist = (Map) report.get('FlatList'); List header = (List) flatlist.get('header'); Map rowTypeMapping = (Map) flatlist.get('rowTypeMapping'); List data = (List) flatlist.get('data'); // extract header names List headerNames = new List(); for (Object obj: header) { Map casted = (Map) obj; headerNames.add(String.valueOf(casted.get('name'))); } // Print all the data for (Integer i = 0; i < data.size(); ++i) { system.debug('Printing Row #' + i); List dataRow = (List) data.get(i); // print rowTypeMapping System.debug('RowType: ' + String.valueOf(rowTypeMapping.get(String.valueOf(dataRow.get(1))))); for (Integer j = 0; j < headerNames.size(); ++j) { String headerName = headerNames.get(j); Object dataCell = dataRow.get(j + 3); // Offset by 3 if (headerName.startsWith('productdimension') && dataCell != null && prodIdToSFIdMap.containsKey(String.valueOf(dataCell))) { dataCell = prodIdToSFIdMap.get(String.valueOf(dataCell)); } System.debug(headerName + ': ' + dataCell); } } # Get Started with Consumer Goods Cloud Streamline customer relationships, grow your business, and initiate intelligent sales with Salesforce Consumer Goods Cloud product. It allows you to collaborate with your customers and deliver on your brand promises. Consumer Goods includes the following: - Retail Execution - Plan store visits for your field representatives and analyze your business's health across stores through the web portal. Use the Salesforce Retail Execution mobile app to stay organized while the fields representatives perform visit activities. - Sync Management - Use the Sync Management app to configure how data is synced between Salesforce and mobile devices. - Direct Store Delivery (DSD): Create routes and tours to define a list of stops for the driver to deliver the goods. - Trade Promotion Management - Plan, create, and run promotional activities, and track them for better performance. You can go to [Integration Service APIs guide](https://developer.salesforce.com/docs/industries/rcgps-integration-service/references/rcgintsrvc-apis?meta=Summary) to learn more about how the Integration APIs are used to integrate data from external systems to the Retail and Consumer Goods (RCG) Trade Promotion Management. - Real Time Reporting (RTR): Provides real-time reports that can be exported and customized using Apex classes. For more information, go to [Consumer Goods Cloud Real Time Reporting Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.cgcloud_rtr_dev_guide.meta/cgcloud_rtr_dev_guide/rtr_integration_api_introduction.htm). ## Retail Execution With Retail Execution, a sales manager can plan store visits for field representatives and analyze the business’s health across stores. As a field representative on a visit, you can track inventory, take orders, and capture visit details using the Retail Execution mobile app. This app can be customized using Modeler to meet the business requirements. For more information on the Modeler, see [Visual Studio Code based Modeler for Consumer Goods Cloud](https://help.salesforce.com/s/articleView?language=en_US&id=sf.modeler_vscode_getting_started_parent.htm&type=5).Use the following resources to get started with Retail Execution: - Use [Retail Execution Custom Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_236_custom_objects.htm) to store information related to customers, transactions, relationships between objects, and other workflows across Retail Execution such as details of an asset survey. - Use [Consumer Goods Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_retail_overview.htm) to store information related to entities that support Retail Execution such as Account, Asset, OperatingHours, Product, User, Visitor, and RetailStore. - Use [Visit Recommendation Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/industries_einstein_visit_recommendation_api_overview.htm), [Associated Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_associated_objects_list_einstein.htm), and [Actions](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/einstein_visit_recommendation_actions_parent.htm) to store information about visit recommendation requests and visit recommendations. - Use [Visit Activity Recommendation Standard Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/industries_einstein_visit_activity_recommendation_api_overview.htm) and [Associated Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_associated_objects_list_einstein_task.htm) to store information about visit task recommendation requests and visit task recommendations. **Sync Management** Sync Management is part of Retail Execution and it ensures that the information available in web portal and mobile application is the same. When business data and business workflow-specific data are modified on Salesforce, the system identifies the difference and applies the changes to mobile devices during a sync process. When a sync process begins, the Sync Management app verifies the mobile app updates, Runtime Artifacts (RTAs), and metadata, and then downloads the changes to mobile devices. Use the following resources to get started with Sync Management: - Use [Sync Management Custom Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_retail_custom_objects_overview.htm) to store information related to synchronization settings, object relationships, performance, and history. **Direct Store Delivery** Direct Store Delivery (DSD) is a supply chain model where a manufacturer sells goods directly to retailers. You can process orders, payments, deliveries, and returns by using DSD. Use the following custom objects to store information related to routes, tour, vehicle, and warehouse: - [cgcloud\_\_Route\_\_c](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_cgcloud__route__c.htm) - [cgcloud\_\_Route\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_cgcloud__route_template__c.htm) - [cgcloud\_\_Tour\_\_c](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tour__c.htm) - [cgcloud\_\_Tour\_Check\_\_c](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tour_check__c.htm) - [cgcloud\_\_Tour\_Object\_Reference\_\_c](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tour_object_reference__c.htm) - [cgcloud\_\_Tour\_Template\_\_c](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tour_template__c.htm) - [cgcloud\_\_Tour\_Template\_Object\_Reference\_\_c](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tour_template_object_reference__c.htm) - [cgcloud\_\_Tour\_Template\_Tour\_Check\_\_c](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tour_template_tour_check__c.htm) - [cgcloud\_\_Tour\_Tour\_Check\_\_c](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_cgcloud__tour_tour_check__c.htm) - [cgcloud\_\_Vehicle\_\_c](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_cgcloud__vehicle__c.htm) - [cgcloud\_\_Vehicle\_Warehouse\_\_c](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_cgcloud__vehicle_warehouse__c.htm) - [cgcloud\_\_Route\_Account\_\_c](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_cgcloud__route_account__c.htm) ## Trade Promotion Management Trade Promotion Management (TPM) helps you oversee the promotions that you run for your retailers, from planning to completion, to ensure that each promotion achieves its objectives. Use TPM to streamline your team’s efforts, overcome the complexities of running several promotions concurrently, and unlock maximum results. Use the following resources to get started with Trade Promotion Management: - Use [Trade Promotion Management Custom Objects](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/sforce_api_objects_236_common_custom_objects.htm) to store information related to promotions, payments, and reports. - Use [Trade Promotion Management Service APIs](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/cgcloud_tpm_service_introduction.htm) to manage products, promotions, and reports. - Use Trade Promotion Management Apex Classes such as [TPM\_ProductFilter Class](https://developer.salesforce.com/docs/atlas.en-us.264.0.retail_api.meta/retail_api/TPM_ProductFilter.htm) to gain programmatic access to your data. # Get Time-Dependent Account Product List Retrieves an array of products from the time-dependent account product list. A time-dependent list is generated from the products that are included in the product assortment that's been defined for the purpose. See [Understand Account Product List](https://help.salesforce.com/s/articleView?id=ind.tpm_admin_concept_account_product_list.htm&type=5&language=en_US "HTML (New Window)"). Limits: - Maximum number of months based on TradeCalMaxNumberMonths. Default value is 18. See [Soft Limits of Trade Calendar](https://help.salesforce.com/s/articleView?id=ind.tpm_reference_trade_calender_soft_limits.htm&type=5&language=en_US "HTML (New Window)"). - Maximum number of products in the time-dependent account product list based on TimeDepAccProdListResponseMaxProds. Default value is 30000. ## Resource GET\_TIME\_DEPENDENT\_ACCOUNT\_PRODUCT\_LIST ## Available version 55.0 ## Request Parameters | Name | Type | Description | Required or Optional | | --- | --- | --- | --- | | accountId | String | ID of the account record from Salesforce. | Required | | validFrom | Number | The date and time that specifies the beginning of the time period (in timestamp format). | Required | | validThru | Number | The date and time that specifies the end of the time period (in timestamp format). | Required | ## Apex Request Example // Logical endpoint name String endpointName = 'GET\_TIME\_DEPENDENT\_ACCOUNT\_PRODUCT\_LIST'; // name of the salesorg for which the hob should be scheduled String salesOrg = '0001'; .OffplatformCallout callout = new .OffplatformCallout(endpointName, salesOrg); // Log Transaction Id String txId = .TransactionHandler.getTransactionIdentifier(); // Account Id for which the products in the global apl should be retrieved Id accountId = '001B000001Q48yMIAR'; // Kroger Atlanta DateTime validFrom = DateTime.valueOfGmt('2022-01-01 00:00:00Z'); DateTime validThru = DateTime.valueOfGmt('2022-12-31 00:00:00Z'); Map urlParameters = new Map(); urlParameters.put('accountsfid', accountId); urlParameters.put('validfrom', validFrom.getTime()); urlParameters.put('validthru', validThru.getTime()); String payload = null; .OffplatformCalloutResponse response = callout.execute(txId, urlParameters, payload); if (response.status != 200) { // Handle error and return error info to caller } // Fetch the list from the response Set accountproducts = new Set(); String aplListString = (String) response.Result; if (!String.isEmpty(aplListString)) { Map mapAccountProductList = (Map) JSON.deserializeUntyped( aplListString ); List listAccountProductListIds = (List) mapAccountProductList.get( 'accountproducts' ); for (Object obj : listAccountProductListIds) { accountproducts.add((Id) obj); } } # getAccounts This method returns the list of accounts valid for the target promotion. Target promotion timeframe is calculated by the difference in days between the original promotion date and the new date. ## Input Parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | promotionId | String | YES | ID of the promotion. | | inStoreDateFrom | String | YES | New start date of the promotion. | ## Input Sample "source": { "class": "CopyPromotionWizardCallable", "method": "getAccounts", "cache": true, "params": { "promotionId": "{! promotionId }", "inStoreDateFrom": "{! promoDateFrom }" } } ## Response Sample \[ { "Name": "\*Kroger Atlanta", "Id": "0012X000023GAClQAO" }, { "Name": "\*Kroger Store #201", "Id": "0012X000023GACxQAO" }, { "Name": "\*Safeway South-East", "Id": "0012X000023GAC5QAO" }, { "Name": "+Kroger Detroit", "Id": "0012X000023GACWQA4" } \] ## Response Properties | Name | Description | | --- | --- | | Id | ID of the Account. | | Name | Name of the Account. | # getAccounts This method returns the list of accounts valid for the target derived promotion. ## Input Parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | promotionId | String | YES | ID of the promotion. | | inStoreDateFrom | String | NO | New start date of the promotion. If not provided, then the source promotion dates are considered. | ## Input Sample "source": { "class": "DerivePromotionWizardCallable", "method": "getAccounts", "cache": true, "params": { "promotionId": "{! promotionId }", "inStoreDateFrom": "{! promoDateFrom }" } } ## Response Sample \[ { "Name": "\*Kroger Atlanta", "Id": "0012X000023GAClQAO" }, { "Name": "\*Kroger Store #201", "Id": "0012X000023GACxQAO" }, { "Name": "\*Safeway South-East", "Id": "0012X000023GAC5QAO" }, { "Name": "+Kroger Detroit", "Id": "0012X000023GACWQA4" } \] ## Response Properties | Name | Description | | --- | --- | | Id | ID of the Account. | | Name | Name of the Account. | # getAccounts This method returns the list of accounts valid for the period defined by the input date from and the date through. ## Input Parameters | Name | Description | | --- | --- | | dateFrom | Valid account start date | | dateThru | Valid account end date | ## Input Sample { "class": "NewPromotionWizardCallable", "method": "getAccounts", "cache": true, "params": { "dateFrom": "{! promoDateFrom }", "dateThru": "{! promoDateThru }" } } ## Response Sample \[ { "Name": "\*Kroger Atlanta", "Id": "0012X000023GAClQAO" }, { "Name": "\*Kroger Store #201", "Id": "0012X000023GACxQAO" }, { "Name": "\*Safeway South-East", "Id": "0012X000023GAC5QAO" }, { "Name": "+Kroger Detroit", "Id": "0012X000023GACWQA4" } \] ## Response Properties This method returns a list of items with the following properties: | Name | Description | | --- | --- | | Id | Account SFDC ID | | Name | Account Name. | # getAccountSets This method returns the list of account sets valid for the target promotion. Target promotion timeframe is calculated by the difference in days between the original promotion date and the new date. ## Input Parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | promotionId | String | YES | ID of the promotion. | | inStoreDateFrom | String | YES | New start date of the promotion. | ## Input Sample "source": { "class": "CopyPromotionWizardCallable", "method": "getAccountSets", "cache": true, "params": { "promotionId": "{! promotionId }", "inStoreDateFrom": "{! promoDateFrom }" } } ## Response Sample \[\[ { "Name": "Prio A customers in Area 47\*", "Id": "a0G2X00002jffpwUAA" }, { "Name": "seg15feb2021", "Id": "a0G7R00002n1zzoUAA" }, { "Name": "South", "Id": "a0G2X00002jffpzUAA" } \] ## Response Properties | Name | Description | | --- | --- | | Id | ID of the Account. | | Name | Name of the Account. | # getAccountSets This method returns the list of account sets valid for the period defined by the input date from and date through. ## Input Parameters | Name | Description | | --- | --- | | dateFrom | Valid Account start date | | dateThru | Valid Account end date | ## Input Sample { "class": "NewPromotionWizardCallable", "method": "getAccountSets", "cache": true, "params": { "dateFrom": "{! promoDateFrom }", "dateThru": "{! promoDateThru }" } } ## Response Sample \[ { "Name": "Prio A customers in Area 47\*", "Id": "a0G2X00002jffpwUAA" }, { "Name": "seg15feb2021", "Id": "a0G7R00002n1zzoUAA" }, { "Name": "South", "Id": "a0G2X00002jffpzUAA" } \] ## Response Properties This method returns a list of items with the following properties: | Name | Description | | --- | --- | | Id | Account Set SFDC Id | | Name | Account Set Name. | # getProducts This method returns the list of tactic templates related to the input promotion template. ## Input Parameters | Name | Description | | --- | --- | | level | The product level to be retrieved. | | dateFrom | Start date of the promotion. | | dateThru | End date of the promotion. | | promotionTemplate | ID of the promotion template. | | accountOrAccountSet | Account or account set of the promotion. | ## Input Sample { "class": "NewPromotionWizardCallable", "method": "getProducts", "params": { "level": "Brand", "dateFrom": "{! promoDateFrom }", "dateThru": "{! promoDateThru }", "promotionTemplate": "{! promoTemplate.Id }", "accountOrAccountSet": "{! if(promoTemplate.AnchorType, if(promoTemplate.AnchorType == 'CustomerSet', promoAnchorAccountSet.Id, promoAnchorAccount.Id), '') }" }, "cache": true } ## Response Sample \[ { "Id": "a2L2X00000Bw3MfUAJ", "Name": "Beverages Adv. Material" }, { "Id": "a2L2X00000Bw3MqUAJ", "Name": "Big Pizza" }, { "Id": "a2L2X00000Bw3MoUAJ", "Name": "Cakes" }, { "Id": "a2L2X00000Bw3MeUAJ", "Name": "Caspro Adv. Material" } \] ## Response Properties This method returns a list of items with the following properties: | Name | Description | | --- | --- | | Id | Product SFDC ID | | Name | Product description value. | # getPromotion This method returns the requested fields for the given promotion ID. ## Input Parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | promotionId | String | YES | ID of the promotion. | | fields | List | YES | List of fields for which the details are required. | ## Input Sample "source": { "class": "CopyPromotionWizardCallable", "method": "getPromotion", "cache": false, "params": { "promotionId": "{! \_input\_.promotionId }", "fields": \[ "Id", "cgcloud\_\_Slogan\_\_c", "cgcloud\_\_Placement\_Date\_From\_\_c", "cgcloud\_\_Anchor\_Account\_\_c", "cgcloud\_\_Anchor\_Account\_Set\_\_c", "cgcloud\_\_Promotion\_Template\_\_r.cgcloud\_\_Anchor\_Type\_\_c" \] } } ## Response Sample { "Id": : "a2a2X000004L7wPQAS", "cgcloud\_\_Slogan\_\_c": "TEST PROMOTION", "cgcloud\_\_Placement\_Date\_From\_\_c": "2024-01-01", "cgcloud\_\_Anchor\_Account\_\_c": "0012X000023GAClQAO", "cgcloud\_\_Anchor\_Account\_Set\_\_c": null, "cgcloud\_\_Promotion\_Template\_\_r.cgcloud\_\_Anchor\_Type\_\_c": "Customer" } ## Response Properties A single object with the requested properties. # getPromotionKPIs This method returns the list of editable and editable calculated KPIs on promotion level for the input promotion template ## Input Parameters | Name | Description | | --- | --- | | promoTemplate | SFDC ID of the promotion template. | ## Input Sample { "class": "NewPromotionWizardCallable", "method": "getPromotionKPIs", "params": { "promoTemplate": "{! promoTemplate.Id }" }, "cache": true } ## Response Sample \[ { "ValueDecimalPlaces": 0, "Name": "Promotion Volume", "Id": "PromoPlanSellOutVol" }, { "ValueDecimalPlaces": 2, "Name": "Promoted Price", "Id": "PromoPlanPromotedPrice" } \] ## Response Properties This method returns a list of items with the following properties:
Name Description
Id KPI name
Name KPI description label.
ValueDedimalPlaces

Maximum number of decimal places expected for a value of the KPI based on the KPI Type

Possible Values:
  • Money: 2
  • Percentage: 2
  • Price: 2
  • Volume: 0
  • None: 10
# getPromotionTemplates This method returns the list of possible Promotion Templates for derive workflow. ## Input Parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | promotionId | String | YES | ID of the promotion. | ## Input Sample "source": { "class": "DerivePromotionWizardCallable", "method": "getPromotionTemplate", "cache": true, "params": { "promotionId": "{! promotionId }" } } ## Response Sample \[ { "Name": "Customer Promotion", "Id": "a2a2X000004L7xPQAS" } \] ## Response Properties | Name | Description | | --- | --- | | Id | ID of the Promotion Template. | | Name | Name of the Promotion Template. | # getPromotionTemplates This method returns the list of promotion templates along with additional information. The method will search for promotion templates where the "Display\_In\_MetadataWizard\_\_c" field is set to true unless the "all" parameter is set to true. ## Input Parameters Wizards are generated from a metadata JSON structure defining the list of components that will be part of a wizard along with some additional properties to define the available actions and the general layout. | Name | Description | | --- | --- | | all | Boolean. If true, it will display all valid promotion templates. If false or not set, it will return only the templates with the flag "Display\_In\_MetadataWizard\_\_c" as true. | ## Input Sample { "class": "NewPromotionWizardCallable", "method": "getPromotionTemplates", "cache": true } ## Response Sample \[ { "NumberOfTacticKPIs": 0, "NumberOfPromotionKPIs": 0, "HasTacticTemplates": true, "ProductDefinitionLevel": "Tactic", "AnchorType": "Customer", "Name": "\*BanTest\_Tacticlevel", "Id": "a2a2X000004L7wPQAS" }, { "NumberOfTacticKPIs": 0, "NumberOfPromotionKPIs": 1, "HasTacticTemplates": true, "ProductDefinitionLevel": "Tactic", "AnchorType": "Customer", "Name": "Customer Promotion", "Id": "a2a2X000004L7xPQAS" } \] ## Response Properties This method will return a list of items with the following properties: | Name | Description | | --- | --- | | AnchorType | Anchor Type for the Promotion. Possible values are "Customer", "CustomerSet" and null | | HasTacticTemplates | Boolean value. True if the Promotion Template can have tactics because it has related Tactic Templates. | | Id | SFDC Id of the Promotion template | | Name | Description value of the promotion template. | | NumberOfPromotionKPIs | Number of Editable and Editable Calculated Promotion Level KPI's the template has. | | NumberOfTacticKPIs | Number of Editable and Editable Calculated Tactic Level KPI's the template has. | | ProductDefinitionLevel | Product definition level for the template. Valid values are "Promotion" and "Tactic" | # getTacticCompensationModels This method returns the list of valid compensation model values for a tactic template based on the tactic template defined tactic record type. ## Input Parameters | Name | Description | | --- | --- | | tacticTemplate | SFDC ID of the tactic template. | ## Input Sample { "class": "NewPromotionWizardCallable", "method": "getTacticCompensationModels", "params": { "tacticTemplate": "{! tacticTemplate.Id }" }, "cache": true } ## Response Sample \[ { "Name": "Per Case", "Id": "PerCase" }, { "Name": "Percentage", "Id": "Percentage" } \] ## Response Properties This method returns the list of items with the following properties: | Name | Description | | --- | --- | | Id | Value for the compensation model | | Name | Label for the compensation model | # getTacticKPIs This method returns the list of editable and editable calculated KPI's on tactic level for the input ppromotion template and tactic template. It returns all the possible KPI's that are part of the tactic template defined KPI subset in the order defined by the sort field. ## Input Parameters | Name | Description | | --- | --- | | promoTemplate | SFDC ID of the promotion template. | | tacticTemplate | SFDC ID of the tactic template. | ## Input Sample { "class": "NewPromotionWizardCallable", "method": "getTacticKPIs", "params": { "promoTemplate": "{! promoTemplate.Id }", "tacticTemplate": "{! tacticTemplate.Id }" }, "cache": true } ## Response Sample \[ { "ValueDecimalPlaces": 10, "Name": "Variable Amount", "Id": "ProVarAmountPriceCut" }, { "ValueDecimalPlaces": 2, "Name": "Fixed Amount", "Id": "ProFixedAmountLumpSum" } \] ## Response Properties This method returns a list of items with the following properties:
Name Description
Id KPI name
Name KPI description label.
ValueDedimalPlaces

Maximum amount of decimal places expected for a value of the KPI based on the KPI type:

Possible Values:
  • Money: 2
  • Percentage: 2,
  • Price: 2
  • Volume: 0
  • None: 10
# getTacticTemplates This method returns the list of tactic templates related to the input promotion template. ## Input Parameters | Name | Description | | --- | --- | | promoTemplate | SFDC ID of the promotion template. | ## Input Sample { "class": "NewPromotionWizardCallable", "method": "getTacticTemplates", "params": { "promoTemplate": "{! promoTemplate.Id }" }, "cache": true } ## Response Sample \[ { "Id": "a3B2X00000167f3UAA", "Name": "Price Cut" }, { "Id": "a3B2X00000167f4UAA", "Name": "Promo Advertising" } \] ## Response Properties This method returns a list of items with the following properties: | Name | Description | | --- | --- | | Id | SFDC ID of the Tactic template | | Name | Description value of the Tactic template. | # Getting Access Token for the User To perform subsequent requests to the Integration API, you must get an access token for accessing the Integration API. You can get access tokens in multiple ways before sending requests to the RTR API endpoints. This example uses the simple username-password combination (not recommended in non-DEV environments). The response contains "access\_token", which is needed for subsequent requests. ## cURL example: curl --location --request POST 'https://login.salesforce.com/services/oauth2/token' \\ --header 'Content-Type: application/x-www-form-urlencoded' \\ --header 'Cookie: BrowserId=S0x8SC\_iEeu04d3AnIIK0w; CookieConsentPolicy=0:0' \\ --data-urlencode 'grant\_type=password' \\ --data-urlencode 'client\_id={{CONNECTED APP CLIENT ID}}' \\ --data-urlencode 'client\_secret={{CONNECTED APP CLIENT SECRET}}' \\ --data-urlencode 'username={{USERNAME}}' \\ --data-urlencode 'password={{PASSWORT}}' ## Sample Response: { "access\_token": "xyz!xyz", "instance\_url": "xyz", "id": "https://login.salesforce.com/id/xyz/xyz", "token\_type": "Bearer", "issued\_at": "1631625949723", "signature": "xyz“ } # Getting CSV Delta Export Once the actual export file is requested, the CSV delta export file can be requested. ## cURL example: curl --location --request GET 'https://int-vir-us.consumergoodscloudprocessingservices.com/api/v1/files/getcsv/{{csvGuid}}?path=delta --header 'Content-Type: application/json' \\ --header 'Authorization: Bearer {{access\_token}}' The response is a binary file that must be stored. Its format is .csv. This archive can then be opened with a compression software. # Getting CSV Full Export After you’ve retrieved the access token, the actual full export file can be requested. ## cURL example: curl --location --request GET 'https://int-vir-us.consumergoodscloudprocessingservices.com/api/v1/files/getcsv/{{csvGuid}}?path=full --header 'Content-Type: application/json' \\ --header 'Authorization: Bearer {{access\_token}}' The response is a binary file that must be stored. The format of this file is .csv. This archive can then be opened with a compression software. # Implementing Workflow Steps Workflow Steps are implemented as APEX classes that are used in implementing the System.Callable interface. global with sharing class implements System.Callable { global Object call(String method, Map context) { ... } } In the Workflow Step record, you need to define 2 attributes that maps to the APEX class: - Classname: The name of the APEX class that will be instantiated. - Method: The string value that will be sent to the APEX class call method as first parameter. - Entity: Defines the entity that will be passed to the APEX class. On the context parameter, the passed in Object contains the following properties: // Common to all steps. String txId: TransactionId of the process String salesOrg: Sales organization passed to the execution. Object input: Whole Input Object Object output: Whole Output Object // Step specific SObject workflowStepRecord: Workflow Step Record. // Entity specific String inputPath: Path of the current input in the main input object. String inputEntityPath: A list of the names of the parent input entities ordered based on the deepness level. (i.e. Promotion/Tactic/TacticBrand). Object currentInput: Current block of the input object being processed. List parentInputs: A list of the parent Input Entities for this step. Each entry on the list will be the input Entity. Has the same number of elements as the inputEntityPath. (i.e. \[ 0 \] → Promotion, \[ 1 \] → Tactic, \[ 2 \] → TacticBrand) String outputPath: Path of the current output in the main output object. String outputEntityPath: A list of the names of the parent output entities ordered based on the deepness level. (i.e. BOPromotion/LOTactic). Object currentOutput: Output object where the rule is expected to set the attributes. Rules are expected to set this object into the proper place of the parent. List parentOutputs: A list of the parent Output Entities for this step. Each entry on the list will be the output Object for the Entity. Has the same number of elements as the outputEntityPath. (i.e. \[ 0 \] → BOPromotion, \[ 1 \] → LOTactic) During runtime, each Workflow Step is executed once for each available entity. # Import Promotions Input Input representation of the promotion import object. ## JSON Example POST promotions/ingest { "workflow" : "Create", "importId" : "12345678-1234-1234-1234-123456789012", "salesOrg" : "0001", "promotions" : \[{ // Promotion Input JSON }\] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | importId | Integer | Import ID of the process. If not passed, a new import transaction will be created. | Optional | 55 | | workflow | Integer | Name of the promotion business object API workflow to be executed. | Required | 55 | | salesOrg | SalesOrgName | Name of the sales organization. | Optional | 55 | | promotions | List | List of promotion payloads. | Required | 55 | # Import Status Output Represents the details of the ingest promotions import status. ## JSON Example { "txid": "201d590c-6cbd-4705-8bc6-acbdec5f9bb1", "details:\[ { "status": "Calculated", "nrOfItems": 25 }, { "status": "ToBeCalculated", "nrOfItems": 50 }, { "status": "Written", "nrOfItems": 50 }, { "status": "Error", "error": "ValidationError", "nrOfItems": 25 "sample": \["aX01000000000001", "aX01000000000002", "aX01000000000005", "aX01000000000006", "aX01000000000007", "aX01000000000008", "aX01000000000009", "aX01000000000010", "aX01000000000011", "aX01000000000012"\] }, { "status": "Error", "error": "TransformationError", "nrOfItems": 5, "sample": \["aX01000000000003", "aX01000000000004", "aX01000000000013", "aX01000000000014", "aX01000000000015" \] }, { "status": "Initial", "nrOfItems": 325 } \] } ## Properties
Property Name Type Description Available Version
txid String The transaction ID of the import workflow. 55
details List<ImportStatus> Indicates the state of the promotions. 55
status String Indicates the import status.
Possible values are:
  • Calculated
  • ToBeCalculated
  • Written
  • Initial
  • Error
 55
nrOfItems Integer Indicates the number of promotions that exist in the given status. 55
sample List<String> The list of the first 10 CUD records IDs. 55
error String Indicates the type of error if any, that occurs during the import. 55
# Ingest Promotions This endpoint receives the promotions payload that must be processed. The system import promotions, creates and updates them, and triggers the promotion calculation. The status of the import can be monitored with the GET\_PROMOTION\_IMPORT\_STATUS endpoint. ## Resource promotions/ingest ## Available Version 55 ## Requires Chatter No ## HTTP Methods POST ## Request Body for POST ### Root XML tag POST promotions/ingest ### JSON Example { "workflow" : "Create", "importId" : "12345678-1234-1234-1234-123456789012", "salesOrg" : "0001", "promotions": \[ { "AnchorAccount": "CS\_Atlanta",// external Id "PromotionTemplate": "Customer Promotion", "Comment": "250aup new bom gcp", "Slogan": "250aup new bom gcp ", "DateFrom": "2024-01-01", "DateThru": "2024-12-31", "PlacementDateFrom": "2024-03-01", "PlacementDateThru": "2024-04-30", "DeliveryDateFrom": "2024-08-01", "DeliveryDateThru": "2024-09-30", "OrderDateFrom": "2024-06-01", "OrderDateThru": "2024-07-30", "CommitDate": "2024-01-10", "ProductFilter": { "Criteria": { "Category": \[ "Snacks", "Beverages" \], "Brand": \[ "Empower\_Cola", "HiChoc" \] } }, "ManualInputs": \[ { "KPI": "ProPlanTotalVolume", "Value": 900000 } \], "Tactics": \[ { "Amount": 2500, "CompensationModel": "PerCase", "DateFrom": "2024-05-01", "DateThru": "2024-07-30", "InStoreDateFrom": "2024-05-01", "InStoreDateThru": "2024-07-15", "ShipmentDateFrom": "2024-05-16", "ShipmentDateThru": "2024-07-30", "TacticTemplate": "PriceReduction" } \] } \] } ### Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | importId | Integer | ImportId of the process. If not passed, a new import transaction will be created. | Optional | 55 | | workflow | Integer | Promotion Business Object API workflow name to execute. | Required | 55 | | salesOrg | SalesOrgName | Sales organization. | Optional | 55 | | promotions | List | List of Promotion payloads. Max 50 items. | Required | 55 | ## Response Body for POST [Promotion Import Output Representation](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/connect_responses_ingest_promotion_output.htm "Represents the details of the ingest promotions import status.") # Ingest Promotions Input Input representation of the ingest promotions request. ## Root XML tag POST promotions/ingest ## JSON Example { "workflow" : "Create", "importId" : "12345678-1234-1234-1234-123456789012", "salesOrg" : "0001", "promotions": \[ { "AnchorAccount": "CS\_Atlanta",// external Id "PromotionTemplate": "Customer Promotion", "Comment": "250aup new bom gcp", "Slogan": "250aup new bom gcp ", "DateFrom": "2024-01-01", "DateThru": "2024-12-31", "PlacementDateFrom": "2024-03-01", "PlacementDateThru": "2024-04-30", "DeliveryDateFrom": "2024-08-01", "DeliveryDateThru": "2024-09-30", "OrderDateFrom": "2024-06-01", "OrderDateThru": "2024-07-30", "CommitDate": "2024-01-10", "ProductFilter": { "Criteria": { "Category": \[ "Snacks", "Beverages" \], "Brand": \[ "Empower\_Cola", "HiChoc" \] } }, "ManualInputs": \[ { "KPI": "ProPlanTotalVolume", "Value": 900000 } \], "Tactics": \[ { "Amount": 2500, "CompensationModel": "PerCase", "DateFrom": "2024-05-01", "DateThru": "2024-07-30", "InStoreDateFrom": "2024-05-01", "InStoreDateThru": "2024-07-15", "ShipmentDateFrom": "2024-05-16", "ShipmentDateThru": "2024-07-30", "TacticTemplate": "PriceReduction" } \] } \] } ## Properties | Name | Type | Description | Required or Optional | Available Version | | --- | --- | --- | --- | --- | | importId | Integer | ImportId of the process. If not passed, a new import transaction will be created. | Optional | 55 | | workflow | Integer | Promotion Business Object API workflow name to execute. | Required | 55 | | salesOrg | SalesOrgName | Sales organization. | Optional | 55 | | promotions | List | List of Promotion payloads. Max 50 items. | Required | 55 | # InStoreLocation Create locations within a retail store’s layout such as aisles, shelves, or backrooms. This object is available in API version 47.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Fields ### Category - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update - **Description**: Category of similar in-store location types across a store group. - **Possible values**: - Aisle - Backroom - Endcap ### Description - **Type**: textarea - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: Description of the in-store location. ### InStoreLocationType - **Type**: picklist - **Properties**: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update - **Description**: Type of in-store location. Most retail stores have similar layouts and have common in-store location types. - **Possible values**: - Assets - Backroom - Bin - Other - Shelf ### 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. ### LocationId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the GPS coordinates of the retail store. ### Name - **Type**: string - **Properties**: Create, Filter, Group, idLookup, Sort, Update - **Description**: User-defined name of the in-store location. ### PlanogramId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Planogram image associated with the in-store location. ### RetailStoreId - **Type**: reference - **Properties**: Create, Filter, Group, Sort - **Description**: ID of the store associated with the location. ## Associated Objects This object has the following associated objects. Unless noted, they’re available in the same API version as this object. - **[InStoreLocationFeed](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 is available for the object. - **[InStoreLocationHistory](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 object. # isPromotionAndUserSameSalesOrg This method validates if the given promotion belongs to the same Salesorg where the user exists. ## Input Parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | promotionId | String | YES | ID of the promotion. | ## Input Sample "source": { "class": "CopyPromotionWizardCallable", "method": "isPromotionAndUserSameSalesOrg", "cache": true, "params": { "promotionId": "{! promotionId }" } } # isPromotionCommitted This method validates if the given promotion is on Committed phase. ## Input Parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | promotionId | String | YES | ID of the promotion. | ## Input Sample "source": { "class": "DerivePromotionWizardCallable", "method": "isPromotionCommitted", "cache": false, "params": { "promotionId": "{! promotionId }" } } # IsPromotionTemplateCopyable This method validates the given promotion has a promotion template that can be copied. ## Input Parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | promotionId | String | YES | ID of the promotion. | ## Input Sample "source": { "class": "CopyPromotionWizardCallable", "method": "isPromotionTemplateCopyable", "cache": true, "params": { "promotionId": "{! promotionId }" } } # isPromotionTemplateDerivable This method validates if the given promotion has a derivable promotion template. ## Input Parameters | Name | Type | Required | Description | | --- | --- | --- | --- | | promotionId | String | YES | ID of the promotion. | ## Input Sample "source": { "class": "DerivePromotionWizardCallable", "method": "isPromotionTemplateDerivable", "cache": true, "params": { "promotionId": "{! promotionId }" } } # JobStatusNotificationService Class Processes job status notifications from external batch processing systems for Trade Promotion Management operations. Use this Apex REST class to receive job status notifications from external batch processing systems. The class processes HTTP POST requests that contain job execution status information for Trade Promotion Management (TPM) operations. When a notification is received, the class validates TPM licensing, parses the notification payload, and routes status updates to the appropriate handler. ## Namespace cgcloud ## doPost(notification) Processes job status notification payloads received through HTTP POST requests. The method validates TPM licensing, parses the incoming JSON notification, identifies the job chain type, and delegates processing to the appropriate handler. Comprehensive logging and error handling are implemented for JSON parsing errors and general exceptions. ## Signature of the Method @HttpPost global static void doPost(String notification) ## Parameters **notification: String** A JSON payload that contains job status notification details, including job chain ID, job ID, batch run status, job type, sales organization, status information, item statistics, timestamps, duration, and process count. ## Return Value Type: void # LWC Configuration In order to access the TPM promotion data in LWC layer, the tpm-promotion service component is used. Use the tpm-promotion component to hook into the promotion state and be able to extract data from the promotion (through events) and push new data to the promotion (through methods). **tpm-promotion component** import { api, LightningElement } from 'lwc'; export default class YourComponent extends LightningElement { @api recordId; // Record id is used to initialize the tpm-promotion component onEditModeChange(event) { // This event is called every time the Edit mode changes // for the promotion this.editMode = event.detail.value; } handleEditModeClick() { // You can push changes/alter the state of the promotion // by calling the component methods // State changes will be notified to all the components of the page this.template.querySelector('cgcloud-tpm-promotion') .setEditMode(!this.editMode); } } 55.0 true lightning\_\_RecordPage cgcloud\_\_Promotion\_\_c cgcloud If your org has [Lightning Web Security](https://developer.salesforce.com/docs/component-library/documentation/en/lwc/lwc.security_lwsec_intro) enabled, the runtimeNamespace property on the metadata file isn’t required. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note Lightning web security is a feature that must be tested before enabling. [LWC Security](https://developer.salesforce.com/docs/component-library/documentation/en/lwc/lwc.security_lwsec_when) When setting the runtimeNamespace property in the metadata file, your component cannot use modules from the ‘@salesforce’ package (any import whose route starts with @salesforce). ## Troubleshooting - Question: When my component runs, I get the error **Scoped imports are not allowed when runtime namespace is specified**. Answer: This error appears when trying to use “@salesforce” modules in your component. When specifying a runtimeNamespace in the metadata file, your component cannot access “@salesforce” resources. To perform APEX calls and other actions that require those modules, use the tpmGenericUtils modules available functions. - Question: When my component runs, I get the error **Attempting to reference cross-namespace module** Error scenarios - Your component does not have the **runtimeNamespace** property set up on it metadata file. To fix it, add the **runtimeNamespace** property with the namespace **cgcloud** to your component. - Your component includes other custom components that do not have the **runtimeNamespace** property in their metadata. Add the **runtimeNamespace** property with the namespace **cgcloud** to the included components (also to the included components of the included ones). All the components used by another component with a **runtimeNamespace** defined must have the **runtimeNamespace** property in their metadata. # Manual Inputs This section provides information about manual inputs. ## handleManualInputs2 - Description: Handles the list of manual inputs provided. - Classname: Promotion2BoApiCoreWorkflowSteps - Method: handleManualInputs Table 1. Input Properties | Property | Description | Required or Optional | | --- | --- | --- | | .KPI | Strings with 80 characters. Specifies the KPI Name to set. | Required | | .Value | Numeric value. Value to set to the KPI. | Required | | .Product | Product ID to set the KPI Value to. If not set, the KPI value is set as total for the promotion or tactic. The product ID can be specified as an SFDC ID or an external ID. | Required | Workflow to set manual inputs on product, tactic, and promotion level. **Sample Request** { // Promotion information Id: "Promo1ExternalId", // .. rest of Promotion input attributes ManualInputs: \[ { KPI: "ProPlanSpend", // Name of the KPI Product: "HiChoc", // Product to apply the KPI, external id of the product level Value: 1234 // Value of the KPI } \], Tactics: \[ { // Tactic Information Id: "Tactic1ExternalId", // .. rest of Tactic input attributes ManualInputs: \[ { KPI: "ProPlanSpend", Product: "HiChoc", Value: 1234 } \] } \] } # Manual Inputs Class This APEX class provides programmatic access to the TPM Promotion Manual Inputs for Calculation Overrides. This class is used also for Scenario Manual Inputs on Promotion. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note You can override the manual fields only after creating an instance of this class. ## Namespace cgcloud - **[TPM\_ManualInputs Methods](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ManualInputs.htm#tpm_manual_inputs)** ## TPM\_ManualInputs Methods The following are methods for TPM\_ManualInputs. - **[global ManualCalculationInput](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ManualInputs.htm#global_manual_calculation)** Adds a new Manual Input entry to the instance. - **[global List](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ManualInputs.htm#unique_531502841)** Returns the list of all Manual Inputs in the current instance. - **[global void removeManualInput](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ManualInputs.htm#unique_1738351664)** Removes the passed in manual input from the instance. If the manual input is not contained in the instance, nothing is removed. - **[global Object toGenericObject](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ManualInputs.htm#generic_object)** Serializes the manual inputs information to a generic Object instance. Useful for using the information in Remote calls. - **[global String toJSON](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ManualInputs.htm#global_TPM_json)** Serializes the manual inputs information for storage. - **[global TPM\_ManualInputs](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ManualInputs.htm#method_promotion.do.work)** Creates an empty structure with no manual inputs. - **[global TPM\_ManualInputs load](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ManualInputs.htm#global_TPM_ManualInputs)** Deserializes the received manual inputs from the input generic object. The current instance will be cleared and the manual inputs represented by the input will be loaded. - **[global TPM\_ManualInputs load](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ManualInputs.htm#manual_input)** Deserializes the received manual inputs from the input payload. The current instance will be cleared and the manual inputs represented by the payload will be loaded. - **[global void clear](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ManualInputs.htm#global_void_clear)** Deletes all manual inputs from the instance. Similar state as creating a new instance. - **[global List getManualInputs](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ManualInputs.htm#globalTPM_GetManualInputs)** Returns a list of all manual inputs in the current instance. - **[global ManualCalculationInput.ManualInput addManualInput](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ManualInputs.htm#globalTPM_AddManualInputs)** Adds a new manual input entry to the instance. ### global ManualCalculationInput Adds a new Manual Input entry to the instance. #### API Version 55 #### Signature global ManualCalculationInput.ManualInput addManualInput(ManualCalculationInput.ManualInput mi) ### global List Returns the list of all Manual Inputs in the current instance. #### API Version 55 #### Signature global List getManualInputs() ### global void removeManualInput Removes the passed in manual input from the instance. If the manual input is not contained in the instance, nothing is removed. #### API Version 55 #### Signature global void removeManualInput(ManualCalculationInput.ManualInput mi) ### global Object toGenericObject Serializes the manual inputs information to a generic Object instance. Useful for using the information in Remote calls. #### API Version 55 #### Signature global Object toGenericObject() ### global String toJSON Serializes the manual inputs information for storage. #### API Version 55 #### Signature global String toJSON() ### global TPM\_ManualInputs Creates an empty structure with no manual inputs. #### API Version 55 #### Signature global TPM\_ManualInputs() ### global TPM\_ManualInputs load Deserializes the received manual inputs from the input generic object. The current instance will be cleared and the manual inputs represented by the input will be loaded. #### API Version 55 #### Signature global TPM\_ManualInputs load(Object data) ### global TPM\_ManualInputs load Deserializes the received manual inputs from the input payload. The current instance will be cleared and the manual inputs represented by the payload will be loaded. #### API Version 55 #### Signature global TPM\_ManualInputs load(String payload) ### global void clear Deletes all manual inputs from the instance. Similar state as creating a new instance. #### API Version 55 #### Signature global void clear() ### global List getManualInputs Returns a list of all manual inputs in the current instance. #### API Version 55.0 #### Signature global List getManualInputs() ### global ManualCalculationInput.ManualInput addManualInput Adds a new manual input entry to the instance. #### API Version 55.0 #### Signature global ManualCalculationInput.ManualInput addManualInput(ManualCalculationInput.ManualInput mi) # Metadata Components This topic describes the list of available components that can be used on metadata-driven wizards. ## Text Table 1. Component Properties | Property | Type | Supports Expression? | Default Value | Required? | Description | | --- | --- | --- | --- | --- | --- | | id | String | No | | Yes | Case-sensitive unique identifier of the component instance. This identifier must be unique between all components in the wizard metadata configuration | | type | String | No | | Yes | Value is Text. | | visible | Boolean | Yes | true | No | Determines whether the component is rendered or not. Even if a component isn’t rendered, validations occur and the value are set on the wizard result. | | editable | Boolean | Yes | true | No | Determines if the value of the component can be edited. | | active | Boolean | Yes | true | No | Determines if the values of the component are set as part of the wizard result. | | label | String | Yes | | No | Display label for the field. | | required | Boolean | No | false | No | Determines if the field is required. If the field is required and no value is provided, the user is unable to submit the wizard. | | outputProperty | String | No | | No | Property of the result where the value of the input is set. | | defaultValue | String | Yes | | No | Default value of the component. | | maxLength | Number | Yes | Infinity | No | Maximum length the input can be. If exceeded, the input won’t be considered valid and the wizard can’t be submitted. | | minLength | Number | Yes | \-Infinity | No | Minimum length the input can be. If the length of the input is less than the minimum length, the input isn’t valid and the wizard can’t be submitted. | | placeholder | String | Yes | | No | Placeholder on the input field for when a value isn’t set. | **Example** { id : promoSlogan , type : Text , outputProperty : Slogan , required : true, label : Slogan , maxLength : 80, defaultValue : {! \_input\_.Slogan } } **Expression Value:** When referenced on an expression, this component returns the current text value of the input. **Result Value** When generating the result, this component sets the value of the text input on the property defined by the outputProperty attribute in the result object. If outputProperty isn’t set or the active property resolves to false, no data is set on the output object. ## Number This component displays a numeric field.
Table 2. Components
PropertyTypeSupports ExpressionDefault ValueRequiredDescription
idStringNoYesCase-sensitive unique identifier of the component instance. This identifier must be unique between all components in the wizard metadata configuration
defaultValueStringYes<empty>NoDefault value of the component.
visibleBooleanYestrueNoDetermines if the component is rendered or not. Even if a component isn’t rendered, validations occur and the value is on the wizard result.
requiredBooleanNofalseNoDetermines if the field is required. If the field is required and no value is provided, the user will not be able to submit the wizard.
editableBooleanYestrueNoDetermines if the value of the component can be edited.
activeBooleanYestrueNoDetermines if the value of the component is set as part of the wizard result.
labelStringYes<empty>NoDisplay label for the field.
autoAdjustBooleanNofalseNoIf enabled, after a user sets a value in the input, the value will be adjusted to the boundaries defined by the max and min properties in order for the input to be valid. If disabled, the wrong input is notified to the user as an invalid input.
decimalPlacesNumberYesInfinityNoMaximum amount of decimal places a value can have. If exceeded, the additional decimal places are truncated.
maxNumberYesInfinityNoMaximum value the input can be. If the value of the input exceeds the maximum value, the input will not be considered valid and the wizard can’t be submitted.
minNumberYes-InfinityNoMinimum value the input can be. If the value of the input is less than the minimum, the input will not be considered valid and the wizard can’t be submitted.
placeholderStringYes<empty>NoPlaceholder on the input field for when a value isn’t set.
outputPropertyStringNo<empty>NoProperty of the result where the value of the input is set.
typeStringNoYesValue is Number.
**Example** { id : promoPrice , type : Number , outputProperty : Price , required : true, label : Price , max : 1000000, min : 0, decimalPlaces : 2, autoAdjust : true } **Expression Value** When referenced on an Expression, this component returns the current numeric value of the input. **Result Value** When generating the result, this component sets the value of the numeric input on the property defined by the outputProperty attribute in the result object. If outputProperty isn’t set or the active property resolves to false, no data is set on the output object. ## Label This component displays a non-editable text. **Properties** | Property | Type | Supports Expression | Default Value | Required | Description | | --- | --- | --- | --- | --- | --- | | id | String | No | | Yes | Case-sensitive unique identifier of the component instance. This identifier must be unique between all components in the wizard metadata configuration | | type | String | No | | Yes | Value is Label | | visible | Boolean | Yes | true | No | Determines if the component is rendered or not. Even if a component isn’t rendered, validations still occur and the value is set on the wizard result. | | color | String | No | black | No | Color of the text. | | message | String | Yes | | No | Message to display on the label. | **Example** { id : myLabel , type : Label , color : red , visible : { left : {! promoTemplate.Name } , operator : equal , right : Customer Promotion }, message : Selected Customer Promotion! } **Expression Value** When referenced on an Expression, this component returns an empty value. **Result Value** This component doesn’t push any value to the result structure. ## Empty This component doesn’t display any input. It takes the space any other input would take. Table 3. Properties | Property | Type | Supports Expression? | Default Value | Required? | Description | | --- | --- | --- | --- | --- | --- | | id | String | No | | Yes | Case-sensitive unique identifier of the component instance. This identifier must be unique between all components in the wizard metadata configuration | | type | String | No | | Yes | Value is Empty | | visible | Boolean | Yes | true | No | Determines if the component is rendered or not. Even if a component isn’t rendered, validations still occur and the value is set on the wizard result. | **Example** { id : myEmptyBlock , type : Empty , visible : { left : {! promoTemplate.Name } , operator : equal , right : Customer Promotion } } **Expression Value** When referenced on an Expression, this component returns an empty value. **Result Value** This component doesn’t push any value to the result structure. ## Date This component displays a Date Picker field. The Date Picker date value is displayed according to the user's locale. Table 4. Properties | Property | Type | Supports Expression? | Default Value | Required? | Description | | --- | --- | --- | --- | --- | --- | | id | String | No | | Yes | Case-sensitive unique identifier of the component instance. This identifier must be unique between all components in the wizard metadata configuration | | type | String | No | | Yes | Value is Date | | visible | Boolean | Yes | true | No | Determines if the component is rendered or not. Even if a component isn’t rendered, validations still take place and the value is set on the wizard result. | | editable | Boolean | Yes | true | No | Determines if the value of the component can be edited. | | active | Boolean | Yes | true | No | Determines if the value of the component is set as part of the wizard result. | | label | String | Yes | | No | Display label for the field. | | required | Boolean | No | false | No | Determines if the field is required. If the field is required and no value is provided, the user won't be able to submit the wizard. | | outputProperty | String | No | | No | Property of the result where the value of the input is set. | | defaultValue | String | Yes | | No | Default value of the component. The Date value must be provided as a String with format YYYY-MM-DD . | **Example** { id : promoDateFrom , type : Date , outputProperty : DateFrom , required : true, label : Date From , defaultValue : 2020-01-01 } **Expression Value** When referenced on an Expression, this component returns the current date of the control as a string with the format YYYY-MM-DD . **Result Value** When generating the result, this component sets the value of the date input on the property defined by the outputProperty attribute in the result object. If outputProperty isn’t set or the active property resolves to false, no data is set on the output object. The result data is set as a String with the format YYYY-MM-DD . ## Duration This component displays a control with 2 inputs. A numeric field and a picklist field. On the numeric field, the user can input a number. On the picklist field, the user can select Days, Weeks, or Months. This control is used to calculate a second date based on another reference date by adding a number of weeks or months to it.
PropertyTypeSupports ExpressionDefault ValueRequiredDescription
idStringNoYesCase-sensitive unique identifier of the component instance. This identifier must be unique between all components in the wizard metadata configuration
typeStringNoYesValue is Duration
visibleBooleanYestrueNoDetermines if the component is rendered or not. Even if a component isn’t rendered, validations still occur and the value is set on the wizard result.
editableBooleanYestrueNoDetermines if the value of the component can be edited.
activeBooleanYestrueNoDetermines if the value of the component is set as part of the wizard result.
labelStringYes<empty>NoDisplay label for the field.
requiredBooleanNofalseNoDetermines if the field is required. If the field is required and no value is provided, the user won't be able to submit the wizard.
outputPropertyStringNo<empty>NoProperty of the result where the value of the input will be set.
defaultValueObjectYesNoDefault values for the Number field and the Weeks/Months picklist of the component. Possible values: day, week, or month.
referenceDateStringYesYesInitial date to add the number of selected weeks/months to. Format: YYYY-MM-DD
Example defaultValue: { metric : week , quantity : 1 } **Example** { id : promoDuration , type : Duration , outputProperty : DateThru , required : true, label : Duration , referenceDate : {! DateFrom } } **Expression Value** When referenced on an Expression, this component returns the computed date of the control as a string with the format YYYY-MM-DD . **Result Value** When generating the result, this component sets the value of the computed date on the property defined by the outputProperty attribute in the result object. If outputProperty isn’t set or the active property resolves to false, no data is set on the output object. The result data is set as a String with the format YYYY-MM-DD . ## Checkbox This component displays a checkbox field. Table 5. Properties | Property | Type | Supports Expression | Default Value | Required | Description | | --- | --- | --- | --- | --- | --- | | id | String | No | | Yes | Case-sensitive unique identifier of the component instance. This identifier must be unique between all components in the wizard metadata configuration | | type | String | No | | Yes | Value is Checkbox | | visible | Boolean | Yes | true | No | Determines if the component is rendered or not. Even if a component isn’t rendered, validations still occur and the value is set on the wizard result. | | editable | Boolean | Yes | true | No | Determines if the value of the component can be edited. | | active | Boolean | Yes | true | No | Determines if the value of the component is set as part of the wizard result. | | label | String | Yes | | No | Display label for the field. | | outputProperty | String | No | | No | Property of the result where the value of the input is set. | | defaultValue | Boolean | Yes | false | No | Default value of the component. | **Example** { id : promoCheckbox , type : Checkbox , outputProperty : myCheckbox , label : Promotion Checkbox , defaultValue : true } **Expression Value** When referenced on an Expression, this component returns the current value of the control as a Boolean. **Result Value** When generating the result, this component sets the value of the control on the property defined by the outputProperty attribute in the result object. If outputProperty isn’t set or the active property resolves to false, no data is set on the output object. The result data is set as a Boolean. ## Picklist This component displays a picklist field. Table 6. Properties | Property | Type | Supports Expression? | Default Value | Required? | Description | | --- | --- | --- | --- | --- | --- | | id | String | No | | Yes | Case-sensitive unique identifier of the component instance. This identifier must be unique between all components in the wizard metadata configuration | | type | String | No | | Yes | Value is Picklist | | visible | Boolean | Yes | true | No | Determines if the component is rendered or not. Even if a component isn’t rendered, validations still occur and the value is set on the wizard result. | | editable | Boolean | Yes | true | No | Determines if the value of the component can be edited. | | active | Boolean | Yes | true | No | Determines if the value of the component is set as part of the wizard result. | | label | String | Yes | | No | Display label for the field. | | required | Boolean | No | false | No | Determines if the field is required. If the field is required and no value is provided, the user won't be able to submit the wizard. | | outputProperty | String | No | | No | Property of the result where the value of the input will be set. | | defaultValue | String || List | Yes | | No | Default value of the component. | | autoSelectFirstItem | Boolean | No | false | No | If set, when rendering the pick list, if no valid value is on the pick list, the system automatically selects the first item on the dataset as value. | | defaultValueIndex | Number | Yes | | No | If set, when rendering the pick list, if no valid value is on the pick list, the system selects the item with the specified index from the dataset as value. | | multiselect | Boolean | No | false | No | If enabled, the user is able to select multiple items on the pick list instead of just a single one. | | maxSelectedItems | Number | No | Infinity | No | If the pick list is multiselect, it defines the maximum number of items that can be selected. Selecting an additional item after the limit is reached will cause the first selected item to be unselected. | | source | List || Object | No | | Yes | Refer to the pick list source section for more information. | | itemLabelField | String | No | Name | No | The property name for each of the items in (or resolved by) the source that will be used as label on the pick list. | | itemValueField | String | No | Id | No | The property name for each of the items in (or resolved by) the source that will be used as value on the pick list. | **Picklist Source** The list of available values for the picklist can be defined in 2 different ways. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note It's important to note that the object records that are part of the dataset for a picklist field can have as many properties as needed. These properties can be accessed through Expressions in other components, as seen on the examples. **Static List of Values** In order to define a static list of values for a picklist, set the source property to be a list of objects. Each record on this list represents a possible value for the picklist: ... source : \[ { Id : myFirstValue , Name : My First Value , MyAdditionalField : MyAdditionalFieldForFirstItem }, { Id : mySecondValue , Name : My Second Value , MyAdditionalField : MyAdditionalFieldForSecondItem } \], itemLabelField : Name , itemValueField : Id ... **APEX Provided List of Values** You can retrieve the list of possible values for a picklist. The APEX callable classes are called to retrieve the values. In the WizardComponentmetadata, specify from which APEX callable class and method we want to get the values from. ... source : { class : MyPicklistValues , method : getPicklistValues , cache : true, params : { myFirstParameter : firstParameterValue , mySecondParameter : {! promoTemplate.Id } } }, itemLabelField : Name , itemValueField : Id ... Table 7. Source Attribute Properties | Property | Type | Default Value | Required? | Description | | --- | --- | --- | --- | --- | | class | String | | Yes | The name of the APEX Callable class. | | method | String | | No | An optional Method name to pass to the callable class. The method can be used to have a single APEX Callable class be able to return different datasets depending on the specified method. | | cache | Boolean | false | No | If set, the response for a Callable APEX class will be cached in the browser. This implies that requests to the same APEX Callable class, to the same method and with the same parameters, will only be performed one time, and subsequent calls reuse the values from previous executions. | | params | Object | {} | No | It's possible to pass additional parameters to the APEX Callable class using the params property. When calling the APEX class, the params object is passed to the APEX class as part of the request. The params object supports expressions as the value for their properties. These expressions values are resolved before calling the APEX callable class. | ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note When using expressions on the params property, the same rules as with other WizardComponents apply. Whenever a referenced component changes, the request to the APEX callable class will be executed again. It's highly advisable to enable caching ( cache : true) on the source in order to not execute duplicated calls against Salesforce servers and greatly improve performance. **Example Callable Class** public with sharing class MyPicklistValues implements System.Callable { public class MyPicklistValuesException extends Exception {}; public Object call(String method, Map params) { // Check that the provided method is the expected method // It is possible to have multiple methods in the same class if (method !== 'getPicklistValues') { throw new MyPicklistValuesException('Invalid Method!'); } // we can extract call parameters from the params property String myFirstParameter = (String) params.get('myFirstParameter'); String mySecondParameter = (String) params.get('mySecondParameter'); return new List> { new Map { 'Id' => 'myFirstValue', 'Name' => 'My First Value', 'MyAdditionalField' => 'MyAdditionalFieldForFirstItem' }, new Map { 'Id' => 'mySecondValue', 'Name' => 'My Second Value', 'MyAdditionalField' => 'MyAdditionalFieldForSecondItem' } }; } } **Example** { id : promoExamplePicklist , type : Picklist , required : true, outputProperty : ExamplePicklist , source : { class : MyPicklistValues , method : getPicklistValues , cache : true, params : { myFirstParameter : firstParameterValue , mySecondParameter : {! promoTemplate.Id } } }, label : ExamplePicklist , autoSelectFirstItem : true } **Expression Value** Depending if the field is multiselect or single select, the value that is accessible from expressions is different: **singles elect** When referenced on an Expression, this component returns the current dataset object that is selected on the picklist. For example, taking into account the above examples: // if the first item is selected (Id = myFirstValue ) { Id : myFirstValue , Name : My First Value , MyAdditionalField : MyAdditionalFieldForFirstItem } // if the second item is selected { Id : mySecondValue , Name : My Second Value , MyAdditionalField : MyAdditionalFieldForSecondItem } Since the picklist exposes an object as an expression value, Properties of these dataset records can be used on expressions using dot notation: {! promoExamplePicklist.MyAdditionalField } --> resolves to MyAdditionalFieldForFirstItem {! promoExamplePicklist.MyNonExistantField } --> resolves to undefined, since the field doesn't exist **multiselect** When referenced on an Expression, this component returns the list of current dataset objects that are selected on the picklist. // if the first item is selected (Id = myFirstValue ) \[ { Id : myFirstValue , Name : My First Value , MyAdditionalField : MyAdditionalFieldForFirstItem } \] // if both the first item and second items are selected \[ { Id : myFirstValue , Name : My First Value , MyAdditionalField : MyAdditionalFieldForFirstItem }, { Id : mySecondValue , Name : My Second Value , MyAdditionalField : MyAdditionalFieldForSecondItem } \] Since the picklist exposes an array as an expression value, items on the array can be accessed using square bracket notation \[0\] . Also, Properties of these dataset records can be used on expressions using dot notation: {! promoExamplePicklist\[0\].MyAdditionalField } --> resolves to MyAdditionalFieldForFirstItem {! promoExamplePicklist\[1\].MyAdditionalField } --> resolves to MyAdditionalFieldForSecondItem {! promoExamplePicklist\[99\].MyAdditionalField } --> resolves to undefined, since the element does not exist. **Result Value** **single select** // if the first item is selected (Id = myFirstValue ) { ExamplePicklist : myFirstValue // since itemValueField is Id , we set the Id property of the selected record } // if the first item is selected (Id = mySecondValue ) { ExamplePicklist : mySecondValue // since itemValueField is Id , we set the Id property of the selected record } **multiselect** // if the first item is selected (Id = myFirstValue ) { ExamplePicklist : \[ myFirstValue \] // since itemValueField is Id , we set the Id property of the selected record } // if the bot items are selected { ExamplePicklist : \[ myFirstValue , mySecondValue \] // since itemValueField is Id , we set the Id property of the selected record } ## ListController This component displays a control that allows users to add items to an Array. For each one of the items, the parameter list of WizardComponent metadata is replicated in order to provide components to handle each item of the list. Table 8. Properties | Property | Type | Supports Expressions | Default Value | Required | Description | | --- | --- | --- | --- | --- | --- | | active | Boolean | Yes | true | No | Determines if the value of the component is set as part of the wizard result. | | columns | Number | No | 3 | No | Defines the number of columns that each item in the list has as layout. | | components | List | No | \[ \] | No | The metadata of the components that will be replicated for each item in the list. | | defaultItems | Number | Yes | 0 | No | When first rendering the control, the number of items that will be created by default. | | editable | Boolean | Yes | true | No | Determines if the value of the component can be edited. | | id | String | No | | Yes | Case-sensitive unique identifier of the component instance. This identifier must be unique between all components in the wizard metadata configuration | | itemUniqueKey | String | Yes | | No | When defined, the component evaluates the passed expression for each one of the items on the list. If it finds any duplicate values on the results of evaluating it, it shows an error message telling the user there are duplicate items and won't allow for the wizard to be submitted. | | label | String | Yes | | No | Display label for the field. | | maxItems | Number | Yes | Infinity | No | The maximum number of items the control can have. | | outputProperty | String | No | | No | Property of the result where the value of the input will be set. | | type | String | No | | Yes | Value is Checkbox | | visible | Boolean | Yes | true | No | Determines if the component is rendered or not. Even if a component isn’t rendered, validations still occur and the value is set on the wizard result. | **Example** { id : TacticController , type : ListController , label : Tactics , outputProperty : Tactics , maxItems : 10, active : {! promoTemplate.HasTacticTemplates } , defaultItems : 2, components : \[ { id : tacticTemplate , type : Picklist , required : true, outputProperty : TacticTemplate , source : { class : NewPromotionWizardCallable , method : getTacticTemplates , params : { promoTemplate : {! promoTemplate.Id } }, cache : true }, label : Tactic Template , defaultValueIndex : {! \_idx\_ } , autoSelectFirstItem : true } \] } **Expression Value** Metadata configuration example components : \[ { id : promoSlogan , // A wizard component for the promotion slogan input type : Text , label : Slogan }, { id : promoSampleText , // A wizard component for a text type : Text , label : SampleText }, { id : TacticController , // A wizard component for the Tactics list type : ListController , label : Tactics , components : \[ // This List of wizard components will create a new scope for the items below! { id : tacticName , type : Text , // For each tactic, we will have a name field label : MyTacticName }, { id : tacticSampleText , type : Text , // For each tactic, we will have a text field label : MyTacticSampleText } \] } \] Expression scope // Context for expressions on the promoSlogan component { promoSlogan : slogan value , // provided by itself promoSampleText : sample text // provided by the promoSampleText component in the same level } // Context for expressions on the tacticName component { promoSlogan : slogan value , // provided by promoSlogan , accessible since it's above in the hierarchy promoSampleText : sample text , // provided by promoSampleText , accessible since it's above in the hierarchy \_idx\_ : 1, // provided by the ListController component, Item index on the array tacticName : tactic 1's name , // provided by itself tacticSampleText : tactic 1's sample text // provided by the tacticSampleText component in the same level } **Result Value** When generating the result, this component sets the array of generated items on the property defined by the outputProperty attribute in the result object. If outputProperty isn’t set or the active property resolves to false, no data is set on the output object. # Metadata Definition This topic describes the metadata structure and the available wizard components that can be used to build wizards. ## Wizard Configuration Wizards are generated from a metadata JSON structure defining the list of components that are part of a wizard along with some additional properties to define the available actions and the general layout.
Table 1. Metadata Properties
Property Type Required? Default Value Description
footerLeftButtons Array<String | WizardButtonMetadata> false [] List of button actions that appears on the footer. The actions cancel and submit have default button styles and can be specified as strings. For custom actions, use the WizardButtonMetadata structure to define proper styling for the buttons.
footerRightButtons Array<String | WizardButtonMetadata> false [] List of button actions that appears on the footer. The actions cancel and submit have default button styles and can be specified as strings. For custom actions, use the WizardButtonMetadata structure to define proper styling for the buttons.
components Array<WizardComponentMetadata> true List of metadata definitions for the components in the wizard.
columns Number false 2 Number of columns the WizardComponent displays.
title String true Title for the wizard that is displayed on the header of the modal.
size String true Wizard modal size.
Possible values:
  • small
  • large
## WizardComponentMetadata This metadata type describes the components that are inside the wizard. Components render in same order they’re placed in the list. Each component has its own specific attributes, however, all components share a common set of attributes that must be specified: { "id": "mySlogan" "type": "Text", "outputProperty": "Slogan", "required": true, "label": "Slogan", "maxLength": 80, "minLength": 1, "defaultValue": "" } Table 2. Shared Component Properties | Property | Type | Required | Description | | --- | --- | --- | --- | | id | String | true | Case-sensitive unique identifier of the component instance. This identifier must be unique between all components in the wizard metadata configuration | | type | String | true | Type of the component to render. this attribute indicates the component that is rendered on UI. Also, this attribute defines the additional attributes required for the component. | ## WizardButtonMetadata This metadata structure defines the buttons that appear at the bottom of the wizard.
Table 3. Button Properties
Property Type Required Description
type String true The action that will be performed after clicking the button. Button type is a free text, which is returned along with the output object when the user clicks a button.
brand String true UI Type of the button. Possible values are:
  • base
  • neutral
  • brand
  • brand-outline
  • destructive
  • destructive-text
  • inverse
  • success
label String true Label for the button.
# Metadata Wizard The MetadataWizard is designed as a library that can be used to build simple wizard pages that are rendered to the user based on the defined wizard metadata. This document describes the NewPromotionWizardCallable APEX Class created for providing data for the New Promotion Metadata Driven wizard. ## Introduction The MetadataWizard engine reads the wizard configuration metadata. It uses the components defined in it's repository to create the required component instances for user interaction. The MetadataWizard engine handles interactions with the wizard buttons (Submit and Cancel). MetadataWizard execution consists of the following components: | Components | Description | | --- | --- | | Wizard Metadata | The configurable part of the wizard, where the various components are defined. The components are defined to render and also to interact between each other. For more information, see [Metadata Definition](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/metadata_definition.htm "This topic describes the metadata structure and the available wizard components that can be used to build wizards.") | | Result Object | The final object that will be returned by the Metadata wizard after execution. Each component in the wizard sets one or more attributes into this output object. Components define where the values are set in the output object through a metadata property outputProperty. | | Component Value | The value that the component exposes for the wizard instance is used to achieve communication between components through the use of expressions in their metadata properties. Whenever a component value changes, it notifies the new value to the other components referencing it (using expressions). It then re-renders the values to ensure that the new metadata values are reflected. | - **[Metadata Definition](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/metadata_definition.htm)** This topic describes the metadata structure and the available wizard components that can be used to build wizards. - **[Metadata Wizard Expression](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/metadata_expression.htm)** Expressions provide dynamic values to Wizard Components. Wizard Components accept expressions in some of their metadata properties. With expressions, you can also access instance values of other Wizard Components and dynamically set the metadata attributes, and create conditions. When a Wizard Component has an expression as a metadata attribute, the Wizard Component gets re-rendered every time the expression value changes. - **[Metadata Components](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/metadata_components.htm)** This topic describes the list of available components that can be used on metadata-driven wizards. - **[Promotion Wizard Input Structure](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/NewPromotionWizardInputStructure.htm)** This document describes the input that SmartUI generates when initializing the new metadata-driven promotion wizard. SmartUI extracts information on where the user clicked when launching the wizard in order to provide as much information as possible to the wizard so it can be used to provide sensible defaults. # Metadata Wizard Expression Expressions provide dynamic values to Wizard Components. Wizard Components accept expressions in some of their metadata properties. With expressions, you can also access instance values of other Wizard Components and dynamically set the metadata attributes, and create conditions. When a Wizard Component has an expression as a metadata attribute, the Wizard Component gets re-rendered every time the expression value changes. ## Literal Value An expression that doesn’t match the structure of the other expression types. **Example** "{! !(promoTemplate.Name == 'Test' || promoTemplate.Name != 'Test2') }" ... Access the properties of identifiers using the dot notation: "{! promoTemplate.Name }"
LiteralExampleResolves to
true"{! true }"Boolean true
false"{! false }"Boolean false
null"{! null }"null
## String Expressions A string with a specific start and end sequence of characters ("{!" and "}"). Use these expressions to retrieve values from other Wizard Component instances by specifying the component ID of the Wizard Component instance. **Example** ... { "id": "myCheckboxField", "type": "Checkbox", }, ... { "id": "myOtherField", "active": "{! myCheckboxField }", ... ## Logical Expressions An object with these three properties - left, right, and operator. Use this expression to perform operations between different values. **Example** { "left": "operator": "equal", "right" : } // Example ... "active" : { "left": "{! myCheckbox}", "operator":"equal", "right": true }, ... List of available operators: - and - or - equal - notEqual - greaterThan - lessThan - greaterThanOrEqual - lessThanOrEqual - sum - subtract - multiply - divide ## Expression Variables Additional values can also be referenced from expressions: - \_input\_ → The input payload passed to the Wizard instance during its creation. Use this variable to set default values: - "{! \_input\_.Slogan }" ## Identifiers for Custom, SObject, and SObject Field Labels To get custom, sObject, and sObject field labels, use the identifiers, $Label and $SObjectType in expressions. ![Note](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/images/icon_note.png) #### Note All Wizard Components support expressions with the $Label and $SObjectType identifiers. **Expression Syntax for a Custom Label:** {! $Label.