PricingActionParameters | Metadata API Developer Guide

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

PricingActionParameters components have the suffix .pricingActionParameters and are stored in the pricingActionParameters folder.

Version

PricingActionParameters components are available in API version 60.0 and later.

Special Access Rules

This metadata type is available with Salesforce Pricing.

Fields

Field Name	Description
contextDefinition	Field Type string Description Required. Context definition record that's associated with the pricing action.
contextMapping	Field Type string Description Required. Context mapping record that's associated with the pricing action.
developerName	Field Type string Description Required. Unique name of the pricing action parameter record. The name must begin with a letter and use only alphanumeric characters and underscores. The name must not include spaces, end with an underscore, or have two consecutive underscores.
effectiveFrom	Field Type dateTime Description Required. Date and time from when the pricing action becomes effective.
effectiveTo	Field Type dateTime Description Date and time till when the pricing action is in effect.
masterLabel	Field Type string Description Required. Master label of the pricing action parameter.
objectName	Field Type string Description Name of the object that's associated with the pricing action. Valid values are: `Case` `Contract` `Opportunity` `Order` `Quote` `SalesAgreement` `WorkOrder`
pricingProcedure	Field Type string Description Pricing procedure record that's associated with this pricing action.

Declarative Metadata Sample Definition

The following is an example of a PricingActionParameters component.

1<PricingActionParameters xmlns="http://soap.sforce.com/2006/04/metadata">
2    <developerName>CMEDefaultActionParameters</developerName>
3    <objectName>ORDER</objectName>
4    <pricingProcedure>PP</pricingProcedure>
5    <effectiveFrom>2024-04-08T07:32:00.000Z</effectiveFrom>
6    <effectiveTo>2024-04-11T07:32:00.000Z</effectiveTo>
7    <contextDefinition>SalesTransactionContext__stdctx</contextDefinition>
8    <contextMapping>SalesAgreementEntitiesMapping</contextMapping>
9    <masterLabel>PAP_test</masterLabel>
10</PricingActionParameters>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>PricingActionParameters</name>
6    </types>
7    <version>66.0</version>
8</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.