afv-library/skills/platform-data-and-tooling-api-context-get/assets/tooling_api/AccountPlanObjMeasCalcDef.json

{
  "sections": [
    "title",
    "description",
    "supported_soap_calls",
    "supported_rest_api_http_methods",
    "fields",
    "special_access_rules",
    "wsdl_segment"
  ],
  "title": "AccountPlanObjMeasCalcDef - Tooling API",
  "description": "Represents the metadata associated with an account plan objective measure calculation definition. An account plan objective measure calculation definition contains a target object, rollup field, and logic for calculating the current value of a sales account plan objective measure. This object is available in API version 63.0 and later.",
  "supported_soap_calls": "`create()`, `delete()`, `describeSObjects()`, `query()`, `retrieve()`, `update()`, `upsert()`",
  "supported_rest_api_http_methods": "`DELETE`, `GET`, `HEAD`, `PATCH`, `POST`, `Query`",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "Description": {
      "type": "textarea",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "A summary of the calculation definition that’s visible to users when they select the definition for an account plan objective measure."
    },
    "DeveloperName": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Record Type Name."
    },
    "ManageableState": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Indicates the manageable state of the specified component that is contained in a package: beta deleted deprecated deprecatedEditable installed installedEditable released unmanaged"
    },
    "MasterLabel": {
      "type": "string",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "Label for the AccountPlanObjMeasCalcDef object. In the UI, this field is Label."
    },
    "NamespacePrefix": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation. The namespace prefix can have one of the following values: In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer. In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects."
    },
    "RollupType": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "The method for calculating the account plan objective measure’s current value from records that match the calculation definition and any optional conditions. Possible values are: Count Max—Maximum Min—Minimum Sum"
    },
    "Status": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "Specifies the status of the calculation definition. Only active calculation definitions are available for users to select when they specify an account plan objective measure. Possible values are: Active Draft Inactive"
    },
    "TargetField": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "The field on TargetObject to use for calculating the account plan objective measure’s current value. Rollup fields on the Campaign, Case, Contact, or Opportunity object are supported. In Setup, this field’s label is Rollup Field."
    },
    "TargetObject": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort",
      "description": "The object to use for calculating the account plan objective measure’s current value. Possible values are: Campaign Case Contact Opportunity"
    },
    "ValueType": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The data type for calculating the account plan objective measure’s current value. Possible values are: Currency Number Percent"
    }
  },
  "special_access_rules": "To access AccountPlanObjMeasCalcDef components, enable account plans.",
  "wsdl_segment": "```xml\n<xsd:complexType name=\"AccountPlanObjMeasCalcDef\">\n  <xsd:complexContent>\n    <xsd:extension base=\"mns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"conditions\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"mns:AccountPlanObjMeasCalcCond\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"developerName\" type=\"xsd:string\"/>\n        <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n        <xsd:element name=\"rollupType\" type=\"xsd:string\"/>\n        <xsd:element name=\"status\" type=\"xsd:string\"/>\n        <xsd:element name=\"targetField\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"targetObject\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```"
}