Revenue Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with Revenue Cloud Developer Resources
Product Catalog Management
Salesforce Pricing
Salesforce Pricing Standard Objects
Salesforce Pricing Business APIs
Resources
Request Bodies
Adjustment Details Input
Configuration Override Input
PBE Derived Pricing Input
Pricing Input
Pricing Recipe Input
Pricing Recipe LookUp Table Input
Pricing Recipe Procedure Input
Pricing Request Input
Pricing Versioned Revision Details Input
Pricing Waterfall Input
Pricing Waterfall Log Input
Procedure Plan Criterion Input
Procedure Plan Definition Input
Procedure Plan Definition Version Input
Procedure Plan Evaluation Input
Procedure Plan Section Input
Procedure Plan Option Input
Response Bodies
Salesforce Pricing Standard Invocable Actions
Salesforce Pricing Metadata API Types
Salesforce Pricing Tooling API Objects
Rate Management
Usage Management
Product Configurator
Transaction Management
Dynamic Revenue Orchestrator
Billing
Revenue Cloud Associated Objects
PDF

Procedure Plan Definition Input

Input representation of the details of a procedure plan definition.
JSON example
This example shows a sample request to create a procedure plan definition record by using the Procedure Plan Definitions (POST) API.
{
  "description": "Definition for Quote",
  "developerName": "Quote_Definition_Sample",
  "name": "Quote_Definition_Sample",
  "primaryObject": "BusinessHours",
  "procedurePlanDefinitionVersions": [
    {
      "active": false,
      "contextDefinition": "SalesTransactionContext__stdctx",
      "readContextMapping": "QuoteEntitiesMapping",
      "saveContextMapping": "QuoteEntitiesMapping",
      "effectiveFrom": "2024-07-15T10:15:30.000Z",
      "developerName": "Quote_Definition_V1",
      "rank": 1
    }
  ]
}
This example shows a sample request to update a procedure plan definition by using the Procedure Plan Definition By ID (PATCH) API.

The properties that aren’t specified in the input are deleted when updating the record.

Note

{
  "description": "Default definition patch update",
  "developerName": "Quote_Definition",
  "name": "Quote_Definition",
  "primaryObject": "Quote",
  "recordId": "1FNxx0000004EsOGAU"
}
Properties
Name Type Description Required or Optional Available Version
description String Description of the procedure plan definition. Optional 62.0
developer​Name String Developer name of the procedure plan definition. Required if you’re invoking the Procedure Plan Definitions API (POST). 62.0
name String Name of the procedure plan definition. Optional 62.0
primary​Object String Source object that’s used to create a procedure with rule-based criteria. This property value must be a valid object name and must be unique in the ProcedurePlanDefinition object. Required if you’re invoking the Procedure Plan Definitions API (POST) and if you’re creating a procedure with rule-based criteria. 62.0
procedurePlan​Definition​Versions Procedure Plan Definition Version Input[] List of versions of a procedure plan definition. Required 62.0
recordId String ID of the procedure plan definition record. Required if you’re invoking the Procedure Plan Definition By ID API (PATCH). 62.0